|
<< Click to Display Table of Contents >> Navigation: The API > JSON API > Gateway Response Codes |
The Gateway adds a application specific return code in the header object.
The response codes are fragmented in four main areas.
▪1000-1999: Request OK
▪2000-2999: Error - URL or Syntax error
▪3000-3999: Error – Syntax OK but wrong content
▪8000-8999: Error – Internal error of the Gateway
Group |
Code |
HTTP Status |
Meaning |
Suggested Message |
|
|
|
|
|
Everything OK |
1000 |
200 |
|
OK |
1002 |
202 |
|
will send telegram later |
|
|
|
|
|
|
1500-1999 |
|
Reserved for manufacturer specific codes |
|
|
|
|
|
|
|
Invalid request from client (invalid URL, wrong JSON) |
2000 |
400 |
invalid REST Resource, e.g. /devices/<deviceId>/invalid |
invalid url %s |
2001 |
404 |
unknown Path, e.g. /unknown/resource |
%s not found |
|
2002 |
400 |
e.g. DELETE /profiles/F6-02-01 |
unsupported request method %s |
|
2003 |
400 |
e.g. /devices/telegrams?direction=invalid |
parameter %s has unknown value %s |
|
2004 |
400 |
POST without DATA |
no data |
|
2005 |
400 |
Malformed JSON |
malformed JSON: %s |
|
|
|
|
|
|
2500-2999 |
|
Reserved for manufacturer specific codes |
|
|
|
|
|
|
|
Invalid data from client |
3000 |
400 |
e.g. D4-01-02 |
invalid EEP %s |
3001 |
400 |
valid but not supported EEP |
unsupported EEP %s |
|
|
|
|
|
|
3100 |
404 |
e.g. /devices/unknown |
unknown device %s |
|
3101 |
400 |
device exists but is e.g. in learn in state |
device %s in unsupported state |
|
3102 |
400 |
POST of different devices with e.g. same friendlyId |
duplicated ID %s |
|
3103 |
400 |
POST of device without deviceId and without IoT label |
Missing deviceId |
|
|
|
|
|
|
3120 |
400 |
|
no functions to set specified |
|
3121 |
400 |
|
incomplete request - fuction(s) missing: %s |
|
3122 |
400 |
|
unknown function %s |
|
3123 |
400 |
|
duplicated function %s |
|
3124 |
400 |
|
function without key |
|
3125 |
400 |
|
missing value of function %s |
|
3126 |
400 |
|
invalid value %s of function %s |
|
3127 |
400 |
|
invalid value %s of function s, only scalar allowed |
|
3128 |
400 |
|
invalid value %s of function s, min: s, max:%s) |
|
|
|
|
|
|
3500-3999 |
|
Reserved for manufacturer specific codes |
|
|
|
|
|
|
|
|
4000-7999 |
|
Reserved |
|
|
|
|
|
|
Internal error at gateway |
8000 |
500 |
|
internal error (%s) |
8001 |
500 |
|
not implemented |
|
|
|
|
|
|
8500-8999 |
|
Reserved for manufacturer specific codes |
|
|
|
|
|
|
|
|
9000-9999 |
|
Reserved |
|