This service retrieves all of the authenticated driver's HOS (hours of service) status events that occurred within the time period specified by the URL. If no time period is specified explicitly, then all of the authenticated driver's events are returned.
TDE does not return the events sorted by any of the time properties or parameter options.
No request body is used for this service. Arguments are included as part of the request URL.
|updated_since||ISO 8601 timestamp||Finds items by modification time. This retrieves only those objects with one or more timestamp members, one of which falls after the specified timestamp.|
|list_all||false (default), true||(only usable with updated_since) If set to true, list_all retrieves a comprehensive list: ProductName returns a larger set of results that includes the IDs (or primary key values) of every object that falls within the selection range and the JSON for the updated objects. Setting list_all to true can be used, for example, if you need to refresh a local cache.|
On success, the response body contains a JSON array of event objects:
|id||string||(preferred but not required due to backwards compatibility) A GUID for the event, used for creating, updating or deleting a specific event.|
|status||string||Indicates the type of the event (the driver's new status). Values: OffDuty (default), Driving, OnDutyNotDriving, HoS16HourExtension, SleeperBerth, InOilfield, OffDutyWellSite, OutOilfield, WeeklyReset, SensorActive, SensorFailed, ShortWorkShiftReset, SignedEmptyDay.|
|eventTime||string||The ISO 8601 timestamp of the status change. TDE prevents assigning future times, beyond a few minutes allowed for variance among clocks.|
|modifiedTime||string||The ISO 8601 timestamp of the last modification to the event. TDE prevents assigning future times, beyond a few minutes allowed for variance among clocks.|
|location||Address||(required on create if Remarks is blank) The location where the event occurred (where the driver changed status).
This field can be updated through the API.
|signatureId||string||Unique identifier for the driver's signature data. If set, this indicates that the event has been signed by the driver.|
|remarks||string||(required on create if Location is blank) An arbitrary string of notes attached to the event. This field can be updated through the API.|
|properties||EventProperties||(optional) Includes any additional information related to the event.|
|custom||JSON object||(optional) Contains one or more custom key-value pairs to hold additional data associated with the event or its location. Each POST updates the contents of this field and adds any new set of key-value pairs. To delete a key, set it to null explicitly, as foo:null.|
|version||int||(read-only) Version number that increments with each editing of the event (1 indicates the original version).|
|odoDetails||Odometer||Odometer data supports compliance reporting and differentiates between unit-supplied and driver-supplied data.