Property Search
OTA Message Pair: OTA_HotelSearchRQ / OTA_HotelSearchRS
Description
The OTA_HotelSearchRQ message is a request for a full list of properties and their basic details such as Hotel Name, Hotel Code, Address, Phone, Location (Longitude and Latitude) and Region Data. This should be the second interface developed after the OTA_Ping messages.
In order to use this service, a live connection to Levart along with a valid username and password are required (HTTP Basic Authentication)
When a client application sends a correctly-formatted OTA_HotelSearchRQ message Levart will respond with an OTA_HotelSearchRS message containing the property details.
Request
<OTA_HotelSearchRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="qsyahdabdasd6d32" TimeStamp="2016-01-28T15:15:00+08:00">
<Criteria>
<Criterion>
<HotelRef ChainCode="ABC Inc" />
</Criterion>
</Criteria>
</OTA_HotelSearchRQ>OTA_HotelSearchRQ Specification
| Element | Num | Description |
|---|---|---|
| OTA_HotelSearchRQ | 1 | Root element |
| @Version | 1 | Current Version 1.0 |
| @EchoToken | 0..1 | EchoToken unique ID string |
| @TimeStamp | 1 | Date and time of the transaction in ISO 8601 format. e.g. 2016-01-28T15:15:00+08:00 |
| Criteria / Critereon / HotelRef | 1 | Hotel Reference element |
| @ChainCode | 1 | The hotel chain for which the information is being requested. The value must be Quest to correctly request all Quest properties on Levart. |
Response (Success)
<OTA_HotelSearchRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="qsyahdabdasd6d32" TimeStamp="2016-01-28T15:15:00+08:00">
<Success/>
<Properties>
<Property HotelCode="www.property.com.au" HotelName="ABC Bunbury" ChainName="ABC Inc" AvailableIndicator="1">
<Position Latitude="-33.32108" Longitude="115.644965"/>
<Address>
<AddressLine>14 Superior Cove</AddressLine>
<CityName>Bunbury</CityName>
<PostalCode>6230</PostalCode>
<StateProv StateCode="WA">Western Australia</StateProv>
<CountryName Code="AU">Australia</CountryName>
</Address>
<ContactNumbers>
<ContactNumber PhoneNumber="+61 8 9122 0000"/>
</ContactNumbers>
<Award Rating="4.0"/>
</Property>
<!-- Next property element... -->
</Properties>
</OTA_HotelSearchRS>Response (Error)
<OTA_HotelSearchRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" EchoToken="qsyahdabdasd6d32" TimeStamp="2016-01-28T15:15:00+08:00">
<Errors>
<Error>Could not find chain.</Error>
</Errors>
</OTA_HotelSearchRS>OTA_HotelSearchRS Specification
| Element | Num | Description |
|---|---|---|
| OTA_HotelSearchRS | 1 | Root element |
| @Version | 1 | Current Version 1.0 |
| @EchoToken | 1 | EchoToken unique ID response. |
| @TimeStamp | 1 | Date and time of the transaction in ISO 8601 format. e.g. 2016-01-28T15:15:00+08:00 |
| Success | 0..1 | Exists if successful query |
| Properties / Property | 1..n | Hotel Reference element |
| @HotelCode | 1 | HotelCode of the current property i.e. www.bunbury.property.questwa.com.au |
| @HotelName | 1 | Name of the Hotel or Property |
| @ChainName | 1 | The hotel chain for which the information is being requested. |
| @AvailableIndicator | 1 | 1 if currently available for sale. |
| Position | 1 | Element describing the physical GPS coordinates of the property |
| @Latitude | 1 | Latitude of property. |
| @Longitude | 1 | Longitude of property. |
| Address | 0..1 | Address element |
| AddressLine | 1 | Main address line |
| CityName | 1 | City or suburb name |
| PostalCode | 0..1 | Postal code where present |
| StateProv | 1 | State or Province element. |
| @StateCode | 0..1 | State Code where possible e.g. WA for Western Australia. |
| CountryName | 1 | Country Name element |
| @Code | 1 | ISO 3166-1 alpha-2 Country Code e.g. AU for Australia |
| ContactNumbers | 1 | ContactNumbers element |
| ContactNumber | 1..n | ContactNumber element |
| @PhoneNumber | 1 | Property phone number |
| Award | 0..1 | Award element |
| @Rating | 1 | Property rating between 1 and 6 stars. e.g. '4.5' for 4½ stars. |