Pagination

The FIMMAS Data Services API sometimes generates more data than it can return in one response. In this case, the response pages will be generated and stored in FIMMAS, and only the first page will be returned. The subsequent pages are associated with the initial request’s UUID and can be retrieved through additional API requests.

A response that is incomplete will be denoted by a 206 response code. Page numbering is 1-based. meaning that the first request is Page 1. All responses will contain a unique transaction identifier, or UUID, in the JSON body. This value should be used in the path to specify which transaction the specified pages should come from.

Here is an example of how that process works, assuming the sample request GET AGENTS POLICIES generates a three page response:

sequenceDiagram; participant app as Application; participant api as Data Services API; app ->> api: GET AGENTS POLICIES; activate api; api -->> app: Page 1 (HTTP 206); deactivate api; Note left of app: HTTP 206 means
more pages are
available.; app ->> api: GET PAGES ?page=2 activate api; api -->> app: Page 2 (HTTP 206) deactivate api; Note left of app: HTTP 206 means
more pages are
available.; app ->> api: GET PAGES ?page=3 activate api; api -->> app: Page 3 (HTTP 200) deactivate api; Note left of app: HTTP 200 means
there are no more
pages available.;