REST API Using Pagination

If you would like to see some data from an endpoint, you can use the page=XX parameter to specify which page of data you would like from the table. The contents of the page is affected by the any sort or other query parameters that you provide.

A quick way to see a sample of data is to use page=1. When you display a page, you will have next and previous on the html page so that you can navigate to next or previous pages easily.

There are some parameters that you can use to limit the amount of data:

• page=XX - will show the XXth page of data, based on a default page size of 25 rows of data per page. For example, page=2 will show rows 26 to 50 data
• page_size=YY - alters the page size from 25 rows of data per page to YY rows of data per page. It can be used in con with the page=XX parameter.
• page_size=all - removes any page size limit for this query when displaying via html
• split_size=ZZ -
• page_size=all&stream=1 - is a very special combination of parameters that creates a continuous stream of all data and returns it from the API as fast as it can. Any program requesting data using this parameter needs be be able to parse the data in real time, as fast as it can because it could return a rather large set of data. It should not be used for viewing data.

 

Examples using pagination to limit results:

• https://127.0.0.1/api/v1/patrons?page=1
  page 1 of the patron table, rows 1 to 25
• https://127.0.0.1/api/v1/events?page=2
  page 2 of the event listing, which is rows 26 to 50 of the data
• https://127.0.0.1/api/v1/events?page=2&page_size=10
  return page 3 of the event data, paginated at 10 rows per page (effectively this is record 21 to 30)
• https://127.0.0.1/api/v1/patrons/pages?include_first&include_last&sort=last_name+first_name&only=page+page_rows+row+page_url+first_name+last_name
  sort the patron table by last name/first name and then, in a summary table, show the first and last person in each page group.