Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

POST an Event to Channel Pool (Version 2.0)

Add one Event to the Channel Pool. There channel pool allows both group events and secondary events to be added, see example below.

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

Group Event

Description, start time, duration, ignore, isLive, isLocked, trigger id, house id, mark in, mark out, created by and metadata can be empty.

Name cannot be empty.

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

Created by defaults to "inthub" if empty.

House id should be specified to create a group video event, where the house id is a Viz One video asset. If the house id exists in VizOne, the video element will be correctly created. If the house id does not exist in VizOne, then a placeholder can be created if it was enabled in the Channel Settings, otherwise the group event will be created, with error.

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.

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.


Syntax
POST /api/channels/[channel]/channel_pool/events

Group event with no video (house id empty)

Request
POST /api/channels/test/channel_pool/events 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>Top Gun</inthub:description>
<inthub:duration>02:12:00.000</inthub:duration>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId />
<inthub:markIn />
<inthub:markOut />
<inthub:createdBy>component</inthub:createdBy>
</inthub:event>
Response
HTTP/1.1 201 Created
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>Top Gun</inthub:description>
<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>[A:15:26:43]</inthub:infoIntegrationsHub>
<inthub:createdBy>component</inthub:createdBy>
<inthub:error />
<inthub:metadata />
</inthub:event>

Group event with video (house id set)

Request
POST /api/channels/test/channel_pool/events 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_video</inthub:name>
<inthub:description>Top Gun Trailer</inthub:description>
<inthub:duration>00:00:50.000</inthub:duration>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId>ABCDEFG</inthub:houseId>
<inthub:markIn>00:00:01.000</inthub:markIn>
<inthub:markOut>00:00:09.000</inthub:markOut>
<inthub:createdBy />
</inthub:event>
Response
HTTP/1.1 201 Created
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_video</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_video" />
<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_video/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_video" />
<inthub:description>Top Gun Trailer</inthub:description>
<inthub:startTime />
<inthub:duration>00:00:50.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId>ABCDEFG</inthub:houseId>
<inthub:markIn>00:00:01.000</inthub:markIn>
<inthub:markOut>00:00:09.000</inthub:markOut>
  <inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:available />
<inthub:loaded />
<inthub:infoIntegrationsHub>[A:15:26:43]</inthub:infoIntegrationsHub>
<inthub:createdBy>inthub</inthub:createdBy>
<inthub:error />
<inthub:metadata />
</inthub:event>

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 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/channel_pool/events 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_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:event>
Response
HTTP/1.1 201 Created
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_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/secondary_1_1" />
<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_1" />
<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_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:event>

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 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/channel_pool/events 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>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:event>
Response
HTTP/1.1 201 Created
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>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:event>

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 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/channel_pool/events 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:event>
Response
HTTP/1.1 201 Created
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>[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:event>

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/channel_pool/events 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: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:event>
Response
HTTP/1.1 201 Created
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: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:event>

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/channel_pool/events 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 a message</inthub:description>
<inthub:offset>00:00:10.000</inthub:offset>
<inthub:createdBy>schedule</inthub:createdBy>
</inthub:event>
Response
HTTP/1.1 201 Created
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 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:event>

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