Skip to main content

BTV Series data model

Name
Type
Description
Localised
Always available
_idStringInternal identifier for the object.NoYes
ActorsArray of strings

A list of actors. For example:

"Tom Cruise",
"Nicole Kidman"
NoNo
AspectStringThe aspect ratio, for example, 16:9 or Widescreen.NoNo
AudioArray of strings

A list of "locale-type" patterns representing the audio streams available for this series.

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

For example:

"Eng-Standard",
"Eng-VisualImpaired",
"Fra-Standard"
NoNo
AudioModeStringThe audio mode. For example, Mono, SRS, THX, 5.1, Nicam Stereo, or Dual Mono.NoNo
BestSalesIndexInteger

Sales index (position) for use in "Top" lists (for example, Top 10 Best Selling).

These are positive numbers, starting at 1.

If -1 or not present, this series is not in any "Top n" index.

NoNo
CategoriesArray of stringsA list of operator-defined category or genre names for this series.NoNo
ContentTypeStringFree text. Used for implementation-specific data.NoNo
CopyProtectionsString

A list of usage rules for controlling certain hardware outputs to prevent unauthorised content copying.

For example:

"CGMS-A",
"HDCP"

If the value is 0 or not present, there is no restriction.

NoNo
CopyrightStringA copyright message.NoNo
CountriesArray of stringsA string of two-letter ISO codes representing countries relevant to this series.NoNo
DefinitionStringThe video definition. One of HD, SD, or 3D.NoNo
DescriptionStringThe description of the series.YesNo
DirectorsArray of stringsA list of directors.NoNo
DvbCategoriesArray of stringsArray of DVB genres and sub-genres.NoNo
EpisodeStringEpisode text string.YesNo
IsRecordableBooleanWhether the end user is allowed to record this series.NoNo
LanguageStringThe original language of the series (three-letter ISO language code).NoNo
nls.TitleStringNative language support for the title field, which allows it to be sorted correctly in the local languare rather than using UTF-8 ordering.

PrivateMetadataStringGeneric field used to pass data directly from the operator to the end-user device without any processing.
One possible use is to pass a list of keyword/value pairs.
NoNo
ProducersArray of stringsA list of producers.NoNo
PromoImagesArray of stringsA list of promo image URLs. Must contain only URL-safe characters.NoNo
providerStringThe identifier of the metadata provider, from the id of the export's CMSVodData element.NoYes
Rating.codeStringParental rating code (from CMS).NoYes
Rating.nameStringLocalised name for the rating, for example, Adult orAdulto.YesYes
Rating.precedenceIntegerQuantitative rating value.NoYes
ScoringIntegerScore of the series.NoNo
ShortTitleStringThe short name of the content.YesNo
StudioStringThe content owner.NoNo
SubtitlesString

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

  • locale: 3-letters ISO language code
  • type: HearingImpaired or Standard

Example:

"Eng-Standard",
"Eng-HearingImpaired",
"Fra-Standard"
NoNo
SynopsisStringA longer description of the series.YesNo
titleString

The name of the series.

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

NoYes
TitleString

The name of the series.

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

YesYes
TotalDownloadsIntegerTotal number of downloads of the series (or of episodes within the series, according to the operator's preference).NoNo
ViewingCounterIntegerNumber of times a piece of content has been viewed.NoNo
ViewingNumberIntegerHow many times a user can watch the series (or episodes within it) once purchased.
If 0 or not present, there is no limitation.
NoNo
YearIntegerThe 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.