Vizion API's HTTP response codes
Vizion uses conventional HTTP response codes to indicate the success or failure of an API request. In general, responses are categorized as follows:
- Success: Codes in the
2XXrange indicate a success. - Client error: Codes in the
4XXrange indicate an error due to the information provided (e.g., a required property was omitted, provided value is incorrect). - Server error: Codes in the
5XXrange indicate an error with Vizion's servers; these are rare.
HTTP status codes
| HTTP Code | Summary | Definition |
|---|---|---|
| 200 | OK | The server successfully processed the request. |
| 400 | Bad Request | The server cannot or will not process the request. Typically, it is due to a malformed request or missing parameter. |
| 401 | Unauthorized | Provided API key lacks required permissions. |
| 403 | Forbidden | A valid API key was not provided. |
| 404 | Not Found | The requested entity could not be found. |
| 422 | Unprocessable Entity | The request was well-formed but rejected due to semantic errors. |
| 429 | Too Many Requests | Too many requests hit the API too quickly, or the request cap has been hit. |
| 500, 502, 503, 504 | Server Errors | Something went wrong on Vizion's end; these are rare. |