This method returns the details of an acknowledgment sent by your organization. The response includes a recipients field which lists the user id of each recipients and the date they acknowledged the alert.
Parameters
Your request data may contain the following parameters. GET or POST the object (as JSON) tohttps://api.kpaehs.com/v1/acknowledgments.info.
| 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. |
id |
string |
"5804f0f30ef50473af5870c6" |
Required | The id of the acknowledgment. |
Example Request
Example Response
{
"ok": true,
"acknowledgment": {
"name": "Box knives without a safety tip are not authorized for use.",
"created": 1476718840515,
"author_id": "5804f0f30ef50473af5870c6",
"specificEmployees_id": [],
"fieldOffices_id": [],
"linesOfBusiness_id": [],
"jobTitles_id": [],
"recipients": [
{
"user_id": "5804f0f30ef50473af5870c6",
"acknowledgedOn": null
},
{
"user_id": "5804f0f40ef50473af5870e9",
"acknowledgedOn": 1475595640604
},
{
"user_id": "5804f0f40ef50473af5870e6",
"acknowledgedOn": 1475768440605
}
]
}
}
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. |