Add and/or Remove Passes

Add passes to and/or delete passes from the access control list of the specified device.

Command Type Device is Online Device is Offline
Synchronous, Queueable Immediate execution, Immediate results and 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-_]*$

Add

array(strings)
Required
Body

The pass(es) to add to the access control list of the device.

Each value must adhere to this regular expression: ^[A-F0-9]{10}$

This property is required and must be included with all requests. If there are no passes to add, define an empty array.

Remove

array(strings)
Required
Body

The pass(es) to delete from the access control list of the device.

Each value must adhere to this regular expression: ^[A-F0-9]{10}$

This property is required and must be included with all requests. If there are no passes to delete, define an empty array.

Request URL

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

Request Body

{
	"Add": ["MyPassNumber"],
	"Remove": []
}

Response Code

200 OK

Response Body

{
	"CommandId": " fbfe6dbd-d03a-42ac-8216-2396de99c315",
	"Status": "Completed",
	"ExceptionList": [],
	"OutputParameterList": []
}

Published CommandQueuedEvent

{
	"Device": "MyDeviceName",
	"CommandId": "fbfe6dbd-d03a-42ac-8216-2396de99c315",
	"CommandName": "UpdatePasses",
	"URI": "/2/Devices/MyDeviceName/AccessControl",
	"Verb": "Post",
	"User": "MyUserName",
	"Parameters": [
		{
		 	"Key": "Add",
		 	"Value": "MyPassNumber"
		}
	],
	"Type": "CommandQueuedEvent",
	"EventId": "ff47841c-6ecd-471f-85ec-46dfc708efc4",
	"EventTime": "2017-05-17T13:51:08Z"
}

Published CommandCompletionEvent

{
	"CommandId": "fbfe6dbd-d03a-42ac-8216-2396de99c315",
	"CommandName": "UpdatePasses",
	"OutputParameterList": [],
	"ExceptionList": [],
	"Device": "MyDeviceName",
	"ReceivedTime": "2017-05-17T13:51:24Z",
	"Type": "CommandCompletionEvent",
	"EventId": "56ae62b2-01c7-4ac3-a5c1-c49849291f3f",
	"EventTime": "2017-05-17T13:51:18Z"
}
Replaces UpdatePasses