Viz Channel Branding User Guide
Version 5.1 | Published October 26, 2023 ©
GET Secondary Events under Primary Event (Version 2.0)
Follow the downlink under a Primary Event to get a collection of secondary events under this Primary Event.
Take note that the collection of secondary events contains a compact version of a Secondary Event, and also that the content is depending on the type of Secondary Event. Use the downlink for each Secondary Event to get details.
Syntax
GET /api/channels/[channel]/playlists/[playlist]/primaryevents/[primary_event]/secondaryevents
Request
GET /api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents 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:secondaryEventsCompact"
xmlns:inthub
=
"http://www.vizrt.com/integrationshub"
>
<
inthub
:secondaryEventCompact
xsi:type
=
"inthub:pageEventCompact"
>
<
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
: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
:secondaryEventCompact>
<
inthub
:secondaryEventCompact
xsi:type
=
"inthub:refPageEventCompact"
>
<
inthub
:name>1000</
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/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
:secondaryEventCompact>
<
inthub
:secondaryEventCompact
xsi:type
=
"inthub:pilotDataElementEventCompact"
>
<
inthub
:name>9000</
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/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
:secondaryEventCompact>
<
inthub
:secondaryEventCompact
xsi:type
=
"inthub:actionEventCompact"
>
<
inthub
:name>1c720ee7-8481-4d00-aa53-fe577b85bcbb</
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/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
:secondaryEventCompact>
<
inthub
:secondaryEventCompact
xsi:type
=
"inthub:msgEventCompact"
>
<
inthub
:name>secondary_msg_1</
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/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
:secondaryEventCompact>
</
inthub
:list>
Disallowed Actions
This end-point does not allow PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.