CCMS API Errors

Heretto API uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 200 class indicate success. Codes in the 400 class indicate an issue with the request (on the client side) like bad request syntax, an unauthorized request, or a missing required parameter; these should be fixed by the user. Codes in the 500 class, which happen rarely, indicate an issue on the Heretto server side; if these occur, retry later or report an issue at support.heretto.com.

Table 1. HTTP Status Codes

Response

Description

200

OK

The request succeeded and the response contains the requested data

400

Bad Request

The request payload is malformed or invalid

401

Unauthorized

Missing or invalid authentication credentials

403

Forbidden

The authenticated client doesn't have permission

404

Not Found

The requested resource doesn't exist

500

Internal Server Error

The server encountered an unexpected condition that prevented it from fulfilling the request