Errors

ITCare API uses conventional HTTP response codes to indicate the success or failure of an API request.

As a general rule:

• Codes in the 2xx range indicate success.

• Codes in the 4xx range indicate incorrect or incomplete parameters (e.g. a required parameter was omitted, or an operation failed with a 3rd party, etc.).

• Codes in the 5xx range indicate an error with ITCare's servers.

This table shows more exemples about HTTP response codes

Code	Description	Reponse body
200	Request successfully processed	Varies depending on what was
201	Successfully created object	Object created
202	Order of creation of the object successfully processed, the request will be processed asynchronously	Empty or tracking object describing the processing of the asynchronous request
400	Bad query - Syntax or consistency error in the query. Must be corrected by the issuer	Blank or indication of the error to be corrected on the client side
401	Unauthenticated access to the resource	Empty
403	Unauthorized access	Empty
404	Non-existent resource	Empty
409	Conflict	Empty
422	Inconsistent data	Empty
500	Fatal API error	Empty
503	Service temporarily unavailable	Empty

ITCare also outputs an error message and an error code formatted in JSON:

{
    "status": "BAD_REQUEST",
    "errorCode": "INVALID_FIELD_VALUE",
    "errorDesc": "name",
    "errorMessage": "Error on field 'name'
}