Skip to main content

VOD Node data model

Name
Type
Description
Localised
Always available
_idStringInternal identifier for the object.NoYes
ancestorsArray of stringsA list of the IDs of all the nodes above the current one, in order, starting from the highest-level one.NoYes
BarkerChannelRefStringThe URI of the barker channel promoting this node.NoNo
childrenArray of stringsA list of IDs of the node's children.NoYes
companyIdStringThe ID of the broadcaster company that is offering the catalogue node.NoNo
descendantsArray of stringsA list of IDs of all the nodes below the current one in the tree.NoYes
idStringThe CMS's identifier for the object.NoYes
isRootBooleanTrue if the node is a top-level/root node.NoYes
localeStringThe locale used for the object's localisable fields.NoYes
nls.TitleStringNative language support for the title field to allow proper sorting on these fields, rather than utf-8 order.NoNo
nodeOrderIntegerThe index of the node, used for explicit ordering of nodes in a parent node or group.

Since MDS 1.1STD4.

NoNo
parentStringThe ID of the node's parent.NoYes
PrivateMetadataStringUsed to pass data directly from the operator to the end-user device without any CMS/SDP processing.
One possible use is to pass a list of keyword/value pairs, separated by semi-colons.
NoNo
PromoImagesStringA list of promo image URLs.
The Metadata Server does not validate the format of this field’s value, and does not attempt to access the URLs to verify the existence of the image files.
NoNo
providerStringThe identifier of the metadata provider, from the ID of the export's CMSVodData element.NoYes
Rating.codeStringParental rating code (from the CMS).NoYes
Rating.nameStringLocalized name for the rating, for example, Adult or Adulto.YesYes
Rating.precedenceIntegerQuantitative rating value.NoYes
regionsArray of stringsThe region identifiers targeted by the catalogue node.NoNo
titleStringThe name of the catalogue node.

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

NoYes
TitleStringThe name of the catalogue node.YesYes
xmlStringThe type of object. This is always Node.NoYes
JavaScript errors detected

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

If this problem persists, please contact our support.