Documentation Center

Viz Multichannel User Guide

Version 4.2 | Published July 31, 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.

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/9770f5ff-de09-4436-a54a-3d64989a3c31 HTTP/1.1
Content-Type: application/vizrt.integrationshub+xml; type=payload
<payload>
<page name="page1" page="6000" take_duration="30" timecode="00:00:30:00" />
<page name="pagePDS" page="2" take_duration="45" timecode="00:00:35:00"/>
</payload>

Response

HTTP/1.1 201 Created
Content-Length: 3579
Content-Type: application/vizrt.integrationshub+xml; type=grouppostreply
Server: Microsoft-HTTPAPI/2.0
 
<grouppostreply xmlns="http://www.vizrt.com/integrationshub">
<page>
<title>Page info for http://localhost:9990/restapi/test/continuous/9770f5ff-de09-4436-a54a-3d64989a3c31/page1</title>
<description>The Super Band/Bullet With Butterfly Wings</description>
<name>page1</name>
<link href="http://localhost:9990/restapi/test/continuous/9770f5ff-de09-4436-a54a-3d64989a3c31/page1" rel="self" type="application/vizrt.integrationshub+xml; type=page" />
<timecode>30</timecode>
<take_duration>30</take_duration>
<page>6000</page>
<attributes>
<attribute name="atomid">
<value>urn:uuid:6e495b5c-a646-461b-964b-61be6d587b33</value>
</attribute>
<attribute name="description">
<value>The Super Band/Bullet With Butterfly Wings</value>
</attribute>
<attribute name="event_created_by">
<value>schedule</value>
</attribute>
<attribute name="guid">
<value>2019-06-14T09:36:33Z_Johan-PC2.vizrt.internal_17232_0</value>
</attribute>
<attribute name="infoIntegrationsHub">
<value>[A:17:42:51]</value>
</attribute>
<attribute name="layer">
<value>LTTOGGLE</value>
</attribute>
<attribute name="modified_date">
<value>2019-06-14T09:36:32.641Z</value>
</attribute>
<attribute name="page">
<value>6000</value>
</attribute>
<attribute name="showautodescription">
<value>true</value>
</attribute>
<attribute name="take_duration">
<value>30</value>
</attribute>
<attribute name="templatedescription">
<value>Lower third</value>
</attribute>
<attribute name="timecode">
<value>30</value>
</attribute>
<attribute name="updated">
<value>2019-06-14T09:36:33Z</value>
</attribute>
<attribute name="name">
<value>page1</value>
</attribute>
</attributes>
<fields>
<field name="01LT">
<mapping />
<value>The Super Band</value>
</field>
<field name="02LT">
<mapping />
<value>Bullet With Butterfly Wings</value>
</field>
</fields>
<take_count />
</page>
<page>
<title>Page info for http://localhost:9990/restapi/test/continuous/9770f5ff-de09-4436-a54a-3d64989a3c31/pagePDS</title>
<description />
<name>pagePDS</name>
<link href="http://localhost:9990/restapi/test/continuous/9770f5ff-de09-4436-a54a-3d64989a3c31/pagePDS" rel="self" type="application/vizrt.integrationshub+xml; type=page" />
<timecode>35</timecode>
<take_duration>45</take_duration>
<page>2</page>
<attributes>
<attribute name="event_created_by">
<value>schedule</value>
</attribute>
<attribute name="infoIntegrationsHub">
<value>[A:17:42:51]</value>
</attribute>
<attribute name="is_pilot_data_element">
<value>true</value>
</attribute>
<attribute name="page">
<value>2</value>
</attribute>
<attribute name="take_duration">
<value>45</value>
</attribute>
<attribute name="timecode">
<value>35</value>
</attribute>
<attribute name="name">
<value>pagePDS</value>
</attribute>
<attribute name="ref_link">
<value>/external/pilotdb/elements/2</value>
</attribute>
</attributes>
<fields />
<take_count />
</page>
</grouppostreply>