product

The product element represents a product (that is, something that can be purchased). Its structure is shown in the following diagram:

Elements and attributes

product
XML Element	Type	Required	Description
Attribute: type	ProductEnumType	Required	The type of the product. The allowed values are subscription, transactional. This attribute is mandatory when used for creation. It can't be updated.
Attribute: technicalTypes	string	Optional	Supported Playable asset type (Technical Type) on linking product with editorial's eg:HD;SD;DASH
Attribute: isFreemium	boolean	Optional	Freemium boolean flag for the product. When this flag is 'true' freemium element should be present. This attribute is optional when used for creation. It can be updated.
Attribute: isShared	boolean Fixedfalse	Optional	Shareable is boolean flag for transactional product.which enhanced to support a mode where any Content associated with a Product can be retailed individually using the terms of a single Product definition
Attribute: published	boolean	Optional	This element allows the Operator to make a decision to publish (or display) respective resources to end user.
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] 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	[PeriodWithOptionalStartEndType] Occurrence0..1	Optional	This period allow to specify the start and end date of the Product<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>
nominalPrice	Occurrence0..1	Optional	The nominal price of the product including a currency and an amount of money express in that currency. The nominal price is optional, but if present both currency and amount are required.<dl><dt>amount</dt><dd>The base amount of money to pay to get access to the content sold by this product.</dd><dt>currency</dt><dd>The 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.</dd></dl>
freemium	Occurrence0..1	Optional	The freemium contains the range of date during which the product can be availed for free and when availed the duration for which it can be used for free per account. The freemium should be present when isFreemium is 'true', both start and end dates and validity period are required.<dl><dt>start</dt><dd>The start of the period of time from which the product can be availed for free. This attribute is mandatory. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.</dd><dt>end</dt><dd>The end of the period of time till which the product can be availed for free. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.</dd><dt>validityPeriod</dt><dd>The free validity duration per account when freemium is availed. The format is based on ISO 8601 with restricted allowed pattern: PnY or PnM or PnW or PnD (but not a mix). Must be positive.</dd></dl>
purchasablePeriod	[PeriodWithOptionalStartEndType] Occurrence0..1	Optional	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 time restriction.If the purchase start is not provided, the system will assume the product can be purchased without start time restriction.If the purchase end is not provided, the system will assume the product can be purchased without end time restriction.<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>
rights	Occurrence0..1	Optional	The rights that could apply to consume this offer<dl><dt>impulsive</dt><dd>If 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 opertor. If the value is not provided, every system will assume the value as false.</dd><dt>rentalDuration</dt><dd>The amount of time during which the content sold by this product can be accessed after the start of the license (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.</dd><dt>consumptionWindow</dt><dd>The 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 license 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. </dd><dt>storageAllowed</dt><dd>Allow a client to download the Content </dd><dt>storageDuration</dt><dd>The Product can be optionally assigned a download content StorageDuration period. Where set this value guides download authorization services to limit the durability of any licence requested by a qualifying account.The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive. </dd><dt>storageStartPeriod</dt><dd>The Product can be optionally assigned a download content StorageStartPeriod period. Where set this value guides download authorization services to limit the period by which a download license must first be used. The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive. </dd></dl>
billingModel	Occurrence0..1	Optional	The billing model that applies for subscription products. This element is ignored for other types.<dl><dt>billingPeriod</dt><dd>The amount of time between two billing. The format is based on ISO 8601 with restricted allowed pattern: PnY or PnM or PnD (but not a mix). Must be positive.</dd></dl>
capabilityProductInfo	Occurrence0..1	Optional	Stores Type and Access duration for Capability Products. This element is ignored for other types.<dl><dt>type</dt><dd>The type of the Capability Product. For example: CU.</dd><dt>accessDuration</dt><dd>The Access duration for the Capability Product. The format is based on ISO 8601 with restricted allowed pattern: PnY or PnM or PnW or PnD (but not a mix). Must be positive.</dd></dl>
deviceClass	string Whitespacepreserve Occurrence0..unbounded	Optional	This device class allow the specification of products that are only available on certain devices, and additional playable only on the device where the Product backing the Content was purchase.

Complex child elements

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

metadataSet (child of product)