Common errors
If the API is unable to successfully process a request, the response should be an error. The following errors will be sent back by the API.
| Error | Type | StatusCode | Description |
|---|---|---|---|
| Bad Request | ValidationException | 400 | Parameters of the request did not meet requirements. Modify the request and try again. |
| Unauthorized | AuthorizationException | 401 | Unable to authenticate with the provided request parameters. Modify the request and try again. |
| Forbidden | AccessDeniedException | 403 | Attempting to perform an action that is not permitted by the current authenticated user. |
| Not Found | ResourceNotFoundException | 404 | The requested resource was not located. Modify the request and try again. |
| Conflict | ResourceAlreadyExistsException | 409 | Attempting to insert the resource which already exists |
| Too Many Requests | TooManyRequests | 429 | Indicates that too many requests are sent in a given amount of time (“rate limiting”). Click here to navigate to details about handling throttled requests |
| Internal Server Exception, and all 500 level errors | ServiceException | 500 (+) | The API encountered an unexpected event during processing. Attempt the request again, if the problem persists, please contact Support. |
Error Representation
{ "requestId": "string", "timestamp": "datetime", "statusCode": "integer", "error": { "errors": [ { "code": null, "type": "string", "message": "string" } ] }}