Replace All Passes

8min

About
Overwrite the access control list of the specified device with a new set of passes.
Command Type
Device is Online
Device is Offline
Synchronous, Queueable
Immediate execution, Immediate results and published results
Queued execution, Published results
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-_]*$
Passes
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}$
At least one value must be defined.
Example
Request URL
PUT https://api.jetstreamrfid.com/2/devices/{Device Name}/accesscontrol
Request Body
{
	"Passes": ["MyPassNumber1", "MyPassNumber2"]
}
Response Code
200 OK
Response Body
{
	"CommandId": "d68d6a29-e8a1-48df-b44a-4365b8c2442c",
	"Status": "Completed",
	"ExceptionList": [],
	"OutputParameterList": []
}
Published CommandQueuedEvent
{
	"Device": "MyDeviceName",
	"CommandId": "d68d6a29-e8a1-48df-b44a-4365b8c2442c",
	"CommandName": "UpdatePasses",
	"URI": "/2/Devices/MyDeviceName/AccessControl",
	"Verb": "Put",
	"User": "MyUserName",
	"Parameters": [
		{
			"Key": "Add",
			"Value": "MyPassNumber1"
		},
		{
			"Key": "Add",
			"Value": "MyPassNumber2"
		},
		{
			"Key": "Remove",
			"Value": "*"
		}
	],
	"Type": "CommandQueuedEvent",
	"EventId": "b302b789-0fba-42bd-98c4-bc732401aff8",
	"EventTime": "2017-05-17T15:16:59Z"
}
Published CommandCompletionEvent
{
	"CommandId": "d68d6a29-e8a1-48df-b44a-4365b8c2442c",
	"CommandName": "UpdatePasses",
	"OutputParameterList": [],
	"ExceptionList": [],
	"Device": "MyDeviceName",
	"ReceivedTime": "2017-05-17T15:16:48Z",
	"Type": "CommandCompletionEvent",
	"EventId": "a15ea1a4-3e5e-47a3-bf91-03ea77416a98",
	"EventTime": "2017-05-17T15:17:08Z"
}
Version Changes
None – this is a new endpoint

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

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-_]*$
Passes 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}$ At least one value must be defined.

Updated 25 Mar 2024

Add or Remove Passes

Get All Passes