Viz Channel Branding User Guide

Add one secondary event to an existing primary event. There are several types of secondary events, examples below.

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

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

Syntax

POST /api/channels/[channel]/playlists/[playlist]/primaryevents/[primary_event]/secondaryevents

Secondary event page

Description, duration, trigger id, offset, created by and metadata can be empty.

Name and page id cannot be empty. Attempting to add a secondary event with page id does not exist in page pool, will return a 'HTTP 400 Can't create secondary page event, page 'NNN' does not exist'.

Description is set from the page of given page id, if left empty.

Duration is set from the page of the given page id, if left empty.

Created by defaults to "inthub" if empty.

If any values are set for is manually edited, loaded, available, info integrations hub, info promo server and take count, the payload will be accepted but the values will be ignored as they can't be set.

Request

POST /api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_1</inthub:name>
    <inthub:description>not used</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pageId>6000</inthub:pageId>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:createdBy>inthub</inthub:createdBy>
    <inthub:metadata>
        <inthub:attribute name="date">2022-03-10</inthub:attribute>
        <inthub:attribute name="time">21:00:00:00</inthub:attribute>
        <inthub:attribute name="event_type">SECONDARY</inthub:attribute>
        <inthub:attribute name="some_metadata">this shows random metadata</inthub:attribute>
    </inthub:metadata>
</inthub:secondaryEvent>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent 
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_1</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_1" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_1" />
    <inthub:refLink rel="pagecontent" type="application/vizrt.integrationshubv2+xml; type=pagecontent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_1/pagecontent" /> 
    <inthub:description>not used</inthub:description>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:takeCount>0</inthub:takeCount>
    <inthub:createdBy>inthub</inthub:createdBy>
    <inthub:infoIntegrationsHub>[A:15:56:49]</inthub:infoIntegrationsHub>
    <inthub:loaded />
    <inthub:available />
    <inthub:isManuallyEdited>false</inthub:isManuallyEdited>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pageId>6000</inthub:pageId>
    <inthub:infoPromoServer />
    <inthub:metadata>
        <inthub:attribute name="date">2022-03-10</inthub:attribute>
        <inthub:attribute name="time">21:00:00:00</inthub:attribute>
        <inthub:attribute name="event_type">SECONDARY</inthub:attribute>
        <inthub:attribute name="some_metadata">this shows random metadata</inthub:attribute>
    </inthub:metadata>
</inthub:secondaryEvent>

Secondary event reference page

Description, duration, trigger id, offset and created by can be empty.

Name and page id cannot be empty. Attempting to add a reference secondary event with page id does not exist in page pool, will return a 'HTTP 400 Can't create reference secondary page event, page 'NNN' does not exist'.

Description is set from the page of given page id, if left empty.

Duration is set from the page of the given page id, if left empty.

Created by defaults to "inthub" if empty.

If any values are set for is manually edited, loaded, available, info integrations hub and take count, the payload will be accepted but the values will be ignored as they can't be set.

Request

POST /api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:refPageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_ref</inthub:name>
    <inthub:description>Default Logo</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pageId>6000</inthub:pageId>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:createdBy>inthub</inthub:createdBy>
</inthub:secondaryEvent>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent 
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:refPageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_ref</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_ref" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_ref" />
    <inthub:description>Default Logo</inthub:description>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:takeCount />
    <inthub:createdBy>inthub</inthub:createdBy>
    <inthub:infoIntegrationsHub>[A:16:10:05]</inthub:infoIntegrationsHub>
    <inthub:loaded />
    <inthub:available />
    <inthub:isManuallyEdited>false</inthub:isManuallyEdited>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pageId>6000</inthub:pageId>
</inthub:secondaryEvent>

Secondary event action

Description, trigger id, offset and created by can be empty.

Name and action id cannot be empty. Attempting to add a secondary action event with action id does not exist in action pool, will return a 'Can't create secondary action event, action 'NNN' does not exist'.

Description is set from the action of given action id, if left empty.

Created by defaults to "inthub" if empty.

If any values are set for is manually edited, loaded, available, info integrations hub, take count, action command and action category, the payload will be accepted but the values will be ignored as they can't be set.

Request

POST /api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:actionEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_action</inthub:name>
    <inthub:description>A cleanup action</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:actionId>viz_cleanup</inthub:actionId>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:createdBy>inthub</inthub:createdBy>
</inthub:secondaryEvent>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent  
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:actionEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_action</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_action" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_action" />
    <inthub:description>A cleanup action</inthub:description>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:takeCount />
    <inthub:createdBy>inthub</inthub:createdBy>
    <inthub:infoIntegrationsHub>[A:16:24:12]</inthub:infoIntegrationsHub>
    <inthub:loaded />
    <inthub:available />
    <inthub:isManuallyEdited>false</inthub:isManuallyEdited>
    <inthub:actionId>viz_cleanup</inthub:actionId>
    <inthub:actionCommand>SCENE CLEANUP</inthub:actionCommand>
    <inthub:actionCategory>viz</inthub:actionCategory>
</inthub:secondaryEvent>

Secondary event pilot data element

Description, duration, trigger id, offset and created by can be empty.

Name and pilot data element id cannot be empty. Pilot data element id must be an integer.

Created by defaults to "inthub" if empty.

If any values are set for is manually edited, loaded, available, info integrations hub and take count, the payload will be accepted but the values will be ignored as they can't be set.

Request

POST /api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent 
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pilotDataElementEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_pde</inthub:name>
    <inthub:description>Pilot data element</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pilotDataElementId>9000</inthub:pilotDataElementId>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:createdBy>inthub</inthub:createdBy>
</inthub:secondaryEvent>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent 
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pilotDataElementEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_pde</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_pde" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_pde" />
    <inthub:description>Pilot data element</inthub:description>
    <inthub:triggerId>735</inthub:triggerId>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:takeCount />
    <inthub:createdBy>inthub</inthub:createdBy>
    <inthub:infoIntegrationsHub>[A:16:16:30]</inthub:infoIntegrationsHub>
    <inthub:loaded />
    <inthub:available />
    <inthub:isManuallyEdited>false</inthub:isManuallyEdited>
    <inthub:duration>00:00:20.000</inthub:duration>
    <inthub:pilotDataElementId>9000</inthub:pilotDataElementId>
</inthub:secondaryEvent>

Secondary event message

Description, offset and created by can be empty.

Name cannot be empty.

Created by defaults to "inthub" if empty.

If any values are set for info integrations hub, the payload will be accepted but the values will be ignored as they can't be set.

Request

POST /api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent 
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:msgEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_message</inthub:name>
    <inthub:description>This is a message</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:createdBy>schedule</inthub:createdBy>
</inthub:secondaryEvent>

Response

HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent  
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:msgEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>secondary_1_message</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_message" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1/secondaryevents/secondary_1_message" />
    <inthub:description>This is a message</inthub:description>
    <inthub:offset>00:00:10.000</inthub:offset>
    <inthub:createdBy>schedule</inthub:createdBy>
    <inthub:infoIntegrationsHub>[A:14:55:14]</inthub:infoIntegrationsHub>
</inthub:secondaryEvent>

Note: The full contract can be used for POST, fields that are read only will be ignored.