TMF669 Party Role Management API REST Specification R19.0.1

  • Maturity level: Level 4 - Forum Approved
  • Created By: API Project

The following document is the specification of the REST API for Party Role management.

The Party Role Management API can be seen as a generalization of Customer Management API where Party Roles may be any – not only a Customer. It shares in fact the same data structure than the Customer API but its use is intended in more general case, for instance within a partnership where the defined roles depend on the partnership kind (see Partnership management API).

This API defines a unique root resource named Party Role. It assumes the use of the following APIs : 

–       the Party Management API for access to parties

–       the Account Management API for definition of accounts

–       the Agreement Management API for agreement definition

General Information

Document series: TMF669
Document version: 4.0.1
Status: TM Forum Approved
Document type: Specifications
Team approved: 08-Aug-2019
IPR mode: RAND
TM Forum Approved: 01-Nov-2019
Date modified: 04-Nov-2019