Device Access Settings

post

https://api.alocity.com/v1/integration-management/device/access-control-settings

This endpoint is used to save the access settings of the specified device.

Controlled Errors

Error Code	Error Message
error_device_not_found	No device was found.
error_saving_access_control_settings	Failed to save access settings.
error_null_access_control_settings	Invalid request object provided

Any status codes returned that are not provided here are generic status codes that can be found here.

Body Params

doorContactPosition

int32

The type of contact sensor the door has. See available values here. If this value is not passed, it will default to 0 which is None.

doorContactType

int32

The intended state of the door when not in active use. See available values here. If this value is not passed, it will default to 0 which is Normally Open.

doorOpenTimeout

int32

Time (in seconds) to allow the door to remain open before alerting the system. If this value is not passed, it will default to 0.

exitButtonContactPosition

int32

The type of contact sensor the exit button has. See available values here. If this value is not passed, it will default to 0 which is None.

exitButtonContactType

int32

The intended state of the exit button when not in use. See available values here. If this value is not passed, it will default to 0 which is Normally Open.

internalRelayEnabled

boolean

Whether or not to use the device's own internal relay for the sensors. If this value is not passed, it will default to false.

ioRelay1Enabled

boolean

Whether or not to use one of the external IO relay for the external IO controller. If this value is not passed, it will default to false.

ioRelay2Enabled

boolean

Whether or not to use one of the external IO relay for the external IO controller. If this value is not passed, it will default to false.

lockReleaseTime

int32

Time (in seconds) for the lock to remain disabled after the door is opened. If this value is not passed, it will default to 0.

serialNumber

string

required

The serial number of the device to update.

wiegandFormat

int32

The format for writing the Wiegand output. See available values here. If this value is not passed, it will default to 0 which is the 26 bit format.

wiegandInputEnabled

boolean

Whether or not to allow the device to read Wiegand input. If this value is not passed, it will default to false.

wiegandOutputEnabled

boolean

Whether or not to allow the device to write Wiegand output. If this value is not passed, it will default to false.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Controlled Errors

200200

400400