Error Documents
An error document is returned when the API encounters an error. Note that error documents are not always returned. See the example error document below for more information regarding the document structure.
Example
{
"error": {
"message": "The service received an invalid zipCode: 94107f",
"code": "600-0043",
"requestId": "91da80e4eb4b1a8d7da08ae04d2b4cf4"
}
}
Error Code References
The application-level error code is comprised of a 3 digit application prefix and a 4 digit application error code.
Gateway error codes are prefaced with '000-'.
| Error Code | Description | HTTP Status |
|---|---|---|
| 600-0000 | Unhandled Error (System/OS Error) | 400 |
| 600-0010 | Internal Server Error | 400 |
| 600-0020 | Authorization Error | 403 |
| 600-0025 | Username, Tenant, and Role Not Authorized | 403 |
| 600-0030 | Document Not Found | 404 |
| 600-0031 | Invalid Document Id | 400 |
| 600-0032 | Invalid Document Class | 400 |
| 600-0033 | Unknown path (check documentation) | 400 |
| 600-0040 | Missing Parameter | 400 |
| 600-0041 | Invalid Data Type | 400 |
| 600-0042 | Invalid Content Type | 400 |
| 600-0043 | Invalid Request Value | 400 |
| 600-0044 | AbiliTec Link Error | 400 |
| 600-0045 | Invalid Request Parameter | 400 |
| 600-0050 | Conflicting Values for Parameter and Header | 400 |
| 600-0060 | Batch Request Limit Exceeded | 400 |
| 600-0070 | Generic Backend Service Error | 400 |
| 600-0080 | Generic Backend Service Error | 400 |
| 600-0095 | Generic Backend Service Error | 400 |
| 600-0100 | Generic Backend Service Error | 400 |
Cloudflare Error Codes
All client requests are routed through Cloudflare for additional security. This means you might receive an error code from Cloudflare itself in some scenarios, such as when calls are made from an IP address that is not whitelisted. These error codes are described here: https://support.cloudflare.com/hc/en-us/sections/200820298-Cloudflare-Errors.
Updated almost 2 years ago