To login with your TM Forum account please click on the Login button below

Don't have an account? You can register by clicking here:

The following document is the specification of the REST API Party Management.
The party management API provides standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.
Party can be an individual or an organization that has any kind of relation with the enterprise.
Party is created to record individual or organization information before the assignment of any role.
For example, within the context of a split billing mechanism, Party management API allows creation of the individual or organization that will play the role of 3rd payer for a given offer and, then, allows consultation or update of his information.
Party management API manages the following data resources:

  • Individual
    • Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.
    • Main Individual attributes are its identifier, place of birth, country of birth, nationality, marital status, birth and death dates, disability, title, , names (given, family, middle, etc.), location, individual identification, related parties
  • Organization
    • Organization represents a group of people identified by shared interests or purpose. Examples include business, department, and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data
    • Main organization attributes are its identifier, type, legal entity, date of creation and cessation, trading name and type, other name, organization identifier, related parties and organization relationships (Parent and Child)

Party management API performs the following operations on individuals and organizations:

  • Retrieval of an individual or organization or of a collection of them depending on filter criteria
  • Full update of an individual or organization
  • Partial update of an individual or organization
  • Creation of an individual or organization
  • Deletion of an individual or organization (for administration purposes)
  • Notification of events:
    • Individual create
    • Individual update
    • Individual delete
    • Organization create
    • Organization update
    • Organization delete
 

© TM Forum 2015. All Rights Reserved