ProductOfferingTerm is indeed a commitment term that would be applied to customers who acquire the containing ProductOffering. Currently in the Open API the model supports only commitment period, represented by the
duration attribute. Other commitment terms (e.g. based on usage or revenues) would have to be modeled as extensions.
The
duration attribute is of type
Quantity, which already has sub-attributes units and amount, so you don't need to extend.
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 1,
"description": "Numeric value in a given unit"
},
"units": {
"type": "string",
"description": "Unit"
}
Hope it helps
------------------------------
Jonathan Goldberg
Amdocs Management Limited
------------------------------
Original Message:
Sent: Jul 29, 2019 07:32
From: Charmy Shah
Subject: API for Product Offering
Hi Jonathan,
Thanks for your valuable inputs and prompt help. Surely it will help us in modeling our requirements in better way.
As per your comments we were going through SID model for 'ProductOfferingTerm' as well as OPen API model for the same. From the reading it seems that Productofferingterm is sort of related to commitment and agreements. Our thought is will it be suitable to map validity requirements to this sub-resource ? If yes then can we can extend to add properties like 'units' (as it does not have such property) to map 'Days' or 'Months' sort of fields.
Please provide your thoughts on the same.
Thanks in advance !!!
------------------------------
Charmy Shah
Sterlite Technologies Limited
Original Message:
Sent: Jul 28, 2019 04:53
From: Jonathan Goldberg
Subject: API for Product Offering
Hi Carmy
1) This type concept is not currently modeled in the catalog, the simplest way for you to proceed would be to add an attribute offeringType, with valid values such as you describe. The SID has the concept of EntitySpecificationType which more generally defines the types of entities, we might consider adding this to the Open API model in the future - note that this is multi-valued (an entity spec can have many spec types).
2) You could use a ProductOfferingTerm to represent the limited time for which the benefits are available - the duration field would indicate the amount of time available for the benefits to be consumed (in your example it would be units=day, amount=28),
Hope it helps
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Original Message:
Sent: Jul 23, 2019 03:02
From: Charmy Shah
Subject: API for Product Offering
Hi Everyone,
We are not able to map following requirements with Open API for Product Offering model
1) Categorizing of product offer as 'Subscription Plan' or 'Recharge Plan' etc.
2) Defining validity for product offer e.g. Customer must consume benefits within 28 days after subscription.
Thanks in advance,
------------------------------
Charmy Shah
Sterlite Technologies Limited
------------------------------