Jetstream API
...
API Endpoints
Device Commands
Unlock a Device's Door
8min
about instructs the specified device to unlock its door the door will remain unlocked for the duration defined by the doorunlocktimelimit configuration setting of the device’s policy command type device is online device is offline synchronous, not queueable immediate execution, immediate results and published results failure to execute applicable to the following device types rfid enclosures (cabinets, fridges, freezers) docid\ kobljqnco2s0 1oznf09g parameters property location details accesskey string required unique header the access key for your user account this value is a 36 character guid provided during user account sign up https //jetstreamrfid com/login/signup 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 ] $ accesstoken string required body the identifier for a person that will be included in the resulting aggregateevent docid\ h9wf20q4agqaylfg4aobn it will appear as the value for the "passrfid" property this value is one of the following a 10 40 character hexadecimal number, a 36 character guid if a 10 40 character hexadecimal number is defined, it needs to be in the access control list of the device get all passes docid\ d7j1rxbgyehbv3bajwgsp provides access to a device's access control list add or remove passes docid\ the3s6mtw3baeauul1a83 provides the ability to make additions and/or deletions to a device's access control list example request url post https //api jetstreamrfid com/2/devices/{device name}/unlockdoor request body { 	"accesstoken" "myaccesstoken" } response code 200 ok response body { 	"commandid" "2b50fff0 e84c 42c1 b294 9eb6895684c3", 	"status" "completed", 	"exceptionlist" \[], 	"outputparameterlist" \[] } published commandqueuedevent { 	"device" "mydevicename", 	"commandid" "2b50fff0 e84c 42c1 b294 9eb6895684c3", 	"commandname" "unlockdoor", 	"uri" "/2/devices/mydevicename/unlockdoor", 	"verb" "post", 	"user" "myusername", 	"parameters" \[ 	 { 	 "key" "accesstoken", 	 "value" "myaccesstoken" 	 } 	], 	"type" "commandqueuedevent", 	"eventid" "80476d30 8d3b 415e 9966 6e5d63876ad9", 	"eventtime" "2017 05 18t03 22 37z" } published commandcompletionevent { 	"commandid" "2b50fff0 e84c 42c1 b294 9eb6895684c3", 	"commandname" "unlockdoor", 	"outputparameterlist" \[], 	"exceptionlist" \[], 	"device" "mydevicename", 	"receivedtime" "2017 05 18t03 22 54z", 	"type" "commandcompletionevent", 	"eventid" "4aa5df90 bfea 49f7 8d69 bce6ba9e21fb", 	"eventtime" "2017 05 18t03 22 52z" } version changes replaces unlockdoor