ποΈ Add user to apartment
Allows to add user to apartment
ποΈ Detach user from apartment
Allows to detach user from apartment
ποΈ Creates user entity
Creates user entity
ποΈ Get users list
Returns users list with options could be used to sort and filter them
ποΈ Delete multiple user items
Allows making massive user deletion by their IDs
ποΈ Get multiple User Entities with link_id
Returns multiple User Entities with link_id with filter, sort and pagination options.
ποΈ Delete multiple User Entities with link_id
Delete multiple User Entities with `link_id`.
ποΈ Create/update multiple User Entities with `link_id'
Create/update multiple User Entities with `link_id`.
ποΈ Attach timeprofile to user
Allows to attach timeprofile to user
ποΈ Detach TimeProfile from user
Allows to detach timeprofile from user
ποΈ Attach identifier to user
Allows to attach identifier to user
ποΈ Detach shared identifier from user
Allows to detach shared identifier from user
ποΈ Detach identifier from user
Allows to detach identifier from user
ποΈ Available device auth factors
Used to get available auth factors. AV-08FB and BI panels do not support input_code
ποΈ Get Wiegand settings
Returns Wiegand input and output settings.
ποΈ Setup Wiegand input/output
Configures Wiegand input/output.
ποΈ Get global access settings
Used to get information about current global access settings
ποΈ Configures global access settings
Used to set information about current global access settings.
ποΈ Get User Entity
Returns detailed info about User
ποΈ Delete User Entity
Deletes User Entity
ποΈ Update User Entity
Updates User Entity `has_dublicates` - if user with the same name already exists, `has_dublicates` will be in true condition `To identify users, use `info` field
ποΈ Get master access code
Get master access code and feature status. Available only on panels with keyboard.
ποΈ Set master access code
Set master access code and feature status. Available only on panels with keyboard.
ποΈ Gets the type of Wiegand used for internal card reader.
Gets the type of Wiegand used for internal card reader.
ποΈ Setup the type of Wiegand used for internal card reader.
Setting up the type of Wiegand used for internal card reader.
ποΈ Get master card number
Get master card number.
ποΈ Set master card number
Set master card number.
ποΈ Toggle outdated identifiers clearing
Get current state of clearing outdated identifiers. After 7 days after expiring outdated identifiers will be automatically cleared from device.
ποΈ Toggle outdated identifiers clearing
Get current state of clearing outdated identifiers. After 7 days after expiring outdated identifiers will be automatically cleared from device.
ποΈ Status of the contacts of the exit button.
Returns status of the contacts of the exit button.
ποΈ Status of the contacts of the exit button.
Returns status of the contacts of the exit button.
ποΈ Get face recognition settings
Get face recognition settings. This feature is available on devices with face recognition.
ποΈ Set face recognition settings
Set face recognition settings. This feature is available on devices with face recognition. A reboot is required after changing the face recognition model
ποΈ Get QR recognition settings
Returns QR feature setting.
ποΈ Set QR recognition settings
Set QR recognition settings
ποΈ Get time after opening until locking
Returns time for which the relay contacts will be closed after opening.
ποΈ Set time after opening until locking
Setup time for which the relay contacts will be closed after opening.
ποΈ Get delay before unlocking
Time delay before panel relay contacts will be open
ποΈ Set delay before unlocking
Time delay before panel relay contacts will be open
ποΈ Get DTMF code for door lock
Returns DTMF code used for opening lock during call
ποΈ Set DTMF code for door lock
Configure DTMF code used for opening lock during call
ποΈ Open lock via HTTP
Open lock and trigger 'access allowed' event via HTTP. In logs will be described as 'Lock is opened by API call'
ποΈ Get remote access server settings
Get remote access server settings.
ποΈ Set remote access server settings
Set remote access server settings.
ποΈ Open the lock from remote server
Opens lock and trigger 'access allowed' event via HTTP (for Remote Access Server needs). In logs will be described as 'Lock is opened by Remote access server'.
ποΈ Deny access from remote server
Show 'access denied' via HTTP (for Remote Access Server needs). In logs will be described as 'Access denied by Remote access server'
ποΈ Get the floor number for lift module
This endpoint is deprecated, use `GET /access/general/elevator/settings`
ποΈ Set the floor number for lift module
This endpoint is deprecated, use `GET /access/general/elevator/settings`
ποΈ Get the lift settings
Returns the number of the floor on which the panel is installed for identification by the
ποΈ Set the lift settings
Configures the number of the floor on which the panel is installed for identification by the
ποΈ Get KONE lift settings
Returns KONE lift adapter, required for interaction with KONE module
ποΈ Set KONE lift settings
Configures KONE lift adapter, required for interaction with KONE module
ποΈ Get debug info about interaction with KONE lift module
Returns debug info when KONE lift module is enabled
ποΈ Create Access Rule
Creates Access Rule Entity.
ποΈ Get All Access Rules
Returns detailed info about all Access Rule
ποΈ Get KONE building topology
Returns available area in the building.
ποΈ Get Access Rule Entity
Returns detailed info about Access Rule
ποΈ Update Access Rule Entity
Updates Access Rule Entity
ποΈ Delete Access Rule
Deletes Access Rule Entity
ποΈ Get All Access Rules attached to User
Returns detailed info about all Access Rule attached to user
ποΈ Attach access rule to user
Attaches access rule to user.
ποΈ Detach access rule from user
Detaches access rule from user
ποΈ Get monitor security mode feature status
If the feature is enabled, then when the card brought to the reader the alarm will be automatically turned on/off on the corresponding monitor.
ποΈ Turn on/off monitor security mode
If the feature is enabled, then when the card brought to the reader the alarm will be automatically turned on/off on the corresponding monitor.
ποΈ Create Identifier Entity
Create Identifier Entity. You can create identifiers with the next types:
ποΈ Get Identifier Entity
Returns detailed info about Identifier
ποΈ Update Identifier Entity
Update Identifier Entity
ποΈ Delete Identifier Entity
Delete Identifier Entity
ποΈ Get identifiers list
Returns identifiers list with options could be used to sort and filter them
ποΈ Delete multiple Identifier items
Delete multiple Identifier items
ποΈ Get multiple Identifier items with link_id
Get multiple Identifier items with `link_id`.
ποΈ Update multiple Identifier items by link_id
Create or Update multiple Identifier items.
ποΈ Delete multiple Identifier items by link_id
Delete multiple Identifier items by `link_id` param.
ποΈ Create Identifier Entity from uploaded image file
Creates Identifier Entity from uploaded image file.
ποΈ Get png representation of the stored QR identifier
Returns png representation of the stored QR identifier
ποΈ Reset Identifier left passes to max
Reset left passes to max, if there is a restriction on the number of passes specified in the identifier settings
ποΈ Attach Time Profile to Identifier
Attach Time Profile rule to Identifier
ποΈ Detach Time Profile from identifier
Detach Time Profile from Identifier
ποΈ Create Time Profile Entity
Create Time Profile Entity. It describes access rules which can be attached to identifiers.
ποΈ Get Time Profile Entity
Returns Time Profile Entity
ποΈ Update Time Profile Entity
Update Time Profile Entity
ποΈ Delete Time Profile Entity
Delete Time Profile Entity
ποΈ Get Time Profiles list
Returns Time Profiles list
ποΈ Delete multiple Time Profile items
Delete Time Profile items by uid
ποΈ Get multiple Time Profile items with link_id
Get multiple Time Profile items with `link_id`.
ποΈ Update multiple Time Profile items by link_id
Create or Update multiple Time Profile items.
ποΈ Delete multiple Time Profile items by link_id
Delete multiple Time Profile items by `link_id` param. This request is used by `Link` management system to remove Time Profiles from panel.
ποΈ Get Free access Time Profile
- Get Free access Time Profile
ποΈ Create Free access Time Profile
- Create Free access Time Profile
ποΈ Get status of the parking terminal feature.
- Getting status of parking terminal feature.
ποΈ Set status of the parking terminal feature.
Opens first relay if access granted, and second if access denied. Supports multifactor mode
ποΈ Get external control settings
Returns info external control availability
ποΈ Set door sensor settings
Customize door sensor feature.
ποΈ Get door sensor settings
Returns info about door sensor options
ποΈ Set door sensor settings
Customize door sensor feature.
ποΈ Get current door sensor status
Returns info about door sensor status
ποΈ Get the type of lock used
Gets the type of lock used:
ποΈ Set the type of lock used
Set the type of lock used:
ποΈ Start emergency mode and open the locks
Open the locks in emergency mode for the specified time, unlock time must be in range [1 - 604800] seconds
ποΈ Cancel emergency mode and close the locks
Cancel emergency mode and close the locks