Errors

We indicate the type of API error that occured in two ways:

  • HTTP status codes.
  • Unique Error Codes. If a situation occurs that you are expected to be able to react to with more precision than HTTP status codes would allow, we will return a unique error code in the response body as well.

Example Error Body

Our error responses always have the following JSON structure:

1{

2  "code": "generic_error",

3  "message": "Http method OPTIONS is not supported."

4}

HTTP Error Status Codes

The following HTTP status error codes are used in our API:

Status CodeDescription
400Bad Request: The request could not be understood by the server.
401Unauthorized: Authentication is required and has failed or has not yet been provided.
403Forbidden: The server understood the request but refuses to authorize it.
404Not Found: The requested resource could not be found.
405Method Not Allowed: The request method is not supported for the requested resource.
408Request Timeout: The server timed out waiting for the request.
409Conflict: The request could not be completed due to a conflict with the current state of the resource.
410Gone: The resource requested is no longer available and will not be available again.
413Payload Too Large: The request is larger than the server is willing or able to process.
415Unsupported Media Type: The request entity has a media type which the server or resource does not support.
416Range Not Satisfiable: The server cannot provide the requested range of data.
422Unprocessable Entity: The server understands the request, but could not succeed in processing it.
429Too Many Requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.
501Not Implemented: The server does not support the functionality required to fulfill the request.
502Bad Gateway: The server received an invalid response from an upstream server.
503Service Unavailable: The server is currently unable to handle the request due to temporary overloading or maintenance.
504Gateway Timeout: The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server.
505HTTP Version Not Supported: The server does not support the HTTP protocol version that was used in the request.

Unique Error Codes

The following unique error codes are used in our API:

Error CodeDescription
generic_errorAn unspecified error has occurred. This is the default error code if nothing more specific applies, check the HTTP status code and the message.
saas_tenant_not_foundProvided tenant GUID (parameter tenant) is not a valid tenant ID.
saas_environment_not_foundProvided tenant environment name (parameter environment) is not a valid environment name for the selected tenant.
saas_company_not_foundProvided company name (parameter company) is not a valid company name for the selected tenant and environment.
server_timeoutServer timeout.
admission_not_allowed_ticket_is_revokedAdmission is not allowed because the ticket has been revoked.
admission_not_allowed_to_many_admissionsAdmission is not allowed because there have been too many admissions.
admission_not_allowed_wrong_date_or_timeAdmission is not allowed due to an incorrect date or time.
ticket_not_foundThe requested ticket could not be found.