Skip to main content

Cookie control banner

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.
Browse Documentation
HTTP - Delivery

Paged list

Created by j.moore, last updated 23 Jul 2020

A paged list is a structure that is used to describe paging details for listing and search results.

Properties

NameData typeData formatDescription
pageIndexnumberintegerThe index of the result set to return
pageSizenumberintegerpageSize
totalCountnumberintegerThe total number of results available
itemsobject[...]A container for the items being returned

Example

The paged list properties provide the information required to implement paging.

JSON
{ "pageIndex": 0, "pageSize": 20, "totalCount": 342, "pageCount": 18, "items": [ { "title": "The Terminator", "tagline": "The thing that won't die, in the nightmare that won't end.", "overview": "<p>In the post-apocalyptic future, reigning tyrannical supercomputers teleport a cyborg assassin known as the \"Terminator\" back to 1984 to kill Sarah Connor, whose unborn son is destined to lead insurgents against 21st century mechanical hegemony. Meanwhile, the human-resistance movement dispatches a lone warrior to safeguard Sarah. Can he stop the virtually indestructible killing machine?</p>", "releaseDate": "1985-01-11T00:00:00", "actors": [], "entryTitle": "The Terminator", "entryDescription": "<p>In the post-apocalyptic future, reigning tyrannical supercomputers teleport a cyborg assassin known as the \"Terminator\" back to 1984 to kill Sarah Connor, whose unborn son is destined to lead insurgents against 21st century mechanical hegemony. Meanwhile, the human-resistance movement dispatches a lone warrior to safeguard Sarah. Can he stop the virtually indestructible killing machine?</p>", "sys": { "id": "b678c784-0bb0-46ff-8837-9e0e79b8ba21", "uri": "/api/delivery/projects/website/entries/b678c784-0bb0-46ff-8837-9e0e79b8ba21", "projectId": "website", "contentTypeId": "movie", "dataFormat": "entry", "language": "en-GB", "metadata": {}, "properties": {}, "version": { "createdBy": "k.smith", "created": "2017-03-07T16:10:41.8894598+00:00", "modifiedBy": "s.bob", "modified": "2017-03-07T16:10:43.5147206+00:00", "publishedBy": "b.murray", "published": "2017-03-07T16:10:43.9989079+00:00", "versionNo": "1.0" }, "owner": "k.smith" } }, { ... } ] }