Open APIs

 View Only
  • 1.  appropriate API for plans

    Posted Jul 05, 2023 16:04

    Hi all

    We are trying to implement an API which today retrieves all available plans based on the customer category. Would it be the product offering TMF 622?



    ------------------------------
    saisricharan Yadavalli
    Verizon Communications
    ------------------------------


  • 2.  RE: appropriate API for plans

    Posted Jul 06, 2023 03:48

    you might like to review the functions with the TMF620 Product Catalogue Management as that has the product offering Specifications within it.

    See 

    TMF620 Product Catalog Management API REST Specification (amazonaws.com)

    Order Management Use Case
    The catalog management API allows the lookup of the catalog elements during order capture.
    UC1: A distributor wants to browse product offerings during order capture and to retrieve product offerings 
    belonging to a given category, for a given channel and a given place. He gets all details on product offerings, 
    product offering prices, product specifications and its characteristics (GET/depth).



    ------------------------------
    Dave Milham
    TM Forum, Chief Architect
    ------------------------------



  • 3.  RE: appropriate API for plans

    Posted Jul 07, 2023 11:44

    Thank you Dave. We are planning to retrieve the available plans for the customer and show the related features. 



    ------------------------------
    saisricharan Yadavalli
    Verizon Communications
    ------------------------------



  • 4.  RE: appropriate API for plans

    Posted Jul 06, 2023 06:55

    it depends what you mean by "plan"
    if it means product offerings (what you sell to the market), then use 620.
    you can use MarketSegmentRef to represent "customer category" and  then filter on that sub-resource (filtering, querying etc are explained in the TMF630 API design guide)



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 5.  RE: appropriate API for plans

    Posted Jul 09, 2023 04:19

    TMF620 (Product Catalog Management) will give you a raw list of product offerings, which you can filter. In addition to Matthieu's suggestion, you can categorize offerings using the Category entity, and create (for example) a category Plan, and perhaps subcategories MobilePlan, VoIPPlan, etc. You can then filter by the offering category.

    For more sophisticated filtering, you might want to consider the Product Offering Qualification API TMF679 - the main issue with that API is that there is no obvious authoring model for the qualification rules. In v5, we are adding Policy to product catalog items, and the policy rules could be used to express qualification semantics.

    Hope it helps



    ------------------------------
    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.
    ------------------------------