ISY Developers:API:V5:REST:Return Codes
ISY_Developers : API : V5 : REST Return codes
REST requests return status in the following format
<RestResponse succeeded="false">
<status>400</status>
<reason code="5004"/>
</RestResponse>
- succeeded attribute will be true if HTTP code = 200, otherwise it will be false
- <status> tag is a copy of the HTTP Status in the header
- <reason> tag is the detailed reason the request succeeded or failed
Some REST requests do not return a <reason> therefore only the HTTP status will be available.
HTTP Status
| Status | Description |
|---|---|
| 200 | HTTP_OK |
| 304 | HTTP_NOT_MODIFIED |
| 400 | HTTP_BAD_REQUEST |
| 401 | HTTP_UNAUTHORIZED |
| 403 | HTTP_FORBIDDEN |
| 404 | HTTP_NOT_FOUND |
| 405 | HTTP_METHOD_NOT_ALLOWED |
| 409 | HTTP_CONFLICT |
| 426 | HTTP_UPGRADE_REQUIRED |
| 500 | HTTP_INTERNAL_ERROR |
| 501 | HTTP_NOT_IMPLEMENTED |
| 503 | HTTP_SERVICE_UNAVAILABLE |
Reason Codes
| Reason | Status | Description |
|---|---|---|
| 0 | 200 | SUCCESS |
| 1 | 403 | FAILED |
| 1001 | 401 | NOT_AUTHORIZED |
| 1002 | 503 | NOT_AVAILABLE |
| 1003 | 501 | NOT_SUPPORTED |
| 1104 | 503 | OUT_OF_MEMORY |
| 1105 | 503 | OUT_OF_STRING_MEMORY |
| 1201 | 400 | INVALID_FILE_NAME |
| 1202 | 400 | INVALID_DIRECTORY_NAME |
| 1203 | 403 | INVALID_DIRECTORY |
| 1204 | 403 | INVALID_FILE_PATH |
| 1205 | 403 | FILE_NOT_FOUND |
| 1206 | 403 | DIRECTORY_NOT_FOUND |
| 1207 | 500 | CANNOT_CREATE_FILE |
| 1208 | 500 | CANNOT_CREATE_DIRECTORY |
| 1209 | 500 | CANNOT_DELETE_FILE |
| 1210 | 500 | CANNOT_DELETE_DIRECTORY |
| 1211 | 500 | FILE_EMPTY |
| 1212 | 500 | FILE_CORRUPT |
| 1213 | 500 | FILE_CONTENT_MISMATCH |
| 2001 | 400 | MALFORMED_REQUEST |
| 2002 | 400 | MALFORMED_NUMERIC_VALUE |
| 2003 | 404 | API_NOT_RECOGNIZED |
| 2004 | 403 | MISSING_PARAMETERS |
| 2005 | 501 | PARAMETER_NOT_SUPPORTED |
| 2101 | 400 | NODE_COMMAND_NOT_VALID |
| 3001 | 403 | INVALID_PROFILE_NUM |
| 3002 | 403 | INVALID_FAMILY_ID |
| 4001 | 400 | INVALID_NLS_KEY |
| 5001 | 400 | NODE_WRONG_PROFILE |
| 5002 | 400 | INVALID_NODE_ADDRESS |
| 5003 | 403 | NODE_NOT_FOUND |
| 5004 | 400 | NODE_ALREADY_EXISTS |
| 5005 | 403 | OUT_OF_NODES |
| 5006 | 400 | INVALID_NODE_DEF_ID |
| 5007 | 400 | INVALID_NODE_NAME |
| 5101 | 403 | PRIMARY_NODE_WRONG_PROFILE |
| 5102 | 400 | PRIMARY_NODE_INVALID_ADDRESS |
| 5104 | 403 | PRIMARY_NODE_NOT_FOUND |
| 5105 | 403 | PRIMARY_NODE_NOT_A_PRIMARY_NODE |
| 5106 | 403 | PRIMARY_NODE_FOR_ANOTHER_NODE |
| 6001 | 501 | CONN_PROTOCOL_NOT_SUPPORTED |
| 6002 | 400 | CONN_INVALID_PROFILE_NAME |
| 6003 | 400 | CONN_INVALID_ENABLED_FLAG |
| 6004 | 403 | CONN_PROFILE_NOT_FOUND |
| 6005 | 403 | CONN_OUT_OF_PROFILE_MEMORY |
| 6006 | 500 | CONN_CANNOT_SERIALIZE_DATA |
| 6007 | 500 | CONN_CANNOT_SAVE_TO_FILE_SYSTEM |
| 6008 | 500 | CONN_PROFILE_DELETION_INCOMPLETE |
| 6101 | 403 | CONN_NET_MISSING_HOST_NAME |
| 6102 | 403 | CONN_NET_MISSING_IP_PORT |
| 6103 | 400 | CONN_NET_INVALID_SSL_FLAG |
| 6104 | 400 | CONN_NET_INVALID_BASE_URL |
| 6105 | 400 | CONN_NET_INVALID_PORT_NUMBER |
| 6106 | 400 | CONN_NET_INVALID_TIMEOUT |
| 6107 | 400 | CONN_NET_INVALID_ISY_USER_NUMBER |
| 6108 | 400 | CONN_NET_INVALID_NS_USER_ID |
| 6110 | 400 | CONN_NET_INVALID_HOST_NAME |
| 6111 | 400 | CONN_NET_INVALID_SNI_FLAG |
| 6119 | 400 | CONN_NET_INVALID_NS_PASSWORD |