Get apartment book feature status

Get apartment phone book feature status.

• When feature enabled, apartment books accessible in GUI by arrows buttons pressing
• This feature is completely disabled in BI-panels and individual panels
• filter_mode - contacts filtering/sorting mode of the apartment phone book: by_name or by_address
• open_when_digit_typed - determines whether the apartment phone book automatically opens as soon as a digit is typed on the panel keypad
• Both filter_mode and open_when_digit_typed are only returned on devices with a 4' display. They are not returned on devices with a 10' display (AA-14)

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• 10' display
• 4' display

---

Schema

anyOf
• MOD1
• MOD2
---
enable boolean
Enables/disables the display of the apartment phone book in the device GUI
enable boolean
Enables/disables the display of the apartment phone book in the device GUI
filter_mode string
Possible values: [by_name, by_address]
Contacts filtering/sorting mode of the apartment phone book:
• by_name - contacts are filtered/sorted by name
• by_address - contacts are filtered/sorted by address
Available only on devices with a 4' display. Not available on devices with a 10' display (AA-14)
open_when_digit_typed boolean
Determines whether the apartment phone book automatically opens as soon as a digit is typed on the panel keypad.
• Available only on devices with a 4' display
• Not available on devices with a 10' display (AA-14)

{
  "enable": false
}

{
  "enable": false
}

{
  "enable": false,
  "filter_mode": "by_name",
  "open_when_digit_typed": false
}

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"
}

This feature is disabled on your device

Loading...