Create/Update messages in the desktop notifications list from Link
This request is used by Link management system to create or update messages which will be displayed on the main screen by link_id
- This feature is available only in AA-14FB panel
- application/json
Request Body required
messages object[]
The list of messages
message stringMessage body
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
created_at integerTimestamp of created message
- 200
- 400
- 401
- 403
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
result object[]
List of operation statuses
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
success booleanOperation status
extended_info stringPossible values: [
created
,updated
,deleted
,entity_not_found
,has_dublicates
,number_taken_by_another_identifier
,bad_base_64_image_file
,face_has_not_recognized
,bound_time_profile_doesnt_exist
,face_id_not_supported
,number_of_face_identifiers_exceeded
,number_of_identifiers_exceeded
,invalid_time_rules_settings
]Entity state information result
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "created"
}
]
}
{
"result": [
{
"link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac",
"success": true,
"extended_info": "created"
}
]
}
- 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
- application/json
- Schema
- Example (from schema)
- Base
- Missed param
- Wrong param type
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"
}
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