HTTP Response Codes

<< Click to Display Table of Contents >>

Navigation:  The API > JSON API >

HTTP Response Codes

Response Codes

The following HTTP response codes apply to all requests to the API services.


HTTP Status Code


200 (OK)

Returned when an application request is successful.

202 (will send later)

The Telegram will be delivered after the device wakes up and sends something. (Device uses Soft Smart Ack)

400 (Bad Request)

Returned when an error has occurred. Most likely whenever wrong or incomplete JSON has been transmitted. In addition, an error key in the header object is transferred

401 (Unauthorized)

Returned when HTTP basic authentication (name/password) is invalid or  privileges are not enough.

403 (Forbidden)

Returned when an application is not allowed to make the request, such as when the application is inactive or the client's IP address is not in the list of known application addresses.

404 (Not Found)

Returned when the requested resource does not exist. For example, the device does not exist or the profile does not exist.

500 (internal error)

Returned when a error on gateway side has occurred. In addition, an error key in the header object is transferred


Response body structure

For a successful request with HTTP Response Code 200, the response message body contains a valid representation of the requested resource in JSON format.

For an error message with HTTP Response Code 400 and 500, the error in the message body is passed with internal error number and description


"header": {
     "httpStatus": HTTP status code,
     "code": "error code + error content", 
     "content": "content of Message",
     "gateway" : "current firmware version",
     "timestamp": "transmission time in UTC format" 
  "object": {...}