This commit is contained in:
Matthias Janetschek
2015-06-01 16:33:09 +02:00
parent 03d71034f8
commit 8de7d5b10c
8 changed files with 292 additions and 144 deletions
+29 -3
View File
@@ -2,12 +2,33 @@
HTTP - GET / HTTP - POST (application/x-www-form-urlencoded):
==============================================================
x) [OUT] DeviceAPIMethod::GET [Args: format, pointer, query?]
-- http[s]://<baseURL>/devices[/<id>/<pointer>]
x) [IN] DeviceAPIMethod::COMMAND [Args: format, pointer, msg]
-- http[s]://<baseURL>/devices/<id>[/<pointer>]
x) [IN] DeviceAPIMethod::STATUS_UPDATE [Args: format, pointer, msg]
x) [EVENT] DeviceAPIMethod::REGISTER_EVENT [Args: format, pointer, event]
- Long-Polling
- WebSocket
-- http[s]://<baseURL>/devices/<id>[/<pointer>]
x) [EVENT] DeviceAPIMethod::REGISTER_EVENT [Args: format, pointer, event]
-- http[s]://<baseURL>/devices/<id>[/<pointer>]
- Long-Polling
HTTP - PUT:
============
x) [IN] DeviceAPIMethod::COMMAND [Args: format, pointer, msg]
-- http[s]://<baseURL>/devices/<id>/command[/<pointer>]
x) [IN] DeviceAPIMethod::STATUS_UPDATE [Args: format, pointer, msg]
-- http[s]://<baseURL>/devices/<id>/statusupdate[/<pointer>]
HTTP - WebSocket:
==================
x) [EVENT] DeviceAPIMethod::REGISTER_EVENT [Args: format, pointer, event]
-- ws://<baseURL>/devices/<id>[/<pointer>]
==============================================================
API Method Parameter:
-- Query: method = get | command | statusupdate | event
@@ -30,3 +51,8 @@ COMMAND/STATUS_UPDATE Parameters:
EVENT Parameters:
-- Query: event = command | statusupdate | statechange | added | removed | all
==============================================================