MiX Telematics REST API

DriverHosSnapshot

Represents a driver's hours of service snapshot.

Fields

SystemType
The type of MiX Telematics system that hosts the driver.
DriverId
The unique identifier of the driver.
LastDriverStatus
The driver's last status.
LastCalculationDate
The date/time at which the driver's hours of service snapshot was last calculated.
DailyDrivingRemainingSeconds
The number of driving seconds remaining for the driver in the current working day.
DailyDrivingRemainingLimitedSeconds
The number of driving seconds remaining for the driver in the current working day, limited by either the weekly or two-weekly driving seconds remaining.
DailyLimitSeconds
The number of seconds to which the driver is limited in the current working day.
WeeklyDrivingRemainingSeconds
The number of driving seconds remaining for the driver in the current working day.
WeeklyLimitSeconds
The number of seconds to which the driver is limited in the current working week.
TwoWeeklyDrivingRemainingSeconds
The number of driving seconds remaining for the driver in the current two-week cycle.
TwoWeeklyLimitSeconds
The number of seconds to which the driver is limited in the current two-week cycle.
LastPositionDate
The date/time of the driver's last position.
RemainingCurrentDrivingTime
The number of seconds remaining for the current driving time.
RemainingTimeTillNextBreak
The number of seconds remaining till next break.
DurationNextBreak
The duration of the next break in seconds.
RemainingDurationCurrentBreak
The number of seconds remaining for the duration of the current break.
TimeBeforeNextDrivingPeriodStart
The number of seconds before the next driving period start.
DurationNextDrivingPeriod
The number of seconds available for the next driving period.
RemainingCurrentDailyDrivingTime
The number of seconds available for the current daily driving period.
RemainingTimeTillNextDailyRest
The number of seconds remaining till the next daily rest.
DurationNextDailyRest
The number of seconds available for the next daily rest.
RemainingDrivingTimeOfCurrentWeek
The number of seconds available for the current weekly driving period.
RemainingTimeTillNextWeeklyRest
The number of seconds remaining till the next weekly rest.
DurationNextWeeklyRest
The number of seconds available for the next weekly rest.
DrivingTimePrevAndCurrWeek
The total number of seconds for the current and previous week.
OpenCompensationLastWeek
The number of seconds in the open compensation for the previous week.
OpenCompensationWeekBeforeLast
The number of seconds in the open compensation for the week before last.
OpenCompensation2NdWeekBeforeLast
The number of seconds in the open compensation for the 2nd week before last.
AdditionalInfoOnVDO1
Addition Info on VDO 1
Origin
Indicates Snapshot calculation origin

Note: Fields which are not available will be omitted.

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:

<?xml version="1.0"?>
<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>