id
string
required
Example:

"hos_log_01D8ZQFGHVJ858NBF2Q7DV9MNC"

sourceId
string
required

The ID used to represent the entity in the source system.

Example:

"123456789"

provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

status
enum<string>
required
Available options:
off_duty,
sleeper_bed,
driving,
on_duty,
yard_move,
personal_conveyance,
waiting_time
driver
required

Reference to the driver for this log Unique identifier for the driver in Terminal.

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startedAt
string
required
Example:

"2021-01-06T03:24:53.000Z"

remarks
object[]
required
metadata
object
required

Internal metadata about the record.

vehicle

The vehicle the driver was driving when the log was recorded. Unique identifier for the vehicle in Terminal.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

codrivers
array

Additional drivers that were included in the HOS log.

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details. Unique identifier for the driver in Terminal.

endedAt
string
Example:

"2021-01-06T03:24:53.000Z"

location
object

Where the log was recorded

raw
object[]
Example:
[]