| GET /hos_events/deleted?from=<starttime>&to=<endtime> |
Print this page
Description
This service retrieves a list of the authenticated driver's deleted HOS (hours of service) events for the time period specified by the URL.
If no time period is specified explicitly, then all deleted events are returned.
Request No request body is used for this service.
Optional parameters
| Name | Value | Description |
|---|
| 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.
|
Response
On success, the response body contains a JSON array of event objects:
| Member |
Type |
Purpose |
| 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).
| Member |
Type |
Purpose |
| street |
string |
The street number and name of the address. |
| city |
string |
The city in which the address is located. |
| region |
string |
The region in which the address is located (e.g., state or province). |
| postalCode |
string |
The postal code or zip code of the address. |
| lat |
double |
(required for POST) The latitude of the address in decimal degrees. |
| lon |
double |
(required for POST) The longitude of the address in decimal degrees. |
| bearingFromStreet |
double? |
The side of the road on which the address is located, indicated as an angle in decimal degrees (0 is north, 90 is east). |
| suburb |
string |
The suburb in which the address is located. |
|
| 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.
| Member |
Type |
Purpose |
| unitId |
int |
(set if the user has an assigned, reporting unit at the event time, overwriting any Id set by user) The Id of the unit that is associated with the event. |
| odo |
double |
The odometer reading as reported by the unit (via the server) or user. If the driver has an assigned unit that has reported data within the last 4 minutes, the value will come from the server. |
| time |
string |
The ISO 8601 timestamp for when the unit or user reported the odometer reading. |
| source |
string |
The source of the odometer data. Values: unit, user (must specify "user" when updating via API). |
|
If the request fails, an
Error Response is generated.
