Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

POST Page to Channel Page Pool (Version 2.0)

Add one page to a channel's Page Pool.

Description is set from template, if left empty.

Name and template cannot be empty. Attempting to add a page with template does not exist in template pool, will return a ' HTTP 400 Failed to create page, missing template: NNN '.

Default duration and time to live can be empty.

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


Syntax
POST /api/channels/[channel]/page_pool
Request
POST /api/channels/test/page_pool HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=page
<inthub:page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>test1</inthub:name>
<inthub:template>6000</inthub:template>
<inthub:description>New description</inthub:description>
<inthub:defaultDuration>00:00:10.000</inthub:defaultDuration>
<inthub:timeToLive>2023-12-31</inthub:timeToLive>
</inthub:page>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=page
<inthub:page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>test1</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=page" href="http://127.0.0.1:9991/api/channels/test/page_pool/test1" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=page" href="http://127.0.0.1:9991/api/channels/test/page_pool/test1" />
<inthub:template>6000</inthub:template>
<inthub:description>New description</inthub:description>
<inthub:defaultDuration>00:00:10.000</inthub:defaultDuration>
<inthub:timeToLive>2023-12-31</inthub:timeToLive>
</inthub:page>

Page with empty optional values

Syntax
POST /api/channels/[channel]/page_pool
Request
POST /api/channels/test/page_pool HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=page
<inthub:page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>test2</inthub:name>
<inthub:template>6000</inthub:template>
<inthub:description></inthub:description>
<inthub:defaultDuration></inthub:defaultDuration>
<inthub:timeToLive></inthub:timeToLive>
</inthub:page>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=page
<inthub:page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>test2</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=page" href="http://127.0.0.1:9991/api/channels/test/page_pool/test2" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=page" href="http://127.0.0.1:9991/api/channels/test/page_pool/test2" />
<inthub:template>6000</inthub:template>
<inthub:description>Lower third</inthub:description>
<inthub:defaultDuration />
<inthub:timeToLive />
</inthub:page>