Response Codes
Zubisoft uses conventional HTTP response codes to indicate the success or failure of an API request.
In general, status codes in the 2xx range mean success.
Codes in the 4xx range mean there was an error in the provided information.
Codes in the 5xx range indicate an error with Zubisotf's servers (these are very rare).
The 'error response' includes an element in the response body that contains a useful description of the reason for the error.
| Status Code | Description |
|---|---|
| 200 | Success (OK) - Everything worked as expected, the request was successfully completed. |
| 400 | Bad Request - The request was unacceptable, often due to a missing, incorrect or required parameter. |
| 401 | Unauthorized - The request was rejected because of invalid keys or token (e.g. incorrect keys) |
| 403 | Forbidden - The API key doesn't have permissions to perform the request (e.g. subscription expired). |
| 404 | Not Found - The requested resource doesn't exist. |
| 405 | Method Not Allowed - The requested resource does not support the HTTP method used, e.g. requesting a list of customers with PUT |
| 406 | Not Acceptable - The requested response type is not supported by the client. |
| 409 | Conflict - The request conflicts with another request |
| 429 | Too Many Requests - Too many requests hit the API too quickly (check the API rate limits). |
| 500 | Server Errors - Zubisoft's server encountered an error which prevents it from fulfilling the request. Although this is very rare, please contact Zubisoft if you see this error. |