The eventelement represents a broadcast event on the editorial channel. Its top-level structure is shown in the following diagram:
Elements and attributes
| event | |||
|---|---|---|---|
| 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> |
| airingStartTime |
|
Optional | The Event airing start date and time. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z. |
| airingEndTime |
|
Optional | The Event airing end date and time. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z. |
| contentLinkId | string
|
Optional | this is used to link similar event from different content Provider |
| isPPV | boolean
|
Optional | This Flag indicates if Event is PPV configured |
| period | [PeriodType]
|
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 event.</dd><dt>longTermCatchUpSupport</dt><dd>Indicate if the Long Term Catch-Up feature is activated for this event.</dd><dt>startOverSupport</dt><dd>Indicate if the Start Over feature is activated for this event.</dd><dt>networkPvrSupport</dt><dd>Indicate Event is nPVR enabled or not.</dd></dl> |
| images | [ImageSetType]
|
Optional | Set of images for this event and associated metadata |
| persons | [PersonSetType]
|
Optional | Set of persons for this content and associated metadata |
| parentalRatings | [ParentalRatingSetType]
|
Optional | Parental ratings used to decide suitability for certain audiences based on its content |
| clientControlsSet | [ClientControlsSet]
|
Optional | client Controls used to decide suitability for certain audiences based on its content |
| editorialContentRef | [BaseResourceType]
|
Optional | Reference to the editorial content (program) containing the editorial metadata of the scheduled event.<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> |
| rights |
|
Optional | Set of properties describing the consumption capabilities of a content <dl><dt>storageAllowed</dt><dd>Allow a client to download the Content </dd></dl> |
Complex child elements
The following complex child elements are described in their own pages:
-
metadataSet (child of editorialChannel > channelEvents > event) -
images (child of editorialChannel > channelEvents > event) -
persons (child of editorialChannel > channelEvents > event) -
parentalRatings (child of editorialChannel > channelEvents > event) -
clientControlsSet (child of editorialChannel > channelEvents > event)