Get the lift settings

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

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

Responses

• 200
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• floor_number integer

  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

  Lift call use cases

  monitor_opens_lock object

  If enabled lift will be called when monitor opens lock

  is_enabled boolean

  Feature activation

  user_opens_lock object

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

  is_enabled boolean

  Feature activation

  monitor_call_in_talk object

  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

  If disabled open lock request from caller will be disabled

{
  "floor_number": 12,
  "send_identifier_number": false,
  "get_apartment_identifier_from_call": false,
  "call_when": {
    "monitor_opens_lock": {
      "is_enabled": false
    },
    "user_opens_lock": {
      "is_enabled": false
    },
    "monitor_call_in_talk": {
      "dtmf_code": "DC",
      "is_enabled": false
    }
  }
}

{
  "floor_number": 12,
  "send_identifier_number": false,
  "get_apartment_identifier_from_call": false,
  "call_when": {
    "monitor_opens_lock": {
      "is_enabled": false
    },
    "user_opens_lock": {
      "is_enabled": false
    },
    "monitor_call_in_talk": {
      "is_enabled": true,
      "dtmf_code": "DA"
    }
  }
}

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...