Open APIs

Expand all | Collapse all

Examples for relatedParty requires update

  • 1.  Examples for relatedParty requires update

    TM Forum Member
    Posted 15 days ago
    Hi,

    I am working on TM666-Account Management and trying to understand relatedParty. As stated in multiple examples across the resources,
    "relatedParty": [{
             "@referredType": "Organization",
             "href": "https://host:port/tmf-api/partyManagement/v4/organization/4665",
             "id": "4665",
             "name": "John Doe",
             "role": "owner"
    } ]

    But I haven't found the API referred in href here. TMF632-PartyManagement has this in R14.5.1 and this is now changed to "https://serverRoot/tmf-api/party/v4/organization/128" in R19. Is this understanding correct?

    Also, I want to understand what would relatedParty mean for a PartyAccount which is not part of any organization.

    Thanks in advance,
    Sravya


    ------------------------------
    Sravya A
    Oracle Corporation
    ------------------------------


  • 2.  RE: Examples for relatedParty requires update

    TM Forum Member
    Posted 15 days ago
    Hi Sravya
    The Party Management API TM632 has endpoints for the two concrete party types Individual and Organization. So the example you quote from TMF666 Account Management refers to the Organization end-point, to retrieve (in this example) an organization whose ID is 4665.
    But please note that the examples are illustrative, not normative. If you want to know what the correct endpoint is for Party Management, you need to go to the Party Management published swagger, where it says:
    "basePath": "/tmf-api/party/v4/",

    Regarding your second query, a relatedParty can be set for any account, and it means whatever the implementation decides that it means, according to the role attribute or the referred type of the related party role. But the most obvious use would be to signify the owner of the account, typically a Customer for a Billing Account, or perhaps a partner/supplier for a Settlement Account.

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