SeriesMaster

title

1

yes

· overrideCanonicalValue: optional; default value is false
· lang: optional unless overrideCanonicalValue=true

Contains title of the content.OpenIngest does not expect attributes to be sent

description

1

no

· type: optional MIME type of the text
· overrideCanonicalValue: optional; default value is false
· lang: optional unless overrideCanonicalValue=true

For movie,seriesMaster, or episode entityTypes, can use shortDescription,mediumDescription, and/or longDescription instead

Harry Potter description

shortDescription

1

no

Merlin has no character lengths but the consuming applications may truncate each of these descriptions

<gmrss:shortDescriptionHarry> Potter</gmrss:shortDescription>

mediumDescription

1

no

<gmrss:mediumDescription>Harry Potter and the Goblet of Fire medium synopsis.</gmrss:mediumDescription>

longDescription

1

no

<gmrss:longDescription>Hermione and Ron try to help Harry win the tri-wizard tournament.</gmrss:longDescription>

pubDate

1

no

1312416000000

releaseYear

1

no

Release year. Automatically populated from pubDate if not specified.

2018

gmrss:languageDetails

1

yes

· intendedAudience: required;
· title: optional; Describes program title language
· description: optional; Program description language
· originalAudio: optional; Language the audio was recorded in.

Create a time marker with the provided offset in milliseconds from the beginning of the asset.

<gmrss:languageDetails title="en-US" description="en-US" episodeTitle="en-US" originalAudio="en-GB" intendedAudience="en-US"/>

entityType

1

yes

Type of video. Legal types are Merlin Program types: Movie, Episode, SeriesMaster, SportingEvent, Other, Preview, Extra, Offer, Person, TvSeason. If the entityType=SeriesMaster,Offer,Person,or TVSeason the element should not have any video content (no videoAssetId or media:group elements). Other items in the GMRSS feed can reference this item using the gmrss:entityReference element.

<gmrss:entityType>SeriesMaster</gmrss:entityType>

gmrss:programVariantId

1

yes

· provider: required, provider of the id and id namespace. Consult the Merlin team to make sure the provider specified is configured for OpenIngest.
· namespace: optional, namespace where the id is unique – within Merlin this is concatenated together with seriesAssetId to form a guid such as "watchable:12345". This should be used if multiple ID spaces exist within the same provider to guarantee uniqueness.

used to create or update programVariant associated with the current item. if cannonicalOverride it set, program fields such as title, episodeTitle, description will be copied to programVariant.Namespace of programVariant is language specific

<gmrss:programVariantId provider="NBC" namespace="SkyShowtime-en-US">GTMV0000645117</gmrss:programVariantId>

gmrss:seriesAssetId

1

yes

· provider: required, provider of the id and id namespace. Consult the Merlin team to make sure the provider specified is configured for OpenIngest.
· namespace: optional, namespace where the id is unique – within Merlin this is concatenated together with seriesAssetId to form a guid such as "watchable:12345". This should be used if multiple ID spaces exist within the same provider to guarantee uniqueness.

ID of the SeriesMaster this item represents, so that Episodes in that series can be connected to it. Other items in the GMRSS feed can reference this item using the gmrss:entityReference element.

<gmrss:seriesAssetId namespace="SkyShowtime" provider="NBC">SM5678</gmrss:seriesAssetId>

gmrss:entityReference

unlimited

no

· provider: required, provider of the tag ID
· entityType: required, required, entity type that this reference points to (example: SeriesMaster)
· namespace: optional, namespace where the ID is unique
· isPrimary: optional, only required when type=entityCollection. isPrimary=true should be set on the primary asset and will create a new entityCollection. isPrimary=false should go on any language variants.

Reference to an entity (e.g. Movie, Episode, TvSeason, SeriesMaster). There can be many entity references per one item. The value of the entity reference is an entity ID in a specific namespace. The entityReference field can be used to link an Episode to a SeriesMaster.

<gmrss:entityReference provider="NBC" entityType="EntityCollection">GTMV0000645117</gmrss:entityReference>

gmrss:tagReference

unlimited

no

· provider: required, provider of the tag ID
· namespace: optional, namespace where the ID is unique
· type: optional, type of the tag to create. Allowed values are ProviderEditorial,ProviderPlacement

Reference to a tag. There can be many tag references per one item. The value of the tag reference is a tag ID in a specific namespace. The tagReference field can be used to create a TagAssociation. If an optional attribute type is provided, also the referred tag will be created if it does not exist. The attribute will be only effective if the ingesting partner has the parameter createTags set to true.

<gmrss:tagReference provider="GRACENOTE_VIDEO_DESCRIPTOR">GN164S651XQJ19N</gmrss:tagReference>

gmrss:creditAssociation

unlimited

no

· type: required; type of credit
· partName: optional; part played
· rank: optional; integer
· cameo: optional; true/false

Used to create persons (both people and characters) within Merlin and relate those persons to a program through a new credit. For credit types of 'Actor' a partReference field is also required to link the actor-person to the character-person.

<gmrss:creditAssociation type="Actor" partName="Shrek" ><gmrss:personReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_MM</gmrss:personReference><gmrss:partReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_SHREK</gmrss:partReference><gmrss:creditAssociation>

gmrss:personReference

unlimited

no

· provider: required; provider of the tag ID
· type: required if personReference is NOT embedded within creditAssociation;
· namespace: optional; namespace where the ID is unique
· partName: optional;
· rank: optional; int
· cameo: optional; true/false

Reference to a person. Use as element in creditAssociation, as standalone field will be deprecated.

`<gmrss:personReference provider="LIVE_EXTRA" type="Appearing">PERSON_ID</gmrss:personReference>`

gmrss:partReference

unlimited

no

· provider: required; provider of the tag ID
· type: optional;
· namespace: optional; namespace where the ID is unique

Reference to a part. Use as element in creditAssociation, as standalone field will be deprecated.

<gmrss:creditAssociation type="Actor" partName="Shrek" ><gmrss:personReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_MM</gmrss:personReference><gmrss:partReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_SHREK</gmrss:partReference><gmrss:creditAssociation>

media:status

1

yes

· state: required; Values are "inactive", "active", "deleted". "active" means a media object is active in the system, "deleted" means a media object has been deleted by the publisher, "inactive" means that the media should be unapproved. Deleted and inactive can be sparse updates, but inactive must be a full object on create.
· reason: optional; Values: add, update, fileUpdate, programOnly. "update" is a forced update, item cannot be sparse. "fileUpdate" used for updating the mediaFile only. "programOnly" is for a program only metadata update (will not update video content)

Specifies the status of a media object – whether it's still active or it has been blocked/deleted.

<media:status reason="add" state="active"/>