Common: Distance
A Hotel Search request can be modified to the distance and direction from the center of a specified city, reference point, or geoocoordinate.
Implementation by Provider
See Implemented Transactions for provider functionality specific to each transaction.
|
Provider |
Implementation |
|---|---|
| Galileo (1G) |
Galileo supports distance and direction modifiers for:
|
| Apollo (1V) |
Apollo supports distance and direction modifiers for:
|
| Worldspan (1P) |
Worldspan supports distance modifiers for:
|
Request
Distance is a companion modifier and must be used in combination with another search location modifer.
In addition to the minimum requirements for a basic Hotel Search, distance and direction requirements can be in the HotelSearchModifiers/Distance element.
In the Distance element:
-
The Units attribute, specifies miles 'MI' or kilometers 'KM'.
For Galileo and Apollo, the maximum support distance is 999 units (miles or kilometers). -
The Value attribute indicates the number of miles or kilometers. This value constitutes a range from the city center ('0' miles/kilometers) to the specified distance.
Note: Ranges that do not begin at '0' are not currently supported.
-
The Direction attribute indicates a cardinal or ordinal direction: 'N', 'S', 'E', 'W', 'NE', 'NW', 'SE', or 'SW'.
Distance can be used without direction. If the Value is populated, but no Direction, then properties within the specified radius from the city center are returned. However, direction cannot be used without distance. If the Direction attribute is sent, a Value must be specified.
Response
The response returns standard Hotel Search data. However, only properties within the requested distance and direction parameters are returned.
Schema
common.xsd CoordinateLocation
Implemented Transactions
Hotel Search (Synchronous)
HotelSearchAvailabilityReq/HotelSearchLocation/Distance
HotelSearchAvailabilityRsp/HotelProperty/Distance
Request
CoordinateLocation values are supported as a Hotel Search request modifier only for Galileo (1G) and Apollo (1V).
Response
If available, CoordinateLocation values are returned in the Hotel search response if provisioned for the requesting Target Branch for Galileo (1G), and Apollo (1V).
