Lockdown a Device
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: RFID Enclosures (Cabinets, Fridges, Freezers)
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 user profile. |
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
Response Code
200 OK
Response Body
Published CommandQueuedEvent
Published CommandCompletionEvent
Version Changes
Added Version Property to Events.