Movement Tracking Service
Snapped Distance
GET snapped distance Data
1min
GET
http://{base_url}/core/api/v1/mts/devices/{deviceId}/apps/{app}/snapped-distance
PATH PARAMETERS
app
string
*deviceId
string
*Denotes the mts device id.
HEADER PARAMETERS
X-COREOS-TID
string
*Tenant ID.
X-COREOS-ACCESS
string
*Access token.
X-COREOS-REQUEST-ID
string
*Unique Request ID.
X-COREOS-USERINFO
string
User info.
X-COREOS-CALLBACK-SECRET
string
base64 encoded callback secret
QUERY PARAMETERS
start
integer
Start time in epoch milliseconds. This timestamp cannot be older than 2 days from current time
duration
string
Example: 2hour -> 2h, 1day -> 1d, 50seconds -> 50s
Time for which data packets need to be fetched. Regex pattern - ^(\d{0,2}(?
\s*))?(\d{0,2}(?\s*))?(\d{0,2}(?\s*))?(\d{0,2}(?\s*))?$id
string
Used to filter for a specific trackId/dispatchId.
callback
string
Example: {"url":"https://alexa1.requestcatcher.com/test","headers":{}}
json string with the callback details. If provided, the API response will be sent to the callback url in an async manner.
snapTrace
boolean
expects a boolean value. If true, it will return the geojson of snapped to road trace points based on OSM (calculated by osrm). By default, its false
RESPONSES
200
OK - The request succeeded.
object
request
Request
error
Error
Error Information
data
GETSnappedDistanceResponse
201
OK - The request was accepted.
object
request
Request
error
Error
Error Information
data
SyncGETSnappedDistanceResponse
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct Tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID


Updated 10 Nov 2023
Did this page help you?