Device Access Settings

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

Response Payload Object

Property

Type

Description

doorContactPosition

integer

The type of contact sensor the door has. For more information, see positions.

doorContactType

integer

The intended state of the door when not in active use. For more information, see types.

doorOpenTimeout

integer

Time (in seconds) to allow the door to remain open before alerting the system.

exitButtonContactPosition

integer

The type of contact sensor the exit button has. For more information, see positions.

exitButtonContactType

integer

The intended state of the exit button when not in use. For more information, see types.

internalRelayEnabled

boolean

Whether or not to use the device's own internal relay for the sensors.

ioRelay1Enabled

boolean

Whether or not to use one of the external IO relays for the external IO controller.

ioRelay2Enabled

boolean

Whether or not to use one of the external IO relays for the external IO controller.

lockReleaseTime

integer

Time (in seconds) for the lock to remain disabled after the door is opened.

serialNumber

string

The serial number of the device.

wiegandFormat

integer

The format for writing the Wiegand output. For more information, see formats.

wiegandInputEnabled

boolean

Whether or not to allow the device to read Wiegand input.

wiegandOutputEnabled

boolean

Whether or not to allow the device to write Wiegand output.

Controlled Errors

Error Code

Error Message

error_device_not_found

No device was found.

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

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!