Viz Multichannel
Version 4.2 | Published July 31, 2020 ©
POST Primary Events to Playlist (Version 2.0)
Add one or several Primary Events to an existing playlist. 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. Note that the response payload if posting a feed-collection will contain all existing events including the just added one(s). The collection returned is not sorted by start-time but by time added.
Attempting to add a Primary Event with a id that already exist will return a 'HTTP 409 PrimaryEvent 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/[playlist_id]/primaryevents
Request
POST /api/channels/test/playlists/continuous/primaryevents 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>1051111_1_VM_16_01_1</inthub:name>
<atom:id>1051111_1_VM_16_01_1</atom:id>
<atom:meta_data>
<atom:attribute name=
"continue_count"
>
0
</atom:attribute>
<atom:attribute name=
"created"
>
6
/
11
/
2018
17
:
33
:
51
</atom:attribute>
<atom:attribute name=
"date"
>
2010
-
09
-
23
</atom:attribute>
<atom:attribute name=
"fixed_duration"
>yes</atom:attribute>
<atom:attribute name=
"seqment"
>
1
</atom:attribute>
<atom:attribute name=
"time"
>
08
:
50
:
15
:
24
</atom:attribute>
</atom:meta_data>
<inthub:description>In-channel trailer</inthub:description>
<inthub:begin_at>
2018
-
11
-06T07:
13
:
40
.000Z</inthub:begin_at>
<inthub:duration>
00
:
00
:
35
:
00
</inthub:duration>
<inthub:ignore>False</inthub:ignore>
<inthub:event_id>1051111_1_VM_16_01_1</inthub:event_id>
<inthub:trigger_id>primary1001</inthub:trigger_id>
<inthub:instance>composite_test</inthub:instance>
<inthub:adjust_begin_at_after_resume>yes</inthub:adjust_begin_at_after_resume>
</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>9770f5ff-de09-
4436
-a54a-3d64989a3c31</inthub:name>
<atom:id>9770f5ff-de09-
4436
-a54a-3d64989a3c31</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/9770f5ff-de09-4436-a54a-3d64989a3c31"
/>
<atom:link rel=
"edit"
type=
"application/atom+xml; type=entry"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/9770f5ff-de09-4436-a54a-3d64989a3c31"
/>
<atom:link rel=
"secondaryevents"
type=
"application/atom+xml; type=feed"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/9770f5ff-de09-4436-a54a-3d64989a3c31/secondaryevents"
/>
<atom:meta_data>
<atom:attribute name=
"deactivate_on_end"
>no</atom:attribute>
<atom:attribute name=
"fixed_duration"
>yes</atom:attribute>
</atom:meta_data>
<inthub:description>REST v1</inthub:description>
<inthub:begin_at>
2019
-
06
-20T03:
00
:
00
.000Z</inthub:begin_at>
<inthub:duration>
01
:
00
:
00
:
00
</inthub:duration>
<inthub:instance>composite_test</inthub:instance>
<inthub:adjust_begin_at_after_resume>yes</inthub:adjust_begin_at_after_resume>
<inthub:pause_after_scheduling>no</inthub:pause_after_scheduling>
<inthub:isManuallyEdited>
true
</inthub:isManuallyEdited>
<inthub:secondaryevents>
<inthub:secondaryevent>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:meta_data>
<atom:attribute name=
"guid"
>
2019
-
06
-14T09:
36
:28Z_Johan-PC2.vizrt.internal_17232_0</atom:attribute>
<atom:attribute name=
"modified_date"
>
2019
-
06
-14T09:
36
:
28
.731Z</atom:attribute>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"templatedescription"
>Logo</atom:attribute>
</atom:meta_data>
<inthub:description>GEOM*products/MCP/Packages/Music_demo/CONCEPT=HD/DEFAULT_LOGO</inthub:description>
<inthub:timecode>
00
:
00
:
01
:
00
</inthub:timecode>
<inthub:duration>
00
:
00
:
10
:
00
</inthub:duration>
<inthub:created_by>schedule</inthub:created_by>
<inthub:page>
1000
</inthub:page>
<inthub:infoIntegrationsHub>[U:
03
:
34
:
57
]</inthub:infoIntegrationsHub>
</inthub:secondaryevent>
</inthub:secondaryevents>
<inthub:infoIntegrationsHub>[U:
21
:
47
:
41
]</inthub:infoIntegrationsHub>
</atom:entry>
<atom:entry>
<inthub:name>9491af52-bc71-
4531
-b73b-4ad020ddc9cc</inthub:name>
<atom:id>9491af52-bc71-
4531
-b73b-4ad020ddc9cc</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"
/>
<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"
/>
<atom:link rel=
"secondaryevents"
type=
"application/atom+xml; type=feed"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/9491af52-bc71-4531-b73b-4ad020ddc9cc/secondaryevents"
/>
<atom:meta_data>
<atom:attribute name=
"deactivate_on_end"
>no</atom:attribute>
<atom:attribute name=
"fixed_duration"
>yes</atom:attribute>
</atom:meta_data>
<inthub:description>REST v2</inthub:description>
<inthub:begin_at>
2019
-
06
-20T04:
00
:
00
.000Z</inthub:begin_at>
<inthub:duration>
01
:
00
:
00
:
00
</inthub:duration>
<inthub:instance>composite_test</inthub:instance>
<inthub:adjust_begin_at_after_resume>yes</inthub:adjust_begin_at_after_resume>
<inthub:pause_after_scheduling>no</inthub:pause_after_scheduling>
<inthub:isManuallyEdited>
true
</inthub:isManuallyEdited>
<inthub:secondaryevents>
<inthub:secondaryevent>
<inthub:name>page1</inthub:name>
<atom:id>page1</atom:id>
<atom:meta_data>
<atom:attribute name=
"guid"
>
2019
-
06
-14T09:
36
:33Z_Johan-PC2.vizrt.internal_17232_0</atom:attribute>
<atom:attribute name=
"modified_date"
>
2019
-
06
-14T09:
36
:
32
.641Z</atom:attribute>
<atom:attribute name=
"showautodescription"
>
true
</atom:attribute>
<atom:attribute name=
"templatedescription"
>Lower third</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>
<inthub:infoIntegrationsHub>[A:
19
:
45
:
29
]</inthub:infoIntegrationsHub>
</inthub:secondaryevent>
<inthub:secondaryevent>
<inthub:name>pagePDS</inthub:name>
<atom:id>pagePDS</atom:id>
<atom:meta_data>
<atom:attribute name=
"is_pilot_data_element"
>
true
</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>
<inthub:infoIntegrationsHub>[A:
19
:
45
:
30
]</inthub:infoIntegrationsHub>
</inthub:secondaryevent>
</inthub:secondaryevents>
</atom:entry>
<atom:entry>
<inthub:name>1051111_1_VM_16_01_1</inthub:name>
<atom:id>1051111_1_VM_16_01_1</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/1051111_1_VM_16_01_1"
/>
<atom:link rel=
"edit"
type=
"application/atom+xml; type=entry"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/1051111_1_VM_16_01_1"
/>
<atom:link rel=
"secondaryevents"
type=
"application/atom+xml; type=feed"
href=
"http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/1051111_1_VM_16_01_1/secondaryevents"
/>
<atom:meta_data>
<atom:attribute name=
"continue_count"
>
0
</atom:attribute>
<atom:attribute name=
"created"
>
6
/
11
/
2018
17
:
33
:
51
</atom:attribute>
<atom:attribute name=
"date"
>
2010
-
09
-
23
</atom:attribute>
<atom:attribute name=
"fixed_duration"
>yes</atom:attribute>
<atom:attribute name=
"seqment"
>
1
</atom:attribute>
<atom:attribute name=
"time"
>
08
:
50
:
15
:
24
</atom:attribute>
</atom:meta_data>
<inthub:description>In-channel trailer</inthub:description>
<inthub:begin_at>
2018
-
11
-06T07:
13
:
40
.000Z</inthub:begin_at>
<inthub:duration>
00
:
00
:
35
:
00
</inthub:duration>
<inthub:ignore>False</inthub:ignore>
<inthub:event_id>1051111_1_VM_16_01_1</inthub:event_id>
<inthub:trigger_id>primary1001</inthub:trigger_id>
<inthub:house_id />
<inthub:instance>composite_test</inthub:instance>
<inthub:presentation>composite</inthub:presentation>
<inthub:adjust_begin_at_after_resume>yes</inthub:adjust_begin_at_after_resume>
<inthub:secondaryevents />
<inthub:infoIntegrationsHub>[A:
22
:
37
:
14
]</inthub:infoIntegrationsHub>
</atom:entry>
</atom:feed>