In all use cases, the Actor is the developer implementing the interface between the TripServices APIs and your company's application that provides travel results to your company's end users. Actors here are not searching/booking travel for themselves but instead are implementing this data handling for input from your company's travel customers.
This use case details how to retrieve an additional page of search results when a search finds more than 100 properties. This process is called pagination.
| Prerequisites | Next steps |
|---|---|
| To proceed with booking:
|
See the TripServices Stays APIs Guide for more about the Hotel Search APIs and which to use after v12 is released.
| Action | Goals and steps | Code Example |
|---|---|---|
Request | Additional search results are available only if the search returns more than 100 properties, as indicated by a value greater than 100 in pagination/totalItems. If totalItems returns a value less than 100, you may be able to return additional results by resending your SearchComplete request with less strict search criteria, such as by increasing the radius around your search point or, if searching by chain codes, increasing the number of chain codes sent.
If the SearchComplete response doesn't return paginationToken, all available search results are returned in the initial response, and pagination is not available. | Endpoint: GET |
| Response | The response returns the next page of search results using the standard SearchComplete v12 response format. The response indicates that this is the second page of search results. | "pagination": { "page": 2, "pageSize": 100, "totalPages": 5, "totalItems": 470, "paginationToken": "ec044728-a0bd-4757-bbd3-af9506060082" }, |
See the TripServices Stays APIs Guide for more about the Hotel Search APIs and which to use after v12 is released.
| Action | Goals and steps | Code Example |
|---|---|---|
Request | Additional search results are available only if the search returns more than 100 properties, as indicated by a value greater than 100 in Properties/totalProperties. If totalProperties returns a value less than 100, you may be able to return additional results by resending your Search by Location request with less strict search criteria, such as by increasing the radius around your search point. For Search by ID, add more property keys to your request.
If the SearchComplete response doesn't return paginationToken, all available search results are returned in the initial response, and pagination is not available. | Endpoint: GET |
| Response | The response returns the next page of search results using the standard Search v11 response format. The response does not indicate what page of search results is returned. | None applicable. |