Get favorites contacts widget

Returns information about favorites contacts widget setting

• When feature enabled, favorites contacts are available in GUI for speed dial
• This feature is available for AA-14FBS panel

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• is_enabled boolean

  Determines whether the feature is enabled

• list_items object[]

  List of favorite contacts

  type string

  Possible values: [apartment, company]

  Contact type

  entity_id integer

  Entity unique ID from apartment tables

{
  "is_enabled": true,
  "list_items": [
    {
      "type": "apartment",
      "entity_id": 1
    }
  ]
}

{
  "is_enabled": false,
  "list_items": [
    {
      "type": "apartment",
      "entity_id": 1
    },
    {
      "type": "company",
      "entity_id": 2
    }
  ]
}

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