Errors
Raven Atlas uses conventional HTTP response codes you are familiar with to show success or failure of requests, basically codes in the 2xx
range shows success whilst response codes in the 4xx
range show failed requests, this could occur because of many reasons, and 5xx
response codes shows an issue with Raven server (Well the 5xx codes hardly occur 😎)
Response Attributes
Property | Type | Description |
---|---|---|
status | string | Shows a successful or failed request |
message | string | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users, this shouldn't be use as an actionable response. |
data | string | returns response data if available |
Error Codes
Codes | Description |
---|---|
400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 - Unauthorized | Unauthorized -- Your access token is wrong. |
402 - Request Failed | The parameters were valid but the request failed. |
403 - Forbidden | The API key doesn't have permissions to perform the request. |
404 - Not Found | The requested resource could not be found. |
405 - Method Not Allowed | Method Not Allowed -- You tried to access an endpoint with an invalid method. |
409 - Conflicts | Conflict -- Your request conflicts with the current state of a resource. |
429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500, 502, 503, 504 - Server Errors | Something went wrong on Raven's end. (These are rare.) |
Additional codes may be used or added in the future. When implementing error handling, always fall back to a generic case for unknown codes.
Updated 29 days ago