Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

GET Pages from a Group

To obtain a page for a specific group in a playlist for a given channel use the following command.

Syntax

GET /restapi/[channel_name]/[playlist_name]/[group_name]/[page_name]

Request

GET /restapi/Channel1/continuous/group1/page2 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshub+xml; type=page
<page xmlns="http://www.vizrt.com/integrationshub">
<title>Page info for http://[true_ip]:9990/restapi/[channelname]/[playlist_name]/[group_name]_pool/[page_name]</title>
<description>[page_description]</description>
<name>[page_name]</name>
<timecode>[page_timecode]</timecode>
<take_duration>[page_take_duration]</take_duration>
<page>[page_page]</page>
<scene>[scene info from sceneinfo]</scene>
<attributes>
<attribute name="[attribute_name]">
<value>[value]</value>
</attribute>
<attribute name="[attribute_name]">
<value>[value]</value>
</attribute>
[..]
</attributes>
<fields>
<field name="[tabfield_name]">
<mapping>[tabfield_mapping]</mapping>
<value>[tabfield_value]</value>
<type>[tabfield_type]</type>
</field>
[..]
</fields>
<link href="http://[true_ip]:9990/restapi/[channelname]/[playlist_name]/[group_name]/[page_name]" rel="self" type="application/vizrt.integrationshub+xml; type=page" />
</page>