Errors
The Veem API communicates errors through standard HTTP status codes with details supplied in the JSON response. Generally the following pattern applies:
- 2xx - Veem received, understood, and accepted a request.
- 3xx - The user agent must take further action in order to complete the request.
- 4xx - An error occurred in handling the request. The most common cause of this error is an invalid parameter.
- 5xx- Veem received and accepted the request, but an error occurred in the Veem service while handling it.
HTTP Error Codes
HTTP Status Code | Description |
---|---|
200 | success |
201 | created |
302 | redirect |
304 | not_modified |
400 | bad_request |
401 | unauthorized |
403 | forbidden |
404 | not_found |
405 | method_not_allowed |
409 | conflict |
412 | precondition_failed |
500 | internal_server_error |
503 | unavailable |
Error Code Response
Name | Type | Error |
---|---|---|
code | integer | The API error code (different from the HTTP code) |
error | string | Short Message |
message | string | Detailed Message |
Error code example:
{
"code": "303",
"error": "Invalid Payee Type",
"Message": "Unexpected payee type entered"
}
The following table lists the most common error responses you are likely to see when using the Veem API. This list is not exhaustive; additional errors can occur. If your application handles all of these responses, though, then it's likely to be a robust application that gracefully handles the majority of user interactions and internet issues.
Updated over 5 years ago