Skip to main content

 

Documentation & User Guides | FotoWare

Paging

All list representations - e.g. 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 fetch 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 page.

Important

  • Clients should not compute page URLs but use the available attributes above.
  • Also, do no 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.

Note: 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
  • Was this article helpful?