Files
api-guidelines/rest/execution/pagination.md
apidesigner 958d90ea5d Creates rest/core-principles/quality.md
Auto commit by GitBook Editor
2018-06-23 12:56:08 +00:00

721 B

Pagination

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

Example

The 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": [
      { ... },
      { ... },
      
      ... 
    ]
  }
}