Overview of formats for errors

Released: JSON representation

In this chapter, you will learn more about the basics of error handling and the format in which errors are returned.

Depending on the result of the processing of an HTTP request, the request is answered with different HTTP status codes. Descriptive information can be returned as JSON as an option.

Example for a response upon a failed request:

Response

HTTP/1.1 400 BadRequest
  
{
    "reason": "10019: Missing value for a mandatory property.",
    "severity": 1,
}

Description of parameters for response upon a failed request:

Property

Description

reason

An optional short description of why the error has occurred. This text is used as the error message’s title.

hint

An optional message for the user containing troubleshooting tips.

details

Optional detailed information about the error.

severity

Optional error severity. Possible values are:

Success = 0,
Information = 1,
Warning = 2,
Error = 3