Get the lift settings

Returns panel floor number and lift call actions status.

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

---

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

  Manages sending the ID number to the elevator controller

• 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

  type of event on which to call elevator

  monitor_opens_lock object

  when lock is opened from the monitor

  is_enabled boolean

  describes feature status, true - on / false - off

  user_opens_lock object

  when lock is opened by user

  is_enabled boolean

  describes feature status, true - on / false - off

  monitor_call_in_talk object

  during call

  is_enabled boolean

  describes feature status, true - on / false - off

  dtmf_code string

  Possible values: Value must match regular expression ^[\d*#ABCD]{1,4}$

  Default value: DC

  dtmf code that is sent to trigger elevator

{
  "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": false,
      "dtmf_code": "DC"
    }
  }
}

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

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...