Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

GET Events in Channel Pool (Version 2.0)

By following the downlink from the channel pool we can retrieve a collection of events. The channel pool can have both secondary events and group events at the root level.

Take note that the collection of events contains a compact version of them. Use the downlink for each event to get details.

Syntax
GET /api/channels/[channel]/channel_pool/events
Request
GET /api/channels/test/channel_pool/events HTTP/1.1
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=list
<inthub:list xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:eventsCompact" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:eventCompact xsi:type="inthub:groupEventCompact">
<inthub:name>primary_element_1_0_0</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/primary_element_1_0_0" />
<inthub:refLink rel="secondaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/primary_element_1_0_0/secondaryevents" />
<inthub:description>Le radeau LE CRASH DU VOL 29</inthub:description>
<inthub:startTime />
<inthub:duration>08:58:13.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<inthub:triggerId />
<inthub:houseId />
<inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:available>1.00</inthub:available>
<inthub:loaded>1.00</inthub:loaded>
<inthub:infoIntegrationsHub>[A:11:47:44]</inthub:infoIntegrationsHub>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:error />
</inthub:eventCompact>
<inthub:eventCompact xsi:type="inthub:pageEventCompact">
<inthub:name>f4e0a087-c6f4-4f40-bca9-a51cdaf43634</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/f4e0a087-c6f4-4f40-bca9-a51cdaf43634" />
<inthub:description>The Smashing Pumpkins/Bullet With Butterfly Wings</inthub:description>
<inthub:triggerId />
<inthub:offset>00:00:02.000</inthub:offset>
<inthub:takeCount>0</inthub:takeCount>
<inthub:createdBy>manual</inthub:createdBy>
<inthub:infoIntegrationsHub />
<inthub:loaded>1.00</inthub:loaded>
<inthub:available>1.00</inthub:available>
<inthub:isManuallyEdited>true</inthub:isManuallyEdited>
<inthub:duration>00:00:10.000</inthub:duration>
<inthub:pageId>6000</inthub:pageId>
<inthub:infoPromoServer>[14:08:30]</inthub:infoPromoServer>
</inthub:eventCompact>
<inthub:eventCompact xsi:type="inthub:refPageEventCompact">
<inthub:name>1000</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/1000" />
<inthub:description>DEFAULT_LOGO</inthub:description>
<inthub:triggerId />
<inthub:offset>00:00:00.000</inthub:offset>
<inthub:takeCount>0</inthub:takeCount>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:infoIntegrationsHub>[A:14:07:54]</inthub:infoIntegrationsHub>
<inthub:loaded>1.00</inthub:loaded>
<inthub:available>1.00</inthub:available>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:duration>00:09:07.890</inthub:duration>
<inthub:pageId>1000</inthub:pageId>
</inthub:eventCompact>
<inthub:eventCompact xsi:type="inthub:pilotDataElementEventCompact">
<inthub:name>9000</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/9000" />
<inthub:description />
<inthub:triggerId />
<inthub:offset>00:00:00.000</inthub:offset>
<inthub:takeCount />
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:infoIntegrationsHub>[A:14:08:28]</inthub:infoIntegrationsHub>
<inthub:loaded />
<inthub:available />
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:duration>00:09:07.890</inthub:duration>
<inthub:pilotDataElementId>9000</inthub:pilotDataElementId>
</inthub:eventCompact>
<inthub:eventCompact xsi:type="inthub:actionEventCompact">
<inthub:name>1c720ee7-8481-4d00-aa53-fe577b85bcbb</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/1c720ee7-8481-4d00-aa53-fe577b85bcbb" />
<inthub:description>Cleanup</inthub:description>
<inthub:triggerId />
<inthub:offset />
<inthub:takeCount>0</inthub:takeCount>
<inthub:createdBy>manual</inthub:createdBy>
<inthub:infoIntegrationsHub />
<inthub:loaded>1.00</inthub:loaded>
<inthub:available>1.00</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:eventCompact>
<inthub:eventCompact xsi:type="inthub:msgEventCompact">
<inthub:name>secondary_msg_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_msg_1" />
<inthub:description>Element with Id '' could not be identified</inthub:description>
<inthub:offset>00:00:10.000</inthub:offset>
<inthub:createdBy>schedule</inthub:createdBy>
<inthub:infoIntegrationsHub>[A:14:55:14]</inthub:infoIntegrationsHub>
</inthub:eventCompact>
</inthub:list>

Disallowed Actions

This end-point does not allow PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.