TMF668 Partnership Management API REST Specification R19.0.1

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

This document is the specification of the REST API for Partnership Management. It includes the model definition as well as all available operations. 

The Partnership Management API defines PartnershipSpecification and Partnership as root resources. RoleSpecifications are sub-objects contained within a PartnershipSpecification. A Partnership declares – as contained instances – the partners involved in the partnership. A partner may be linked to agreements and accounts (such as billing or settlements accounts) in line with partnership specification (which may declare the used agreement specifications). The declared role name being played by the engaged party (“role” attribute in the RelatedParty structure) should match one of the role specifications declared in the partnership specification.

The following APIs are typically used in conjunction with this API:

  • Party API: defining the parties
  • Agreement API: Definition of the terms of an agreement or an agreement specification
  • Account API: Definition of billing/settlement/financial accounts that may be attached to partners

General Information

Document series: TMF668
Document version: 3.0.1
Status: TM Forum Approved
Document type: Specifications
Team approved: 10-Sep-2019
IPR mode: RAND
TM Forum Approved: 29-Nov-2019
Date modified: 03-Dec-2019