Error Handling
Response
All errors are sent back using this format
{
"message": "Description of the error",
"cause": "Optional debugging data",
"code": "See codes below"
}
Common Error Codes
| Code | Description | Suggested Fix |
|---|---|---|
| ED001 | Generally raised if your input or query does not contain required information or is otherwise invalid | Review the call being made and the relevant API documentation for any potential missing or misconfigured data |
| ED002 | Generally raised because an underlying call was unable to find or process sub information | Check infrastructure logs to determine if services are down. Otherwise contact support |
| ED003 | Generally raised due to some underlying logic call being invalid. | It could be caused by incorrect data being provided to the service, or the data from the underlying data stores being incorrect |
| ED004 | Invalid or no Tenancy ID | Your call did not include a valid X-TENANCY. Or you no longer belong to that tenancy |
| ED005 | Unauthorised | You do not have permission to perform this action. Check your permissions and try again |