Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

POST Pages to a Group

To add or update a collection of pages for a given group, in a playlist for a given channel use the following command.

The Request (example)/Response example given shows how to post two pages to a group. No additional pages are added by rules.

Note: Posting off multiple resources are allowed. The Location in the response points to the nearest parent (i.e. the entry the POST was made to). Each specific element is linked in the verbose response.

Note: After this request is done the system is primed to perform a Page Content Filling process against Promo Server as soon as there is no immediate additional requests sent.

Syntax

POST /restapi/[channel_name]/[playlist_name]/[group_name]/

Request (example)

POST /restapi/MovieChannel/continuous/group1 HTTP/1.1
Content-Type: application/vizrt.integrationshub+xml; type=payload
<payload>
<page name="page1" page="now" take_duration="30" timecode="00:00:10:00" />
<page name="page2" page="nextshow" take_duration="14" timecode="00:59:30:00"/>
</payload>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshub+xml; type=grouppostreply
Content-Location: http://localhost:9990/restapi/MovieChannel/continuous/group1
<grouppostreply xmlns="http://www.vizrt.com/integrationshub">
<page>
<title>Page info for http://localhost:9990/restapi/MovieChannel/continuous/group1/page1</title>
<description>Good words need great graphics/A bad graphic is worse than no graphic/Size DOES matters! Superb HD graphics from Vizrt/Your analogue station just entered a new era - history/No Viz. No Fizz/It...s TV. You must VIZualize it/Mood music for the eyes. Vizrt/No story is complete without a Viz graphic</description>
<name>page1</name>
<link href="http://localhost:9990/restapi/MovieChannel/continuous/group1/page1" rel="self" type="application/vizrt.integrationshub+xml; type=page" />
<timecode>00:00:10:00</timecode>
<take_duration>30</take_duration>
<page>now</page>
<attributes>
<attribute name="description">
<value>Good words need great graphics/A bad graphic is worse than no graphic/Size DOES matters! Superb HD graphics from Vizrt/Your analogue station just entered a new era - history/No Viz. No Fizz/It...s TV. You must VIZualize it/Mood music for the eyes. Vizrt/No story is complete without a Viz graphic</value>
</attribute>
<attribute name="event_created_by">
<value>schedule</value>
</attribute>
<attribute name="page">
<value>now</value>
</attribute>
<attribute name="take_duration">
<value>30</value>
</attribute>
<attribute name="timecode">
<value>00:00:10:00</value>
</attribute>
<attribute name="name">
<value>page1</value>
</attribute>
</attributes>
<fields>
<field name="1">
<value>Good words need great graphics</value>
<mapping />
</field>
<field name="2">
<value>A bad graphic is worse than no graphic</value>
<mapping />
</field>
<field name="3">
<value>Size DOES matters! Superb HD graphics from Vizrt</value>
<mapping />
</field>
<field name="4">
<value>Your analogue station just entered a new era - history</value>
<mapping />
</field>
<field name="5">
<value>No Viz. No Fizz</value>
<mapping />
</field>
<field name="6">
<value>It...s TV. You must VIZualize it</value>
<mapping />
</field>
<field name="7">
<value>Mood music for the eyes. Vizrt</value>
<mapping />
</field>
<field name="8">
<value>No story is complete without a Viz graphic</value>
<mapping />
</field>
</fields>
</page>
[... MORE ... deleted to save space ...]
</fields>
</page>
</grouppostreply>