List
Overview
This is an “abstract” entity type, a group of related entities.
A list response consists of 0 or more entities. Lists are pageable. Lists are frequently partial representations. List calls provide query parameters (typically fields) to select which XML tags are included Lists may have a <link> tags with the rel attributes of next or prev. Following the href will change the current page. Note that computing the total can be slow for large lists, so we discourage building your own paging links. If you must, please cache and send the total query parameter with each request.
List specific tags
| Name | Description |
|---|---|
| itemsPerPage | The number of items in a full page. |
| startIndex | Zero based index of the first element on this page. |
| totalResults | Total number of items, across all pages |
Examples
See Publication list, or any other list, for a concrete example.