Set the lift settings

Configures the number of the floor on which the panel is installed for identification by the lift module and settings when the lift call must be triggered.

The function works when using the appropriate lift module, for example EVRC-IP. For the detailed description please follow lift module manual.

application/json

Request Body required

• floor_number integer required

  Possible values: >= 1 and <= 98

  Default value: 12

  The model describes the number of the floor on which the panel is installed for identification by the elevator module

• send_identifier_number boolean

  If enabled identifier number will be send to lift controller within call request

• get_apartment_identifier_from_call boolean

  Allows to send to the elevator the first linked to apartment identifier upon lock opening in call

• call_when object required

  Lift call use cases

  monitor_opens_lock object required

  If enabled lift will be called when monitor opens lock

  is_enabled boolean required

  Feature activation

  user_opens_lock object required

  If enabled lift will be called when access is granted by identifier

  is_enabled boolean required

  Feature activation

  monitor_call_in_talk object required

  Allow to call elevator during call using DTMF code (via special button on monitor)

  dtmf_code string

  Possible values: non-empty and <= 4 characters, Value must match regular expression ^[\d*#A-D]{1,4}$

  The model describes elevator dtmf code, which will be used for calling elevator. Dtmf must contains any digit, letters from A to D in capital.

  is_enabled boolean required

  If disabled open lock request from caller will be disabled

Responses

• 200
• 400
• 401
• 403

---

OK

Validation error. Required fields are not provided.

• Wrong floor number
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Wrong floor number

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Wrong floor number"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...