Jetstream API
...
API Endpoints
Device Commands

Lock a Device

8min

About

Instructs the specified device to lock for a defined number of hours. During a lockdown period, a device may not be accessed.

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 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-_]*$

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/2/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": "/2/Devices/MyDeviceName/lockdown", "Verb": "Post", "User": "MyUserName", "Parameters": [ { "Key": "Hours", "Value": "1" } ], "Type": "CommandQueuedEvent", "EventId": "98115b7b-3f7f-439b-ba27-ac1234d7569c", "EventTime": "2017-05-18T00:31:20Z" }

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": "2017-05-18T00:31:35Z" }

Version Changes

Replaces Lockdown