The ECLYPSE Rest API attempts to return appropriate HTTP status codes for every request.
Response Code | Text | Description |
---|---|---|
200 | OK | Success! |
204 | No Content | The server has fulfilled the request but does not need to return an entity-body. |
207 | Multi-Status | A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. The default Multi-Status response body is a text/XML or application/XML HTTP entity with a 'multistatus' root element. |
304 | Not Modified | There is no new data to return. |
400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will provide further explanations. |
401 | Unauthorized | Authentication credentials are missing or incorrect. |
404 | Not Found | The URL requested is invalid or the resource requested, such as an object, does not exist. For example, the URL is invalid. |
422 | Unprocessable Entity | The 422 (Unprocessable Entity) status code means the server understands the content type of the request entity (hence a 415 (Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but it was still unable to process the contained instructions. For example, this error condition may occur if an XML request body contains well-formed (i.e., syntactically correct), but semantically erroneous XML instructions. |
500 | Internal Server Error | There is a malfunction. Please try again or post to the Distech Controls Developer page so we may investigate the issue. |
503 | Service Unavailable | The server is currently unavailable because it is running at full capacity, or down for maintenance. This is typically a temporary issue that is quickly resolved. This may be due to missing equipment. |
When the ECLYPSE Rest API returns error messages, it does so in json, xml, text or html format according the "Accept" header. For example, an error might look like this:
{
"details": "The server has not found anything matching the request URI.",
"errorMessage": "Sorry, that page does not exist",
"errorCode": 22,
"status": 404
}
<profile>
<Error>
<ErrorCode>22</ErrorCode>
<ErrorMessage>Sorry, that page does not exist</ErrorMessage>
<Status>404</Status>
<Details>
The server has not found anything matching the request URI.
</Details>
</Error>
</profile>
errorCode : 22 | errorMessage : Sorry, that page does not exist | status : 404 | details : The server has not found anything matching the request URI.
In addition to descriptive error text, error messages contain machine-parseable codes. While the text for an error message may change, the codes will stay the same. The following table describes the codes which may appear when working with the API:
1000 => 1099 : System General Exceptions
1100 => 1199 : Request Exceptions
1200 => 1299 : BACnet Exceptions
1300 => 1399 : Network Exceptions
1400 => 1499 : File Exceptions
1500 => 1599 : User-Management Exceptions
Response Code | Text | Description |
---|---|---|
1000 | No code | This response code is used when no other code is able to precisely identify the error. |
1001 | An element is missing on the device | This response code is used to indicate that there is a missing hardware part on the device that is needed to complete the request. |
1002 | Internal error | This response code is used to indicate that an unexpected internal error occurred on the device. |
1003 | You don't have the good permission to access to this resource | You can not access this resource because you lack sufficient permission credentials, or you have attempted to access an inaccessible location. |
1004 | Sorry, that page does not exist | The resource does not exist. |
1100 | Decoding error | The value sent to the device can not be decoded. (The syntax body is wrong). |
1101 | ENCODE_ERROR | There is an error during the data encoding. |
1102 | The content type is not supported | The server can not handle this content-type. You need to select another one. It will be made available in the near future. |
1103 | The media type is not supported | There is an error with the Accept or Content type. The values are either missing, invalid, or not supported. |
1104 | Required value are not present | During a POST, this error is sent when a required value is missing, or the request is empty. |
1105 | Method not supported | The HTTP method used is not supported by the resource. |
1106 | An attribute in the request header is missing | The request header is missing information, for example, content-length, accept, content-type,etc. |
1107 | Invalid url value | Usually occurs when an ID, or a custom value in the URL is invalid. |
1108 | File upload exception | Exception for errors encountered while processing the upload file request. (data invalid, zip file invalid...) |
1109 | An entity in the request header is not valid | There is an error in the request header. |
1110 | The request is invalid or malformed | The values in the request are either invalid or not authorized. |
1111 | Data send are incomplete | This response code indicates that the data sent in the body element is not complete. For example, a part of the data may have been omitted. |
1112 | The value is invalid | You have attempted to set a value that does not exist. The value may also be invalid, or can not be supported for this request. This often occurs when you attempt to reach a specific value that does not exist within the SELECT query parameter. This can also occur during a post trying to set a wrong/invalid value. |
1200 | There is an issue with the property | The property does not exist. It is invalid or can not be written. |
1300 | Bad network data | There is an error on the network configuration. The device will not work with the given values. |
1400 | File or directory does not exists | The file or the directory you tried to access during the request was invalid and does not exist. |
1401 | File or directory are maybe locked | The file in the directory is locked because it is being used in another process. |
1402 | Delete processing error | An error occurred while trying to delete the current file or directory. Try again in order to complete the request. |
1403 | You don't have enough permissions on the file or folder for the request you intend | File or directory can not be accessed, because of permission restrictions. |
1404 | Directory already exists | The directory can not be created because it already exists. |
1405 | File creation error | An error occurred while trying to create a file, or extracting a .ZIP file. |
1500 | Authentication test failed | The authentication to another Radius server failed. Verify that the parameters were sent correctly. |