Enable/disable apartment book display in the GUI
Set 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_nameorby_addressopen_when_digit_typed- determines whether the apartment phone book automatically opens as soon as a digit is typed on the panel keypad- Both parameters are optional and only take effect on devices with a 4' display. When not provided, the current values are preserved. Devices with a 10' display (AA-14) ignore both parameters
- application/json
Request Body required
- MOD1
- MOD2
- enable boolean required
Enables/disables the display of the apartment phone book in the device GUI
- enable boolean required
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 nameby_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)
anyOf
Responses
- 200
- 400
- 401
- 403
- 404
OK
- Missed json body or wrong param.
Response sample:
"error": "Wrong JSON body" - Required field is not provided.
Response sample:where
"error": "Wrong JSON body: no value for `param`"param- is a required field that was not provided - Field was of the wrong type.
Response sample:where
"error": "Wrong JSON body: value `param` was of the wrong type"param- is a field of the wrong type filter_modevalue is not one of the supported modes. Checked only on devices with a 4' display. Response sample:"error": "Wrong filter_mode"
- application/json
- Schema
- Example (from schema)
- Base
- No value
- Wrong param type
- Wrong filter_mode
Schema
- error string
Error message
{
"error": true
}
{
"error": "Wrong JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
{
"error": "Wrong filter_mode"
}
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...