Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

PUT on Secondary Event under a Primary Event (Version 2.0)

Update a Secondary Event definition. There are several types of secondary events, examples below.

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
PUT /api/channels/[channel]/playlists/[playlist]/primaryevents/[primary_event]/secondaryevents/[secondary_event]

Secondary event page

Name, page id and created by can't be adjusted from it's original value.

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

Offset defaults to "00:00:00.000" if empty.

Metadata section will update completely according to how it is specified. If the metadata section is empty, all metadata will be removed. If a metadata attribute is removed, then that metadata will be removed. If metadata values are updated, they will be updated accordingly.

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
PUT /api/channels/test/playlists/continuous/primaryevents/primary_element_2_0_0/secondaryevents/secondary_1_1 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>new description</inthub:description>
<inthub:offset>00:00:05.000</inthub:offset>
<inthub:duration>00:00:01.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 200 OK
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_element_2_0_0/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_element_2_0_0/secondaryevents/secondary_1_1" />
<inthub:description>new description</inthub:description>
<inthub:triggerId>735</inthub:triggerId>
<inthub:offset>00:00:05.000</inthub:offset>
<inthub:takeCount>0</inthub:takeCount>
<inthub:createdBy>inthub</inthub:createdBy>
<inthub:infoIntegrationsHub>[U:17:15:15]</inthub:infoIntegrationsHub>
<inthub:loaded />
<inthub:available />
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:duration>00:00:01.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

Name, page id and created by can't be adjusted from it's original value.

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

Offset defaults to "00:00:00.000" 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>New 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 200 OK
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>New 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>[U:17: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

Name, action id and created by can't be adjusted from it's original value.

Description, trigger id, offset and action command can be empty.

Offset defaults to "00:00:00.000" if empty.

If any values are set for is manually edited, loaded, available, info integrations hub, take count 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:actionCommand>SCENE CLEANUP 1</inthub:actionCommand>
</inthub:secondaryEvent>
Response
HTTP/1.1 200 OK
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>[U:16:34:12]</inthub:infoIntegrationsHub>
<inthub:loaded />
<inthub:available />
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:actionId>viz_cleanup</inthub:actionId>
<inthub:actionCommand>SCENE CLEANUP 1</inthub:actionCommand>
<inthub:actionCategory>viz</inthub:actionCategory>
</inthub:secondaryEvent>

Secondary event pilot data element

Name, pilot data element id and created by can't be adjusted from it's original value.

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

Offset and duration defaults to "00:00:00.000" 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:12.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 200 OK
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:12.000</inthub:offset>
<inthub:takeCount />
<inthub:createdBy>inthub</inthub:createdBy>
<inthub:infoIntegrationsHub>[U:21:10: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

Name and created by can't be adjusted from it's original value.

Description and offset can be 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 an updated message</inthub:description>
<inthub:offset>00:00:10.000</inthub:offset>
<inthub:createdBy>schedule</inthub:createdBy>
</inthub:secondaryEvent>
Response
HTTP/1.1 200 OK
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 an updated message</inthub:description>
<inthub:offset>00:00:10.000</inthub:offset>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:infoIntegrationsHub>[U:14:57:04]</inthub:infoIntegrationsHub>
</inthub:secondaryEvent>