Set announcement settings

Configures the announcement settings. When enabled, the announcement URL is displayed during standby mode.

application/json

Request Body required

• enable boolean

  Determines whether the feature is enabled

• url http/rtsp url

  Web or RTSP address

• timeout integer

  Possible values: >= 10 and <= 300

  Displaying timeout in minutes

Responses

• 200
• 400
• 401

---

OK

• 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
• Missed param
• Wrong param type

---

Schema

• error string

  Error information

{
  "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 information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...