Open APIs

Hello,

Is there an agreed pattern to support changes to a related party in a TMF API.

For e.g. if the Org or Individual associated with a Product or Service changes, how do we request the change in the TMF APIs.

Is it a Product Order or Service Order of type modify or is there any other pattern.

If it is an order then how do we indicate that the related party has changed?

Regards

Milind

Hi Milind

I'm not quite sure what you are referring to. It could be:

• The data on a related party has changed, e.g. an individual who was playing party role of Customer no longer has a tax exemption
• The reference to the related party needs to be changed, e.g. the billing contact for a billing account is now Jane Smith instead of Rudy Patel

For the second situation, presumably you would PATCH (json-patch or merge-patch) the relevant reference to the related party in the containing entity

The first situation is more tricky, since it could be that the data change has side effects (e.g. in my example on tax calculation). I don't think this is a pure API concern, it's more of a system design consideration. For example, you could have some listener that consumes events on Party, and which would take appropriate action in the case of a significant change.

Hope it helps

Hello,

Is there an agreed pattern to support changes to a related party in a TMF API.

For e.g. if the Org or Individual associated with a Product or Service changes, how do we request the change in the TMF APIs.

Is it a Product Order or Service Order of type modify or is there any other pattern.

If it is an order then how do we indicate that the related party has changed?

Regards

Milind

Thanks Jonathan. I was more thinking of the 2nd scenario where the contact has changed.

We could patch the Product or the Service object with the new party as you suggest.

However should we use the Inventory API i.e 637 or 638?

Regards

Milind

Hi Milind

I'm not quite sure what you are referring to. It could be:

• The data on a related party has changed, e.g. an individual who was playing party role of Customer no longer has a tax exemption
• The reference to the related party needs to be changed, e.g. the billing contact for a billing account is now Jane Smith instead of Rudy Patel

For the second situation, presumably you would PATCH (json-patch or merge-patch) the relevant reference to the related party in the containing entity

The first situation is more tricky, since it could be that the data change has side effects (e.g. in my example on tax calculation). I don't think this is a pure API concern, it's more of a system design consideration. For example, you could have some listener that consumes events on Party, and which would take appropriate action in the case of a significant change.

Hope it helps

Hello,

Is there an agreed pattern to support changes to a related party in a TMF API.

For e.g. if the Org or Individual associated with a Product or Service changes, how do we request the change in the TMF APIs.

Is it a Product Order or Service Order of type modify or is there any other pattern.

If it is an order then how do we indicate that the related party has changed?

Regards

Milind