Skip to main content
Skip table of contents

editorialChannel (technical-based)

Legend

ColourMeaning

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

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel
EditorialChannelTypeOptional
This element defines an editorial channel. It contains the definitions of the events for a specific period.Not used
providerResourceIdstringMandatoryBE_8006Channel IDNot used
providerIdstringMandatoryGLOBALProviderNot usedcompanyId
namestringMandatoryARTEHDFr_8006Channel nameMandatorylongName

cmsData - editorialChannel - metaDataSet

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel







metadataSet

MetadataSetTypeOptional

Not usedEpgDescription

locale
Mandatory

Mandatorylocale
metadata
MetadataTypeOptional

MandatoryEpgElement
key="Title"stringOptionalESPN ChannelEditorial channel titleNot usedprivateMetadata
key="Description"stringOptionalDescriptionEditorial channel descriptionOptionalprivateMetadata
key="Rating"stringOptional1Channel rating (numeric)MandatoryprivateMetadata
key="ChannelNumber"stringOptional25Editorial channel numberMandatorytvChannel
key="ShortName"stringOptionalESPNShort name for the editorial channelNot usedprivateMetadata

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"stringOptionalUSA,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 useprivateMetadata
key="filteringListIsAllowList"stringOptionaltrueIndicates if the filteringList is an allowed list or not.OptionalprivateMetadata
key="blockingList"stringOptionalUSA;INDA list of countries where playback is allowed.Future useprivateMetadata
key="blockVpn"stringOptionaltrueA global per operator value to indicate if VPN blocking is turned on or off.Future useprivateMetadata
key="blockIfOffNet"stringOptionaltrueFiltering of content for on/off network.Optional
key="blockingListIsAllowList"stringOptionaltrue

Indicates if the blockingList is an allowed list or not.

OptionalprivateMetadata

cmsData - editorialChannel - periodToDelete

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






editorialChannel






periodToDelete
PeriodWithOptionalStartEndTypeOptional

Specifies the time period for which events blonging to the editorial channel are to be deleted.

Reserved for future use.

Not used
startgmtdatetimeOptional2016-01-01T00:00:00Z
Not used
endgmtdatetimeOptional2038-01-01T00:00:00Z
Not used

cmsData - editorialChannel - channelEvents

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel







channelEvents
ChannelEventsTypeOptional
Defines common attributes of all root elements of the channelEvents element.Not used
startFromstringOptional2012-05-31T06:10:30ZThe duration start from date to be used to filter the results. ISO 8601 format up to the second but no time zone.Not used
endUntilstringOptional2012-05-31T06:10:30ZThe duration end until date to be used to filter the results. ISO 8601 format up to the second but no time zone.Not usedprogram

cmsData - editorialChannel - channelEvents - event

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel







channelEvents







event
EventTypeOptional

Not used
providerResourceIdstringMandatory193016452Event ID

namestringMandatoryArte journalEvent nameMandatorytitle
providerIdstringMandatoryplurimediaProviderNot usedproviderId

cmsData - editorialChannel - channelEvents - event - metadataSet

ElementFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel










channelEvents









event








metadataSet

MetadataSetTypeOptional

Not usedEpgDescription (locale)

locale
Mandatory

Not usedEpgElement
metadata
MetadataTypeOptional

MandatoryprivateMetadata
key="Title"stringOptionalProgram for channel OneEvent titleMandatoryprivateMetadata
key="Description"stringOptionalEvery day at 1pmEvent descriptionNot usedPeriod
key="broadcastEventId"stringOptional157

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"stringOptionalUSA,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 useprivateMetadata
key="filteringListIsAllowList"stringOptionaltrueIndicates if the filteringList is an allowed list or not.OptionalprivateMetadata
key="blockingList"stringOptionalUSA;INDA list of countries where playback is allowed.Future useprivateMetadata
key="blockVpn"stringOptionaltrueA global per operator value to indicate if VPN blocking is turned on or off.Future useprivateMetadata
key="blockIfOffNet"stringOptionaltrueFiltering of content for on/off network.Optional
key="blockingListIsAllowList"stringOptionaltrueIndicates if the blockingList is an allowed list or not.OptionalprivateMetadata

cmsData - editorialChannel - channelEvents - event - airingStartTime/airingEndTime

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData










editorialChannel







channelEvents







event







airingStartTime
gmtdatetimeOptional2021-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.

MandatoryairingStartTime
airingEndTime
gmtdatetimeOptional2021-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.

MandatoryairingEndTime

cmsData - editorialChannel - channelEvents - event - period

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel







channelEvents







event

EventTypeOptional

Not used
period
PeriodTypeOptional
Specifies the start and end date/time of the eventMandatorystart
startgmtdatetimeOptional2012-05-31T06:10:30ZStart 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.Mandatoryend
endgmtdatetimeOptional2012-05-31T06:10:30ZEnd 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 - clientControls

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






editorialChannel






channelEvents






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 - event - timeShifting

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialChannel







channelEvents







event







timeShifting

Optional
Data related to the time-shifting featureMandatory
shortTermCatchUpSupportbooleanOptionalFALSEIndicates if the short-term catch-up feature is activated for this event.MandatoryisCatchUp
longTermCatchUpSupportbooleanOptionalTRUEIndicates if the long-term catch-up feature is activated for this event.MandatoryisCatchUp
startOverSupportbooleanOptionalFALSEIndicates if the start over feature is activated for this event.OptionalisStartOver
networkPvrSupportbooleanOptionalFALSEIndicates if network PVR feature is activated for this event.Not usedisnPvr

cmsData > editorialChannel > channelEvents > event > images

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONIHS
cmsData







editorialChannel







channelEvents







event







images

ImageSetType




image

ImageType






idstringMandatory650980Unique identifier of the imageMandatory


uristringOptionalhttp://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpgURI of the image for downloadOptionaluri
height

integerOptional272Image heightMandatoryheight
width

integerOptional352Image widthMandatorywidth
aspect

stringOptional
Aspect ratio of the Image, for example, 16x9Mandatoryaspect
category

stringOptional
Category of the ImageOptionalcategory
primary

booleanOptional
Indicates if the image is primary or notOptionalprimary
preferred

booleanOptional
Indicates whether the image is the preferred image that should be used when there are multiple images that could be used in the same context.

captions



CaptionsTypeOptional
Set of locale-specific image titlesOptionalcaptions

localestringMandatory
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 usedlocale
title
stringOptional
Locale-specific name of the imageOptionaltitle

externalId



ExternalIdTypeOptional
Source information of the imageOptionalexternalId
externalSource
ExternalSourceTypeOptional

OptionalexternalSource
sourceNamestringMandatory
Name of the external source, for example, gracenoteimdb, etc.Optional
resourceIdstringMandatory
Identifier of the resource (person or image) in the external sourceOptionalexternalResourceId

cmsData > editorialChannel > channelEvents > event > persons

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDSCCP
cmsData








editorialChannel








channelEvents








event








persons

PersonSetTypeOptional
Set of persons for this content and associated metadataNot used
persons
person

PersonTypeMandatory
Defines a person element ie., the cast or crew for the editorial contentMandatory
persons

idstringMandatorySTCUEnabled_EditorialLevel_New_person_1Unique identifier of the personMandatory
id

dateOfBirthstringOptional22/04/1990Date of birth of the person in 'YYYY-MM-DD' formatMandatory
dateOfBirth

typestringMandatorycastThe type of person, restricted to cast or personaMandatory
type
names



NamesTypeOptional
Defines the locale-specific name of the personMandatory
names


localestringOptionalen_GBLanguage/country code in which the name is written. It must conform to ISO-639 and ISO 3166-1.Mandatory
locale

name


stringOptionalThomas Sean ConneryLocale-specific name of the personMandatory
name
details



DetailsTypeOptional
Defines the locale-specific bio data of the personMandatory
details




localestringOptionalen_GBLanguage-country code in which the bio data is written. It must conform to ISO-639 and ISO 3166-1Mandatory
locale

bio


stringOptionalScottish actor with distinctive accentLocale-specific bio data of the personMandatory
bio
roles



stringOptionalactor;directorOne more roles played by the person for this program, semi-colon separated. For example writerdirector, or actor.Mandatory
role
images


ImageSetTypeOptional
Represents a set of imagesNot used

image

ImageTypeMandatory
Represents an imageMandatory


idstringMandatorySTCUEnabled_EditorialLevel_New_Img_person_1Unique identifier of the imageMandatory


uristringOptionalhttp://face.tmsimg.com/assets/assets/Img_person_1.jpgURI of the image for downloadMandatory

height

integerOptional272Image heightMandatory

width

integerOptional352Image widthMandatory

aspect

stringOptional16x9Aspect ratio of the Image, for example, 16x9Mandatory

category

stringOptionalIconicCategory of the ImageOptional

primary

booleanOptionaltrueIndicates if the image is primary or notOptional

preferred

booleanOptional
Indicates whether the image is the preferred images that should be used when there are multiple images that could be used in the same context.


captions

CaptionsTypeOptional
Set of locale -pecific image titlesOptional



localestringMandatoryen_GBLanguage/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
stringOptionalImg_EditorialLevel_priddra1_1Locale-specific name of the imageOptional

externalId

ExternalIdTypeOptional
Source information of the imageNot used

externalSource
ExternalSourceTypeOptional

Optional

sourceNamestringMandatorygracenoteName of the external source, for example, gracenoteimdb, etc.Optional

resourceIdstringMandatoryI456Identifier of the resource (person or image) in the external sourceOptional

cmsData > editorialChannel > channelEvents > event > parentalRatings

Elements
TypeRequiredSample dataDescriptionIONMDS
cmsData






editorialChannel







channelEvents







event







parentalRatings

ParentalRatingSetTypeOptional

Not used
parentalRating
          
            
ParentalRatingTypeMandatory

MandatoryratingBody
ratingBodyNamestringMandatoryMotion Picture Association of America (MPAA)The friendly name of the ratings body. This is unique across all ratings bodies in the system.Mandatorycode

contentRatingCode

stringMandatoryTV-PGThe content rating code. This is unique across all content ratings in the system.Mandatory

countryCode

TwoCharStringMandatoryUSThe country codeNot usedcontentRef

cmsData > editorialChannel > channelEvents > event > editorialContentRef

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






editorialChannel






channelEvents






event






editorialContentRef
EditorialContentTypeOptional

Mandatory
providerIdstringMandatoryGLOBALProviderMandatory
providerResourceIdstringMandatoryContentIDEditorial content IDNot used

cmsData > editorialChannel > channelEvents > timeShifting

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData









editorialChannel







channelEvents







timeShifting

Optional
Data related to the time-shifting featureMandatorycatchUpSupport
shortTermCatchUpSupportbooleanOptionalFALSEIndicates if the short-term catch-up feature is activated for this editorial channel.MandatorycatchUpSupport
longTermCatchUpSupportbooleanOptionalTRUEIndicates if the long-term catch-up feature is activated for this editorial channel.MandatorycatchUpSupport
startOverSupportbooleanOptionalFALSEIndicates if the start over feature is activated for this editorial channel.OptionalstartOverSupport
networkPvrSupportbooleanOptionalFALSEIndicates if the network PVR feature is activated for this editorial channel.Not usednetworkPvrSupport
 

cmsData > editorialChannel > timeshifting

ElementsTypeRequiredSample dataDescriptionION
cmsData





editorialChannel







timeShifting


Optional
Data related to the time-shifting feature
shortTermCatchUpParameters
eventDefaultFlag
booleanOptionalTRUEThe default value of the shortTermCatchUpSupport flag for newly-created eventsNot used
longTermCatchUpParameterseventDefaultFlagbooleanOptionalFALSEThe default value of the longTermCatchUpSupport flag for newly-created eventsNot used
startOverParameterseventDefaultFlagbooleanOptionalTRUEThe default value of the startOverSupport flag for newly-created eventsNot used
networkPvrParameterseventDefaultFlagbooleanOptionalTRUEThe default value of the networkPvrSupport flag for newly-created eventsNot used

cmsData > editorialChannel > guardTime

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






editorialChannel






guardTime

Optional

Not used
startdurationMandatory
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
enddurationMandatory
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

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONIHS
cmsData







editorialChannel







images

ImageSetTypeOptional
Represents a set of imagesNot used
image

ImageTypeMandatory
Represents an imageMandatory

idstringMandatory650980Unique identifier of the imageMandatory


uristringOptionalhttp://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpgURI of the image for downloadMandatoryuri
height

integerOptional272Image heightMandatoryheight
width

integerOptional352Image widthMandatorywidth
aspect

stringOptional
Aspect ratio of the Image, for example, 16x9Mandatoryaspect
category

stringOptional
Category of the imageOptionalcategory
primary

booleanOptional
Indicates if the image is primary or notOptionalprimary
preferred

booleanOptional
Indicates whether the image is the preferred images that should be used when there are multiple images that could be used in the same context.

captions

CaptionsTypeOptional
Set of locale-specific image titlesOptionalcaptions

localestringMandatory
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".Mandatorylocale
title
stringOptional
Locale-specific name of the imageOptionaltitle
externalId

ExternalIdTypeOptional
Source information of the imageOptionalexternalId
externalSource
ExternalSourceTypeOptional

OptionalexternalSource
sourceNamestringMandatory
Name of the external source, for example, gracenoteimdb, etc.Optional
resourceIdstringMandatory
Identifier of the resource (person or image) in the external sourceOptionalexternalResourceId
 

cmsData - editorialChannel - clientControls

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
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

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
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.



cmsData - editorialChannel - regionalSettings and sourcePreference

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialChannel








regionalSettings




Optional





location 
String
"Berlin"The location

locationType
String
"custom"The location type

channelName
String
"Das Erste Berlin"The name of the channel

LCN
Int
2The Logical Channel Number (LCN)

sourcePreference
String
"OTT"The source preference for this location. Must be either OTT or DVB.

sourcePreference

String
"DVB"

The source preference for the channel. Must be either OTT or DVB.

This can be overridden on a per-region basis by setting a sourcePreference in a regionalSettings  block.



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.