For long lists (where long means more than 50 entries) the information is ‘paged’.
Not in the meaning like in [beta CHS][1] where the pagination is done with links to the different pages.
In the API the ‘pages’ must be retrieved with subsequent queries, using the 2 optional parameters “items_per_page
” and “start_index
” (as highlighted in their API description).
Thus for instance with
items_per_page=20
/ start_index=50
I can find 20
entries (of the 204
in total for the specific Officer) starting from the 50th
:
so 50th
-69th
where if I can actually see the entry the customer is asking for:
"appointed_to": {
"company_status": "active",
"company_name": "TO LTD",
"company_number": "06930357"
},
"appointed_on": "2009-06-10",
"links": {
"company": "/company/06930357"
},
The query’s parameters are bounced back in the Response Body:
Ex.
Response body
{
"items_per_page": 20,
"start_index": 50,
"etag": "bf8de68ade82f3b701baee0000eec3e333c77a73",
"kind": "personal-appointment",
"total_results": 204,
The items per page is limited to 50
So a request with items_per_page: 51
will give back, up to 50
entries from the provided start_index
[1]: https://beta.companieshouse.gov.uk/