Pagination

Integrating Pagination with the Izix API

When integrating with the Izix API, understanding and implementing pagination is crucial for efficiently managing data retrieval from endpoints that return multiple items, such as profiles, reservations, and access-rights. All top-level API resources allow bulk fetches through “list” API methods. For example, you can list profiles, list reservations, and list access rights.

"_pagination": {
        "page": 4,
        "total_items": 25,
        "pages": 13,
        "per_page": 2
    },
    "_links": [
        {
            "rel": "prev",
            "type": "GET",
            "href": "https://api.izix.eu/access-rights?page=3"
        },
        {
            "rel": "next",
            "type": "GET",
            "href": "https://api.izix.eu/access-rights?page=5"
        }
    ]
}

This guide will detail how to implement pagination when making requests to such endpoints in the Izix API.

Understanding Pagination Parameters

To effectively use the Izix API's pagination, you need to familiarize yourself with the following parameters typically included in any paginated API response:

• page: The current page number of the dataset that is being accessed.
• total_items: The total count of items across all pages, helping you understand the dataset's size.
• pages: The total number of pages available, which is determined by the total number of items and the number of items per page.
• per_page: The number of items displayed on each page. This can be adjusted to fit the data needs of your application.

These parameters are presented in a JSON structure like this within the API response:

"_pagination": {  
    "page": 4,  
    "total_items": 25,  
    "pages": 13,  
    "per_page": 2  
}

Steb-by-Step Integration

Step 1: Request Data with Pagination
When you request a list from the Izix API, use the pagination parameters to specify the page and the number of items per page. Here’s an example of how you might construct a request URL:

GET https://api.izix.eu/access-rights?page=4&per_page=2

This request fetches the fourth page of access rights, showing 2 items on that page.

Step 2: Parsing Pagination Links
The Izix API facilitates easy navigation between pages by providing _links in the API responses. These links indicate URLs to the next or previous pages, which you can directly use to fetch subsequent data without recalculating the URL parameters.

Here's how these links appear in the response:

"_links": [  
    {  
        "rel": "prev",  
        "type": "GET",  
        "href": "https://api.izix.eu/access-rights?page=3"  
    },  
    {  
        "rel": "next",  
        "type": "GET",  
        "href": "https://api.izix.eu/access-rights?page=5"  
    }  
]

Step 3: Implementing Navigation
In your application, implement functionality that utilizes these links for navigating through the data. This can be as simple as providing buttons or links that trigger new API requests using the href values from the _links array.

Best Practices for Using Pagination

• Consistency: Always use the same pagination strategy across different API endpoints to minimize confusion and errors.
• Error Handling: Implement error handling for cases where users might request a page number that doesn’t exist or when there are no more pages to fetch.
• Data Caching: Consider caching pages or certain data locally to reduce the number of requests needed and improve your application’s performance.