Skip to main content

BTV Programme data model

Name
Type
Description
Localised
Always available
_idStringInternal identifier for the object.NoYes
ActorsArray of stringsThe actors associated with the programme.NoNo
AspectString

The aspect ratio.
Examples:

4:3
16:9
Widescreen
NoNo
AudioArray of strings

A list of “locale-type” patterns representing the audio streams available for this content.

  • locale: three-letter ISO language code
  • type: VisualImpaired or Standard

For example:

"Eng-Standard",
"Eng-VisualImpaired"'
"Fra-Standard"
NoNo
AudioModeString

The audio mode. For example,  MonoSRSTHX5.1Nicam Stereo, or Dual Mono.

NoNo
CategoriesArray of stringsThe operator-defined category or genre names that apply to this content.NoNo
CopyrightStringA copyright message.YesNo
CountriesArray of stringsThe two-letter ISO codes representing countries that apply to this programme.NoNo
DefinitionStringThe video definition. One of: HD, SD, or 3D.NoNo
DescriptionStringThe description of the programme.YesNo
DirectorsArray of stringsThe directors associated with the programme.NoNo
editorial

BTV Content data model object

The associated parent editorial of this programme.NoNo
editorial.technicalsArray of BTV Content data model objectsThe child technicals of the associated editorial.NoNo
EpisodeString

Localised text representation of the index of the episode in the series. This field is used to display the episode number.
For example:

Season 3, Episode 2
YesNo
eventIdNumberThe ID of the scheduled programme.NoNo
idStringThe CMS's identifier for the object.NoYes
isCatchUpBooleanWhether the time-shift “catch-up” function is available for this event.NoNo
IsRecordableBooleanWhether the end user is allowed to record this series.NoNo
isStartOverBooleanWhether the time-shift “start-over” function is available for this event.NoNo
IsTimeshiftedBooleanWhether the programme is a time-shifted broadcast of an earlier programme. Typically used for "+1 hour" channels.NoNo
LanguageStringThe original language of the content (three-letter ISO language code).NoNo
localeStringThe locale used for the object's localisable fields.NoYes
nls.TitleStringThe native language support for the title field – allowing for sorting according to the native language, rather than utf-8 order, as would be done through the Title field itself.YesNo
periodJSON object (see below)Details of the broadcast schedule for this programme.NoYes
period.durationNumberThe length of time this item will appear in the catalogue, in seconds. If not supplied, the duration is omitted, not calculated.NoNo
period.endString: a date and time in ISO 8601 formatThe end time of the broadcast event.NoYes
period.providerIdStringThe identifier of the metadata provider, from the ID of the export's CMSVodData element.NoYes
period.startstring: a date and time in ISO 8601 SormatThe start time of the broadcast event.NoYes
PrivateMetadataStringGeneric field used to pass directly data from the operator to the end-user device without any processing.
One possible use is to pass a list of keyword/value pairs separated by semi-colons.
NoNo
ProducersArray of stringsThe producers associated with the programme.NoNo
productRefsArray of stringsThe CMS IDs of the products that provide access to this programme.NoNo
profileRefStringThe CMS ID of the encoding profile that applies to this asset.NoNo
PromoImagesArray of stringsThe URLs of promo images. Must be composed of URL-safe characters only. NoNo
providerStringThe identifier of the metadata provider, from the id of the export's CMSBtvData element.NoYes
Rating.codeStringParental rating code (from CMS).NoYes
Rating.nameStringLocalized name for the rating, for example, Adult or Adulto.YesYes
Rating.precedenceIntegerQuantitative rating value.NoYes
RecommendedProgrammeIdsArray of strings

The CMS programme IDs recommended for this programme (information taken from a recommendation engine or from the customer) with rank (a positive integer, where a higher number means a stronger recommendation) using the following pattern:

<ProgrammeId>/<Rank>

A referenced programme might be scheduled before or after the current one, and might be on a different channel.

NoNo
RecommendedVodItemIdsArray of strings

The CMS VodItem IDs recommended for this programme (this information comes from the recommendation engine or from the customer) with rank (a positive integer, where a higher number means a stronger recommendation) using the following pattern:

<VodItemId>/<Rank>
NoNo
serviceRefStringThe CMS ID of the channel carrying the programme.NoYes
ShortTitleStringThe short form of the title of this programme. Indended for use on devices with limited space.YesNo
SOCU_filenameStringName of the asset file when this event is available via catch-up or start-over functionality.NoNo
StudioStringThe name of the owner of the content broadcast in this programme.NoNo
SubtitlesString

A list of “locale-type” patterns representing the subtitle streams available for this content.

  • locale: three-letter ISO language code.
  • type: HearingImpaired or Standard.

For example:

"Eng-Standard",
"Eng-HearingImpaired",
"Fra-Standard"
NoNo
SynopsisStringA longer description of the programme.YesNo
titleStringThe name of the programme.

This field is not localised. Multi-language clients should use the Title field instead.

NoYes
TitleStringThe title of the programme displayed to the user.

The CMS mandates that this field will be populated for at least one locale-form of the asset.

YesNo
typeStringThe domain of the object, always btv in this case.NoNo
xmlStringThe type of the object. In this case, always Programme.NoYes
YearStringThe year of production of the content.NoNo
JavaScript errors detected

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

If this problem persists, please contact our support.