Sign in

b647f1808dda

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Asset

Track locations of an asset

get/skynet/asset/{id}/location/list

Path parameters

idstring required

ID of the asset for which the location track information needs to be retrieved. This is the same ID that was generated/provided at the time of creating the asset.

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.

start_timeinteger

Time after which the tracked locations of the asset need to be retrieved.

end_timeinteger

Time until which the tracked locations of the asset need to be retrieved.

geometry_type'polyline' | 'polyline6' | 'geojson'

geometry format to encode the path linking the tracked locations of the asset.

Set the geometry format to encode the path linking the tracked locations of the asset.

Please note that geometry_type is effective only when mapmatch property of correction parameter is set to 1.

correctionstring mapmatch=boolean,interpolate=boolean,mode=string
Example:correction=mapmatch=1,interpolate=0,mode=car

Describe the geometry characteristics through a , separated list of properties.

Setting mapmatch to 1 returns the geometry of the tracked points, snapped to the nearest road.

Setting interpolate to 1 smoothens the snapped geometry by adding more points, as needed. Please note, mapmatch should be set to 1 for interpolate to be effective.

mode is used to set the transport mode for which the snapped route will be determined. Allowed values for mode are car and truck.

pninteger

Denotes page number. Use this along with the ps parameter to implement pagination for your searched results. This parameter does not have a maximum limit but would return an empty response in case a higher value is provided when the result-set itself is smaller.

psinteger

Denotes number of search results per page. Use this along with the pn parameter to implement pagination for your searched results.

Response

OK

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.