Open APIs

Dears,
In TMF632 Party Management, I wonder if I can use the "GET /individual?fields=…" endpoint to retrieve the party (with customer role) information using the individual identification info like (identificationId: 51DD1234, and identificationType: passport) as these attributes are second level attributes, please advice!

------------------------------
Mohammad Obeidat
Leading Point
------------------------------

Hi Mohammad

You can use the JSON Path "filter" directive as documented in the TMF630 Design Guidelines Part 6 (JSON Path Extension).

It would look something like this for your use case...

GET /individual?field=...&filter=individualIdentification[?(@.identificationId=='51DD1234'&&@.identificationType=='passport']

Note that you will need to URL/URI-encode the relevant special characters above.

------------------------------
ROCHANA MACHAROEN
ADVANCED INFO SERVICE PLC. (AIS)
------------------------------

Hi Mohammad,

Typically, it filters using top-level attributes such as id and name.

Possible Alternatives:

1. Custom Filtering: Some implementations might support custom filtering. Try:

GET /individual?filter=identification.id==51DD1234;identification.type==passport

2. Retrieve and Filter Locally: Get all individuals and filter based on identificationId and identificationType in your application.

I hope this will help you to sole your problem.........

------------------------------
Raabs Frank
TO BE VERIFIED
------------------------------

Thanks ROCHANA MACHAROEN and Raabs Frank,
Seems I missed to mention that this API will be inbound (I will expose it in my solution to be used by external parties), so in this case I will provide a custom API that will receive the id number and id type as a parameters and return the filtered data to the caller. What do you think?

------------------------------
Mohammad Obeidat
Leading Point
------------------------------

Hi Mohammad

The idea behind the TM Forum Open APIs (and 3GPP Open APIs) is to attempt to provide an industry-standard, globally recognized terminology for the APIs.  These APIs can be extended (customized) using the polymorphism mechanisms/patterns described in the TMF630 Design Guidelines Part 2.

That said, if I understand you correctly, it sounds like you are proposing to implement an inbound proprietary API.  This would mean that all API consumers would have to implement your proprietary API.

------------------------------
ROCHANA MACHAROEN
ADVANCED INFO SERVICE PLC. (AIS)
------------------------------

Original Message:
Sent: Sep 17, 2024 09:25
From: Mohammad Obeidat
Subject: Retrieve Party Information with Identity Inputs

Thanks ROCHANA MACHAROEN and Raabs Frank,
Seems I missed to mention that this API will be inbound (I will expose it in my solution to be used by external parties), so in this case I will provide a custom API that will receive the id number and id type as a parameters and return the filtered data to the caller. What do you think?

------------------------------
Mohammad Obeidat
Leading Point
------------------------------