Set device settings

application/json

Request Body

device_mode string required

Possible values: [access-control-manual, call-any, call-up, call-down, call-up-down]

Default value: call-any

Mode	Available ports	Description
access-control-manual	16	Module duplicates the floor buttons in the lift car and allows them to be activated when using identifiers (RFID, QR etc.)
call-any	16	Mode duplicates the functionality of the lift call buttons on the floor, the relay contacts are connected to the UP or DOWN buttons contacts on the floor or device that replaces them. Reacts on incoming "Permit" broadcast - the lift will arrive at the monitor installation floor when Permit button is pressed. Also allows: Call lift to the panel floor when using identifier with panel Call lift to the panel floor when the lock is opened during a call between the panel and the monitor
call-up	16	Mode duplicates the functionality of the lift call buttons on the floor, the relay contacts are connected to the UP buttons contacts on the floor or device that replaces them. Reacts on incoming "Appoint" broadcast - the lift will arrive at the monitor installation floor when UP button is pressed. Also allows if handle_permit_in_updown_mode enabled: Call lift to the panel floor when using identifier with panel Call lift to the panel floor when the lock is opened during a call between the panel and the monitor Reacts on incoming "Permit" broadcast - the lift will arrive at the monitor installation floor when Permit button is pressed.
call-down	16	Mode duplicates the functionality of the lift call buttons on the floor, the relay contacts are connected to the DOWN buttons contacts on the floor or device that replaces them. Reacts on incoming "Appoint" broadcast - the lift will arrive at the monitor installation floor when DOWN button is pressed. Also allows if handle_permit_in_updown_mode enabled: Call lift to the panel floor when using identifier with panel Call lift to the panel floor when the lock is opened during a call between the panel and the monitor Reacts on incoming "Permit" broadcast - the lift will arrive at the monitor installation floor when Permit button is pressed.
call-up-down	8 up, 8 down	Mode duplicates the functionality of the lift call buttons on the floor, the relay contacts are connected to the UP and DOWN buttons contacts on the floor or device that replaces them. Reacts on incoming "Appoint" broadcast - the lift will arrive at the monitor installation floor when UP or DOWN button is pressed. Relays 1-8 are connected to the lift call DOWN buttons. Relays 9-16 are connected to the lift call UP buttons. Also allows if handle_permit_in_updown_mode enabled: Call lift to the panel floor when using identifier with panel Call lift to the panel floor when the lock is opened during a call between the panel and the monitor Reacts on incoming "Permit" broadcast - the lift will arrive at the monitor installation floor when Permit button is pressed.

relay_mode string required
Possible values: [COM-NO, COM-NC]
Relay default state NO/NC
invert_all_relays boolean required
Default value: false
turning on all relays after booting
relay_open_time integer required
Possible values: >= 10 and <= 9999
Relay switching time, in milliseconds
handle_permit_in_updown_mode boolean
Default value: false
Allows broadcasts processing in UP, DOWN, and UP-DOWN modes. Feature allows:
- Call lift to the panel floor when using identifier with panel
- Call lift to the panel floor when the lock is opened during a call between the panel and the monitor
- Reacts on incoming Permit broadcast - the lift will arrive at the monitor installation floor when Permit button is pressed. In UP-DOWN mode Permit will trigger only UP relays.
lift_release_time object required
Time for which relay changes its state
api integer required
Possible values: >= 1 and <= 9999
Relay switching time via API, in seconds
card integer required
Possible values: >= 1 and <= 9999
Relay switching time via identifiers, in seconds

Responses

Data validation error

application/json

Schema
Example (from schema)

Schema

error object
object containing info about error
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error]
Error code
message string
Error message
data object
Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.
param string
extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

Please log in

application/json

Schema
Example (from schema)
Example

Schema

error object
object containing info about error
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error]
Error code
message string
Error message
data object
Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.
param string
extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Set device settings​

Set device settings