Requests for lists of items are paged to minimize response sizes.
Page Size
By default, the API only shows 25 items per page. This value can be adjusted by setting the ?pageSize, query parameter. The maximum value for this parameter is 100 items per page.
Getting the further results (Page Number)
You can request subsequent items on requesting a different page using the ?pageNumber, query string parameter.
Navigating the pages
Navigation can be achieved by reading the Link Headers provided in the response. There can be up to 4 links (first, previous, next, last).
Sample Link Header in Response:
{
"link": "<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\"first\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\"previous\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\"next\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\"last\""
}
Sample Response Header including Link Headers:
{
"pragma": "no-cache",
"date": "Thu, 09 Apr 2015 16:39:56 GMT",
"content-type": "application/json; charset=utf-8",
"cache-control": "no-cache",
"link": "<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\"first\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\"previous\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\"next\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\"last\"",
"content-length": "100",
"x-total-count": "",
"expires": "-1"
}
Total Count
The total number of results for the specified query parameters is provided in the form of a custom header.
Sample Total Count Header:
{
"x-total-count": 737
}