The Driver Dailies endpoint provides a summary of a Driver’s day. This record is updated throughout the Day and may be in a Certified or Uncertified state. When the Driver certifies his log and the certification process produces a PDF document using the following fields: Driver Mileage, Driver Information, Driver History, Settings, and completed DVIRs. In addition when a Driver certifies his log, the Driver Dailies API is updated to record the Driver’s final OnDutyND, Driving, OffDuty, and Sleeper hours for the day. These hours may be useful to populate planning systems for Driver scheduling.
Driver Dailies are automatically deleted after a specific period of time following the data retention policy.
Fields
| Tag | Data Type | Required | Description |
| accountId | Long | No | The id of the Account that owns this record. |
| androidOsVersion * | Character (255) | No | Indicates the Android OS version of the device used by the Driver on this day. |
| androidSoftwareVersion * | Character (255) | No | Indicates the Android App version used by the Driver on this day. |
| attachedTrailers (deprecated) | Text | No | Indicates all Trailers that have been used by the Driver on this day. |
| caOffDutyDeferral | Text | No | Canada OffDuty Deferral Status of the Driver on this day. Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z) |
| cargo | Character (255) | No |
Indicates the type of cargo carried. Can either be:
|
| carrier | Character (255) | Yes | The Name of the Carrier under which the Driver operated on this day. |
| carrierDotNumber | Character (255) | Yes | The US DOT Number of the Carrier under which the Driver operated on this day. This must be a valid US DOT Number if the Driver is using a US Cycle. |
| certified | Boolean | Yes | Indicates if this record has been Certified by Driver. |
| certifyTimestamp | Text | No | Timestamp when the daily driver log was Certified Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z) |
| coDriverHistory | Array | No | A JSON Array containing the Vehicle co-Drivers on this day |
| coDriverName (deprecated, use coDriverHistory and coDrivers) | Character (255) | No | Name of the Vehicle co-Driver on this day |
| coDrivers | Array | No | A JSON Array containing the current Vehicle co-Drivers |
| cycleCan | Character (255) | Yes | Indicates the Canada cycle and rules used. Canada available cycles are the following:
|
| cycleUsa | Character (255) | Yes | Indicates the USA cycle and rules used. USA available cycles are the following:
|
| deviceIdentifier or mobileDeviceIdentifier | Character (25) | No | Unique string that identifies the last device used by the Driver that day. Can be the IMEI on GSM devices or the MEID for CDMA devices. |
| driverDailyDocuments | Array | No | A collection of Driver Daily Documents associated with the Driver Daily |
| driverEmail | Character (255) | Yes | The email address of the Driver. |
| driverFullName | Character (255) | No | The full name of the Driver. |
| driverPhone | Character (255) | No | The contact number of the Driver. |
| exceptionRemarks | Text (unlimited) | No | Remarks about the Driver Exceptions taken on this day. |
| exceptions | Text (unlimited) | No |
Driver Exceptions to DOT rules that were taken on this day. Available exceptions for USA are:
For Canada the available exceptions are:
|
| fields | Array | No | List of generic key-value pair for general usage. Example usage are for shipment details and miles driven today by states information. |
| homeTerminalAddress | Character (255) | Yes | Full address of Home Terminal |
| homeTerminalTimeZone | Character (255) | Yes |
The ID of the time zone used by the Driver on this day:
|
| id | Auto-incremented Long | Auto | Unique identifier |
| iosOsVersion ** | Character (255) | No | Information for the iOS version of the device used by the driver on this day. |
| iosSoftwareVersion ** | Character (255) | No | Information for the iOS app version used by the driver on this day. |
| lastChangedDate | Text | Auto | Auto-generated timestamp of the last change made to this record Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z) |
| logDate | Text | Yes | The date for this Driver Daily. Format: ‘YYYY-MM-DD’ |
| mainOfficeAddress | Character (255) | Yes | The full address of Main Office Terminal |
| manualLog | Boolean | No | Indicates if the log was manually entered or not. |
| operatingZone | Text | No | The operating zone of the driver. |
| shippingDocsManifestNo | Character (255) | No | The Shipping Documents Manifest Number |
| shippingDocsShipperCommodity | Character (255) | No | The Shipper Documents Commodity |
| startTimeOfDay | Text | No | The time start of each Driver Daily which defaults to midnight. Note: Format must be in (HH:MM:SS) |
| totalDrivingHours | Text | No | Total Driving Hours at the time of certification of the Driver Daily. Note: Must be in seconds Duration format (PT##S). Where ## is the number of seconds (see examples) |
| totalOnDutyNDHours | Text | No | Total On Duty Not Driving Hours at the time of certification of the Driver Daily. Note: Must be in seconds Duration format (PT##S). Where ## is the number of seconds (see examples) |
| totalOffDutyHours | Text | No | Total Off Duty Hours at the time of certification of the Driver Daily. Note: Must be in seconds Duration format (PT##S). Where ## is the number of seconds (see examples) |
| totalSleeperHours | Text | No | Total Sleeper Hours at the time of certification of the Driver Daily. Note: Must be in seconds Duration format (PT##S). Where ## is the number of seconds (see examples) |
| totalWaitingAtWellSiteHours | Text | No | Total Waiting at Well Site Hours at the time of certification of the Driver Daily. Note: Must be in seconds Duration format (PT##S). Where ## is the number of seconds (see examples) |
| trailerHistory | Array | No | A JSON Array containing the trailers on this day |
| trailersAttached | Array | No | A JSON Array containing the current trailers attached |
| trailerId (deprecated) | Character (255) | No | A comma separated list of names of Trailers used by the driver on this day. |
| useGpsOdometer | Boolean | No | Indicates if the odometer values for this Driver Daily is from the GPS. |
| userId | Long | Yes | The ID of the Driver of this Daily. |
| username | Character (255) | Yes | The username of the Driver. |
| vehicle | Object | No | A JSON Object containing the vehicles on this day |
| vehicleHistory | Array | No | A JSON Array containing the current vehicles attached |
| vehicleId (deprecated) | Character (255) | No | A comma separated list of names of Vehicles used by the Driver on this day. |
* These fields are not returned when the Driver used an iOS application.
** These fields are not returned when the Driver used an Android application.
Note: Fields marked as “deprecated” are automatically populated with values from the new fields when they are empty.
Read
| API PATH: | /api/v2/driverDailies |
| METHOD: | GET |
| PARAMETERS: | user-id – Retrieves matching records for a specific User (e.g. user-id=1252160, all Users by default) home-terminal-id – Retrieves matching records for Users under a specific Terminal (e.g. home-terminal-id=1813, all Terminals by default) from-log-date – Retrieves records with a date on or after the date given (e.g. from-log-date=2018-06-11) to-log-date – Retrieves records with a date on or before the date given (e.g. to-log-date=2018-06-11) from-change-timestamp – Retrieves records modified since the timestamp supplied (e.g. from-change-timestamp=2018-06-11T12:00:00.000Z) to-change-timestamp – Retrieves records modified before the timestamp supplied (e.g. to-change-timestamp=2018-06-11T12:00:00.000Z, REQUIRES from-change-timestamp) offset – Retrieves matching records after an offset value (e.g. offset=2, zero offset by default) limit – Retrieves a number of records per page specified by the value (e.g. limit=10, all records by default) |
| SORTING: | sort=id – Sort records by their id field in ascending order (DEFAULT) sort=-id – Sort records by their id field in descending order |
| QUERY STRING EXAMPLES: | Get the Driver Daily record with the specified id: api/v2/driverDailies/247660 Get Driver Dailies for all Users (requires PERM_IS_ACCOUNT_ADMIN permission) for a given day: ?from-log-date=2018-06-11&to-log-date=2018-06-11 Get two daily records of the current Account with an offset of 1 : ?offset=1&limit=2 |
| EXAMPLE RESPONSE: |
[
{
"androidOsVersion": "6.0.1",
"androidSoftwareVersion": "1.0.1803.12873",
"attachedTrailers": "[\"Trailer1\",\"Trailer2\"]",
"caOffDutyDeferral": null,
"cargo": "PROPERTY",
"carrier": "Carrier1",
"carrierDotNumber": "101",
"certified": true,
"certifyTimestamp": "2018-06-11T12:00:00.000Z",
"coDriverHistory": [
{
"id": "Jay Park",
"name": 1252091
}
],
"coDriverName": "Jay Park",
"coDrivers": [
{
"id": "Jay Park",
"name": 1252091
}
],
"cycleCan": "Can70hr7daysSouth",
"cycleUsa": "US70hr8days",
"driverDailyDocuments": [],
"driverEmail": "johndoe@mail.com",
"driverFullName": "John Doe",
"driverPhone": "312-855-2324",
"exceptionRemarks": "Enabled Exception",
"exceptions": "DriverSalesPerson",
"fields": [],
"homeTerminalAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"homeTerminalTimeZone": "CST6CDT",
"logDate": "2018-06-11",
"mainOfficeAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"manualLog": false,
"mobileDeviceIdentifier": "123456789",
"pdfToken": "",
"shippingDocsManifestNo": "01",
"shippingDocsShipperCommodity": "02",
"startTimeOfDay": "00:00:00.000",
"totalDrivingHours": "PT1740S",
"totalOnDutyNDHours": "PT2520S",
"totalOffDutyHours": "PT67859S",
"totalSleeperHours": "PT14280S",
"operatingZone": "USA",
"totalWaitingAtWellSiteHours": "PT0S",
"trailerHistory": [
{
"id": "Trailer2",
"name": 1265291
},
{
"id": "Trailer1",
"name": 1265292
}
],
"trailersAttached": [
{
"id": "Trailer2",
"name": 1265292
}
],
"trailerId": "[\"Trailer2\"]",
"useGpsOdometer": false,
"userId": 1252090,
"username": "johndoe@mail.com",
"vehicle": {
"id": "Vehicle1",
"name": 1265293
},
"vehicleHistory": [
{
"id": "Vehicle1",
"name": 1265293
}
],
"vehicleId": "[\"Vehicle1\"]",
"accountId": 1248401,
"id": 247660,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|
Create
| API PATH: | /api/v2/driverDailies |
| METHOD: | POST |
| EXAMPLE REQUEST: |
[
{
"androidOsVersion": "6.0.1",
"androidSoftwareVersion": "1.0.1803.12873",
"attachedTrailers": "[\"Trailer1\",\"Trailer2\"]",
"caOffDutyDeferral": null,
"cargo": "PROPERTY",
"carrier": "Carrier1",
"carrierDotNumber": "101",
"certified": true,
"certifyTimestamp": "2018-06-11T12:00:00.000Z",
"coDriverHistory": [
{
"id": "Jay Park",
"name": 1252091
}
],
"coDriverName": "Jay Park",
"coDrivers": [
{
"id": "Jay Park",
"name": 1252091
}
],
"cycleCan": "Can70hr7daysSouth",
"cycleUsa": "US70hr8days",
"driverDailyDocuments": [],
"driverEmail": "johndoe@mail.com",
"driverFullName": "John Doe",
"driverPhone": "312-855-2324",
"exceptionRemarks": "Enabled Exception",
"exceptions": "DriverSalesPerson",
"fields": [],
"homeTerminalAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"homeTerminalTimeZone": "CST6CDT",
"logDate": "2018-06-11",
"mainOfficeAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"manualLog": false,
"mobileDeviceIdentifier": "123456789",
"pdfToken": "",
"shippingDocsManifestNo": "01",
"shippingDocsShipperCommodity": "02",
"startTimeOfDay": "00:00:00.000",
"totalDrivingHours": "PT1740S",
"totalOnDutyNDHours": "PT2520S",
"totalOffDutyHours": "PT67859S",
"totalSleeperHours": "PT14280S",
"totalWaitingAtWellSiteHours": "PT0S",
"trailerHistory": [
{
"id": "Trailer2",
"name": 1265291
},
{
"id": "Trailer1",
"name": 1265292
}
],
"trailersAttached": [
{
"id": "Trailer2",
"name": 1265292
}
],
"trailerId": "[\"Trailer2\"]",
"useGpsOdometer": false,
"userId": 1252090,
"username": "johndoe@mail.com",
"vehicle": {
"id": "Vehicle1",
"name": 1265293
},
"vehicleHistory": [
{
"id": "Vehicle1",
"name": 1265293
}
],
"vehicleId": "[\"Vehicle1\"]"
}
]
|
| EXAMPLE RESPONSE: |
[
{
"androidOsVersion": "6.0.1",
"androidSoftwareVersion": "1.0.1803.12873",
"attachedTrailers": "[\"Trailer1\",\"Trailer2\"]",
"caOffDutyDeferral": null,
"cargo": "PROPERTY",
"carrier": "Carrier1",
"carrierDotNumber": "101",
"certified": true,
"certifyTimestamp": "2018-06-11T12:00:00.000Z",
"coDriverHistory": [
{
"id": "Jay Park",
"name": 1252091
}
],
"coDriverName": "Jay Park",
"coDrivers": [
{
"id": "Jay Park",
"name": 1252091
}
],
"cycleCan": "Can70hr7daysSouth",
"cycleUsa": "US70hr8days",
"driverDailyDocuments": [],
"driverEmail": "johndoe@mail.com",
"driverFullName": "John Doe",
"driverPhone": "312-855-2324",
"exceptionRemarks": "Enabled Exception",
"exceptions": "DriverSalesPerson",
"fields": [],
"homeTerminalAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"homeTerminalTimeZone": "CST6CDT",
"logDate": "2018-06-11",
"mainOfficeAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"manualLog": false,
"mobileDeviceIdentifier": "123456789",
"pdfToken": "",
"shippingDocsManifestNo": "01",
"shippingDocsShipperCommodity": "02",
"startTimeOfDay": "00:00:00.000",
"totalDrivingHours": "PT1740S",
"totalOnDutyNDHours": "PT2520S",
"totalOffDutyHours": "PT67859S",
"totalSleeperHours": "PT14280S",
"totalWaitingAtWellSiteHours": "PT0S",
"trailerHistory": [
{
"id": "Trailer2",
"name": 1265291
},
{
"id": "Trailer1",
"name": 1265292
}
],
"trailersAttached": [
{
"id": "Trailer2",
"name": 1265292
}
],
"trailerId": "[\"Trailer2\"]",
"useGpsOdometer": false,
"userId": 1252090,
"username": "johndoe@mail.com",
"vehicle": {
"id": "Vehicle1",
"name": 1265293
},
"vehicleHistory": [
{
"id": "Vehicle1",
"name": 1265293
}
],
"vehicleId": "[\"Vehicle1\"]",
"accountId": 1248401,
"id": 247660,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|
Update
| API PATH: | /api/v2/driverDailies |
| METHOD: | PUT |
| EXAMPLE REQUEST: |
[
{
"androidOsVersion": "6.0.1",
"androidSoftwareVersion": "1.0.1803.12873",
"attachedTrailers": "[\"Trailer1\",\"Trailer2\"]",
"caOffDutyDeferral": null,
"cargo": "PROPERTY",
"carrier": "Carrier1",
"carrierDotNumber": "101",
"certified": true,
"certifyTimestamp": "2018-06-11T12:00:00.000Z",
"coDriverHistory": [
{
"id": "Jay Park",
"name": 1252091
}
],
"coDriverName": "Jay Park",
"coDrivers": [
{
"id": "Jay Park",
"name": 1252091
}
],
"cycleCan": "Can70hr7daysSouth",
"cycleUsa": "US70hr8days",
"driverDailyDocuments": [],
"driverEmail": "johndoe@mail.com",
"driverFullName": "John Doe",
"driverPhone": "312-855-2324",
"exceptionRemarks": "Enabled Exception",
"exceptions": "DriverSalesPerson",
"fields": [],
"homeTerminalAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"homeTerminalTimeZone": "CST6CDT",
"logDate": "2018-06-11",
"mainOfficeAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"manualLog": false,
"mobileDeviceIdentifier": "123456789",
"pdfToken": "",
"shippingDocsManifestNo": "01",
"shippingDocsShipperCommodity": "02",
"startTimeOfDay": "00:00:00.000",
"totalDrivingHours": "PT1740S",
"totalOnDutyNDHours": "PT2520S",
"totalOffDutyHours": "PT67859S",
"totalSleeperHours": "PT14280S",
"totalWaitingAtWellSiteHours": "PT0S",
"trailerHistory": [
{
"id": "Trailer2",
"name": 1265291
},
{
"id": "Trailer1",
"name": 1265292
}
],
"trailersAttached": [
{
"id": "Trailer2",
"name": 1265292
}
],
"trailerId": "[\"Trailer2\"]",
"useGpsOdometer": false,
"userId": 1252090,
"username": "johndoe@mail.com",
"vehicle": {
"id": "Vehicle1",
"name": 1265293
},
"vehicleHistory": [
{
"id": "Vehicle1",
"name": 1265293
}
],
"vehicleId": "[\"Vehicle1\"]",
"id": 247660
}
]
|
| EXAMPLE RESPONSE: |
[
{
"androidOsVersion": "6.0.1",
"androidSoftwareVersion": "1.0.1803.12873",
"attachedTrailers": "[\"Trailer1\",\"Trailer2\"]",
"caOffDutyDeferral": null,
"cargo": "PROPERTY",
"carrier": "Carrier1",
"carrierDotNumber": "101",
"certified": true,
"certifyTimestamp": "2018-06-11T12:00:00.000Z",
"coDriverHistory": [
{
"id": "Jay Park",
"name": 1252091
}
],
"coDriverName": "Jay Park",
"coDrivers": [
{
"id": "Jay Park",
"name": 1252091
}
],
"cycleCan": "Can70hr7daysSouth",
"cycleUsa": "US70hr8days",
"driverDailyDocuments": [],
"driverEmail": "johndoe@mail.com",
"driverFullName": "John Doe",
"driverPhone": "312-855-2324",
"exceptionRemarks": "Enabled Exception",
"exceptions": "DriverSalesPerson",
"fields": [],
"homeTerminalAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"homeTerminalTimeZone": "CST6CDT",
"logDate": "2018-06-11",
"mainOfficeAddress": "55 East Monroe Street Suite 1900 Chicago Illinois 60603-5701",
"manualLog": false,
"mobileDeviceIdentifier": "123456789",
"pdfToken": "",
"shippingDocsManifestNo": "01",
"shippingDocsShipperCommodity": "02",
"startTimeOfDay": "00:00:00.000",
"totalDrivingHours": "PT1740S",
"totalOnDutyNDHours": "PT2520S",
"totalOffDutyHours": "PT67859S",
"totalSleeperHours": "PT14280S",
"totalWaitingAtWellSiteHours": "PT0S",
"trailerHistory": [
{
"id": "Trailer2",
"name": 1265291
},
{
"id": "Trailer1",
"name": 1265292
}
],
"trailersAttached": [
{
"id": "Trailer2",
"name": 1265292
}
],
"trailerId": "[\"Trailer2\"]",
"useGpsOdometer": false,
"userId": 1252090,
"username": "johndoe@mail.com",
"vehicle": {
"id": "Vehicle1",
"name": 1265293
},
"vehicleHistory": [
{
"id": "Vehicle1",
"name": 1265293
}
],
"vehicleId": "[\"Vehicle1\"]",
"accountId": 1248401,
"id": 247660,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|
Stats
| API PATH: | /api/v2/driverDailies/meta/counts |
| METHOD: | GET |
| DESCRIPTION: | Returns the number of certified and certifiable logs |
| EXAMPLE RESPONSE: |
{
"certifiedLogs": 0,
"uncertifiedLogs": 10,
"driverCounts": [
{
"userId": 1253084,
"certifiedLogs": 0,
"uncertifiedLogs": 9
},
{
"userId": 1253089,
"certifiedLogs": 0,
"uncertifiedLogs": 1
}
]
}
|
API error calls
| ERROR MESSAGE | POSSIBLE CAUSES |
| Cannot find requested driver daily record. (id = <id>) | PUT error because driver daily id does not exist |