Skip to main content
Skip table of contents

product (technical-based)

Legend

ColourMeaning

Mandatory for ingest, optional or not used for ION

Mandatory for ION, optional for ingest

Mandatory for both ingest and ION

Optional for ingest and optional or not used for ION

cmsData - product

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product
ProductTypeOptional
This element defines a product to create/update.Not usedproduct
providerIdstringMandatoryGLOBALUnique identification of a parent node Mandatory
providerResourceIdstringMandatoryTVOD_LEG_WALLEC2Unique resource identification of a parent nodeMandatory
namestringMandatoryTVOD_LEG_WALLECName of the productMandatory
typeProductEnumTypeMandatorytransactionalType of the product, allowed values are subscription and transactional. Attribute is mandatory when used for creation. It cannot be updated.Mandatorytype

cmsData - product - metadataSet

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product








metadataSet

MetadataSetTypeOptional
Metadata editorial  The different allowed metadata and their definitions must be defined outside of the scheme.Not usedEpgDescription

locale
Mandatoryen_GBLanguage/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1.
If the metadata set is not localised, the locale must be set to "none".
Mandatory
metadata
MetadataTypeOptional
Metadata valueMandatoryEpgElement
key="TitleForProduct"stringOptionalWALL-ETitle for productMandatoryprivateMetadata
key="Rating"stringOptional
RatingNot used
key="CMS4ProductType"stringOptionalsingleSpecifies whether it is a CMS4ProductType or not.Not used

cmsData - product - period

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






product






period
PeriodWithOptionalStartEndTypeOptional
Specifies the start and end date of the product.Not used
startgmtdatetimeMandatory2018-11-20T13:12:27ZStart date of the productMandatory
endgmtdatetimeMandatory2018-11-20T13:12:27ZEnd date of the productMandatory

cmsData - product - nominalPrice

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product

billingModel








nominalPrice

Optional
The nominal price of the product including a currency and an amount of money expressed in that currency. The nominal price is optional, but if present both currency and amount are required.Mandatoryprice
amountdecimalMandatory100The base amount of money to pay to get access to the content sold by this productMandatoryvalue
currencystringMandatoryEURThe currency in which the price is defined for this product. It is a free string but it is recommended to use the ISO 4217 currency code.Mandatorycurrency

cmsData - product - purchasablePeriod

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product







purchasablePeriod
PeriodWithOptionalStartEndTypeOptional
The period of time during which the product can be purchased by the end user. If the purchase period is not provided, the system will assume the product can be purchased without a time restriction. If the purchase start is not provided, the system will assume the product can be purchased without a start time restriction. If the purchase end is not provided, the system will assume the product can be purchased without an end time restriction.Not used
startgmtdatetimeMandatory2018-11-20T13:12:27ZStart date of the product purchaseMandatorystartPurchase, price.startPurchase
endgmtdatetimeMandatory2018-11-20T13:12:27ZEnd date of the product purchaseMandatoryendPurchase, price.endPurchase

cmsData - product - rights

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product







rights

Optional
The rights that could apply to consume this offerNot used
impulsivebooleanMandatorytrueIf true, the product can be purchased by the end user through the client application or can be entitled by the operator. If false, the product can only be entitled by the operator. If the value is not provided, every system will assume the value as false.Optionalimpulsive
rentalDurationdurationMandatoryPT5400SThe amount of time during which the content sold by this product can be accessed after the start of the licence (the start can be at purchase time in absolute mode or at first viewing time in relative mode). This applies only for transactional products. The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive.OptionalrentalDuration
consumptionWindowdurationMandatoryP3Y6M4DT12H30M5SThe amount of time after purchase during which initial access to the content sold by this product can be attempted, then the rentalDuration applies. When set, this indicates Relative Mode usage rule calculations should apply. The field value indicates the range within which a relative product viewing can commence. A licence calculation agent determines the final
end time of product viewing based on rental duration and its own configuration. When this value is omitted, it means absolute mode. This applies only for transactional products. The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive.
OptionalconsumptionWindow

cmsData - product - billingModel

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







product







billingModel



Optional
The billing model that applies for subscription products. This element is ignored for other types.Not used
billingPeriod
Mandatory
The amount of time between two billings. The format is based on ISO 8601 with restricted allowed pattern: PnY or PnM or PnD (but not a mix). Must be positive.MandatorybillingPeriod
JavaScript errors detected

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

If this problem persists, please contact our support.