Lockdown a Device

8 min

about instructs the specified device to lock for a defined number of hours during a lockdown period, a device cannot be accessed, even with valid credentials command type device is online device is offline synchronous, queueable immediate execution, published results queued execution, published results applicable to the following device types docid\ uxzf6ddof1t2zgzzjh9m6 parameters property location details accesskey string required unique header the access key for your user account this value is a 36 character guid provided in your docid\ bbifqiuixnd5iafmrebbi devicename string required unique url the name of the device this value has a max length of 128 ascii characters this value must adhere to this regular expression ^\[a za z0 9 , ] $ hours int required body the number of hours to lockdown the device this value is a number within the following range 0 – 168 a value of 0 means that the device should end the lockdown example request url post https //api jetstreamrfid com/3/devices/{device name}/lockdown request body { 	"hours" 1 } response code 200 ok response body { 	"commandid" "6bd4b8fb d964 4d00 ae0a e3943d58e004", 	"status" "completed", 	"exceptionlist" \[], 	"outputparameterlist" \[] } published commandqueuedevent { 	"device" "mydevicename", 	"commandid" "6bd4b8fb d964 4d00 ae0a e3943d58e004", 	"commandname" "lockdown", 	"uri" "/3/devices/mydevicename/lockdown", 	"verb" "post", 	"user" "myusername", 	"parameters" \[ 	 { 	 "key" "hours", 	 "value" "1" 	 } 	], 	"type" "commandqueuedevent", 	"eventid" "98115b7b 3f7f 439b ba27 ac1234d7569c", 	"eventtime" "2018 05 18t00 31 20z", 	"version" 3 } published commandcompletionevent { 	"commandid" "6bd4b8fb d964 4d00 ae0a e3943d58e004", 	"commandname" "lockdown", 	"outputparameterlist" \[], 	"exceptionlist" \[], 	"device" "mydevicename", 	"receivedtime" "2017 05 18t00 31 36z", 	"type" "commandcompletionevent", 	"eventid" "a0a1a21b 7537 4a75 9eee cb2e9688f146", 	"eventtime" "2018 05 18t00 31 35z", 	"version" 2 } version changes added version property to events