Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

POST Pages to the Page Pool

Use the command below to add or update a collection of pages for a channel's Page Pool.

The Request (example)/Response example provided shows how to post one page to the Page Pool.

Note: Multiple resources can be posted. Each specific element is linked in the verbose response.

Syntax

POST /restapi/[channel_name]/page_pool

Request (example)

POST /restapi/VizMusic/page_pool HTTP/1.1
Content-Type: application/vizrt.integrationshub+xml; type=payload
<payload>
<page name="example3" template="8000_clip" />
</payload>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshub+xml; type=pagepoolpostreply
<pagepoolpostreply xmlns="http://www.vizrt.com/integrationshub">
<title>Post result info to http://localhost:9990/restapi/VizMusic/page_pool</title>
<ispagepool>true</ispagepool>
<link href="http://localhost:9990/restapi/VizMusic/page_pool" rel="self" type="application/vizrt.integrationshub+xml; type=pagepoolpostreply" />
<page>
<title>Page info for http://localhost:9990/restapi/VizMusic/page_pool/example3</title>
<description>Coming Up Next.../Famous Band live and unplugged/...</description>
<name>example3</name>
<link href="http://localhost:9990/restapi/VizMusic/page_pool/example3" rel="self" type="application/vizrt.integrationshub+xml; type=pagepoolpage" />
<take_duration />
<timetolive />
<attributes>
<attribute name="description">
<value>Coming Up Next.../Famous Band live and unplugged/...</value>
</attribute>
<attribute name="guid">
<value>MuC_Client_52fe29ac-0b20-46c3-a12a-e1684ea75a42</value>
</attribute>
<attribute name="layer">
<value>LTTOGGLE</value>
</attribute>
<attribute name="templatedescription">
<value>Coming up next - Video clip</value>
</attribute>
<attribute name="name">
<value>example3</value>
</attribute>
</attributes>
<fields>
<field name="clip">
<mapping />
<value />
</field>
<field name="01UPNEXTLT">
<mapping />
<value>Coming Up Next...</value>
</field>
<field name="02UPNEXTLT">
<mapping />
<value>Famous Band live and unplugged</value>
</field>
</fields>
</page>
</pagepoolpostreply>