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)

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

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.

Example

Request URL

POST https://api.jetstreamrfid.com/3/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": "/3/Devices/MyDeviceName/unlockdoor", "Verb": "Post", "User": "MyUserName", "Parameters": [ { "Key": "AccessToken", "Value": "MyAccessToken" } ], "Type": "CommandQueuedEvent", "EventId": "80476d30-8d3b-415e-9966-6e5d63876ad9", "EventTime": "2018-05-18T03:22:37Z", "Version":3 }

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": "2018-05-18T03:22:52Z", "Version":2 }

Version Changes

Added Version Property to Events.