SearchComplete Pagination API Reference

Get

search/searchcomplete/{SearchIdentifier}?pageNumber={x}

For {SearchIdentifier} send the value from the v12 SearchComplete response pagination/paginationToken. If paginationToken is not returned, no additional search results are available.

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.com/12/hotel | Production https://api.travelport.com/12/hotel/

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/12/hotel/ | Production https://api.travelport.net/12/hotel/

Note the 12 in SearchComplete, which is on model version 12.

Related Content: JSON Hotel APIs Guide, Hotel Search Guide, SearchComplete API Reference

SearchComplete uses pagination by default. SearchComplete returns up to 100 properties, or all available if fewer than 100. The response notes the total number of properties found and, if more than 100, it also returns an identifier to be used for retrieving additional pages of results. ( See the JSON Hotel APIs Guide for more details.) You can then send the SearchComplete Pagination request to retrieve each additional page of 100 properties until all available properties have been retrieved.

SearchComplete uses ODMClosed Open Data Model. ODM is an open source, object-oriented data model developed by Open Travel, a cross-sector technology alliance for the travel community. The JSON APIs are based on the ODM model using either version 11 or version 12. See the JSON Hotel APIs Guide for details. version 12, and is referred to as a v12 API. SearchComplete and SearchComplete Pagination are the only Hotel APIs on model v12. After these requests, you continue the workflow with v11 APIs: Proceed directly to booking using either the v11 Create Reservation full payload or reference payload request (what's the difference?). Optionally, before booking, you can use the v11 Hotel Rules API to request rules for any rate.

For more details, see the sections on API Versions and Workflows in the JSON Hotel APIs Guide.

The identifier used for paging is saved for 30 minutes. You cannot retrieve additional results from that search after it expires.

Request

As part of the request requirements, also see Authentication and Common Hotel API Headers.

Query Parameters

pageNumber*

Send the page number of the page of results to retrieve. The SearchComplete response returns page 1, so values here should be between 2 and 5 inclusive. You are not required to retrieve pages consecutively.

Request Body

This API does not send a request payload.

Response

Pagination responses use the standard SearchComplete response structure. See the SearchComplete API Reference for documentation.