Set announcement settings
- Feature enables/disables displaying announcement (HTTP page or RTSP stream) in standby mode
- This feature is disabled in BI-panels
- application/json
Request Body required
- announcement_enable boolean required
Determines whether the feature is enabled
- announcement_url http/rtsp url required
Announcement address
- announcement_timeout integer required
Possible values:
>= 15
and<= 900
Timeout in seconds
Responses
- 200
- 400
- 401
OK
Validation error. Required fields are not provided.
- Timeout must be in range from 15 to 900 seconds
- Missed json body or wrong param. Response sample:
"error": "Wrong JSON body"
- Required field is not provided. 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 timeout
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": "Timeout must be in range from 15 to 900 seconds"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}
Loading...