Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

PUT on Event under Channel Pool (Version 2.0)

Update an Event definition under Channel Pool. Can be group event or several types of secondary events, examples below.


Syntax
PUT /api/channels/[channel]/channel_pool/events/[event]

Group Event

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

Description, startTime, duration, ignore, trigger id, mark in, mark out, isLive, isLocked and metadata can be empty.

Ignore, isLive and isLocked defaults to "false" if empty.

If mark in and mark out have values when house id is empty, they will be ignored as they can't be set for non-video events.

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 and error, the payload will be accepted but the values will be ignored as they can't be set.

Request
PUT /api/channels/test/channel_pool/events/group_1 HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:groupEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>group_1</inthub:name>
<inthub:description>New description</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>02:12:00.000</inthub:duration>
<inthub:ignore>False</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:houseId />
<inthub:markIn />
<inthub:markOut />
<inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:metadata />
</inthub:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:groupEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>group_1</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/group_1" />
<inthub:refLink rel="secondaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/group_1/secondaryevents" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/group_1" />
<inthub:description>New description</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>02:12:00.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId />
<inthub:markIn />
<inthub:markOut />
<inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:available />
<inthub:loaded />
<inthub:infoIntegrationsHub>[U:16:23:40]</inthub:infoIntegrationsHub>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:error />
<inthub:metadata />
</inthub: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.

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/channel_pool/events/secondary_1_page HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>secondary_1_page</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:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>secondary_1_page</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_page" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_page" />
<inthub:refLink rel="pagecontent" type="application/vizrt.integrationshubv2+xml; type=pagecontent" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_page/pagecontent" />
  <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:event>

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.

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
PUT /api/channels/test/channel_pool/events/secondary_1_ref HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_ref" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/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:event>

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.

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
PUT /api/channels/test/channel_pool/events/secondary_1_action HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event  
<inthub:event 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=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_action" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/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:event>

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.

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
PUT /api/channels/test/channel_pool/events/secondary_1_pde HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_pde" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/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:event>

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
PUT /api/channels/test/channel_pool/events/secondary_1_message HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=event
<inthub:event 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:event>
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=event  
<inthub:event 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=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/secondary_1_message" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/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:event>