Table of Contents
Paging
10. March 2025
Table of Contents
All list representations - for example. representations that are list-like in form and contain several elements, such as assetlist, and collectionlist, are paged. Paging uses a request to the server to retrieve only part of the list so the client can gradually scroll or "page" through the content.
If the list contains very few elements, the paging attribute can have the value null indicating that paging is not available.
JSON format
paging: {
prev: "",
next: "/fotoweb/archives/5001-testarchive/;p=1",
first: "/fotoweb/archives/5001-testarchive/",
last: "/fotoweb/archives/5001-testarchive/;p=0"
}
As shown above, the paging attribute has links to previous and next pages, as well as first and last pages.
Note
- Clients should not compute page URLs but use the available attributes above.
- Also, do not make assumptions about the number of elements per page. The number of elements may vary; using the attributes above FotoWeb will make the paging work as intended.
Accept headers/media types for collections
| Accept header | Usage |
|---|---|
| application/vnd.fotoware.collection+json | This media type can only be requested for the first page of a collection. This is because the “collection” media type contains both a list of assets and a list of sub-collections (folders), so it wouldn’t be clear which of those lists is being “paged”. |
| application/vnd.fotoware.assetlist+json | Used for paging of the asset list |
| application/vnd.fotoware.collectionlist+json | Used for paging of the sub-collection list |
Paging Attributes
| Attribute | Description |
|---|---|
paging |
Paging information. Ifnull, the list is not paged, i.e., the representation contains the entire list. |
paging.next |
URL of next page. If |
paging.prev |
URL of the previous page. If |
paging.first |
URL of the first page. This attribute is nevernullor""(empty string), and can be used for restarting navigation at the beginning of the list. |
paging.last |
URL of the last page. If nullor""(empty string), then the last page is not known because it is not known how many pages there are. The last page (if the list has a finite length) can be “discovered” by following paging.next repeatedly. |
Note
The attributes paging.first and paging.last have identical values on all pages, assuming that the contents of the list do not change during iteration
If paging is not null for one page, then it is not null for any page.
For the page retrieved from paging.last, paging.next is nullor""(empty string).
For the page retrieved from paging.first, paging.prev is nullor""(empty string).
Any page reached from a paging.next link has a valid paging.prev link that links back to its referrer, assuming that the contents of the list do not change during iteration
Any page reached from a paging.prev link has a valid paging.next link that links back to its referrer, assuming that the contents of the list do not change during iteration
The contents of some lists may change at any time, so it is recommended to not assume that paging.last stays the same during iteration.
Important points
Clients should not make any assumptions about:
Whether or not a list is paged (i.e., they should always check if paging is nulland act accordingly).
Whether or not paging.last is null or""(empty string).
The format of page URLs or the meaning of any parts, including, but not limited to, the order of page numbers (increasing or decreasing).
The number of elements of a page, or whether or not different pages of the same list have the same number of elements.