Setup favorite contacts widget
Configures favorites contacts widget
- When feature enabled, favorites contacts are available in GUI for speed dial
- This feature is available for AA-14FBS panel
- application/json
Request Body required
- is_enabled boolean required
Determines whether the feature is enabled
list_items object[] required
List of favorite contacts
type string requiredPossible values: [
apartment
,company
]Contact type
entity_id integer requiredEntity unique ID from apartment tables
Responses
- 200
- 400
- 401
- 403
- 404
OK
- List cannot be empty
- Missed json body or wrong param. Response sample:
"error": "Wrong JSON body"
- auth_factors must contain at least one item 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 entity id
- Wrong type
Schema
- error string
Error message
{
"error": true
}
{
"error": "Missed JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
{
"error": "Wrong contact entity_id=1"
}
{
"error": "Wrong contact type. Available values are in range: [apartment, company]"
}
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...