Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

GET Secondary Event (Version 2.0)

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

Take note that the content depends on the type of Secondary Event, and the collection of entries under meta_data sub-section is not set in size or content, and depends on the actual meta data attributes on the secondary events in the playlist.

Syntax
GET /api/channels/[channel]/playlists/[playlist]/primaryevents/[primary_event]/secondaryevents/[secondary_event]
Request
GET /api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents/f4e0a087-c6f4-4f40-bca9-a51cdaf43634 HTTP/1.1
Response
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=secondaryevent
<inthub:secondaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="inthub:pageEvent" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>f4e0a087-c6f4-4f40-bca9-a51cdaf43634</inthub:name>
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents/f4e0a087-c6f4-4f40-bca9-a51cdaf43634" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=secondaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents/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>[13:40:14]</inthub:infoPromoServer>
<inthub:metadata>
<inthub:attribute name="some_metadata">some data</inthub:attribute>
</inthub:metadata>
</inthub:secondaryEvent>

Disallowed Actions

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