Skip to main content
GET
Live Position Latest

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Query Parameters

vehicleIds
string[]

Comma separated list of vehicle identifiers (alphanumeric).

groupIds
string[]

Comma separated list of group ids.

driverIds
string[]

Comma separated list of driver identifiers (alphanumeric).

fromDateTime
string<date-time>

Start date and time for the tracking data retrieval

showAllVehicleStatus
boolean

Boolean (true/false) to indicate if details of all vehicles should be included, irrespective of their status. If not specified, defaults to FALSE, so vehicles with a status of SOLD are excluded from the response.

locale
string

Locale for the response data.

hideSpeedIfSpeedSensitive
boolean

Boolean (true/false) to indicate if the vehicle speed should be excluded from the output if the driver;'s group (if there is a driver for the vehicle) or the vehicle's group has been defined to be speed sensitive. If not specified, defaults to FALSE, so the vehicle's speed is included in the response.

Response

Latest live position data successfully returned

items
object[]

Array of vehicle position details.

processedDateTime
string<date-time>

Date and time when the request was completed, in UTC, in format of YYYY-MM-DDThh:mm:ss.ms.

totalCount
integer<int32>

Total number of items that matched the search parameters.

Example:

1