This section provides details on the data object that reflects the API's common response to error cases, and lists the API's range of response status codes for both error and success cases.

Error responses

If an error occurs, this API responds with JSON objects that provide information you can use to debug the problem. Each type URI specifies a unique error case.

API endpoints routinely respond with failure codes to a wide range of problems with the integrity of the data. The API returns HTTP response codes that correspond to the httpStatus element in the JSON response, eliminating the need to query the header for the response code. For all non‚Äď2xx HTTPS status codes, the API responds with a JSON object like this:

{
    "httpStatus": 400,
    "instance": "49046f42-f51f-403b-be60-6fb8179aa1d2",
    "detail": "Start date and End date are same",
    "title": "Bad Request"
}

For details on information contained in the error responses, refer to Error response syntax.