Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

POST a Playlist to Channel (Version 2.0)

Add a playlist to a channel. For normal installations a single continuous playlist is the recommended approach.

Name can only be "continuous" or in the date format "yyyy_MM_dd".

Broadcast date must match the name, for continuous playlist it can only be "continuous", for a playlist in date format, the broadcast date must match the playlist date with format "yyyy-MM-dd".

Description is automatically set if left empty. For continuous playlist is set to " Continuous Playlist" and for playlist in date format is set to " Playlist for yyyy-MM-dd " by default.

If any values are set for loaded, available and update, the payload will be accepted but the values will be ignored as they can't be set.

Attempting to add a playlist that already exists will return a ' HTTP 409 Can't add playlist 'NNN', it already exists‘ .


Syntax
POST /api/channels/[channel]/playlists

Continuous playlist

Request - Continuous Playlist
POST /api/channels/test/playlists HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=playlist
<inthub:playlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>continuous</inthub:name>
<inthub:description>Continuous Playlist</inthub:description>
<inthub:broadcastDate>continuous</inthub:broadcastDate>
</inthub:playlist>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=playlist
<inthub:playlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>continuous</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=playlist" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=playlist" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous" />
<inthub:refLink rel="primaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents" />
<inthub:refLink rel="state" type="application/vizrt.integrationshubv2+xml; type=playliststate" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/state" />
<inthub:refLink rel="refresh" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/refresh" />
<inthub:description>Continuous Playlist</inthub:description>
<inthub:broadcastDate>continuous</inthub:broadcastDate>
<inthub:loaded />
<inthub:available />
<inthub:updated />
</inthub:playlist>

Playlist in date format

If events should be split by date or playlist for other usage is required, see the following example:

Request - Date Playlist
POST /api/channels/test/playlists HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=playlist
<inthub:playlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>2019_12_01</inthub:name>
<inthub:description>Playlist for 2019-12-01</inthub:description>
<inthub:broadcastDate>2019-12-01</inthub:broadcastDate>
</inthub:playlist>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=playlist
<inthub:playlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>2019_12_01</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=playlist" href="http://127.0.0.1:9991/api/channels/test/playlists/2019_12_01" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=playlist" href="http://127.0.0.1:9991/api/channels/test/playlists/2019_12_01" />
<inthub:refLink rel="primaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/playlists/2019_12_01/primaryevents" />
<inthub:refLink rel="state" type="application/vizrt.integrationshubv2+xml; type=playliststate" href="http://127.0.0.1:9991/api/channels/test/playlists/2019_12_01/state" />
<inthub:refLink rel="refresh" href="http://127.0.0.1:9991/api/channels/test/playlists/2019_12_01/refresh" />
<inthub:description>Playlist for 2019-12-01</inthub:description>
<inthub:broadcastDate>2019-12-01</inthub:broadcastDate>
<inthub:loaded />
<inthub:available />
<inthub:updated />
</inthub:playlist>

Note: The full contract can be used for POST, fields that are read only will be ignored.