Vehicle Tracking API

Vehicle Tracking API

Any third party applications may use these API to empower business.

This API is based on REST standards, and is compatible with all kinds of programming languages.

API Details

Authentication Request

Array
(
    [api_id] => [Required] CITS_API_VT001
    [api_name] => [Optional] auth
    [system_time] => [Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [username] => [Required] <username: Login Credentials, unique username for each user>
    [password] => [Required] <password: Login Credentials, system/user generated password>
    [authentication_key] => [Required] <authentication_key: Login Credentials, system generated merchant id>
)
JSON String: {"api_id":"[Required] CITS_API_VT001","api_name":"[Optional] auth","system_time":"[Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","username":"[Required] <username: Login Credentials, unique username for each user>","password":"[Required] <password: Login Credentials, system\/user generated password>","authentication_key":"[Required] <authentication_key: Login Credentials, system generated merchant id>"}

Authentication Response

Array
(
    [api_id] => CITS_API_VT001
    [api_name] => auth
    [system_time] => <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [expiretime] => <system_generated_time: System Time expiring Stamp in GMT>
    [error] => <error_message_code: 0 for success [default_value: 0]>
    [message] => <system_message: sucess or error>
    [results] => <return_results: Number of results returned by the system [default_value: 0]>
    [session_key] => <authenticated_key: On sucess>
)
JSON String: {"api_id":"CITS_API_VT001","api_name":"auth","system_time":"<system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","expiretime":"<system_generated_time: System Time expiring Stamp in GMT>","error":"<error_message_code: 0 for success [default_value: 0]>","message":"<system_message: sucess or error>","results":"<return_results: Number of results returned by the system [default_value: 0]>","session_key":"<authenticated_key: On sucess>"}

Start Trip Request

Array
(
    [api_id] => [Required] CITS_API_VT002
    [api_name] => [Optional] trip_start
    [system_time] => [Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [session_key] => [Required] <authenticated_key: On returned on sucessful login>
    [records] => [Required: 2 in example] <fetch_records: Number of records for which the data has to be pulled [default_value: 1]>
    [deviceids] => Array
        (
            [deviceid_1] => Array
                (
                    [id] => [Required] <deviceid: Unique Device Identification Number>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                )

            [deviceid_2] => Array
                (
                    [id] => [Optional] <deviceid: Unique Device Identification Number>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                )

        )

)
JSON String: {"api_id":"[Required] CITS_API_VT002","api_name":"[Optional] trip_start","system_time":"[Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","session_key":"[Required] <authenticated_key: On returned on sucessful login>","records":"[Required: 2 in example] <fetch_records: Number of records for which the data has to be pulled [default_value: 1]>","deviceids":{"deviceid_1":{"id":"[Required] <deviceid: Unique Device Identification Number>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"deviceid_2":{"id":"[Optional] <deviceid: Unique Device Identification Number>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"}}}

Start Trip Response

Array
(
    [api_id] => CITS_API_VT002
    [api_name] => trip_start
    [system_time] => <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [error] => <error_message_code: 0 for success>
    [message] => <system_message: sucess or error>
    [results] => <return_results: Number of results returned by the system>
    [deviceids] => Array
        (
            [deviceid_1] => Array
                (
                    [id] => <deviceid: Unique Device Identification Number>
                    [lng] => <longitude: Longitude value of the device at any given time>
                    [lat] => <latitude: Latitude value of the device at any given time>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                )

            [deviceid_2] => Array
                (
                    [id] => <deviceid: Unique Device Identification Number>
                    [lng] => <longitude: Longitude value of the device at any given time>
                    [lat] => <latitude: Latitude value of the device at any given time>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                )

        )

)
JSON String: {"api_id":"CITS_API_VT002","api_name":"trip_start","system_time":"<system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","error":"<error_message_code: 0 for success>","message":"<system_message: sucess or error>","results":"<return_results: Number of results returned by the system>","deviceids":{"deviceid_1":{"id":"<deviceid: Unique Device Identification Number>","lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"deviceid_2":{"id":"<deviceid: Unique Device Identification Number>","lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"}}}

End Trip Request

Array
(
    [api_id] => [Required] CITS_API_VT003
    [api_name] => [Optional] trip_end
    [system_time] => [Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [session_key] => [Required] <authenticated_key: On returned on sucessful login>
    [records] => [Required: 2 in example] <fetch_records: Number of records for which the data has to be pulled [default_value: 1]>
    [deviceids] => Array
        (
            [deviceid_1] => Array
                (
                    [id] => [Required] <deviceid: Unique Device Identification Number>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                    [end_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                )

            [deviceid_2] => Array
                (
                    [id] => [Optional] <deviceid: Unique Device Identification Number>
                    [start_time] => [Optional] <time: Time value of the device at given time [default_value: Server Time]>
                    [end_time] => [Optional] <time: Time value of the device at given time [default_value: Server Time]>
                )

        )

)
JSON String: {"api_id":"[Required] CITS_API_VT003","api_name":"[Optional] trip_end","system_time":"[Required] <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","session_key":"[Required] <authenticated_key: On returned on sucessful login>","records":"[Required: 2 in example] <fetch_records: Number of records for which the data has to be pulled [default_value: 1]>","deviceids":{"deviceid_1":{"id":"[Required] <deviceid: Unique Device Identification Number>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>","end_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"deviceid_2":{"id":"[Optional] <deviceid: Unique Device Identification Number>","start_time":"[Optional] <time: Time value of the device at given time [default_value: Server Time]>","end_time":"[Optional] <time: Time value of the device at given time [default_value: Server Time]>"}}}

End Trip Response

Array
(
    [api_id] => CITS_API_VT003
    [api_name] => trip_end
    [system_time] => <system_generated_time: System Time Stamp in GMT [default_value: Server Time]>
    [error] => <error_message_code: 0 for success>
    [message] => <system_message: sucess or error>
    [results] => <return_results: Number of results returned by the system>
    [transaction_time] => <time: Time value of the device at given time>
    [deviceids] => Array
        (
            [deviceid_1] => Array
                (
                    [id] => <deviceid: Unique Device Identification Number>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                    [end_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                    [total_distance] => <distance: Calculated Distance>
                    [distance_units] => <unit: Units to used distance>
                    [route] => Array
                        (
                            [results] => <route return_results: Number of results returned by the system>
                            [route_path] => Array
                                (
                                    [1] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                    [2] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                    [3] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                )

                        )

                )

            [deviceid_2] => Array
                (
                    [id] => <deviceid: Unique Device Identification Number>
                    [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                    [end_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                    [total_distance] => <distance: Calculated Distance>
                    [distance_units] => <unit: Units to used distance>
                    [route] => Array
                        (
                            [results] => <route return_results: Number of results returned by the system>
                            [route_path] => Array
                                (
                                    [1] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                    [2] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                    [3] => Array
                                        (
                                            [lng] => <longitude: Longitude value of the device at any given time>
                                            [lat] => <latitude: Latitude value of the device at any given time>
                                            [start_time] => [Required] <time: Time value of the device at given time [default_value: Server Time]>
                                        )

                                )

                        )

                )

        )

)
JSON String: {"api_id":"CITS_API_VT003","api_name":"trip_end","system_time":"<system_generated_time: System Time Stamp in GMT [default_value: Server Time]>","error":"<error_message_code: 0 for success>","message":"<system_message: sucess or error>","results":"<return_results: Number of results returned by the system>","transaction_time":"<time: Time value of the device at given time>","deviceids":{"deviceid_1":{"id":"<deviceid: Unique Device Identification Number>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>","end_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>","total_distance":"<distance: Calculated Distance>","distance_units":"<unit: Units to used distance>","route":{"results":"<route return_results: Number of results returned by the system>","route_path":{"1":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"2":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"3":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"}}}},"deviceid_2":{"id":"<deviceid: Unique Device Identification Number>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>","end_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>","total_distance":"<distance: Calculated Distance>","distance_units":"<unit: Units to used distance>","route":{"results":"<route return_results: Number of results returned by the system>","route_path":{"1":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"2":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"},"3":{"lng":"<longitude: Longitude value of the device at any given time>","lat":"<latitude: Latitude value of the device at any given time>","start_time":"[Required] <time: Time value of the device at given time [default_value: Server Time]>"}}}}}}