The node element represents a node, that is a grouping of content. Its structure is shown in the following diagram:
Elements and attributes
| node | |||
|---|---|---|---|
| XML Element | Type | Required | Description |
| Attribute: name | string | Required | Working name of the resource (used usually to identify a resource in the operator UI) |
| Attribute: providerId | string | Required | id of the content provider |
| Attribute: providerResourceId | string | Required | id of the resource for this specific content provider |
| metadataSet | [MetadataSetType]
|
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]
|
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> |
| parentRef | [BaseResourceType]
|
Optional | Reference to the parent node containing this node<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> |
| position | unsignedInt
|
Optional | The Node's position among its parent's children. Two nodes can have the same position, in such case the order is not guaranteed. Lowest values come first. |
| period | [PeriodWithOptionalStartEndType]
|
Optional | This period allow to specify the start and end date of the event<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> |
| timeShifting |
|
Optional | Data relative to the timeShifting feature<dl><dt>shortTermCatchUpSupport</dt><dd>Indicate if the Short Term Catch-Up feature is activated for this node.</dd><dt>longTermCatchUpSupport</dt><dd>Indicate if the Long Term Catch-Up feature is activated for this node.</dd></dl> |
| preferenceSet | [preferenceSetType]
|
Optional | Reference of the EditorialContents and ContentGroups |
| preferenceSetType / preference | [BaseResourceType]
|
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> |
| orderingFields | [orderingFieldsType]
|
Optional | orderingField when set tailors the return order of Node items |
| orderingFieldsType / orderingField | string
|
Required | |
Complex child elements
The following complex child elements are described in their own pages: