HOS Summary

Retrieve a list of daily HOS summaries

Retrieves a list of daily HOS summaries with pagination metadata. When driverId is provided, returns certifications for that driver sorted by startTimeUTC descending. When driverId is not provided, returns certifications across all drivers sorted by startTimeUTC descending (most recent first).

get/v2/eldDailyCertifications

Request

  • Base URL: https://api.onswitchboard.com
  • URL: https://api.onswitchboard.com/v2/eldDailyCertifications
  • Auth: API key in header x-api-id and API key in header x-api-key

Query parameters

limitinteger

Maximum number of results to return per request. Defaults to 20 when driverId is not provided, or 50 when driverId is provided. (1-50)

pagestring

Deprecated. Use cursorId instead. Offset-based page number (0 or greater); page * limit must not exceed 500.

cursorIdstring

Object id from meta.nextCursor of the previous response. Returns the next page after this id (exclusive).

driverIdstring

The id of the driver for HOS daily logs. When omitted, returns certifications across all drivers.

startmillisinteger

The starting epoch timestamp in milliseconds (0 or greater)

endmillisinteger

The ending epoch timestamp in milliseconds (0 or greater)

sort'asc' | 'desc'

Sort order for startTimeUTC. Options: "asc" (ascending) or "desc" (descending). Defaults to "desc".

Response

Successfully retrieved daily HOS summaries info

Example response

{
  "data": [
    {
      "id": "2ntvSpRGIK",
      "driver": "2ntvSpRGIK",
      "startTimeUTC": "2020-01-01T00:00:00.000Z",
      "onDutyConsumed": 110000,
      "drivingTimeConsumed": 28800000,
      "caCycleTimeLeft": 110000,
      "caOnDutyTimeLeft": 110000,
      "caDriveTimeLeft": 110000,
      "caShiftOnDutyTimeLeft": 110000,
      "caShiftDriveTimeLeft": 110000,
      "caShiftHours": 110000,
      "usCycleTimeLeft": 110000,
      "usOnDutyTimeLeft": 110000,
      "usDriveTimeLeft": 110000,
      "shiftStartTime": "2024-01-15T08:00:00.000Z",
      "shiftEndTime": "2024-01-15T20:00:00.000Z"
    }
  ],
  "meta": {
    "count": 20,
    "limit": 20,
    "hasMore": true,
    "nextCursor": "abc123XYZ0",
    "previousCursor": "abc123XYZ0",
    "warning": "The \"cursor\" query parameter is deprecated; use \"cursorId\" instead."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.