| Field | Data Type | Description |
|---|
| ApiKey |
string |
Your unique key that is mapped to your affiliate id and brand id |
| UserID |
string |
A unique id to represent your user. Results are cached per user. If you make subsequent requests (either SearchByCity or SearchByHotel) with the same search parameters will have the results retrieved from cache. A session id is perfect for this value if you use sessions on your website. |
| UserAgent |
string |
The user's useragent string. We use this value along with the userIPAddress value below to help protect you from fraud and automated requests/screen-scraping |
| UserIPAddress |
string |
The user's ip address. Some providers show different prices depending on the client's country (determined by ip address). To ensure the same rates are shown to the user once they are redirected to the provider's site this value must be entered. The ip address is also used to help prevent fraud and abuse of our systems. |
| CityID |
int |
Unique key to respresent a city. Taken from the static data api or static data download. |
| Checkin |
dateTime |
The checkin date |
| Checkout |
dateTime |
The checkout date |
| Guests |
int |
The number of guests (adults + children) that the search is for |
| Rooms |
int |
The number of rooms the user wishes to search for |
| LanguageCode |
string |
Two letter language code. Room names and descriptions will be cached (for later use in HotelSearch method) in this language if translations are available. See a list of valid values here |
| DisplayCurrency |
string |
Three letter currency code in which the rates will be returned. Leave this empty to use the default currency based on the user's IP address |
| AvailableOnly |
boolean |
false if you want to return all hotels even if they are unavailable/have no rates |
| MinPrice |
decimal |
The minimum price filter |
| MaxPrice |
decimal |
The maximum price filter |
| HotelNameContains |
string |
Text string used to filter hotels by name |
| StarRatingFilter |
Array of int |
List of star ratings used to filter the results. |
| FacilityFilter |
Array of int |
List of facilities used to filter the results. See here for the valid values |
| ChainIDFilter |
Array of int |
List of chains used to filter the results. See here for the valid values |
| PropertyTypeFilter |
Array of unsignedByte |
List of property types used to filter the results. See here for the valid values |
| LocationID |
int |
The id of the location used to filter the results. Used in conjunction with 'Distance' below. See here for valid values |
| Distance |
int |
The distance from the above location used to filter the results. Used in conjunction with 'LocationID' above. |
| Latitude |
decimal |
Rather than using our pre-defined locations you can use a custom latitude/longitude to filter the results. . Used in conjunction with 'Distance' above. |
| Longitude |
decimal |
Rather than using our pre-defined locations you can use a custom latitude/longitude to filter the results. Used in conjunction with 'Distance' above. |
| SortField |
Enumeration |
'Name', 'Rating', 'MinRate', or 'ConsumerRating' |
| SortAscending |
boolean |
Apply ascending/descending sort order to 'sortField' |
| PageIndex |
int |
0 based index used for paging. 0 will return page 1. 1 will return page 2 etc. |
| PageSize |
int |
The size of the pages. To be used in combination with 'pageIndex'. |
| TimeOutInSeconds |
int |
The timeout we use when searching our provider's sites. A larger timeout will produce more results at the expense of usability. 0 to use our defaults. |
| Field | Data Type | Description |
|---|
| ApiKey |
string |
Your unique key that is mapped to your affiliate id and brand id |
| UserID |
string |
A unique id to represent your user. Results are cached per user. If you make subsequent requests to the SearchByHotel method with the same search parameters, results will be retrieved from cache. A session id is perfect for this value if you use sessions on your website. |
| UserAgent |
string |
The user's useragent string. We use this value along with the userIPAddress value below to help protect you from fraud and automated requests/screen-scraping |
| UserIPAddress |
string |
The user's ip address. Some providers show different prices depending on the clients country (determined by ip address). To ensure the same rates are shown to the user once they are redirected to the provider's site this value must be entered. The ip address is also used to help prevent fraud and abuse of our systems. |
| HotelID |
int |
Unique key to respresent a hotel. Taken from the static data download. |
| Checkin |
dateTime |
The checkin date |
| Checkout |
dateTime |
The checkout date |
| Guests |
int |
The number of guests (adults + children) that the search is for |
| Rooms |
int |
The number of rooms the user wishes to search for |
| LanguageCode |
string |
Two letter language code. Room names and descriptions may be returned in this language if translations are available. See a list of valid values here |
| DisplayCurrency |
string |
Three letter currency code in which the rates will be returned. Leave this empty to use the default currency based on the user's IP address |
| TimeOutInSeconds |
int |
The timeout we use when searching our provider's sites. A larger timeout will produce more results at the expense of usability. 0 to use our defaults. |
| Field | Data Type | Description |
|---|
| Provider |
string |
Three letter code of the provider. See list here |
| Name |
string |
Name of the room |
| Description |
string |
Description of the room. Can sometimes be empty for some providers |
| Currency |
string |
The currency of the below price |
| Price |
decimal |
The price per room per stay |
| ConvertedPrice |
decimal |
The price converted using the inputed 'DisplayCurrency' or the outputed HotelSearchResponse.Currency |
| Taxes |
decimal |
The total amount of any taxes and fees. 0 if there are no taxes, null if the provider did not return any tax information. |
| Key |
string |
http://www.hotelscombined.com/ProviderRedirect.aspx?a_aid=[affiliateId]&brandId=[brandId]&splash=[true|false]&key=[Key]&label=[optional15CharacterTrackingLabel]
the 'spash' parameter determins whether the intermediate page showing redirection information is shown or not.
This will redirect to correct page on the provider's site. You must mask our domain name by using a CName record in your DNS system.
This value is already url encoded.
|
| ID | Name |
|---|
| 1 |
Business Center |
| 2 |
Room Service |
| 3 |
High-speed Internet |
| 4 |
Fitness Room/Gym |
| 5 |
Restaurant |
| 6 |
Parking |
| 7 |
Swimming pool |
| 8 |
Pet Friendly |
| 9 |
Airport shuttle |
| 10 |
Disabled Access |
| 11 |
Concierge |
| 12 |
Valet Parking |
| 13 |
Tour Desk |
| 14 |
Massage / Beauty Centre |
| 15 |
Bar / Lounge |
| 17 |
Elevator / Lift |
| 18 |
24 Hour Reception |
| 19 |
Dry Cleaning |
| 20 |
Babysitting / Child Services |
| 21 |
Air Conditioned |
| 22 |
Non-Smoking Rooms |
| 23 |
Tennis Courts |
| 24 |
Convention Center |
| 27 |
Golf Course |
| 28 |
Housekeeping |
| 29 |
Banquet Facilities |
| 30 |
Conference Room(s) |
| 31 |
Currency Exchange |
| 32 |
Medical Assistance Available |
| 33 |
Multilingual Staff |
| 34 |
Safe-Deposit Box |
| 35 |
Sauna |
| 36 |
Security Guard |
| 37 |
News Stand |
| 38 |
ATM / Cash Machine |
| 39 |
Mini Bar |
| 40 |
Refrigerator |
| 41 |
Cable / Satellite TV |
| 42 |
Secretarial Service |
| 43 |
In Room Movies |
| 44 |
Connecting Rooms |
| 45 |
Bath / Hot Tub |
| 46 |
Porters |
| 47 |
Wake-up Service |
| 48 |
Florist |
| 49 |
Meeting Rooms |
| 50 |
Kitchenette |
| 51 |
Coffee / Tea Maker |
| 52 |
Microwave |
| 53 |
Hair Dryer |
| 54 |
Complimentary Toiletries |
| 55 |
Modem / Data Port |
| 56 |
TV |
| 57 |
CD Player |
| 58 |
DVD Player |
| 59 |
Private beach |
| 60 |
Laundry service |
| 61 |
Spa bath / Jacuzzi |
| 62 |
Bicycle Rental |
| 63 |
Casino |
| 64 |
Shops |
| 65 |
Excursions |
| 66 |
Garden |
| 67 |
Golf Course (on site) |
| 68 |
Golf Course (nearby) |
| 69 |
Squash Courts |
| 70 |
Water Sports (motorized) |
| 71 |
Water Sports (non-motorized) |
| 72 |
Beach (Direct Access) |
| 73 |
Beach (Nearby) |
| 74 |
Boating |
| 75 |
Dog Racing |
| 78 |
Gym off-site |
| 79 |
Jet-Ski |
| 80 |
Mountain Biking |
| 81 |
Nature Trail |
| 82 |
Scuba Diving |
| 83 |
Skating Rink |
| 84 |
Walking |
| 85 |
Windsurfing |
| 86 |
Cycling |
| 87 |
Fine Dining |
| 88 |
Football Field |
| 89 |
Horse Racing |
| 90 |
Karaoke |
| 91 |
Mountain Climbing |
| 92 |
Nightclubs |
| 94 |
Shopping (outlet) |
| 95 |
Tennis Courts (indoor) |
| 96 |
Water Activities |
| 97 |
Wine Tasting |
| 98 |
Billiards |
| 99 |
Dart Board |
| 100 |
Fishing |
| 102 |
Golf (miniature) |
| 103 |
Horse Riding |
| 104 |
Playground |
| 105 |
Cricket Pitch |
| 106 |
Dancing |
| 107 |
Bowling Alley |
| 108 |
Volleyball |
| 109 |
Tennis Courts (outdoor) |
| 110 |
Rock Climbing |
| 111 |
Animal Watching |
| 112 |
Canoeing |
| 113 |
Surfing |
| 114 |
Bird Watching |
| 115 |
Kayaking |
| 116 |
Clay Pigeon Shooting |
| 117 |
Hiking |
| 118 |
Jogging and exercise trail |
| 119 |
Ice skating |
| 120 |
Beach Soccer and Volleyball |
| 121 |
Pool Games |
| 122 |
Diving Centre |
| 123 |
Easel |
| 124 |
Scooter/Moped Rentals on site |
| 125 |
Ecotours on Site |
| 126 |
Motor Boating on site |
| 127 |
Aerobics on site |
| 128 |
Lake |
| 129 |
Museums/Galleries |
| 130 |
Shopping (antiques) |
| 131 |
Sightseeing Tours |
| 132 |
Water-skiing |
| 133 |
Computer |
| 134 |
Laptop |
| 136 |
Photocopier |
| 139 |
Desk |
| 140 |
Direct dial phone |
| 141 |
Ticket Service |
| 142 |
Office Supplies |
| 144 |
Courier |
| 145 |
Colour Printing |
| 146 |
Binding |
| 147 |
Dictaphone |
| 148 |
Facsimile |
| 149 |
Lamination |
| 150 |
Laser printing |
| 151 |
Blackboard |
| 152 |
Posting |
| 153 |
Scanning |
| 154 |
Ballroom |
| 155 |
Function Rooms |
| 156 |
Meeting Coordinator |
| 158 |
Audio/Visual Equipment |
| 160 |
Video Conferencing |
| 161 |
Conference Manager |
| 162 |
Flip chart |
| 163 |
LCD Projector |
| 164 |
Microphone and Wireless Microphone |
| 165 |
Podium |
| 166 |
Screen and Moveable Screen |
| 167 |
Stage |
| 168 |
TV set cabinet |
| 169 |
White board |
| 170 |
Mini-cassette Recorder |
| 171 |
Portable Phone |
| 172 |
Slide Projector |
| 173 |
Full-service catering |
| 174 |
Bridal Showers |
| 175 |
Ceremonies |
| 176 |
Engagement Parties |
| 177 |
Rehearsal Dinners |
| 178 |
Custom event planning available |
| 179 |
Exhibit Space |
| 180 |
Flowers and Gift Arrangements For Individuals or Conference Attendees |
| 181 |
Disabled Accessible Rooms |
| 182 |
Disabled Parking |
| 183 |
Wheel Chair Access |
| 184 |
Knock Light (Hearing Impaired) |
| 185 |
Salon |
| 187 |
Fitness Facilities |
| 189 |
Jacuzzi |
| 190 |
Steam Room |
| 191 |
Massage |
| 192 |
Solarium |
| 193 |
Spa & Wellness Centre |
| 194 |
Steam Bath |
| 195 |
Barber/Beauty Shop |
| 196 |
Beauty Salon |
| 197 |
Health Centre |
| 198 |
Body Treatments |
| 199 |
Facial Treatments |
| 200 |
Analogue dial-up data port |
| 202 |
Internet Connection (wireless) |
| 203 |
Bathrobes |
| 204 |
Towels |
| 208 |
Shared Bathroom |
| 209 |
Shower |
| 210 |
En suite |
| 211 |
Private Bathroom |
| 212 |
Private Toilet |
| 213 |
Bathtub/Shower Combination |
| 214 |
Bidet |
| 215 |
Grab bars in bathroom |
| 216 |
Bath Menu |
| 218 |
Jetted Tub |
| 219 |
Spa/Jetted Tub |
| 220 |
Child Pool |
| 221 |
Pool Indoor |
| 222 |
Pool Outdoor |
| 223 |
Outdoor heated pool |
| 225 |
Kids Club |
| 226 |
Cots |
| 227 |
Baby Listening/Monitoring |
| 228 |
Family Friendly Menu |
| 229 |
Games Available |
| 230 |
Highchairs |
| 232 |
Supervised child care/activities |
| 234 |
Disco |
| 235 |
Live Music |
| 236 |
Theatre |
| 238 |
Pub |
| 239 |
Poolside Bar |
| 240 |
Coffee Shop/Cafeteria |
| 242 |
Picnic Area/Tables |
| 243 |
Packed Lunches |
| 244 |
Breakfast in the Room |
| 247 |
Doorman/doorwoman |
| 248 |
Personal Shopper Service |
| 251 |
Security and video surveillance in public areas |
| 252 |
Executive Floor |
| 253 |
Luggage Storage |
| 254 |
Allergy-Free Room Available |
| 255 |
Designated Smoking Area |
| 256 |
Shops in Hotel |
| 257 |
Souvenirs/Gift Shop |
| 258 |
Ice Machine |
| 259 |
Vending Machines |
| 263 |
Cell phone/mobile rental |
| 264 |
Smoking Room |
| 266 |
Family Room |
| 270 |
Express Check-In/Check-Out |
| 271 |
Separate check-in and check-out |
| 272 |
Late check-out (subject to availability) |
| 274 |
Gay/Lesbian Friendly |
| 275 |
Designer Hotel |
| 278 |
Shoe Shine |
| 279 |
Forgotten items service |
| 281 |
Self Laundry |
| 285 |
No Parking |
| 288 |
Bus Parking |
| 291 |
Paid Parking |
| 292 |
Free Parking |
| 293 |
Fireplace |
| 294 |
Pillow Top Mattress |
| 295 |
Bedding/Pillow Choices |
| 296 |
Doctor on call |