Open APIs

  • 1.  Which API is recommended to return subscriber profile information

    TM Forum Member
    Posted Oct 12, 2021 12:17
    Hi,

    I have a requirement to expose subset of subscriber's profile for a requested IMSI. The expected response data includes data like
    • IMSI
    • MSISDN
    • Organisation name
    • Subscription type like PAYA/PAYG etc
    • AccountType
    • Tariff Purpose
    • Account Eligibility status
    Thanks
    Yogesh

    ------------------------------
    Yogesh Rane
    Hutchison 3G UK
    ------------------------------


  • 2.  RE: Which API is recommended to return subscriber profile information

    TM Forum Member
    Posted Oct 13, 2021 03:15
    TMF Open API does not model specific lines of business. IMSI would presumably a Logical Resource, so you could create a ResourceSpecification with charcteristics (e.g. sub type), relationships to other ResourceSpecs (e.g. MSISDN which is itself a logical resource). The commercial aspects (reference to customer, billing account, tariff) would be more likely modeled as part of ProductSpecfiication.
    The ODA project has started to create sample product/service/resource models, you can see a first published draft here. The authors have decided to make IMSI an attribute of the Logical SIM, but there could be other approaches.
    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.
    ------------------------------



  • 3.  RE: Which API is recommended to return subscriber profile information

    TM Forum Member
    Posted Oct 14, 2021 06:13
    Many thanks for your reply @Jonathan Goldberg. I will look into the draft you shared. Is there anywhere I can find the canonical data model defined for Telecom industry in general. So that it can be used to define new APIs, for e.g. If my new API needs entities like Customer and Order then from the reference data model I can pick the relevant data structure.

    I hope my question makes sense?

    Cheers

    ------------------------------
    Yogesh Rane
    Hutchison 3G UK
    ------------------------------



  • 4.  RE: Which API is recommended to return subscriber profile information

    TM Forum Member
    Posted Oct 14, 2021 11:08
    Hi Yogesh
    The models for all Open API resources are embedded in the published Open API swagger files for each API (API table here gives access to the published assets). These swaggers are generated from underlying JSON schemas, but TMF has not (yet) published the individual entity schemas independently.
    You would follow the EntityRef (or EntityRefOrValue) pattern to refer to Customer, ProductOrder, etc. as described in the TMF630 design guidelines document set.
    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.
    ------------------------------