Home > Aria Crescendo Documentation > Aria Crescendo tm-forum api > TMF669 Party Role Management

TMF669 Party Role Management

Table of contents

Aria gained conformance certification from TM Forum for this API in January 2022. 

TMF669 Party Role Management API provides:

  • The creation and management of Party Role, a supplemental field within Aria Crescendo.
  • The retrieval of one or more Party Roles within Aria Crescendo.

This API is a generalization of the Customer management API where the Party Role defines the type of relationship this entity has with the Organization.
In Aria the Party Role is defined as a supplemental field that can be applied to an Account.

The full API specification for TMF669 can be found on the TM Forum site: TMF669 Party Role Management API REST Specification R19.0.1 | TM Forum

The Table below shows the API mandated resource along with mandated operations for conformance.

PartyRole

Operation Mandatory/Optional Comments
GET M

Response Status Code 200 if successful

    Response Status Code 404 if not found
POST M Status Code 201 if resource created
PATCH M Status Code 200 if resource created
DELETE M Status Code 204 if resource deleted

PartyRole Operations

  • Create and Update a Party Role
    • This operation creates and updates the party role supplemental field within Aria Crescendo
  • Retrieve Party Role
    • This operation retrieves a list of party roles from Aria Crescendo
  • Retrieve Party Role by filters
    • This operation retrieves party roles based on a variety of filter conditions from Aria Crescendo
  • Delete Party Role
    • This operation deletes a Party Role
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.