Open APIs

 View Only
  • 1.  Address model in TMF658 Loyalty Management?

    TM Forum Member
    Posted Oct 01, 2019 08:35
    Hi all,

    My first post here and am attempting to get more acclimated with TMF Open API modeling.  I have been working with a team trying to use the TMF658 Loyalty Management API.  They are looking to add a Shipping Address model (extended from the Address JSON schema) to the API in order for the object to be stored and retrieved later for display on a GUI.  TMF658 mentions CustomerOrder on pg 15 (Processing of events that may result in a LoyaltyAction being executed (LoyaltyEarn, CustomerOrder, BusinessInteraction), but doesn't go into much details around it.

    I am part of the Enterprise Architecture group trying to set guidelines around proper use and extensions around TMF Open APIs.  The TMF658 base-spec doesn't include an Address model so I'm trying to understand if this API is the right place to put it.  I think the challenge is still making the right judgment call about when to extend and when not to (and whether or not there are hard and fast rules around that).

    Apologies in advance if this question appears pedestrian.

    Thanks,
    Kevin.

    ------------------------------
    Kevin Ng
    TELUS
    ------------------------------


  • 2.  RE: Address model in TMF658 Loyalty Management?

    TM Forum Member
    Posted Oct 03, 2019 13:30
    Along with all the other APIs, Loyalty Management is being refreshed with the latest design guidelines. It may be done in R19.5 or a later release.
    The Address model (and the old Address API) has been replaced by GeographicAddress (and GeographicSite and GeographicLocation) - and so also the Address schema is deprecated.
    THe address APIs are also planned for R19.5, but in the meantime you can look at the schemas in GitHub at https://github.com/tmforum-rand/schemas in the Common folder.
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Address model in TMF658 Loyalty Management?

    TM Forum Member
    Posted Oct 04, 2019 15:25
    Thank you, Jonathan.

    ------------------------------
    Kevin Ng
    TELUS
    ------------------------------