Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

POST a Primary Event to Playlist (Version 2.0)

Add one Primary Event to an existing playlist.

Description, duration, ignore, trigger id, house id, mark in, mark out, created by and metadata can be empty.

Name, is live, is locked and start time cannot be empty. Start time should be in format "yyyy-MM-ddTHH:mm:ss.fffZ".

Ignore defaults to "false" if empty.

Created by defaults to "inthub" if empty.

House id should be specified to create a primary video event, where the house id is a Viz One video asset. If the house id exists in VizOne, the video element will be correctly created. If the house id does not exist in VizOne, then a placeholder can be created if it was enabled in the Channel Settings, otherwise the primary event will be created, with error.

If mark in and mark out have values when house id is empty, they will be ignored as they can't be set for non-video events.

If any values are set for is manually edited, loaded, available, info integrations hub and error, the payload will be accepted but the values will be ignored as they can't be set.

Attempting to add a primary event that already exists will return a 'HTTP 409 Can't add primary event 'NNN', it already exists‘ .

Note: After this request is done the system may perform a Page Content Filling process, against Promo Server, when no additional requests are sent within a configurable timeout.

Note: After this request is done the system runs the rules specified under the Rules section.

Syntax
POST /api/channels/[channel]/playlists/[playlist]/primaryevents

Primary event with no video (house id empty)

Request
POST /api/channels/test/playlists/continuous/primaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>primary_1</inthub:name>
<inthub:description>Top Gun</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>02:12:00.000</inthub:duration>
<inthub:ignore>False</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId />
<inthub:markIn />
<inthub:markOut />
<inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:createdBy>component</inthub:createdBy>
   <inthub:metadata>
<inthub:attribute name="date">2022-03-10</inthub:attribute>
<inthub:attribute name="time">21:00:00:00</inthub:attribute>
<inthub:attribute name="event_type">PRIMARY</inthub:attribute>
<inthub:attribute name="some_metadata">this shows random metadata</inthub:attribute>
</inthub:metadata>
</inthub:primaryEvent>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>primary_1</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_1" />
<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_1/secondaryevents" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1" />
<inthub:description>Top Gun</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>02:12:00.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId />
<inthub:markIn />
<inthub:markOut />
<inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:available />
<inthub:loaded />
<inthub:infoIntegrationsHub>[A:15:26:43]</inthub:infoIntegrationsHub>
<inthub:createdBy>component</inthub:createdBy>
<inthub:error />
<inthub:metadata>
<inthub:attribute name="date">2022-03-10</inthub:attribute>
<inthub:attribute name="time">21:00:00:00</inthub:attribute>
<inthub:attribute name="event_type">PRIMARY</inthub:attribute>
<inthub:attribute name="some_metadata">this shows random metadata</inthub:attribute>
</inthub:metadata>
</inthub:primaryEvent>

Primary event with video (house id set)

Request
POST /api/channels/test/playlists/continuous/primaryevents HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>primary_1_video</inthub:name>
<inthub:description>Top Gun Trailer</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>00:00:50.000</inthub:duration>
<inthub:ignore>False</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId>ABCDEFG</inthub:houseId>
<inthub:markIn>00:00:01.000</inthub:markIn>
<inthub:markOut>00:00:09.000</inthub:markOut>
  <inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:createdBy />
   <inthub:metadata />
</inthub:primaryEvent>
Response
HTTP/1.1 201 Created
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:name>primary_1_video</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_1_video" />
<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_1_video/secondaryevents" />
<inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_1_video" />
<inthub:description>Top Gun Trailer</inthub:description>
<inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
<inthub:duration>00:00:50.000</inthub:duration>
<inthub:ignore>false</inthub:ignore>
<inthub:triggerId>primary1001</inthub:triggerId>
<inthub:houseId>ABCDEFG</inthub:houseId>
<inthub:markIn>00:00:01.000</inthub:markIn>
<inthub:markOut>00:00:09.000</inthub:markOut>
  <inthub:isLocked>false</inthub:isLocked>
<inthub:isLive>false</inthub:isLive>
<inthub:isManuallyEdited>false</inthub:isManuallyEdited>
<inthub:available />
<inthub:loaded />
<inthub:infoIntegrationsHub>[A:15:26:43]</inthub:infoIntegrationsHub>
<inthub:createdBy>inthub</inthub:createdBy>
<inthub:error />
<inthub:metadata />
</inthub:primaryEvent>

Note: The full contract can be used for POST, fields that are read only will be ignored.