Added
Updates to GET /hos/daily-logs
over 4 years ago by Tyler Freckmann
The GET /hos/daily-logs endpoint has been updated to include an optional parameter expand=vehicle parameter and the following additional response body fields: adverseDrivingClaimed, bigDayClaimed, isUsShortHaulActive, carrierName, carrierFormattedAddress, carrierUsDotNumber, homeTerminalName, homeTerminalFormattedAddress. Details below! 🔎
New optional query parameter:
expand- You can set this parameter tovehicleto include more fields in the entries of thedata[].logMetaData.vehicles[]array. When this parameter is not set, only the vehicle'sid,name, andexternalIdsare returned. Setting this parameter tovehicleexpands the vehicle field to includevehicleVinandlicensePlate.
For example, querying without the expand parameter returns a vehicles[] array like the following:
{
"vehicles": [
{
"id": "XXXXXXXXXXXXXXX",
"name": "Xxxxxx Xxx",
"externalIds": {...}
}
]
}Querying with expand=vehicle returns a vehicles[] array with additional fields:
{
"vehicles": [
{
"id": "XXXXXXXXXXXXXXX",
"name": "Xxxxxx Xxx",
"externalIds": {...},
"vehicleVin": "XXXXXXXXXXXXXXXXX",
"licensePlate": "XXXXXXXXX"
}
]
}New response fields:
The following fields have been added to the data[].logMetaData field:
adverseDrivingClaimed- boolean - Whether the driver has claimed the Adverse Driving Exemption for this HOS day chart.bigDayClaimed- boolean - Whether the driver has claimed the Big Day Exemption for this HOS day chart.isUsShortHaulActive- boolean - Whether the driver has the 150 air-mile Short Haul Exemption active for this HOS day chart.carrierName- string - The name of the carrier used for this HOS chart.carrierFormattedAddress- string - The address of the carrier used for this HOS chart.carrierUsDotNumber- int64 - The US DOT number of the carrier used for this HOS chart.homeTerminalName- string - The name of the Home Terminal used for this HOS chart.homeTerminalFormattedAddress- string - The address of the Home Terminal used for this HOS chart.
See the reference docs for full details.
