editorialChannel (editorial-based) | NAGRAVISION Documentation Portal

Legend

Colour	Meaning
	Mandatory for ingest, optional or not used for ION
	Mandatory for ION, optional for ingest
	Mandatory for both ingest and ION
	Optional for ingest and optional or not used for ION

cmsData - editorialChannel

Elements		Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`		EditorialChannelType	Optional		This element defines an editorial channel. It contains the definitions of the events for a specific period.	Not used
		`providerResourceId`	string	Mandatory	`BE_8006`	Channel ID	Not used
		`providerId`	string	Mandatory	`GLOBAL`	Provider	Not used	`companyId`
		`name`	string	Mandatory	`ARTEHDFr_8006`	Channel name	Mandatory	`longName`

cmsData - editorialChannel - metaDataSet

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`metadataSet`			MetadataSetType	Optional			Not used	`EpgDescription`
				`locale`		Mandatory			Mandatory	`locale`
			`metadata`		MetadataType	Optional			Mandatory	`EpgElement`
				`key="Title"`	string	Optional	`ESPN Channel`	Editorial channel title	Not used	`privateMetadata`
				`key="Description"`	string	Optional	`Description`	Editorial channel description	Optional	`privateMetadata`
				`key="Rating"`	string	Optional	`1`	Channel rating (numeric)	Mandatory	`privateMetadata`
				`key="ChannelNumber"`	string	Optional	`25`	Editorial channel number	Mandatory	`tvChannel`
				`key="ShortName"`	string	Optional	`ESPN`	Short name for the editorial channel	Not used	`privateMetadata`
				The following key-value pairs are related to geofiltering and geoblocking. They can be set at both channel and event level. If one is set at the channel level, it cannot be overridden at the event level. The channel setting always takes precendence.
				`key="filteringList"`	string	Optional	`USA,IND`	A list of locations. If these are countries, they are as represented in the ISO standard. This list will be used by OpCon to populate the selection list. Values must be comma-separated.	Future use	`privateMetadata`
				`key="filteringListIsAllowList"`	string	Optional	`true`	Indicates if the `filteringList` is an allowed list or not.	Optional	`privateMetadata`
				`key="blockingList"`	string	Optional	`USA;IND`	A list of locations where playback is allowed.	Future use	`privateMetadata`
				`key="blockVpn"`	string	Optional	`true`	A global per operator value to indicate if VPN blocking is turned on or off.	Future use	`privateMetadata`
				`key="blockIfOffNet"`	string	Optional	`true`	Filtering of content for on/off network.	Optional
				`key="blockingListIsAllowList"`	string	Optional	`true`	Indicates if the `blockingList` is an allowed list or not.	Optional	`privateMetadata`

cmsData - editorialChannel - periodToDelete

Elements			Fields/attributes	Type	Required	Sample data	Description	ION
`cmsData`
	`editorialChannel`
		`periodToDelete`		PeriodWithOptionalStartEndType	Optional		Specifies the time period for which events belonging to the editorial channel are to be deleted. Reserved for future use.	Not used
			`start`	gmtdatetime	Optional	`2016-01-01T00:00:00Z`		Not used
			`end`	gmtdatetime	Optional	`2038-01-01T00:00:00Z`		Not used

cmsData - editorialChannel - channelEvents

Elements			Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`		ChannelEventsType	Optional		Defines common attributes of all root elements of the channelEvents element.	Not used
			`startFrom`	string	Optional	`2012-05-31T06:10:30Z`	The duration start from date to be used to filter the results. ISO 8601 format up to the second but no time zone.	Not used
			`endUntil`	string	Optional	`2012-05-31T06:10:30Z`	The duration end until date to be used to filter the results. ISO 8601 format up to the second but no time zone.	Not used	`program`

cmsData - editorialChannel - channelEvents - event

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`		EventType	Optional			Not used
				`providerResourceId`	string	Mandatory	`193016452`	Event ID
				`name`	string	Mandatory	`Arte journal`	Event name	Mandatory	`title`
				`providerId`	string	Mandatory	`plurimedia`	Provider	Not used	`providerId`

cmsData - editorialChannel - channelEvents - event - metadataSet

Element						Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`metadataSet`			MetadataSetType	Optional			Not used	`EpgDescription (locale)`
						`locale`		Mandatory			Not used	`EpgElement`
					`metadata`		MetadataType	Optional			Mandatory	`privateMetadata`
						`key="Title"`	string	Optional	`Program for channel One`	Event title	Mandatory	`privateMetadata`
						`key="Description"`	string	Optional	`Every day at 1pm`	Event description	Not used	`Period`
						`key="broadcastEventId"`	string	Optional	`157`	The broadcast event ID. This value should typically match the one in the DVB Event Information Table (EIT), allowing client applications to cross-reference actual (DVB) to expected (Platform) events. Note that this must be defined in the `metadata locale="none"` block.
						The following key-value pairs are related to geofiltering and geoblocking. They can be set at both channel and event level. If one is set at the channel level, it cannot be overridden at the event level. The channel setting always takes precendence.
						`key="filteringList"`	string	Optional	`USA,IND`	A list of countries as represented in the ISO standard. It will be used by OpCon to populate the selection list. Values must be comma-separated.	Future use	`privateMetadata`
						`key="filteringListIsAllowList"`	string	Optional	`true`	Indicates if the `filteringList` is an allowed list or not.	Optional	`privateMetadata`
						`key="blockingList"`	string	Optional	`USA;IND`	A list of countries where playback is allowed.	Future use	`privateMetadata`
						`key="blockVpn"`	string	Optional	`true`	A global per operator value to indicate if VPN blocking is turned on or off.	Future use	`privateMetadata`
						`key="blockIfOffNet"`	string	Optional	`true`	Filtering of content for on/off network.	Optional
						`key="blockingListIsAllowList"`	string	Optional	`true`	Indicates if the `blockingList` is an allowed list or not.	Optional	`privateMetadata`

cmsData - editorialChannel - channelEvents - event - airingStartTime/airingEndTime

Elements					Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`airingStartTime`	gmtdatetime	Optional	`2021-06-14T10:00:00Z`	The event airing start date and time. ISO 8601 format up to the second and using the ""Z"" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.	Mandatory	`airingStartTime`
				`airingEndTime`	gmtdatetime	Optional	`2021-06-15T10:00:00Z`	The event airing start date and time. ISO 8601 format up to the second and using the ""Z"" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.	Mandatory	`airingEndTime`

cmsData - editorialChannel - channelEvents - event - period

Elements					Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`			EventType	Optional			Not used
				`period`		PeriodType	Optional		Specifies the start and end date/time of the event	Mandatory	`start`
					`start`	gmtdatetime	Optional	`2012-05-31T06:10:30Z`	Start date of the parent resource. An ISO 8601 compatible gmt date/time up to the second : yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against start will be true.	Mandatory	`end`
					`end`	gmtdatetime	Optional	`2012-05-31T06:10:30Z`	End date of the parent resource. An ISO 8601 compatible gmt date/time up to the second: yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against end will be true.	Not used

cmsData - editorialChannel - channelEvents - event - timeShifting

Elements					Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`timeShifting`			Optional		Data related to the time-shifting feature	Mandatory
					`shortTermCatchUpSupport`	boolean	Optional	`FALSE`	Indicates if the short-term catch-up feature is activated for this event.	Mandatory	`isCatchUp`
					`longTermCatchUpSupport`	boolean	Optional	`TRUE`	Indicates if the long-term catch-up feature is activated for this event.	Mandatory	`isCatchUp`
					`startOverSupport`	boolean	Optional	`FALSE`	Indicates if the start over feature is activated for this event.	Optional	`isStartOver`
					`networkPvrSupport`	boolean	Optional	`FALSE`	Indicates if network PVR feature is activated for this event.	Not used	`isnPvr`

cmsData - editorialChannel - channelEvents - event - images

Elements								Fields/attributes	Type	Required	Sample data	Description	ION	IHS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`images`					ImageSetType
					`image`				ImageType
								id	string	Mandatory	`650980`	Unique identifier of the image	Mandatory
								uri	string	Optional	`http://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpg`	URI of the image for download	Optional	`uri`

						`height`			integer	Optional	`272`	Image height	Mandatory	`height`
						`width`			integer	Optional	`352`	Image width	Mandatory	`width`
						`aspect`			string	Optional		Aspect ratio of the Image, for example, `16x9`	Mandatory	`aspect`
						`category`			string	Optional		Category of the Image	Optional	`category`
						`primary`			boolean	Optional		Indicates if the image is primary or not	Optional	`primary`
						`captions`			CaptionsType	Optional		Set of locale-specific image titles	Optional	`captions`
								`locale`	string	Mandatory		Language/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1. If the `MetadataSet` is not localised, the locale must be set to `"none"`.	Not used	`locale`
							`title`		string	Optional		Locale-specific name of the image	Optional	`title`
						`externalId`			ExternalIdType	Optional		Source information of the image	Optional	`externalId`
							`externalSource`		ExternalSourceType	Optional			Optional	`externalSource`
								`sourceName`	string	Mandatory		Name of the external source, for example, `gracenote`, `imdb`, etc.	Optional
								`resourceId`	string	Mandatory		Identifier of the resource (person or image) in the external source	Optional	`externalResourceId`
						`locale`			string	Optional	`en_EN`	The locale that the image applies to. Multiple locales can be specified for each image.

cmsData - editorialChannel - channelEvents - event - persons

Elements										Fields/attributes	Type	Required	Sample data	Description	ION	CCP
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`persons`							PersonSetType	Optional		Set of persons for this content and associated metadata	Not used	`persons`
					`person`						PersonType	Mandatory		Defines a person element ie., the cast or crew for the editorial content	Mandatory	`persons`
										`id`	string	Mandatory	`STCUEnabled_EditorialLevel_New_person_1`	Unique identifier of the person	Mandatory	`id`
										`dateOfBirth`	string	Optional	`22/04/1990`	Date of birth of the person in 'YYYY-MM-DD' format	Mandatory	`dateOfBirth`
										`type`	string	Mandatory	`cast`	The type of person, restricted to `cast` or `persona`	Mandatory	`type`
						`names`					NamesType	Optional		Defines the locale-specific name of the person	Mandatory	`names`
										`locale`	string	Optional	`en_GB`	Language/country code in which the name is written. It must conform to ISO-639 and ISO 3166-1.	Mandatory	`locale`
							`name`				string	Optional	`Thomas Sean Connery`	Locale-specific name of the person	Mandatory	`name`
						`details`					DetailsType	Optional		Defines the locale-specific bio data of the person	Mandatory	`details`
										`locale`	string	Optional	`en_GB`	Language-country code in which the bio data is written. It must conform to ISO-639 and ISO 3166-1	Mandatory	`locale`
							`bio`				string	Optional	`Scottish actor with distinctive accent`	Locale-specific bio data of the person	Mandatory	`bio`
						`roles`					string	Optional	`actor;director`	One more roles played by the person for this program, semi-colon separated. For example `writer`, `director`, or `actor`.	Mandatory	`role`
						`images`					ImageSetType	Optional		Represents a set of images	Not used
							`image`				ImageType	Mandatory		Represents an image	Mandatory
										`id`	string	Mandatory	`STCUEnabled_EditorialLevel_New_Img_person_1`	Unique identifier of the image	Mandatory
										`uri`	string	Optional	`http://face.tmsimg.com/assets/assets/Img_person_1.jpg`	URI of the image for download	Mandatory
								`height`			integer	Optional	`272`	Image height	Mandatory
								`width`			integer	Optional	`352`	Image width	Mandatory
								`aspect`			string	Optional	`16x9`	Aspect ratio of the Image, for example, `16x9`	Mandatory
								`category`			string	Optional	`Iconic`	Category of the Image	Optional
								`primary`			boolean	Optional	`true`	Indicates if the image is primary or not	Optional
								`captions`			CaptionsType	Optional		Set of locale -specific image titles	Optional
										`locale`	string	Mandatory	`en_GB`	Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1. If the captions are not localised, the locale must be set to `"none"`.	Optional
									`title`		string	Optional	`Img_EditorialLevel_priddra1_1`	Locale-specific name of the image	Optional
								`externalId`			ExternalIdType	Optional		Source information of the image	Not used
									`externalSource`		ExternalSourceType	Optional			Optional
										`sourceName`	string	Mandatory	`gracenote`	Name of the external source, for example, `gracenote`, `imdb`, etc.	Optional
										`resourceId`	string	Mandatory	`I456`	Identifier of the resource (person or image) in the external source	Optional

cmsData - editorialChannel - channelEvents - event - parentalRatings

Elements						Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`parentalRatings`		ParentalRatingSetType	Optional			Not used
					`parentalRating`	ParentalRatingType	Mandatory			Mandatory	`ratingBody`
						string	Mandatory	`Motion Picture Association of America (MPAA)`	The friendly name of the ratings body. This is unique across all ratings bodies in the system.	Mandatory	`code`
						string	Mandatory	`TV-PG`	The content rating code. This is unique across all content ratings in the system.	Mandatory
						TwoCharString	Mandatory	`US`	The country code	Not used	`contentRef`

cmsData - editorialChannel - channelEvents - event - editorialContentRef

Elements					Fields/attributes	Type	Required	Sample data	Description	ION
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
				`editorialContentRef`		EditorialContentType	Optional			Mandatory
					`providerId`	string	Mandatory	`GLOBAL`	Provider	Mandatory
					`providerResourceId`	string	Mandatory	`ContentID`	Editorial content ID	Not used

cmsData - editorialChannel - channelEvents - event - contentLinkId

Elements					Type	Required	Description
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
			`event`	`contentLinkId`	String	Optional	For deep linking, this specifies the ID of the same event from a different content provider.

cmsData - editorialChannel - channelEvents - event - clientControls

Elements					Type	Required	Sample data	Description
`cmsData`
	`editorialChannel`
		`channelEvents`
			`event`
			`event`	`clientControls`	`ClientControlsMetaDataType`	Optional	`"clientControls"` `:[` `{"key"` `:` `"CU"` `,` `"value"` `:` `true` `},` `{"key"` `:` `"SO"` `,` `"value"` `:` `true` `}` `]`	Specifies the capabilities that are enabled or disabled for the event. (For example, catch-up or start-over.) These are expressed as key/value pairs, where: `key_name` is the name of a capability that has been configured in Platform. `value` is `true` or `false`. `true` means that the product is enabled for the event. `false` means it is disabled.

cmsData - editorialChannel - channelEvents - timeShifting

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialChannel`
		`channelEvents`
			`timeShifting`			Optional		Data related to the time-shifting feature	Mandatory	`catchUpSupport`
				`shortTermCatchUpSupport`	boolean	Optional	`FALSE`	Indicates if the short-term catch-up feature is activated for this editorial channel.	Mandatory	`catchUpSupport`
				`longTermCatchUpSupport`	boolean	Optional	`TRUE`	Indicates if the long-term catch-up feature is activated for this editorial channel.	Mandatory	`catchUpSupport`
				`startOverSupport`	boolean	Optional	`FALSE`	Indicates if the start over feature is activated for this editorial channel.	Optional	`startOverSupport`
				`networkPvrSupport`	boolean	Optional	`FALSE`	Indicates if the network PVR feature is activated for this editorial channel.	Not used	`networkPvrSupport`

cmsData - editorialChannel - timeshifting

Elements					Type	Required	Sample data	Description	ION
`cmsData`
	`editorialChannel`
		`timeShifting`				Optional		Data related to the time-shifting feature
			`shortTermCatchUpParameters`	`eventDefaultFlag`	boolean	Optional	`TRUE`	The default value of the shortTermCatchUpSupport flag for newly-created events	Not used
			`longTermCatchUpParameters`	`eventDefaultFlag`	boolean	Optional	`FALSE`	The default value of the longTermCatchUpSupport flag for newly-created events	Not used
			`startOverParameters`	`eventDefaultFlag`	boolean	Optional	`TRUE`	The default value of the startOverSupport flag for newly-created events	Not used
			`networkPvrParameters`	`eventDefaultFlag`	boolean	Optional	`TRUE`	The default value of the networkPvrSupport flag for newly-created events	Not used

cmsData - editorialChannel - guardTime

Elements			Fields/attributes	Type	Required	Description	ION
`cmsData`
	`editorialChannel`
		`guardTime`			Optional		Not used
			`start`	duration	Mandatory	Schedule event start accuracy given as an offset. It will be used for any record order to specify the capture start (event.start - start). The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. If `guardTime start` is not specified, capture start will equal event start.	Not used
			`end`	duration	Mandatory	Schedule event end accuracy given as an offset. It will be used for any record order to specify the capture end (event.end + end). The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. If `guardTime end` is not specified, capture end will equal event end.	Not used

cmsData - editorialChannel - images

Elements						Fields/attributes	Type	Required	Sample data	Description	ION	IHS
`cmsData`
	`editorialChannel`
		`images`					ImageSetType	Optional		Represents a set of images	Not used
			`image`				ImageType	Mandatory		Represents an image	Mandatory
						`id`	string	Mandatory	`650980`	Unique identifier of the image	Mandatory
						`uri`	string	Optional	`http://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpg`	URI of the image for download	Mandatory	`uri`

				`height`			integer	Optional	`272`	Image height	Mandatory	`height`
				`width`			integer	Optional	`352`	Image width	Mandatory	`width`
				`aspect`			string	Optional		Aspect ratio of the Image, for example, `16x9`	Mandatory	`aspect`
				`category`			string	Optional		Category of the image	Optional	`category`
				`primary`			boolean	Optional		Indicates if the image is primary or not	Optional	`primary`
				`captions`			CaptionsType	Optional		Set of locale-specific image titles	Optional	`captions`
						`locale`	string	Mandatory		Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1. If the captions are not localised, the locale must be set to `"none"`.	Mandatory	`locale`
					`title`		string	Optional		Locale-specific name of the image	Optional	`title`
				`externalId`			ExternalIdType	Optional		Source information of the image	Optional	`externalId`
					`externalSource`		ExternalSourceType	Optional			Optional	`externalSource`
						`sourceName`	string	Mandatory		Name of the external source, for example, `gracenote`, `imdb`, etc.	Optional
						`resourceId`	string	Mandatory		Identifier of the resource (person or image) in the external source	Optional	`externalResourceId`
				`locale`			string	Optional	`en_EN`	The locale that the image applies to. Multiple locales can be specified for each image.

cmsData - editorialChannel - clientControls

Elements

Fields/attributes

Type

Required

Sample data

Description

ION

MDS

cmsData

editorialChannel

clientControls

ClientControlsMetaDataType

Optional

"clientControls" :[

{"key" : "CU" , "value" : true },

{"key" : "SO" , "value" : true }

]

Specifies the capabilities that are enabled or disabled for the channel. (For example, catch-up or start-over.)

These are expressed as key/value pairs, where:

key_name is the name of a capability that has been configured in Platform.
value is true or false. true means that the product is enabled for the channel. false means it is disabled.

cmsData - editorialChannel - dvbinfo

Elements

Fields/attributes

Type

Required

Sample data

Description

ION

MDS

cmsData

editorialChannel

dvbinfo

Optional

"dvbinfo" : [
{
    "triplet" : {
      "onid" : 156 ,
      "tsid" : 8100 ,
      "sid" : 257
    } ,
    "nid" : 1000
}
] }

Specifies the DVB triplet information for the channel. This consists of:

onid – original network ID
tsid – transport stream ID
sid – service ID
nid – network ID

This information allows client devices to match broadcast channels to the corresponding metadata provided by MDS and thus enhance the information about the channel that is presented to the user.