Open APIs

 View Only
  • 1.  TMF658 - Loyalty Management

    TM Forum Member
    Posted Jul 01, 2022 04:45

    Hi,

    We started working on TMF658 Implementation.

    I have question regd response structure for  GET /loyaltyManagement/loyaltyAccount/{account}/loyaltyBalance API

    Response structure looks below.  But it doesnt have any place for adding additional custom information e.g. Tiers/Level or something else

    {
       "id": "iTunes",
       "href": " http://server:port/loyaltyManagement/loyaltyAccount/JohnLoyalty/loyaltyBalance/iTunes",
       "quantity": {
                "unit": "NZD",
                "balance": 300
        },
       "loyaltyProgramMember": {
           "id": "PHDUIU8336",
           "href": "http://server:port/loyaltyManagement/loyaltyProgramMember/PHDUIU8336"
       }
       "validFor": {
           "startDateTime": "2016/02/19 18:42:23",
           "endDateTime": "2018/12/30 17:42:23"
       }
    }

     As TMF658 is still not in PROD , will it be possible to support this ? 



    ------------------------------
    Abhijeet Sharma
    Amdocs Management Limited
    ------------------------------


  • 2.  RE: TMF658 - Loyalty Management

    TM Forum Member
    Posted Jul 04, 2022 21:31
    Hello @Abhijeet Sharma,
    Thanks for your question which arrive just on-time, as @Philip Stander and I are working on the TMF658 API specifications update which shall be finalized this week.​

    Customer's Tiers/Level informations shall be specified in the loyaltyProgramMember entity which will contain Tiers, Characteristic and other relevant fields....

    Do you see other relevant custom information that shall be stored at Balance level ?

    Regards,
    Frédéric


    ------------------------------
    Frederic Schmeler
    Salesforce
    ------------------------------



  • 3.  RE: TMF658 - Loyalty Management

    TM Forum Member
    Posted Jul 04, 2022 21:32
    Hi Abhijeet Sharma,
    This is the good timing for sending us questions concerning TMF658 API as @Philip Stander and I are updating the specifications as we speak.

    Concerning your question, you may consider adding the tiers/level information to the LoyaltyProgramMember entity which provides tiers and characteristics fields.
    Do you see any other custom informations which may apply at AccountBalance entity level?

    Regards,
    Frédéric

    ------------------------------
    Frederic Schmeler
    Salesforce
    ------------------------------



  • 4.  RE: TMF658 - Loyalty Management

    TM Forum Member
    Posted Jul 04, 2022 21:32
    Hi,

    Philip from Globetom here. I am working with @Frederic Schmeler from SalesForce on the next release (4.0) of the API.

    On the question of additional attributes like LoyaltyTier as part of balance, the Tier information will be characteristics of the LoyaltyProgramMember.

    The LoyaltyProgramMember resource will contain a loyaltyTier attribute and it also inherits from PartyRole to which you can add multiple characteristics if you wanted to add additional information relating to the loyalty tier.

    The LoyaltyBalance resource will be derived in release 4.0 from the standard AccountBalance schema so we do not really have freedom to add characteristics to balance unless there is good use case.​

    ------------------------------
    Philip Stander
    Globetom
    ------------------------------