GET Api/v1/Drivers
Fetches a paged list of drivers matching the given search criteria.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Search | string |
None. |
|
| TerminalId | Collection of string |
None. |
|
| OnDuty | boolean |
None. |
|
| Driving | boolean |
None. |
|
| OffDuty | boolean |
None. |
|
| SleeperBerth | boolean |
None. |
|
| Deleted | boolean |
None. |
|
| DriverStatus | DriverStatus |
None. |
|
| ViolationFilter | ViolationFilter |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of DriverSnapshotViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Driver_Id | integer |
None. |
|
| LastAssessment_Id | integer |
None. |
|
| LastDutyStatus_Id | globally unique identifier |
None. |
|
| PublicId | string |
None. |
|
| Name | string |
None. |
|
| Deleted | boolean |
None. |
|
| Status | string |
None. |
|
| Metric | boolean |
None. |
|
| TerminalName | string |
None. |
|
| TerminalPublicId | string |
None. |
|
| TimeZone | string |
None. |
|
| CompanyCode | string |
None. |
|
| VehicleNumber | string |
None. |
|
| UserName | string |
None. |
|
| string |
None. |
||
| LastDutyStatus | string |
None. |
|
| StatusModifier | string |
None. |
|
| Location | string |
None. |
|
| Remark | string |
None. |
|
| Source | string |
None. |
|
| SourceAddress | string |
None. |
|
| Author | string |
None. |
|
| Effective | date |
None. |
|
| Expiry | date |
None. |
|
| DrivingTimeAvailable | time interval |
None. |
|
| Recorded | date |
None. |
|
| TimeStamp | date |
None. |
|
| DrivingTimeElapsedInShift | time interval |
None. |
|
| DutyTimeAvailable | time interval |
None. |
|
| DutyTimeElapsedInShift | time interval |
None. |
|
| DutyTimeElapsedInCycle | time interval |
None. |
|
| NumberOfViolations | integer |
None. |
|
| NumberOfActiveViolations | integer |
None. |
|
| Organization | string |
None. |
|
| DashboardStatus | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"driver_Id": 1,
"lastAssessment_Id": 1,
"lastDutyStatus_Id": "240a6bef-01b9-414d-94eb-04733e2e975f",
"publicId": "sample string 3",
"name": "sample string 4",
"deleted": true,
"status": "sample string 6",
"metric": true,
"terminalName": "sample string 8",
"terminalPublicId": "sample string 9",
"timeZone": "sample string 10",
"companyCode": "sample string 11",
"vehicleNumber": "sample string 12",
"userName": "sample string 13",
"email": "sample string 14",
"lastDutyStatus": "sample string 15",
"statusModifier": "sample string 16",
"location": "sample string 17",
"remark": "sample string 18",
"source": "sample string 19",
"sourceAddress": "sample string 20",
"author": "sample string 21",
"effective": "2025-04-21T05:32:40.6409069-06:00",
"expiry": "2025-04-21T05:32:40.6409069-06:00",
"drivingTimeAvailable": "00:00:00.1234567",
"recorded": "2025-04-21T05:32:40.6409069-06:00",
"timeStamp": "2025-04-21T05:32:40.6409069-06:00",
"drivingTimeElapsedInShift": "00:00:00.1234567",
"dutyTimeAvailable": "00:00:00.1234567",
"dutyTimeElapsedInShift": "00:00:00.1234567",
"dutyTimeElapsedInCycle": "00:00:00.1234567",
"numberOfViolations": 1,
"numberOfActiveViolations": 1,
"organization": "sample string 27",
"dashboardStatus": "Violation"
},
{
"driver_Id": 1,
"lastAssessment_Id": 1,
"lastDutyStatus_Id": "240a6bef-01b9-414d-94eb-04733e2e975f",
"publicId": "sample string 3",
"name": "sample string 4",
"deleted": true,
"status": "sample string 6",
"metric": true,
"terminalName": "sample string 8",
"terminalPublicId": "sample string 9",
"timeZone": "sample string 10",
"companyCode": "sample string 11",
"vehicleNumber": "sample string 12",
"userName": "sample string 13",
"email": "sample string 14",
"lastDutyStatus": "sample string 15",
"statusModifier": "sample string 16",
"location": "sample string 17",
"remark": "sample string 18",
"source": "sample string 19",
"sourceAddress": "sample string 20",
"author": "sample string 21",
"effective": "2025-04-21T05:32:40.6409069-06:00",
"expiry": "2025-04-21T05:32:40.6409069-06:00",
"drivingTimeAvailable": "00:00:00.1234567",
"recorded": "2025-04-21T05:32:40.6409069-06:00",
"timeStamp": "2025-04-21T05:32:40.6409069-06:00",
"drivingTimeElapsedInShift": "00:00:00.1234567",
"dutyTimeAvailable": "00:00:00.1234567",
"dutyTimeElapsedInShift": "00:00:00.1234567",
"dutyTimeElapsedInCycle": "00:00:00.1234567",
"numberOfViolations": 1,
"numberOfActiveViolations": 1,
"organization": "sample string 27",
"dashboardStatus": "Violation"
}
]