This method returns a list of employees and their driver qualification status details.
Parameters
Your request data may contain the following parameters. GET or POST the object (as JSON) tohttps://api.kpaehs.com/v1/driver-qualifications.list.
| Parameter | TypeScript | Example | Required | Description |
|---|---|---|---|---|
token |
string |
"YOUR_TOKEN" |
Required | Your API Token |
pretty |
boolean |
true |
Optional | true means the response json will include white space for readability. Default is false. |
Example Request
Example Response
{
"ok": true,
"users": [
{
"id": "5f3d4a1322c181d6a810cf18",
"employeeNumber": "DBROWN",
"requirements": [
{
"id": 1039,
"title": "Driver’s Application for Employment",
"status": "active",
"expiration": "never",
"lastCompleted": "07/06/2020"
},
{
"id": 1034,
"title": "DOT Medical Examiner's Certificate",
"status": "active",
"expiration": "01/11/2022",
"lastCompleted": "01/11/2020"
},
{
"id": 1033,
"title": "CDL / Permit / Driver's License",
"status": "active",
"expiration": "04/10/2023",
"lastCompleted": "04/10/2020"
}
]
},
{
"id": "5f3d4a1522c181d6a810cfed",
"employeeNumber": "47538",
"requirements": [
{
"id": 1040,
"title": "Receipt of FMCSR Book",
"status": "active",
"expiration": "never",
"lastCompleted": "01/12/2020"
},
{
"id": 1039,
"title": "Driver’s Application for Employment",
"status": "active",
"expiration": "never",
"lastCompleted": "01/08/2020"
},
{
"id": 1033,
"title": "CDL / Permit / Driver's License",
"status": "active",
"expiration": "07/12/2023",
"lastCompleted": "07/12/2020"
}
]
},
{
"id": "5f3d4a1422c181d6a810cf9c",
"employeeNumber": "47511",
"requirements": [
{
"id": 1040,
"title": "Receipt of FMCSR Book",
"status": "active",
"expiration": "never",
"lastCompleted": "03/15/2020"
},
{
"id": 1039,
"title": "Driver’s Application for Employment",
"status": "active",
"expiration": "never",
"lastCompleted": "04/18/2020"
},
{
"id": 1033,
"title": "CDL / Permit / Driver's License",
"status": "expiring",
"expiration": "08/31/2020",
"lastCompleted": "08/31/2017"
}
]
}
]
}
Errors
If an error occurs, the response JSON will have ok set to false:
{
"ok": false,
"error": "token_invalid",
"description": "The token `YOUR_TOKEN` was not found."
}
The error field will contain one of the following error identifiers and there
may also be a description field with a more detailed explanation:
| Identifier | Description |
|---|---|
api_method_not_found |
The requested url did not match any KPA Flex API method. |
request_method_invalid |
The requested method was not GET or POST. |
request_data_invalid |
The request did not include a valid JSON request object. |
rate_limit_exceeded |
This token is exceeding its request limit. |
token_missing |
The request did not include a token. |
token_invalid |
The request token was invalid. |
token_inactive |
The request token was has been deactivated. |
token_permission |
The request token does not have write permission. |
account_inactive |
The request token was for an account that is not active. |
parameter_unexpected |
The request data included a parameter that is not supported. |
parameter_missing |
The request data failed to include a parameter which was required. |
parameter_invalid |
The request data included a parameter which had a value that is not allowed. |
server_error |
The server encountered an internal error. |
content_not_found |
The requested content was not found. |