Get All Passes

Return all passes that are currently contained in the access control list of the specified device.

Command Type Device is Online Device is Offline
Synchronous, Queueable Immediate execution, Published results Queued execution, Published results

More Info

Applicable to the following device(s): Enclosures - Firmware v3, Enclosures - Firmware v4

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

Request URL

GET https://jetstream.tersosolutions.com/2/devices/{Device Name}/accesscontrol

Request Body

None Required

Response Code

200 OK

Response Body

{
	"CommandId": "0093fac7-1d82-430a-8bd2-0562c2067037",
	"Status": "Completed",
	"ExceptionList": [],
	"OutputParameterList": [
		{
		    "Key": "PassRfid",
		    "Value": "MyPassNumber"
		}
	]
}

Published CommandQueuedEvent

{
	"Device": "MyDeviceName",
	"CommandId": "0093fac7-1d82-430a-8bd2-0562c2067037",
	"CommandName": "GetPasses",
	"URI": "/2/Devices/MyDeviceName/AccessControl",
	"Verb": "Get",
	"User": "MyUserName",
	"Parameters": [],
	"Type": "CommandQueuedEvent",
	"EventId": "b2bd08c9-6001-45d0-8981-dda986b2d0b2",
	"EventTime": "2017-05-16T21:17:21Z"
}

Published CommandCompletionEvent

{
	"CommandId": "0093fac7-1d82-430a-8bd2-0562c2067037",
	"CommandName": "GetPasses",
	"OutputParameterList": [
		{
		    "Key": "PassRfid",
		    "Value": "MyPassNumber"
		}
	],
	"ExceptionList": [],
	"Device": "MyDeviceName",
	"ReceivedTime": "2017-05-16T21:17:13Z",
	"Type": "CommandCompletionEvent",
	"EventId": "59236a58-2581-4f10-be5c-44c11e681794",
	"EventTime": "2017-05-16T21:17:12Z"
}
Replaces GetPasses