PUT Active Screen for Live Video

Overview

---

The table below provides key details about the PUT method for changing active screen for the Live Video.

PUT Active Screen for Live Video
Method	PUT
URL or Endpoint	/api/v2/projectId/live-videos/id/active-screens
Headers	Authorization
Content Type	application/json
Parameters	id, projectId
Request Body	channelId

The description of the URL parameter is as follows:

id URL Parameter
URL Parameter Name	id
Mandatory	Yes
Type	string
Description	Unique Id of the live video.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "channelId": "string"
}

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
channelId	No	string	Unique identifier of the channel

Response

{
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "videoId": "string",
        "channelId": "string"
    },
    "resultInfo": null,
    "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	bool	Returns a boolean value indicating the success or failure of the request.
videoId	string	Returns a unique identifier of the live video.
channelId	string	Returns a unique identifier of the active channel.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed