Get HOS logs - OPEN API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page

integer

optional

A page number within the paginated result set.

page_size

integer

optional

Number of results to return per page.

driverIds

array[string]

required

startedAfter

string <date-time>

optional

2024-05-22T01:40:16.274753Z

startedBefore

string <date-time>

optional

2024-05-22T01:40:16.274753Z

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

count

integer

optional

Example:

10

page_size

integer

optional

Example:

123

optional

Example:

null

current

integer

optional

Example:

1

optional

Example:

2

results

array[object (HosLogsResponse) {9}]

optional

id

string

required

driver

string | null

required

Driver ID

vehicle

string | null

required

Vehicle ID

codrivers

array[string]

read-onlyrequired

Co Driver ID

startedAt

string <date-time>

optional

endedAt

string <date-time>

optional

location

object (Location)

required

status

enum<string>

required

offDuty - offDuty

sleepingBed - sleepingBed

driving - driving

onDuty - onDuty

intermediateW/CLP - intermediateW/CLP

intermediateW/RLP - intermediateW/RLP

personalConveyance - personalConveyance

yardMove - yardMove

certification - certification

login - login

logout - logout

enginePowerUpW/CLP - enginePowerUpW/CLP

enginePowerUpW/RLP - enginePowerUpW/RLP

engineShutDownW/CLP - engineShutDownW/CLP

engineShutDownW/RLP - engineShutDownW/RLP

malfunctionLogged - malfunctionLogged

malfunctionCleared - malfunctionCleared

diagnosticEventLogged - diagnosticEventLogged

diagnosticEventCleared - diagnosticEventCleared

Allowed values:

offDutysleepingBeddrivingonDutyintermediateW/CLPintermediateW/RLPpersonalConveyanceyardMovecertificationloginlogoutenginePowerUpW/CLPenginePowerUpW/RLPengineShutDownW/CLPengineShutDownW/RLPmalfunctionLoggedmalfunctionCleareddiagnosticEventLoggeddiagnosticEventCleared

remark

string

required

Remark

Example

{
  "count": 10,
  "page_size": 123,
  "previous": null,
  "current": 1,
  "next": 2,
  "results": [
    {
      "id": "string",
      "driver": "string",
      "vehicle": "string",
      "codrivers": [
        "string"
      ],
      "startedAt": "2019-08-24T14:15:22Z",
      "endedAt": "2019-08-24T14:15:22Z",
      "location": {
        "latitude": 0,
        "longitude": 0
      },
      "status": "offDuty",
      "remark": "string"
    }
  ]
}