Device-specific error (error)

Last updated on May 25, 2023

The structure is used to describe errors that occur when processing a query about a specific device. For example, you can use this structure to describe an error that occurs when a socket or lamp fails to turn off.

Field	Type	Mandatory?	Description
id	string	✔︎	Device ID
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

{
    "id": string,
    "code": integer,
    "message": integer
}

Example of error description

The example describes a situation when the request about specific device was not processed due to the 500 Internal Server Error. For example, this device could not be deleted.

{
  "id": "ABCD_005",
  "code": 500,
  "message": "System error"
}