Hours of Service API

Overview

The Hours of Service API allows you to continually send updated HOS information for individual drivers directly from an ELD into the Trip Management service. This ensures that Trip Management calculates and updates trip information, including rest stops, to ensure drivers remain in compliance with HOS regulations.

What can you do with the HOS API?

The HOS API allows you to seamlessly integrate real-time HOS data from an ELD into Trip Management. This ensures trip planning and recalculations always use the latest HOS status for each driver.

• Send HOS updates from an ELD to Trip Management as often as every 15 minutes.
• Update HOS data for multiple drivers simultaneously using individual driverId values.
• Trip Management automatically stores and applies the most recent HOS data for accurate trip calculations.

Getting started

To use the API, you must be licensed for Trip Management and have an API key.

Authentication

Every request needs to be authenticated by adding the API key to the HTTP Authorization header.

POST /api/v1/drivers/hos

Full URL: https://hos-availability-api.trimblemaps.com/api/v1/drivers/hos

Request body

{
   "hos":{
      "driverId":"string",
      "driverName":"string",
      "ruleType":0,
      "alternativeRuleType":0,
      "cycleTimeGains":[
         0
      ],
      "hosRemainingTimes":{
         "drivingTimeUntilBreak":0,
         "drivingInDay":0,
         "onOffDutyInDay":0,
         "onDutyInWeek":0,
         "canadaWindowOnDutyTime":0,
         "canadaTimeUntilFullDayBreak":0,
         "drivingInWeek":0,
         "onDutyInDay":0,
         "europeOnDutyInDay":0,
         "consecutiveDriving":0,
         "drivingFortnightly":0,
         "dutyStatus":0,
         "lastCycleResetDateTime":"2024-09-10T20:13:12.058Z",
         "last24HourBreakDateTime":"2024-09-10T20:13:12.058Z"
      },
      "isOnDuty":true,
      "last24HourBreak":"2024-09-10T20:13:12.058Z",
      "lastCycleReset":"2024-09-10T20:13:12.058Z"
   },
   "references":{
      "integrationPartner":"string",
      "sourceReferenceId":"string"
   },
   "publishedOn":"2024-09-10T20:13:12.058Z",
   "lastRefresh":"2024-09-10T20:13:12.058Z"
}

Request body fields

Note: All time values are in milliseconds unless otherwise specified.

hos

hos.hosRemainingTimes

references

Top-level fields