OpenTV ENTera & OpenTV Platform Documentation

nodeLink

The nodeLink element represents a link between one or more nodes and an actual content (resource). Its structure is shown in the following diagram:

nodeLink.png

Elements and attributes

nodeLink
XML Element Type Required Description
Attribute: id string Optional id of the content provider
Attribute: publishToEndUser boolean Optional "true" if the Node Link must be published to the end user devices, "false" otherwise
Attribute: technicalType string Optional Supported Playable asset type (Technical Type) eg:HD;SD;DASH
Attribute: name string Optional Title of vodItem as Name
Attribute: previewDate gmtdatetime Optional previewDate of nodeLink. A ISO 8601 compatible gmt datetime up to the second : yyyy-mm-ddThh:mm:ssZ.
metadataSet [MetadataSetType]
  • Occurrence0..unbounded
Optional This element defines a specific set of metadata for a specific locale. Only one MetadataSet per locale is allowed.<dl><dt>locale</dt><dd>Language-country code in which the metadata set is written. It must be conformed to ISO-639 and ISO 3166-1. If the MetadataSet is not localised, the locale must be set to "none".</dd></dl>
MetadataSetType / metadata [MetadataType]
  • Occurrence0..unbounded
Optional Metadata editorial or not of the metadata owner. The different metadata allowed and their definition must be defined outside of the scheme<dl><dt>key</dt><dd>Metadata key. it must be unique for a specific resource and for a specific locale.</dd></dl>
period [PeriodType]
  • Occurrence0..1
Optional This period allow to specify the start and end date of the Node Link<dl><dt>start</dt><dd>Start date of the parent resource. A ISO 8601 compatible gmt datetime up to the second : yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against start will be true</dd><dt>end</dt><dd>End date of the parent resource. A ISO 8601 compatible gmt datetime up to the second: yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against end will be true.</dd></dl>
nodeRefSet [NodeRefSetType]
  • Occurrence0..1
Optional Weak reference to an external content group (Other than series and season. This content group is not necessary existing).
NodeRefSetType / nodeRef [BaseResourceType]
  • Occurrence0..unbounded
Optional <dl><dt>providerId</dt><dd>id of the content provider</dd><dt>providerResourceId</dt><dd>id of the resource for this specific content provider</dd></dl>
resourceRef [ResourceReferenceType]
  • Occurrence1
Required Reference to the linked editorial content<dl><dt>type</dt><dd>Allows to specify the kind of resource that a content group is linked to (allowed values: editorialContent,contentGroup)</dd><dt>providerId</dt><dd>id of the content provider</dd><dt>providerResourceId</dt><dd>id of the resource for this specific content provider</dd></dl>

Complex child elements

The following complex child elements are described in their own pages: