This method returns a list of contractor requirements.
Parameters
Your request data may contain the following parameters. GET or POST the object (as JSON) tohttps://api.kpaehs.com/v1/contractor-requirements.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. |
limit |
number |
100 |
Optional | The maximum number of requirements to return. Max 500. Defaults to 100. Use page to fetch additional requirements. |
page |
number |
1 |
Optional | The page of requirements to return. Defaults to 1. The requirements field paging.last_page tells you what the last valid page number is. |
type |
string |
"training" |
Optional | The requirement type to filter by. Must be one of the following 'Upload', 'Form', 'Signoff', 'Training' |
Example Request
Example Response
{
"ok": true,
"paging": {
"total": 5,
"last_page": 1
},
"requirements": [
{
"id": "4050433E-F36B-1410-8C82-006D55A93A8F",
"name": "Policy Signoff",
"type_id": 3,
"type": "SignOff",
"isActive": true,
"compliance_scoring": true,
"recurring": false,
"vendor_count": 0,
"form_expiration_date": false
},
{
"id": "2D50433E-F36B-1410-8C82-006D55A93A8F",
"name": "Training Completion",
"related_id": "1",
"type_id": 1,
"type": "Upload",
"isActive": true,
"compliance_scoring": true,
"recurring": false,
"vendor_count": 1,
"form_expiration_date": false
},
{
"id": "4C42433E-F36B-1410-8C82-006D55A93A8F",
"name": "Equipment Inspection",
"description": "123",
"related_id": "5",
"type_id": 2,
"type": "Form",
"isActive": true,
"compliance_scoring": false,
"recurring": false,
"vendor_count": 0,
"form_expiration_date": false
},
{
"id": "FF3F433E-F36B-1410-8C82-006D55A93A8F",
"name": "Document Upload",
"related_id": "1",
"type_id": 1,
"type": "Upload",
"isActive": true,
"compliance_scoring": false,
"recurring": false,
"vendor_count": 1,
"form_expiration_date": false
},
{
"id": "4350433E-F36B-1410-8C82-006D55A93A8F",
"name": "Ladder Safety",
"related_id": "11001",
"type_id": 4,
"type": "Training",
"isActive": true,
"compliance_scoring": true,
"recurring": false,
"vendor_count": 0,
"form_expiration_date": false
}
]
}
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. |