Modules to Contract: Octopus Guest, Octopus Enterprise, Octopus Business
Version | Date | Author | Description |
|---|---|---|---|
1.0 | 2017-10-01 | Initial Draft | |
1.1 | 2017-12-15 | Versión 1.1 |
In this document the different functions accessible through the REST interface of the WIFI application are detailed. For each method, the input parameters, the values that it returns and the possible response messages are specified.
The general format of access is:
https://<server-domainname>/rest/<version>
Please find below each one of these functions:
HTTP Code Responses ("Status Codes")
All response codes used belong to the HTTP standard. Below are the ones used in the API of the WIFI platform.
2XX - Success in the request.
4XX - Error occurred in the client side.
5XX - Error occurred in the Server side.
Status Code | Description |
200 | OK |
201 | Created |
202 | Accepted (Request accepted, and queued for execution) |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Resource not found |
405 | Method Not Allowed |
409 | Conflict |
412 | Precondition Failed |
413 | Request Entity Too Large |
500 | Internal Server Error |
501 | Not Implemented |
503 | Service Unavailable |