Open APIs

Expand all | Collapse all

PartyRole API TMF669

  • 1.  PartyRole API TMF669

    TM Forum Member
    Posted 8 days ago
    Hi All,

    Hope you are doing well,

    I have a question about PartyRole API. In below example which i copied from Party Role Management API REST Specification document, name and engagedParty.name are same. But per the definition of the partyRole name, it's (A string. A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles) so i can't understand how "Global Pirates" can be a partyRole name.
    I think as this is a name for the partyRole, so it should be a name to define a role, like provider or etc, So that this role can be used in the party management API to define associate a role to a party.
    I'd appreciate if you would help me to use part and partyRole API properly.
    Our use case is that we are going to onboard around 1000 party as provider.
       A. I think we should have one record for the partyRole called Provider. And also have 1000 record for the parties, and relate each of them (in the party management API) to the Provider partyRole.
       B. But based on below example, i should have 1000 record for the parties and 1000 record for their partyRole as provider.
    Which one of above is correct based on the standard? If B i'd appreciate if you explain why A is incorrect.

    {
        "@type": "PartyRole",
        "href": "https:/host:port/tmf-api/partyRoleManagement/v4/partyRole/4079",
        "id": "4079",
        "name": "Global Pirates",// ??? I think as this is a role, so it should be a name to define a role, like provider or etc.
        "status": "Approved",
        "statusReason": "NDA has been signed",
        "validFor": {
            "startDateTime": "2018-06-16T00:00Z",
            "endDateTime": "2019-01-13T00:00Z"
        },
        "engagedParty": {
            "@referredType": "Organization",
            "href": "https:/host:port/tmf-api/partyManagement/v2/organization/99",
            "id": "99",
            "name": "Global Pirates",
            "role": "Provider"
        },
    ....

    ------------------------------
    Arash Zolfaghari
    Tecnotree
    ------------------------------


  • 2.  RE: PartyRole API TMF669

    TM Forum Member
    Posted 7 days ago
    Hi Arash
    Please take a look at my post on another thread here, I gave examples of Party and Party Role.
    Hope it helps.
    Feel free to reach out if you additional clarification.

    ------------------------------
    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: PartyRole API TMF669

    TM Forum Member
    Posted 7 days ago
    Dear Jonathan,

    Thanks for your kind support as always. I've already studied that post and also other posts which you've discussed about Party/PartyRole before. I'm totally agree with your modeling and illustration on that example. But let me visualize my problem hope it will help.
    Let's suppose we have some parties which can have two Roles, let's say Dealer and Provider. What currently it can be configured using TMF632 (Party management API) and TMF669 (PartyRole management API) is something like below:



    But what i'm saying is that why we can not use these two API like below? Don't you think it was a better design and more close to GB922_PartyR17.5.1 [Figure P.04]?





    ------------------------------
    Arash Zolfaghari
    Tecnotree
    ------------------------------



  • 4.  RE: PartyRole API TMF669

    TM Forum Member
    Posted 6 days ago
    Hi Arash
    Firstly, I would urge you (and anyone who gives examples in community posts) to use realistic examples, e.g. with actual names of people, etc., instead of Party 01, Party 02. It's much easier to relate to such examples.
    At any rate, you have basically surfaced the fact that in the Open API we are missing the concept of PartyRoleSpecification, which is present in the SID - Information Framework.
    PRS allows me to define party roles (Dealer, Supplier, etc.).
    We are now working on improvements to the User Roles and Permissions API (TMF672), and this has surfaced a very strong relationship between UserRole (prime entity in that API) and the PRS, so maybe a by-product of this work will be improvement suggestion also for PartyRole API to add the Specification.
    Reluctant to commit to anything, just sharing some thoughts.

    ------------------------------
    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.
    ------------------------------