Project

General

Profile

REST APIs » History » Revision 9

Revision 8 (Hammel, 06 Apr 2018 17:08) → Revision 9/16 (Hammel, 12 Jul 2018 10:00)

h1. REST APIs 

 h2. Monitor Server Node (imwww) 

 table{width:100%}. 
 |_. Resource Name |_. HTTP Verbs    |_. HTTP Methods              |_. Returns      |_. Direction     |_. Description | 
 | Pair              | CREATE Pair     |    POST /pair/iot             | UUID           | From IoT Node | Pair an IoT node w/ Monitor server | 
 | Pair              | CREATE Pair     |    POST /pair/iot/register    | ACK            | From IoT Node | Register an IoT node w/Monitor w/server using UUID | 
 | Pair              | CREATE Pair     |    POST /pair/jarvis/<uuid> | Public keys    | From Jarvis     | Pair a Jarvis node with Monitor server | 
 | Monitor           | GET Monitor ID|    GET /monitor               | Monitor ID     | From Jarvis     | Monitor Identify information | 
 | Device            | GET Devices     |    GET /device                | Device list    | From Jarvis     | Get list of device IDs and descriptors | 
 | Device            | UPDATE Device |    PUT /device/<uuid>         | Device state | From Jarvis     | Change device state with JSON | 
 | Device            | GET Device      |    GET /device/<uuid>         | Device state | From Jarvis     | Get Device state as JSON | 

 Notes 
 * Monitor identity includes location and possibly other descriptors that uniquely identify the monitor 

 h2. IoT Node (embedded in Arduino device code) 

 table{width:100%}. 
 |_. Resource Name |_. HTTP Verbs |_. HTTP Methods                 |_. Returns      |_. Direction |_. Description | 
 | Device            | UPDATE Device|    PUT /device/<uuid>     | Device state | From Monitor Server | Change device state with JSON | 
 | Device            | GET Device     |    GET /device/<uuid>     | Device state | From Monitor Server | Get Device state as JSON | 
 | Device            | GET Register |    GET /register/<uuid> | ACK            | From Monitor | Provides UUID from monitor |