This service is used to log one or more new HOS (hours of service) status events or to update existing events for the authenticated driver.
A revision history for each event is stored internally, but it is not publicly exposed.
For any event:
Standard driver status events (OffDuty, SleeperBerth, Driving, OnDutyNotDriving, and OffDutyWellSite) cannot be created with the same EventTime as other standard driver status events. However, these can be created with the same eventTime as any of the other status events.
The request body is 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.
On success, the response body contains a JSON array of event objects. There is one entry in the array for each entry in the request body. Only the eventTime and id fields of the events will be returned. If a transaction error occurs while processing a particular event object, then that object will include additional fields specified by the error object.If the request fails, an Error Response is generated.