Moreover - the pagination applies at the top level - the entity being returned by the GET, Billing Account in your example. It is very natural to page through a set of entities.
Of course there is no magic, the API implementation needs to be developed to support pagination, and with very large result sets (10,000s, 100,000s) you probably wouldn't want to have direct page access, rather cursor-based (key-set) paging.
But consider what would happen if (hypothetically) you had a direct list of billing account references within Party or PartyRole. You would need somehow to manage pagination at the sub-entity level, which is something that we haven't figured out how to even express in the Open API model and patterns.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------
Original Message:
Sent: May 03, 2022 09:36
From: Koen Peeters
Subject: "contact" modelling
Hi Igor,
TMF630 describes pagination support for OpenAPI. It applies in principle to all APIs and is done at the server side.
Regards
------------------------------
Koen Peeters
OryxGateway
------------------------------
Original Message:
Sent: May 03, 2022 09:10
From: Igor Dubrovin
Subject: "contact" modelling
With this approach, not sure if we can support pagination in API. If, for example, I need o get list of "contacts" for specific account, I need to get "billing account" entity and look for "related party" structure. The pagination has to be done on UI level, not on back end. Is that correct?
------------------------------
Igor Dubrovin
Bell Canada
Original Message:
Sent: May 03, 2022 09:00
From: Igor Dubrovin
Subject: "contact" modelling
Thank you Jonathan and Koen.
Yes that it is our current approach. I though there are some other more efficient way.
Regards.
------------------------------
Igor Dubrovin
Bell Canada
Original Message:
Sent: May 03, 2022 08:53
From: Koen Peeters
Subject: "contact" modelling
Hi Igor,
There is indeed not a single call that gets you all the entities that are linked to it.
However you can search different entities using something like:
GET /tmf-api/accountManagment/v4/billingAccount?relatedParty.name=<contact>
Regards
------------------------------
Koen Peeters
OryxGateway
Original Message:
Sent: May 03, 2022 08:34
From: Igor Dubrovin
Subject: "contact" modelling
HI Jonathan,
The problem is when I get details of the Party Individual (contact), I can't get reference to a Billing Account. Therefore I don't know which billing account the contact is referencing to.
Hope I clarified the question.
Sincerely,
Igor Dubrovin
------------------------------
Igor Dubrovin
Bell Canada
Original Message:
Sent: Apr 28, 2022 07:26
From: Jonathan Goldberg
Subject: "contact" modelling
Hi Igor
I don't completely follow your problem, sorry.
Billing Account and Customer both have a relatedParty reference, which you can use to point directly to a Party (Individual), or to a PartyRole (contact, for example). If you want to retrieve the relatedParty details, either you would do GET based on the contents of the relatedParty, or set the depth directive on the original GET of the Billing Account or Customer.
What is the problem?
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.