Omilia uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Omilia’s servers (these are rare).
Not all errors map cleanly onto HTTP response codes, however. To understand the source of the error please refer to the list of codes in the documentation.
The Omilia API uses the following error codes:
HTTP Error Codes
|
Error Code |
Meaning |
|---|---|
|
200 |
OK - Everything worked as expected |
|
201 |
Created - The request was successful, and the server has created a new resource. |
|
202 |
Accepted - The request has been accepted for processing, but the processing is not yet complete. This status code is typically used for asynchronous operations where the server acknowledges receiving the request and informs the client that the processing will continue in the background. |
|
204 |
No Content - The server successfully processed the request but there is no additional content to send back. |
|
400 |
Bad Request - The request was unacceptable, often due to missing a required parameter |
|
401 |
Unauthorized - No valid API key provided |
|
402 |
Request Failed - The parameters were valid but the request failed |
|
403 |
Forbidden - Most common example is "No available licenses" |
|
404 |
Not Found - The requested resource doesn’t exist |
|
409 |
Conflict - The request conflicts with another request (perhaps due to using the same idempotent key) |
|
429 |
Too Many Requests - Too many requests hit the API too quickly. We recommend an exponential backoff of your requests |
|
500, 502, 503, 504 |
Internal Server Error - A generic error message returned when an unexpected condition was encountered on the server |
|
502 |
Bad Gateway - The server, while acting as a gateway or proxy, received an invalid response from an inbound server. |
|
503 |
Service Unavailable - The server is not ready to handle the request. Common causes include temporary overloading or maintenance of the server. |
|
504 |
Unidentified Server Error |