Open APIs

Hi All

The href object for the related party object reference has some very useful fields, but then include two fields - name and role - that fail to natch to the underlying class field names.

The "name" field could be the "name" field in Role, the "tradingName" field in Organization, or "FullName" in Individual.
The "role" field is probably "name" in Role, but has no equivalent in the other two base classes.

While thes eare probably many ways to address this, I would like to suggest we arrive at a pragmatic and reasonable comprimise - why not replace all of the "name_x" fields with a simple full name, present in all classes. 

This variance is inconsistent with the ideals of standardization we are striving to achieve.

Thanks

------------------------------
Hugo Vaughan
Crowd Frame Consulting Limited.
------------------------------

Hi Hugo

The SID has two distinct concepts, Party and Party Role:

• Party can be Individual or Organization - representing the real-world concepts of people or organizations (companies, governments, charities, etc.), without reference to their relationship with the (communications) service provider.
• PartyRole can be many different things - Customer, Partner, Supplier, Employee, Contact, and more - representing the role that the party plays in its relationship with the service provider. The same Party may have multiple relationships with the service provider, e.g. John Smith might be an employee of NXT Communications, and at the same time he might be a Customer of NXT.

In the Open API model, a design pattern was adopted whereby the relationship between entities and Party/PartyRole was collapsed into the single RelatedPartyRef, which can point to a Party or to a PartyRole. The role in RelatedPartyRef would be empty if the reference is to a Party, or contains the nature of the role if the reference is to a PartyRole. And the name is the name of the Party or PartyRef.

I suggest you reach out to @Mariano Belaunde, the team lead for APIs in this area, for more clarifications.

Hope it helps



​

------------------------------
Jonathan Goldberg
Amdocs Management Limited
------------------------------

Original Message:
Sent: Aug 24, 2018 07:11
From: Hugo Vaughan
Subject: Inconsistencies in partyRole Href within Swagger for Customer Account API

Hi All

The href object for the related party object reference has some very useful fields, but then include two fields - name and role - that fail to natch to the underlying class field names.

The "name" field could be the "name" field in Role, the "tradingName" field in Organization, or "FullName" in Individual.
The "role" field is probably "name" in Role, but has no equivalent in the other two base classes.

While thes eare probably many ways to address this, I would like to suggest we arrive at a pragmatic and reasonable comprimise - why not replace all of the "name_x" fields with a simple full name, present in all classes.

This variance is inconsistent with the ideals of standardization we are striving to achieve.

Thanks

------------------------------
Hugo Vaughan
Crowd Frame Consulting Limited.
------------------------------