REST APIs » History » Version 10
Hammel, 13 Jul 2018 09:36
1 | 1 | Hammel | h1. REST APIs |
---|---|---|---|
2 | |||
3 | 9 | Hammel | h2. Monitor Node (imwww) |
4 | 1 | Hammel | |
5 | table{width:100%}. |
||
6 | 6 | Hammel | |_. Resource Name |_. HTTP Verbs |_. HTTP Methods |_. Returns |_. Direction |_. Description | |
7 | 9 | Hammel | | Pair | CREATE Pair | POST /pair/iot | UUID | From IoT Node | Pair an IoT node w/ Monitor | |
8 | 10 | Hammel | | Pair | CREATE Pair | POST /pair/iot/<uuid> | ACK | From IoT Node | Register an IoT node w/Monitor using UUID | |
9 | | Pair | CREATE Pair | POST /pair/jarvis/<uuid> | ACK | From Jarvis | Pair a Jarvis node with Monitor | |
||
10 | 6 | Hammel | | Monitor | GET Monitor ID| GET /monitor | Monitor ID | From Jarvis | Monitor Identify information | |
11 | | Device | GET Devices | GET /device | Device list | From Jarvis | Get list of device IDs and descriptors | |
||
12 | | Device | UPDATE Device | PUT /device/<uuid> | Device state | From Jarvis | Change device state with JSON | |
||
13 | | Device | GET Device | GET /device/<uuid> | Device state | From Jarvis | Get Device state as JSON | |
||
14 | |||
15 | Notes |
||
16 | * Monitor identity includes location and possibly other descriptors that uniquely identify the monitor |
||
17 | 1 | Hammel | |
18 | h2. IoT Node (embedded in Arduino device code) |
||
19 | 7 | Hammel | |
20 | 1 | Hammel | table{width:100%}. |
21 | 9 | Hammel | |_. Resource Name |_. HTTP Verbs |_. HTTP Methods |_. Returns |_. Direction |_. Description | |
22 | | Device | UPDATE Device| PUT /device/<uuid> | Device state | From Monitor | Change device state with JSON | |
||
23 | | Device | GET Device | GET /device/<uuid> | Device state | From Monitor | Get Device state as JSON | |
||
24 | | Device | GET Register | GET /register/<uuid> | ACK | From Monitor | Provides UUID from monitor | |