Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

GET an Event in Channel Pool (Version 2.0)

Following the downlink while retrieving the collection of Events under channel pool one can also do a GET directly on a single Event.

Take note that the content depends on the type of Event, which can be of type Group Event or any type of Secondary Event.


Syntax
GET /api/channels/[channel]/channel_pool/events/[event]
Request
GET /api/channels/test/channel_pool/events/element_1_0_0 HTTP/1.1
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>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/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/element_1_0_0/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/element_1_0_0" />
<inthub:description>Le radeau LE CRASH DU VOL 29</inthub:description>
<inthub:startTime>2024-01-17T04:00:00.000Z</inthub:startTime>
<inthub:duration>00:10:00.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<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>1.00</inthub:available>
<inthub:loaded>1.00</inthub:loaded>
<inthub:infoIntegrationsHub />
  <inthub:createdBy>manual</inthub:createdBy>
<inthub:error />
<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>element_2_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/element_2_0_0" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=event" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/element_2_0_0" />
<inthub:refLink rel="pagecontent" type="application/vizrt.integrationshubv2+xml; type=pagecontent" href="http://127.0.0.1:9991/api/channels/test/channel_pool/events/element_2_0_0/pagecontent" />
  <inthub:description>The Smashing Pumpkins/Bullet With Butterfly Wings</inthub:description>
<inthub:triggerId>element_2_0_0</inthub:triggerId>
<inthub:offset />
<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:duration />
<inthub:pageId>page0</inthub:pageId>
<inthub:infoPromoServer />
<inthub:metadata />
</inthub:event>

Disallowed Actions

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