联系我们分页
大多数请求返回多条记录是分页。如果分页响应,响应将包含值页面,total_pages,total_entries,next_page,previous_page,以及一段链接与url检索第一个,下一个,以前的,去年页的记录。
注意:你应该总是使用分页提供的url
链接部分的一个反应,而不是构建分页链接自己。分页的反应的例子
例如,检索客户的第一页,你会作出以下要求:
旋度" https://api.habob客服端下载rvestapp.com/v2/clients " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”回应:
{“客户”:(“{2000客户端对象}”),“页面”:1,“total_pages”:3,“total_entries”:257年,“next_page”:2,“previous_page”:零,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”,“下一个”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=2&per_page=2000”,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=3&per_page=2000”}}在这个反应中,您可以看到分页包含元数据的值。检索客户的下一个页面,使用下一个URL中提供链接部分:
旋度“https://api.harbob客服端下载vestapp.com/v2/clients?页面=2&per_page=2000" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Harvest-Account-Id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"回应:
{“客户”:(“{2000客户端对象}”),“页面”:2,“total_pages”:3,“total_entries”:257年,“next_page”:2,“previous_page”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”,“下一个”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=3&per_page=2000”,“以前”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=3&per_page=2000”}}检索客户的最后一页,使用去年URL中提供链接部分:
旋度“https://api.harbob客服端下载vestapp.com/v2/clients?页面=3&per_page=2000" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Harvest-Account-Id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"回应:
{“客户”:(“{57客户对象}”),“页面”:3,“total_pages”:3,“total_entries”:257年,“next_page”:零,“previous_page”:2,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=2000”,“下一个”:零,“以前”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=2&per_page=2000”,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=3&per_page=2000”}}分页参数
分页的端点使用下面的可选参数:
per_page——返回每页的记录数量。默认和最大
per_page值的API请求2000年。如果你想收到的最大每页记录数,不提供一个值,默认总是支持的最大数量。如果你提供一个值
per_page太大,你将会收到422年Unprocessable实体错误代码和一个无效的per_page参数错误消息。
页面——一个指示器的页面应该返回的记录。- 如果可能,您应该避免使用的
页面直接参数,而不是依靠提供的值第一个,下一个,以前的,去年url的链接部分的响应。
- 如果可能,您应该避免使用的
per_page参数的例子
检索记录少于最大页面大小支持,添加per_page参数的URL。例如,要检索最近创建的客户:
旋度“https://api.harbob客服端下载vestapp.com/v2/clients?per_page=1" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Harvest-Account-Id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"回应:
{“客户”:(“{1客户端对象}”),“页面”:1,“total_pages”:257年,“total_entries”:257年,“next_page”:2,“previous_page”:零,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=1&per_page=1”,“下一个”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=2&per_page=1”,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/clients?page=257&per_page=1”}}