(required)

The authentication token received in response to the call to POST authentication_credentials or GET authentication_token. Applications should pass the authentication token in the custom "X-auth" HTTP header to avoid passing it in in the query string.

(optional)

Indicates that only drivers from the specified system should be returned.

(optional) *

Indicates that only drivers belonging to the specified organisation should be returned. * Required when retrieving data from the Fleet Manager system. Ignored when retrieving data from the X-Drive system.

(optional) *

A comma separated list of driver identifiers indicating that only drivers with the specified identifiers should be returned. * Ignored when retrieving data from the X-Drive system.

(optional) *

Indicates that only drivers belonging to the specified site should be returned. NOTE: This parameter cannot be used in conjunction with the driver_ids parameter and will be ignored if both are passed. * Ignored when retrieving data from the Asset Management or X-Drive system.

(optional) *

Indicates whether or not to include the last known position of each driver that is returned. Passing a value of 1, t, or true will result in positions being included. * Ignored when retrieving data from the X-Drive system.

(optional)

Indicates whether or not to include locations/addesses resolved by reverse-geocoding for the positions that are returned. Passing a value of 1, t, or true will result in locations being included. NOTE: Including locations is substantially slower, and should only be done when absolutely necessary! Where possible, applications should call GET geocoding/location or POST geocoding/coordinates to retrieve locations/addresses when required.

(optional) *

Indicates whether or not to include the vehicle associated with each driver that is returned. Passing a value of 1, t, or true will result in the associated vehicle being included. NOTE: This parameter can only be used in conjunction with the include_positions parameter. * Ignored when retrieving data from the X-Drive system.

(optional)

Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.

(optional)

Only available for JSON format. If supplied, the response will contain JSON dates serialized in the specified format. 0 = Timestamp with offset e.g. "\/Date(1346080140000+0500)\/". 2 = ISO8601 e.g. "2012-08-27T15:09:00.0000000+05:00". Applications may pass this parameter in the custom "X-DateFormat" custom HTTP header instead of this query parameter.

(optional)

The authenticated user's globalisation preferences as received in response to the call to GET account/profile or in the custom "X-Globalisation" HTTP header returned in response to authenticated calls. Applications should pass this back to the server with every call, either in this parameter, or in the the custom "X-Globalisation" HTTP header if automatic conversion of values is required.

auth

(required)

system_type

(optional)

organisation_id

(optional) *

driver_ids

(optional) *

site_id

(optional) *

include_positions

(optional) *

include_locations

(optional)

include_associated

(optional) *

callback

(optional)

date_format

(optional)

globalisation

(optional)

Response format

JSON XML CSV