Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

GET Channel

To obtain a collection of the playlists (headers) that exist under a specific channel use the following command.

Note: Each channel has a link to its full collection of groups.

Syntax

GET /restapi/[channel_name]

Example Request

GET /restapi/Channel1 HTTP/1.1

Example Response

HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshub+xml; type=channel
<channel xmlns="http://www.vizrt.com/integrationshub">
<title>Channel info for http://localhost:9990/restapi/Channel1</title>
<name>Channel1</name>
<link href="http://localhost:9990/restapi/Channel1" rel="self" type="application/vizrt.integrationshub+xml; type=channel" />
<playlist>
<description>Channel Pool</description>
<name>channel_pool</name>
<link href="http://localhost:9990/restapi/Channel1/channel_pool" rel="self" type="application/vizrt.integrationshub+xml; type=playlist" />
<ischannelpool>true</ischannelpool>
<ispagepool>false</ispagepool>
</playlist>
<playlist>
<description>Continuous Playlist</description>
<name>continuous</name>
<link href="http://localhost:9990/restapi/Channel1/continuous" rel="self" type="application/vizrt.integrationshub+xml; type=playlist" />
<ischannelpool>false</ischannelpool>
<ispagepool>false</ispagepool>
</playlist>
<playlist>
<description>Page Pool</description>
<name>page_pool</name>
<link href="http://localhost:9990/restapi/Channel1/page_pool" rel="self" type="application/vizrt.integrationshub+xml; type=pagepool" />
<ischannelpool>false</ischannelpool>
<ispagepool>true</ispagepool>
</playlist>
</channel>