Files
api-guidelines/execution/pagination.md
apidesigner 2d8d5630a1 Updates execution/pagination.md
Auto commit by GitBook Editor
2017-02-24 07:45:39 +00:00

717 B

Pagination

A collection resource SHOULD provide the first, last, next and prev links for navigation within the collection.

Example

Collection of Orders using the collection navigation link and offset and limit query parameters:

{
  "_links": {
    "self": { "href": "/orders?offset=100&limit=10" },
    "prev": { "href": "/orders?offset=90&limit=10" },
    "next": { "href": "/orders?offset=110&limit=10" },
    "first": { "href": "/orders?limit=10" },
    "last": { "href": "/orders?offset=900&limit=10" }
  },
  "total_count": 910,
  "_embedded": {
    "order": [
      { ... },
      { ... },
      
      ... 
    ]
  }
}