Error handling

Clym uses conventional HTTP response codes to indicate the success or failure of an API request. Status codes in the 2xx range indicate success, status codes in the 4xx range indicate an error on your side, while status codes in the 5xx range indicate an error on our side.

The error object returned usually has the following pattern.

{
    "error": {
        "code": "DATA.INVALID_NAME",
        "ns": "DATA",
        "message": "The specified name is not valid",
        "status": 400,
        "data": {
            "field": "name"
        }
    }
}

• code represents the error code, always in uppercase

• ns represents the namespace of that error, such as DATA or PARTNER or INSTANCE

• message represents additional information about the error that occurred

• status represents the HTTP status code returned

• data represents additional structured information about the error.