Open APIs

 View Only
  • 1.  Bundled Product Offering GET response

    TM Forum Member
    Posted Jan 31, 2020 14:29
    Hi Experts,

    In TMF 620, when fetching product offering which is a Bundled offering, we would like to expand the whole structure till its last leaf node in a single response
    For example, Below is the structure of the bundled offering

    BundledPO
           BPO1
                 PO3
                 PO4
           PO2(Simple)


    Now, GET Req on BundledPO with URL /productOffering/{Id of BundledPO}?depth=3, response will be mapped as shown below

    {
       "id": "Id of BundledPO",
       "href": "Href of BundledPO",
       "isBundle": true,
       .
       .
         "bundledProductOffering": [
         {
           "id": "Id of BPO1",
           "href": "href of BP01",
          "bundledProductOfferingOption": {
          .
          .
       }
    },
    {
       "id": "Id of PO2",
       "href": "href of PO2",
       "bundledProductOfferingOption": {
        .
        .
      }
      }
    ],

    In the above example, BPO1 also needs to be expanded further with its child nodes PO3 and PO4. Do we need to extend the 'bundledProductOffering' to capture those child nodes in the same response? My question is majorly on the GET method, to avoid multiple calls ,wherever possible, to avoid chattiness and low latency

    Appreciate your inputs

    ------------------------------
    Bharathi

    ------------------------------


  • 2.  RE: Bundled Product Offering GET response

    Posted Feb 02, 2020 05:23
    Hi Bharathi,
    In your example, the response to "GET /productOffering/{Id of BundledPO}?depth=3" should include the expanded representations of PO3 and PO4 (under the bundledProductOffering field of BPO1). So, with a single call, you can retrieve expanded forms of all product offerings.
    Actually, depth=2 is sufficient to retrieve PO3 and PO4 in your example (without expanding their references to other resources).
    You can refer to  "TMF630 REST API Design Guidelines Part 2" for details.
    Regards,


    ------------------------------
    Şanver Narin
    PiA-TEAM INC.
    ------------------------------