Skip to main content

Problem

Error body returned for every non-2xx response (media type application/problem+json). Branch on the HTTP status together with errorCode; errorMessage is for people, may be translated and can change without notice. errorCode families: E<status> (generic HTTP errors such as malformed JSON E400 or a missing API key E401), AE_ERR_nnn (validation and business rules of this API; interpret them per endpoint family), GEN_ERR_500 (unexpected failure), VAL_ERR_001 (a request-body constraint), and codes passed through from the platform (for example TGL_INVALID, RC_ERR_100, WS_ERR_101).

statusstringrequired

Reason phrase of the HTTP status.

statusCodeinteger<int32>required

HTTP status of the response, repeated in the body.

errorCodestringrequired

Stable, machine-readable error code. Switch on this value, never on errorMessage.

errorMessagestring

Human-readable explanation, usually naming the offending field and where it is. May be translated into the user's language. Do not parse it.

Problem
{
"status": "string",
"statusCode": 0,
"errorCode": "string",
"errorMessage": "string"
}