Open APIs

 View Only

Migrate an existing API to TMF 679

  • 1.  Migrate an existing API to TMF 679

    Posted Aug 01, 2023 10:40
    Edited by Ilyas Premji Aug 02, 2023 04:40

    Hello,

    I have a requirement to migrate an existing API to the TMF 679 Product Offering Qualification.

    The existing API works as the following:

    • Receives a request from the channel asking for addons and compatible offers related to a specific PO code.
    • The addons and compatible offers can be one of the following types: compatible_addons, dependent_addons, updowngrade_offers
    • The response structure of the current API is as the following:

    [
      {
        "code": "UPDOWNGRADE_OFFERS",
        "groups": [
          {
            "code": "Group1",
            "category": "DOWNGRADE",
            "entities": [
              {
                "poCode": "PO1"
              },
              {
                "poCode": "PO2"
              }
            ]
          },
          {
            "code": "Group2",
            "category": "UPGRADE",
            "entities": [
              {
                "poCode": "PO3"
              },
              {
                "poCode": "PO4"
              }
            ]
          }
        ]
      },
      {
        "code": "COMPATIBLE_OFFER",
        "groups": [
          {
            "code": "Group3",
            "category": "Group3",
            "entities": [
              {
                "poCode": "PO5"
              },
              {
                "poCode": "PO6"
              }
            ]
          },
          {
            "code": "Group4",
            "category": "Group4",
            "entities": [
              {
                "poCode": "PO7"
              },
              {
                "poCode": "PO8"
              }
            ]
          }
        ]
      }
    ]

    The server will always return the qualified POs categorized by base category "code" and group category "groups.code".

    Is there a way to map the above structure to the standard productOfferingQualificationItem object? specifically to (productOfferingQualificationItem.productOffering or productOfferingQualificationItem.product). Or i shall extend the TMF schema to support the above custom object?

    Looking forward to your guidance and support ASAP.