Open APIs

 View Only
  • 1.  TMF620, Discrepancy between 'price' models; ProductOffering vs. ProductOfferingPrice

    TM Forum Member
    Posted 16 days ago
    Hi All,
    I'm looking at the resource diagrams for ProductOffering and ProductOfferingPrice in the Product Catalog Management User Guide (TMF620, V4.1.0), and trying to understand how to model ProductOfferingPrice.price.

    In the ProductOffering Resource diagram (pg 24) and descriptions, ProductOfferingPriceRefOrValue.price is represented as a ProductPriceValue, and there is no TaxItem class associated with ProductOfferingPrice.  Here, ProductPriceValue holds tax information about the specific price (dutyFreeAmount, taxCategory, taxRate).

    In the ProductOfferingPrice Resource diagram (pg 41), ProductOfferingPrice.price is simply an attribute of type Money, and there is a separate TaxItem class that holds the tax information.

    Is one of these models "more correct" than the other; perhaps one is outdated?  Which one should be used?

    Thank You.

    ------------------------------
    John Streete
    Amdocs Management Limited
    ------------------------------


  • 2.  RE: TMF620, Discrepancy between 'price' models; ProductOffering vs. ProductOfferingPrice

    TM Forum Member
    Posted 13 days ago
    Hi John
    It looks to me as if there may have been a publishing issue here. In the tooling that we use to generate Open API assets (swagger, user guide, etc.), the <xxxx>RefOrValue appears in the master schema as allOf (<xxxx> and <xxxx>Ref) - so there should not be an inconsistency between <xxxx> and <xxxx>refOrValue in the generated swagger (note that the tooling expands allOf in swagger generation).
    Some very delicate changes were made in this API in v4.1 to restore compatibility in ProductOfferingPrice with an older version of the API (which had separate classes for price alteration), and it's possible that the swagger was updated manually.
    Perhaps @Kamal Maghsoudlou can clarify.​

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: TMF620, Discrepancy between 'price' models; ProductOffering vs. ProductOfferingPrice

    TM Forum Member
    Posted 12 days ago

    Thank you Jonathan,

     @@Kamal Maghsoudlou, if you could provide some guidance here it would be much appreciated.  We are trying to understand why ProductOfferingPrice defines'price' as a Money (TMF620, v4.1, pg 41), and ProductOfferintPriceRefOrValue defines 'price' as a ProductPriceValue (TMF620, pg 24), and which definition is correct/should be used.

    Thank You



    ------------------------------
    John Streete
    Amdocs Management Limited
    ------------------------------