Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Trip

Start a trip

Add a new trip to the system with the provided data.

post/skynet/trip/start

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

custom_idstring

Set a unique ID for the new trip. If not provided, an ID will be automatically generated in UUID format. A valid custom_id can contain letters, numbers, “-”, & “_” only.

Please note that the ID of a trip can not be changed once it is created.

asset_idstring required

Specify the ID of the asset which is making this trip. The asset will be linked to this trip.

namestring

Specify a name for the trip.

descriptionstring

Add a custom description for the trip.

meta_dataobject

An JSON object to collect additional details about the trip. Use this property to add any custom information / context about the trip. The input will be passed on to the response as-is and can be used to display useful information on, for example, a UI app.

attributesobject

attributes can be used to store custom information about a trip in key:value format. Use attributes to add any useful information or context to your trips like the driver name, destination etc.

Please note that the maximum number of key:value pairs that can be added to an attributes object is 100. Also, the overall size of attributes object should not exceed 65kb.

Example request

{
  "name": "\"name\": \"Employee Pickup\"",
  "stops": [
    {
      "name": "\"name\":\"Head Office\""
    }
  ]
}

Response

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.