Unlock a Device's Door
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)
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. |
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 - 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 provides access to a device's access control list. Add or Remove Passes provides the ability to make additions and/or deletions to a device's access control list. |
POST https://api.jetstreamrfid.com/2/devices/{Device Name}/unlockdoor
200 OK
Replaces UnlockDoor