Viz Multichannel
Version 4.2 | Published July 31, 2020 ©
POST Secondary Events under Primary Event (Version 2.0)
Add one or several Secondary Events to an existing Primary Event. If posting multiple events in a single request, wrap it as a entry-collection inside a feed, as seen below. If posting a single event the payload can optionally be of entry-type only, see example below.
Attempting to add a Secondary Event with a id that already exist will return a 'HTTP 409 SecondaryEvent named 'NNN' already exists' declaring the reason for rejection and the duplicate id. If multiple events are posted and one is detected as a duplicate, the full payload is rejected.
Syntax
POST /api/channels/test/playlists/continuous/primaryevents/[primary_event_id]/secondaryevents
Request - Feed with Multiple Secondary Events
POST /api/channels/test/playlists/continuous/primaryevents/9491af52-bc71-
4531
-b73b-4ad020ddc9cc/secondaryevents HTTP/
1.1
Content-Type: application/atom+xml; type=feed
<atom:feed xmlns:vaext=
"http://www.vizrt.com/atom-ext"
xmlns:vizid=
"http://www.vizrt.com/opensearch/vizid"
xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
xmlns:inthub=
"http://www.vizrt.com/integrationshub"
xmlns=
"http://www.w3.org/2007/app"
xmlns:atom=
"http://www.w3.org/2005/Atom"
>
<atom:entry>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:meta_data>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"templatedescription"
>Lower third</atom:attribute>
<atom:attribute name=
"somemetadata"
>some value</atom:attribute>
</atom:meta_data>
<inthub:description>The Famous Band/Bullet With Butterfly Wings</inthub:description>
<inthub:timecode>
00
:
00
:
31
:
00
</inthub:timecode>
<inthub:duration>
00
:
00
:
30
:
00
</inthub:duration>
<inthub:created_by>schedule</inthub:created_by>
<inthub:page>
6000
</inthub:page>
</atom:entry>
<atom:entry>
<inthub:name>pagePDS</inthub:name>
<atom:id>pagePDS</atom:id>
<atom:meta_data>
<atom:attribute name=
"myoptionalmetadata"
>some value</atom:attribute>
</atom:meta_data>
<inthub:timecode>
00
:
00
:
36
:
00
</inthub:timecode>
<inthub:created_by>schedule</inthub:created_by>
<inthub:page>
2
</inthub:page>
</atom:entry>
</atom:feed>
Response
HTTP/
1.1
201
Created
Content-Type: application/atom+xml; type=feed
<atom:feed xmlns:vaext=
"http://www.vizrt.com/atom-ext"
xmlns:vizid=
"http://www.vizrt.com/opensearch/vizid"
xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
xmlns:inthub=
"http://www.vizrt.com/integrationshub"
xmlns=
"http://www.w3.org/2007/app"
xmlns:atom=
"http://www.w3.org/2005/Atom"
>
<atom:entry>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:link rel=
"self"
type=
"application/atom+xml; type=entry"
href=
"http://localhost:9991/api/channels/test/playlists/continuous/primaryevents/group1/secondaryevents/page1"
/>
<atom:link rel=
"edit"
type=
"application/atom+xml; type=entry"
href=
"http://localhost:9991/api/channels/test/playlists/continuous/primaryevents/group1/secondaryevents/page1"
/>
<atom:meta_data>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"templatedescription"
>Lower third</atom:attribute>
<atom:attribute name=
"somemetadata"
>some value</atom:attribute>
</atom:meta_data>
<inthub:description>The Famous Band/Bullet With Butterfly Wings</inthub:description>
<inthub:timecode>
00
:
00
:
31
:
00
</inthub:timecode>
<inthub:duration>
00
:
00
:
30
:
00
</inthub:duration>
<inthub:created_by>inthub</inthub:created_by>
<inthub:page>
6000
</inthub:page>
<inthub:infoIntegrationsHub>[A:
00
:
25
:
09
]</inthub:infoIntegrationsHub>
</atom:entry>
<atom:entry>
<inthub:name>pagePDS</inthub:name>
<atom:id>pagePDS</atom:id>
<atom:link rel=
"self"
type=
"application/atom+xml; type=entry"
href=
"http://localhost:9991/api/channels/test/playlists/continuous/primaryevents/group1/secondaryevents/pagePDS"
/>
<atom:link rel=
"edit"
type=
"application/atom+xml; type=entry"
href=
"http://localhost:9991/api/channels/test/playlists/continuous/primaryevents/group1/secondaryevents/pagePDS"
/>
<atom:meta_data>
<atom:attribute name=
"myoptionalmetadata"
>some value</atom:attribute>
</atom:meta_data>
<inthub:timecode>
00
:
00
:
36
:
00
</inthub:timecode>
<inthub:created_by>inthub</inthub:created_by>
<inthub:page>
2
</inthub:page>
<inthub:infoIntegrationsHub>[A:
00
:
25
:
09
]</inthub:infoIntegrationsHub>
</atom:entry>
</atom:feed>
If posting a single Secondary Event, if can be posted as the entry alone, against the same address.
Request - Entry of Single Secondary Events
POST /api/channels/test/playlists/continuous/primaryevents/9491af52-bc71-
4531
-b73b-4ad020ddc9cc/secondaryevents HTTP/
1.1
Content-Type: application/atom+xml; type=entry
<atom:entry xmlns:vaext=
"http://www.vizrt.com/atom-ext"
xmlns:vizid=
"http://www.vizrt.com/opensearch/vizid"
xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
xmlns:inthub=
"http://www.vizrt.com/integrationshub"
xmlns=
"http://www.w3.org/2007/app"
xmlns:atom=
"http://www.w3.org/2005/Atom"
>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:meta_data>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"somemetadata"
>some other value</atom:attribute>
<atom:attribute name=
"templatedescription"
>Lower third</atom:attribute>
</atom:meta_data>
<inthub:description>The Very Famous Band/Bullet With Butterfly Wings</inthub:description>
<inthub:timecode>
00
:
00
:
15
:
00
</inthub:timecode>
<inthub:duration>
00
:
00
:
30
:
00
</inthub:duration>
<inthub:page>
6000
</inthub:page>
</atom:entry>
Response
HTTP/
1.1
200
OK
Content-Type: application/atom+xml; type=entry
<atom:entry xmlns:vaext=
"http://www.vizrt.com/atom-ext"
xmlns:vizid=
"http://www.vizrt.com/opensearch/vizid"
xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
xmlns:inthub=
"http://www.vizrt.com/integrationshub"
xmlns=
"http://www.w3.org/2007/app"
xmlns:atom=
"http://www.w3.org/2005/Atom"
>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:link rel=
"self"
type=
"application/atom+xml; type=entry"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/9491af52-bc71-4531-b73b-4ad020ddc9cc/secondaryevents/page1"
/>
<atom:link rel=
"edit"
type=
"application/atom+xml; type=entry"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/9491af52-bc71-4531-b73b-4ad020ddc9cc/secondaryevents/page1"
/>
<atom:meta_data>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"somemetadata"
>some other value</atom:attribute>
<atom:attribute name=
"templatedescription"
>Lower third</atom:attribute>
</atom:meta_data>
<inthub:description>The Very Famous Band/Bullet With Butterfly Wings</inthub:description>
<inthub:timecode>
00
:
00
:
15
:
00
</inthub:timecode>
<inthub:duration>
00
:
00
:
30
:
00
</inthub:duration>
<inthub:created_by>inthub</inthub:created_by>
<inthub:page>
6000
</inthub:page>
<inthub:infoIntegrationsHub>[A:
23
:
36
:
21
]</inthub:infoIntegrationsHub>
</atom:entry>