[ARCHIVE] Pagination Optionality

Archived 2024-06-04. See CDS, Pagination

Question

The Consumer Data Standards state:

Each API end point that can return multiple records will stipulate whether pagination is supported for the end point or not. For end points that will return less than a reasonably sized page of results in the majority of circumstances support for paging may not be included.

In the event a Data Holder doesn't support paging for an API, does this mean that the page and page-size filters would be ignored by the Data Holder API and that no page links (first, next, pref, last) and meta data (totalRecords, totalPages) would be returned?

Answer

The statement in the standards you are quoting is an indicator as to how the end points within the standards will be developed.  It basically implies that pagination will be assessed for every end point on a case by case basis but will not always be included simply because an array of records is returned in a response.

That said, once this decision is made, under consultation, for a specific end point it is not optional for a data holder.  For end points that specify support for pagination in the standards this support is mandatory.  For end points that do not specify support for pagination pagination must not be added.

As you can imagination, in the context of a recipient building a single client to interact with over 100 banks, allowing this level of optionality to every bank would dramatically increase client build costs.

See

• Consumer Data Standards - Pagination