<< Click to Display Table of Contents >> Navigation: The API > JSON Adminstrator API > REST Resources > Devices > POST > Internet of Things Device > POST /devices/ (iot) |
InternetOfThings Device
Any App using "InternetOfThings" learn in needs to transmit the QR-Code in a property called iotLabel to the gateway.
Client to Gateway:
Resource Path |
HTTP method |
/devices |
POST |
Necessary call parameters:
parameter |
datatype |
value / formatting |
description |
|
header |
object |
{} |
|
|
device |
object |
{} |
|
|
|
learnInProcedure |
string |
internetOfThings |
|
|
firstSeen |
string |
yyyy-mm-ddT hh:mm:ss.sss+ hhmm |
date/time |
|
iotLabel |
string |
30S00000190F448+1P000C00000002+10Z00+11ZFFFFFFFE |
Valid IoT Label. Refer to IoT Label |
example:
HTTP POST command including QR-Code
a.HTTP Response of the POST command
b.Message from the gateway over the streaming admin-API after the scan (Device has not been operating so far)
c.Message after the device has been discovered by any first telegram
POST /devices |
Body: |
{ "header" : { "content" : "device" }, "device" : { "learnInProcedure" : "internetOfThings", "firstSeen" : "2017-04-04T20:53:03.795+0100", "iotLabel" : "30S000001910188+1P004000000002+10Z00+11Z27DF41AA" } }
|
a. Answer of the gateway to an IoT POST command |
{ "header": { "httpStatus": 200, "content": "device", "gateway": "DC-GW/EO-IP v0.99.39", "timestamp": "2017-06-19T13:35:48.934+0200" }, "device": { "deviceId": "01910188", "friendlyId": "device", "learnInProcedure": "internetOfThings", "eeps": [ { "eep": "D2-01-11", "version": 0.9, "direction": "both" }, { "eep": "F6-03-01", "version": 0.9, "direction": "from" } ], "manufacturer": "Jaeger Direkt", "firstSeen": "2017-04-04T21:53:03.795+0200", "secured": false, "iotLabel": "30S000001910188+1P004000000002+10Z00+11Z27DF41AA", "productId": "004000000002", "remanState": "NotSeen", "remanCode": "27DF41AA", "softSmartAck": false, "transmitModes": [ { "key": "buttonDI", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonA0", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonB0", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonC0", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonD0", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonBI", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonCI", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "switch", "transmitOnConnect": true, "transmitOnEvent": true, "transmitOnDuplicate": false }, { "key": "multipleButtons", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true }, { "key": "buttonAI", "transmitOnConnect": false, "transmitOnEvent": true, "transmitOnDuplicate": true } ], "operable": false, "supported": true } } |
b. Streaming admin-API Event (Device has not been operating so far) |
JSON Object: |
{ "header" : { "content" : "device", "gateway" : "DC-GW/EO-IP v0.99.39", "timestamp" : "2017-06-19T13:35:48.926+0200" }, "device" : { "deviceId" : "01910188", "friendlyId" : "device", "learnInProcedure" : "internetOfThings", "eeps" : [ { "eep" : "D2-01-11", "version" : 0.9, "direction" : "both" }, { "eep" : "F6-03-01", "version" : 0.9, "direction" : "from" } ], "manufacturer" : "Jaeger Direkt", "firstSeen" : "2017-04-04T21:53:03.795+0200", "secured" : false, "iotLabel" : "30S000001910188+1P004000000002+10Z00+11Z27DF41AA", "productId" : "004000000002", "remanState" : "NotSeen", "remanCode" : "27DF41AA", "softSmartAck" : false, "transmitModes" : [ { "key" : "buttonDI", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonA0", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonB0", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonC0", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonD0", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonBI", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonCI", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "switch", "transmitOnConnect" : true, "transmitOnEvent" : true, "transmitOnDuplicate" : false }, { "key" : "multipleButtons", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true }, { "key" : "buttonAI", "transmitOnConnect" : false, "transmitOnEvent" : true, "transmitOnDuplicate" : true } ], "operable" : false, "supported" : true } }
|
c. Streaming admin-API Event (Device has been seen for the first time) |
JSON Object: |
{ |