GET /driver_hos_snapshots

Requests hours of service snapshots for the specified driver/s.

Note: This call is only available for the Asset Management system.

Parameters

auth

(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.

driver_ids

(required)

A comma separated list of driver identifiers indicating that only driver HOS snapshots for the drivers with the specified identifiers should be returned.

callback

(optional)

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

date_format

(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.

globalisation

(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.

Request Content Type

N/A

Response

Returns DriverHosSnapshot resources in the requested format.

Response Content Type

application/json, application/javascript (JSONP), application/xml or text/csv as requested

Give It A Try...

Enter appropriate parameter values then click on the link which appears to try the API call...

Note: You must have JavaScript support enabled in your browser to use this feature.

auth

(required)

driver_ids

(required)

callback

(optional)

date_format

(optional)

globalisation

(optional)

Response format

 

Request Examples

GET /driver_hos_snapshots?auth=a78581e7935349c39873812572cda216&driver_id=8973754b-f084-4ba8-b954-483c6084f607
GET /driver_hos_snapshots.json?auth=a78581e7935349c39873812572cda216&driver_id=8973754b-f084-4ba8-b954-483c6084f607
GET /driver_hos_snapshots.xml?auth=a78581e7935349c39873812572cda216&driver_id=8973754b-f084-4ba8-b954-483c6084f607
GET /driver_hos_snapshots.csv?auth=a78581e7935349c39873812572cda216&driver_id=8973754b-f084-4ba8-b954-483c6084f607

Response Examples

JSON body:

[{"SystemType":"AssetManagement","DriverId":"e274cb50-d779-4486-9124-7585de39e795","LastDriverStatus":"Undefined","LastCalculationDate":"\/Date(1337273980546)\/","DailyDrivingRemainingSeconds":36000,"DailyDrivingRemainingLimitedSeconds":36000,"DailyLimitSeconds":36000,"WeeklyDrivingRemainingSeconds":201650,"WeeklyLimitSeconds":201650,"TwoWeeklyDrivingRemainingSeconds":324000,"TwoWeeklyLimitSeconds":324000,"LastPositionDate":"\/Date(1337455434000)\/"}]

XML body:

<ArrayOfDriverHosSnapshot xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<DriverHosSnapshot SystemType="AssetManagement">
		<DriverId>e274cb50-d779-4486-9124-7585de39e795</DriverId>
		<LastDriverStatus>Undefined</LastDriverStatus>
		<LastCalculationDate UtcOffset="0">2012-05-17T16:59:40</LastCalculationDate>
		<DailyDrivingRemainingSeconds>36000</DailyDrivingRemainingSeconds>
		<DailyDrivingRemainingLimitedSeconds>36000</DailyDrivingRemainingLimitedSeconds>
		<DailyLimitSeconds>36000</DailyLimitSeconds>
		<WeeklyDrivingRemainingSeconds>201650</WeeklyDrivingRemainingSeconds>
		<WeeklyLimitSeconds>201650</WeeklyLimitSeconds>
		<TwoWeeklyDrivingRemainingSeconds>324000</TwoWeeklyDrivingRemainingSeconds>
		<TwoWeeklyLimitSeconds>324000</TwoWeeklyLimitSeconds>
		<LastPositionDate UtcOffset="0">2012-05-19T19:18:22Z</LastPositionDate>
	</DriverHosSnapshot>
</ArrayOfDriverHosSnapshot>

CSV body:

SystemType,DriverId,LastDriverStatus,LastCalculationDate,DailyDrivingRemainingSeconds,DailyDrivingRemainingLimitedSeconds,DailyLimitSeconds,WeeklyDrivingRemainingSeconds,WeeklyLimitSeconds,TwoWeeklyDrivingRemainingSeconds,TwoWeeklyLimitSeconds,LastPositionDate
AssetManagement,e274cb50-d779-4486-9124-7585de39e795,Undefined,"2012-07-06T06:35:21.440357Z",36000,36000,36000,201650,201650,324000,324000,0001-01-01