Coordinate Location (Latitude and Longitude)
Common:CoordinateLocation
As a Hotel Search request modifier, CoordinateLocation returns hotel properties listed with the requested latitude and longitude. In the response, CoordinateLocation provides geo-coordinate values (latitude and longitude) for exact mapping of hotel properties.
Note: Coordinate location values are supported only for agencies that are provisioned for Hotel Content Plus (HCP). Please contact your Travelport representative for more information.
Implementation by Provider
See Implemented Transactions for provider functionality specific to each transaction.
Provider |
Implementation |
---|---|
Galileo (1G) |
The CoordinateLocation modifier is supported in Hotel Search requests. In Release 7.1, latitude and longitude Coordinate Locations were added as a modifier to Hotel Search requests for Galileo (1G). Before Release 7.1, CoordinateLocation values were only returned as response data for Galileo. Geo-coordinates are supported in Hotel Search responses for Target Branches that are provisioned for Coordinate Location. Contact your Travelport representative for more information. |
Apollo (1V) |
The CoordinateLocation modifier is supported in Hotel Search requests. In Release 7.1, latitude and longitude Coordinate Locations were added as a modifier to Hotel Search requests for Apollo (1V). Before Release 7.1, CoordinateLocation values were only returned as response data for Apollo. Geo-coordinates are supported in Hotel Search responses for Target Branches that are provisioned for Coordinate Location. Contact your Travelport representative for more information. |
Worldspan (1P) |
CoordinateLocation is not supported in Hotel Search requests or responses. Error Message
If CoordinateLocation is used as a Hotel Search modifier, an error message is returned: Hotel Search by Coordinate Location is not supported for this provider. |
How To
For a Hotel Search request modifier, both CoordinateLocation @Latitude and @Longitude values are required.
The number of properties returned is based on provisioning for the PCC (Pseudo City Code). A maximum of 50 properties are returned in a response; if additional properties are available, NextResultReference can be used to request additional results (Get More).
If both @Latitude and @Longitude values are not sent in the request, an error message is returned: Must provide Latitude and Longitude for Hotel Search by Coordinate Location.
Supported Properties
Some hotel properties do not have corresponding latitude/longitude coordinates. Therefore, if 0.00 is sent for both the @Latitude and @Longitude values, the request will be processed and may return properties.
Distance and Direction
By default, properties are returned within a 16-kilometer or 10-mile radius of the request latitude and longitude coordinates. The Distance modifier can be used to decrease or increase the default radius from 0 to 75 miles.
If the Distance modifier is also included in the request, properties are returned in order for nearest to farthest from the specified coordinates. Properties are also returned in distance buckets of 1-2 miles, 3-5 miles, 6-10 miles, 11-30 miles, and 30-75 miles. Within each bucket, Featured Properties (FP) are moved or sorted to the top of that buckets.
Distance @Direction can also be used to modify the cardinal and ordinal directions (N, E, S, W, NE, NW, SE, SW) from the specified geo-coordinate.
Other Search Modifiers
CoordinateLocation can be used in combination with the Distance modifier. However, CoordinateLocation is mutually exclusive with the following search modifiers. If CoordinateLocation values are sent in combination with one or more of the following modifiers, CoordinateLocation is processed, the other modifiers are ignored, and a warning is returned:
- ReferencePoint (Reference Point Name or Postal Code)
- VendorLocation (Property Number/ID)
- HotelAddress
- Transportation
Condition | Error/Warning Message |
---|---|
CoordinateLocation is requested in combination with ReferencePoint (Name or Postal Code), Transportation, VendorLocation, or HotelAddress. CoordinateLocation supersedes the other search modifiers, which are ignored. | Coordinate Location was used and other search modifiers Reference Point Name, Postal Code, Transportation, Property ID or Hotel Address were ignored. |
No properties are found within the requested CoordinateLocation values. |
NO PROPERTIES FOUND AT THIS LOCATION - REFINE SEARCH PARAMETERS. |
The Distance value is greater than the maximum 75 miles/120 km. The maximum Distance of 75 miles or 120 kilometers is then processed for the request. | Max Distance cannot exceed 75 miles or 120 kilometers. Search modified for max of 75 miles or 120 kilometers. |
Schema
common.xsd CoordinateLocation
Element/Attribute | Description |
---|---|
CoordinateLocation |
The latitude and longitude associated to hotel properties. Both @Latitude and @Longitude are numeric values; inclusive of decimal point. Plus (+) and minus (-) can proceed the coordinates. Plus (+) is optional to indicate a positive coordinate. Minus (-) is required to indicate a negative coordinate. For example:
Error Message
If incorrect formats are sent for latitude or longitude, an error message is returned: INVALID REF PT FORMAT LAT/LON. Note that the responses refers to Reference Points (Ref Pt), which are processed together with latitude and longitude coordinates in Galileo and Apollo. In Universal API, Reference Points and Coordinate Location are separate modifiers that both use latitude and longitude coordinates. |
@latitude |
The latitude of the hotel property coordinate. |
@longitude | The longitude of the hotel property coordinate. |
Implemented Transactions
HotelSearchAvailabilityReq/HotelSearchLocation/CoordinateLocation
HotelSearchAvailabilityRsp/HotelProperty/CoordinateLocation
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).