Pagination
**********

Specifying the page in a request
================================
If pagination is supported on a collection resource, the client has the
possibility to provide the ``page`` query parameter.

The page size is 500. This number is not modifiable.

If the page is larger than the last page, the same result as the last page is returned.

Example
-------

.. code-block:: bash

    GET /events?page=3 HTTP/1.1


Pagination data in a paginated response
=======================================
Paginated responses always include pagination data.

Response data
-------------
========== ======== ===========================================
Field name Type     Description
========== ======== ===========================================
item_count Integer  The total number of items in the collection
========== ======== ===========================================

Link relations
--------------
========== ======================================
Field name Description
========== ======================================
first      The number of orders in the collection
prev       The number of orders in the collection
next       The number of orders in the collection
last       The number of orders in the collection
========== ======================================

Example
-------
.. code-block:: javascript

    {
        "_links": {
            "first": { "href": "https://shopping-api.paylogic.com/<resource>" },
            "prev": { "href": "https://shopping-api.paylogic.com/<resource>?page=1" },
            "next": { "href": "https://shopping-api.paylogic.com/<resource>?page=3" },
            "last": { "href": "https://shopping-api.paylogic.com/<resource>?page=5" },
            // Other links ...
        },
        "item_count": 210,
        "_embedded": {
            // Embedded data ...
        }
    }