Table of Contents
When requesting data from the Supportable Data Export API, there are several error codes which may be sent back for various reasons. The following is a list of error codes and how to handle them.
Codes #
The request path is valid, but the syntax of the request is invalid. See the body of the error message to understand what needs to be fixed, and try again.
Below is an example of a 400 error message which was sent back to the user due to a malformed request:
{
"message": "One or more errors occurred",
"errors": [
"Provided subEntityId is not a valid ObjectId.",
"Provided offeringId is not a valid ObjectId."
]
}
Below is an example of a 400 error message which was sent back to the user due to a parameter being entered incorrectly:
{
"message": "One or more errors occurred",
"errors": [
"Query parameter 'startDateTime' is not recognized. Allowed parameters are 'startDateTimeUtc'
and 'endDateTimeUtc'."
]
}
The following is a list of error types:
| Code | Name | Description |
|---|---|---|
| 400 | Bad Request | Indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). |
| 401 | Unauthorized | Your token is invalid or expired. Retrieve another token and try again. |
| 403 | Forbidden | Your request path and token are valid, but your Company is not authorized to make this request. Contact Supportable to gain authorization. |
| 404 | Not Found | The request path is invalid or does not exist. Check the request path and fix any typos or errors and try again. |
| 405 | Method Not Allowed | The request path is valid, but does not allow the HTTP request method used. Check your request method (POST, GET, PUT, etc) and correct accordingly. |
| 500 | Internal Server Error | Something went wrong while Supportable was processing the request. Please try again later. |
