Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

GET Primary Events in Playlist (Version 2.0)

By following the downlink from the description of a single playlist we can retrieve a collection of primary events.

Take note that the collection of primary events contains a compact version of a Primary Event. Use the downlink for each Primary Event to get details.

Syntax
GET /api/channels/[channel]/playlists/[playlist]/primaryevents
Request
GET /api/channels/test/playlists/continuous/primaryevents 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:primaryEventsCompact" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:primaryEventCompact>
<inthub:name>primary_element_1_0_0</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/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/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents" />
<inthub:description>Le radeau LE CRASH DU VOL 29</inthub:description>
<inthub:startTime>2008-04-23T03:48:17.280Z</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:primaryEventCompact>
<inthub:primaryEventCompact>
<inthub:name>primary_element_2_0_0</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_2_0_0" />
<inthub:refLink rel="secondaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_2_0_0/secondaryevents" />
<inthub:description>Flicka</inthub:description>
<inthub:startTime>2008-04-23T04:15:54.160Z</inthub:startTime>
<inthub:duration>37:49:25.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:primaryEventCompact>
</inthub:list>

Disallowed Actions

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