GET Api/v1/Drivers/{id}
Fetches a driver by public ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
driver public ID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
DriverViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Pk | integer |
None. |
|
| PublicId | string |
None. |
|
| Username | string |
None. |
|
| string |
None. |
||
| Name | string |
None. |
|
| Metric | boolean |
None. |
|
| Status | ApiDriverStatus |
None. |
|
| LastDutyStatus | DutyStatusEventViewModel |
None. |
|
| LastAssessment | AssessmentViewModel |
None. |
|
| Organization | OrganizationViewModel |
None. |
|
| Terminal | TerminalViewModel |
None. |
|
| Vehicle | VehicleViewModel |
None. |
|
| Regulations | Collection of RegulationCodeViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"pk": 1,
"publicId": "sample string 2",
"username": "sample string 3",
"email": "sample string 4",
"name": "sample string 5",
"metric": true,
"status": 0,
"lastDutyStatus": {
"type": "duty status",
"status": 0,
"statusModifier": 0,
"odometer": 1.0,
"odometerWasInferred": true,
"location": "sample string 3",
"remark": "sample string 4",
"source": 0,
"sourceAddress": "sample string 5",
"id": "7d443677-5595-4ef9-b799-cb504314b1bd",
"author": "sample string 7",
"effective": "2025-12-12T18:26:26.8964072-07:00",
"declared": "2025-12-12T18:26:26.8964072-07:00",
"recorded": "2025-12-12T18:26:26.8964072-07:00",
"isCorrection": true,
"isCorrected": true,
"correctingEventId": "f7bb0634-5b9a-48d2-b9c5-50ceaaf1c2e5"
},
"lastAssessment": {
"timeStamp": "2025-12-12T18:26:26.8964072-07:00",
"appliedRegulation": "sample string 2",
"appliedRegulationDescription": "sample string 3",
"violations": [
{
"violationCode": "sample string 1",
"effective": "2025-12-12T18:26:26.8964072-07:00",
"created": "2025-12-12T18:26:26.8964072-07:00",
"becomesViolation": "2025-12-12T18:26:26.8964072-07:00",
"timeToReset": "00:00:00.1234567",
"earliestReset": "2025-12-12T18:26:26.8964072-07:00",
"latestViolationTime": "2025-12-12T18:26:26.8964072-07:00",
"assessmentTime": "2025-12-12T18:26:26.8964072-07:00",
"isWarning": true,
"text": "sample string 10",
"jurisdiction": "sample string 11",
"category": "sample string 12",
"categoryDetail": "sample string 13"
},
{
"violationCode": "sample string 1",
"effective": "2025-12-12T18:26:26.8964072-07:00",
"created": "2025-12-12T18:26:26.8964072-07:00",
"becomesViolation": "2025-12-12T18:26:26.8964072-07:00",
"timeToReset": "00:00:00.1234567",
"earliestReset": "2025-12-12T18:26:26.8964072-07:00",
"latestViolationTime": "2025-12-12T18:26:26.8964072-07:00",
"assessmentTime": "2025-12-12T18:26:26.8964072-07:00",
"isWarning": true,
"text": "sample string 10",
"jurisdiction": "sample string 11",
"category": "sample string 12",
"categoryDetail": "sample string 13"
}
],
"warnings": [
{
"violationCode": "sample string 1",
"effective": "2025-12-12T18:26:26.8964072-07:00",
"created": "2025-12-12T18:26:26.8964072-07:00",
"becomesViolation": "2025-12-12T18:26:26.8964072-07:00",
"timeToReset": "00:00:00.1234567",
"earliestReset": "2025-12-12T18:26:26.8964072-07:00",
"latestViolationTime": "2025-12-12T18:26:26.8964072-07:00",
"assessmentTime": "2025-12-12T18:26:26.8964072-07:00",
"isWarning": true,
"text": "sample string 10",
"jurisdiction": "sample string 11",
"category": "sample string 12",
"categoryDetail": "sample string 13"
},
{
"violationCode": "sample string 1",
"effective": "2025-12-12T18:26:26.8964072-07:00",
"created": "2025-12-12T18:26:26.8964072-07:00",
"becomesViolation": "2025-12-12T18:26:26.8964072-07:00",
"timeToReset": "00:00:00.1234567",
"earliestReset": "2025-12-12T18:26:26.8964072-07:00",
"latestViolationTime": "2025-12-12T18:26:26.8964072-07:00",
"assessmentTime": "2025-12-12T18:26:26.8964072-07:00",
"isWarning": true,
"text": "sample string 10",
"jurisdiction": "sample string 11",
"category": "sample string 12",
"categoryDetail": "sample string 13"
}
],
"drivingTimeAvailable": "00:00:00.1234567",
"drivingTimeElapsedInShift": "00:00:00.1234567",
"drivingTimeElapsedInCycle": "00:00:00.1234567",
"drivingTimeAvailableInShift": "00:00:00.1234567",
"dutyTimeAvailable": "00:00:00.1234567",
"dutyTimeElapsedInShift": "00:00:00.1234567",
"dutyTimeElapsedInCycle": "00:00:00.1234567",
"dutyTimeAvailableInShift": "00:00:00.1234567",
"dutyTimeAvailableInCycle": "00:00:00.1234567",
"offDutyTimeElapsedInShift": "00:00:00.1234567",
"sleeperBerthTimeElapsedInShift": "00:00:00.1234567",
"cycleGain": "00:00:00.1234567",
"timeUntilCycleReset": "00:00:00.1234567",
"timeUntilShiftReset": "00:00:00.1234567",
"dateOfNext24HoursOffRequired": "2025-12-12T18:26:26.8964072-07:00",
"isCycleApplicable": true
},
"organization": {
"id": 1,
"name": "sample string 2",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"usDotCompanyName": "sample string 3",
"usDotNumber": "sample string 4",
"nscCompanyName": "sample string 5",
"nscNumber": "sample string 6"
},
"terminal": {
"id": 1,
"publicId": "sample string 2",
"name": "sample string 3",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"organization": {
"id": 1,
"name": "sample string 2",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"usDotCompanyName": "sample string 3",
"usDotNumber": "sample string 4",
"nscCompanyName": "sample string 5",
"nscNumber": "sample string 6"
},
"timeZoneId": "sample string 4",
"observesDst": true,
"timeZoneName": "sample string 6",
"timeZoneStandardName": "sample string 7",
"timeZoneDaylightName": "sample string 8",
"timeZoneTzid": "sample string 9",
"startHour": "00:00:00.1234567",
"personalConveyanceSettings": {
"usKm": 1.0,
"usWarningThresholdKm": 2.0,
"canadaKm": 3.0,
"canadaWarningThresholdKm": 4.0
}
},
"vehicle": {
"pk": 1,
"number": "sample string 2",
"licensePlate": "sample string 3",
"odometer": 4.0,
"trailer": "sample string 5",
"overrideCompanyAutoDutyStatusSetting": true,
"autoDutyStatusDisabled": true,
"hosEnabled": true,
"terminal": {
"id": 1,
"publicId": "sample string 2",
"name": "sample string 3",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"organization": {
"id": 1,
"name": "sample string 2",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"usDotCompanyName": "sample string 3",
"usDotNumber": "sample string 4",
"nscCompanyName": "sample string 5",
"nscNumber": "sample string 6"
},
"timeZoneId": "sample string 4",
"observesDst": true,
"timeZoneName": "sample string 6",
"timeZoneStandardName": "sample string 7",
"timeZoneDaylightName": "sample string 8",
"timeZoneTzid": "sample string 9",
"startHour": "00:00:00.1234567",
"personalConveyanceSettings": {
"usKm": 1.0,
"usWarningThresholdKm": 2.0,
"canadaKm": 3.0,
"canadaWarningThresholdKm": 4.0
}
},
"organization": {
"id": 1,
"name": "sample string 2",
"address": {
"id": 1,
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"city": "sample string 5",
"stateProvince": "sample string 6",
"country": "sample string 7",
"postalCode": "sample string 8"
},
"usDotCompanyName": "sample string 3",
"usDotNumber": "sample string 4",
"nscCompanyName": "sample string 5",
"nscNumber": "sample string 6"
}
},
"regulations": [
{
"value": "sample string 1",
"cycleName": "sample string 2",
"description": "sample string 3"
},
{
"value": "sample string 1",
"cycleName": "sample string 2",
"description": "sample string 3"
}
]
}