Case IQ Knowledge Base

How can we help?

API Error Handling

Error response for API

{
    "name": "SERVICE_ACCOUNT_ERROR",
    "httpstatus": <ERROR_STATUS_CODE>,
    "meta": {
        "message": <ERROR_MESSAGE_DETAIL>
    },
    "message": <ERROR_CODE_MESSAGE>
}

ERROR_STATUS_CODE can be one of following codes:

400 // Bad request
401 // Unauthorized
403 // Forbidden
404 // Not found
405 // Method is not allowed
409 // Conflict
429 // Too many requests
500 // Internal server error

ERROR_MESSAGE_DETAIL depends on the service is user calling, e.g. Case not found.

ERROR_CODE_MESSAGE can be one of the following messages:

BAD_REQUEST            // Bad request
UNAUTHORIZED           // Unauthorized
FORBIDDEN              // Forbidden
NOT_FOUND              // Not found
METHOD_NOT_ALLOWED     // Method is not allowed
CONFLICT               // Conflict
TOO_MANY_REQUESTS      // Too many requests
INTERNAL_SERVER_ERROR  // Internal server error