Common error in query processing (common error)

Last updated on May 25, 2023

The structure describes a common error. This error is only returned, if a Device-specific error (error) cannot be returned and when an error can be localized to a specific device, such device-specific error should be posted.

Field	Type	Mandatory?	Description
code	integer	✔︎	Error code. The following codes may be used: 400 - query validation error 401 – authorization error 403 – token verification error 500 – internal system error 503 – server unavailable
message	string	✔︎	Free-format error description
details	list<string>		More details of the error

{
    "code": integer,
    "message": string,
    "details": list<string>
}

Example of error description

The example describes a situation when the request was not processed due to the 500 Internal Server Error. For example, a request to delete devices was not executed.

{
    "code": 500,
    "message": "System error",
    "details": [{"key1", "key2"}]
}