Skip to Content

Changes for page 4. Hotel Search

Last modified by Giorgi Mdivnishvili on 2024/09/04 09:58
From version 25.1
edited by Giorgi Mdivnishvili
on 2024/09/04 09:58
Change comment: There is no comment for this version
To version 18.1
edited by Giorgi Mdivnishvili
on 2024/02/29 10:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -15,6 +15,7 @@
15 15  Method POST
16 16  
17 17  
18 +
18 18  == **Request example:** ==
19 19  
20 20  {{code language="Json"}}
... ... @@ -40,8 +40,6 @@
40 40  {{/code}}
41 41  
42 42  
43 -== Definition of Request Parameters ==
44 -
45 45  (% class="table-bordered" %)
46 46  (% class="info" %)|**Parameter**|**Value**|**Description**
47 47  |** "MaxResultCount"**|2,|Maximum number of results to display
... ... @@ -55,6 +55,7 @@
55 55  |** "ChildrenAges"**| "",|children ages, the must be separated with ","
56 56  |** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
57 57  
57 +== ==
58 58  
59 59  (% class="wikigeneratedid" %)
60 60  In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
... ... @@ -62,6 +62,7 @@
62 62  
63 63  == Response Example ==
64 64  
65 +
65 65  {{code language="json"}}
66 66  {
67 67   "result": [
... ... @@ -183,30 +183,27 @@
183 183  {{/code}}
184 184  
185 185  
186 -== Definition of Response Parameters ==
187 187  
188 -
189 -
190 190  (% class="table-bordered" %)
191 191  (% class="info" %)|**Parameter**|**value**|**Description**
192 192  |**{**| |
193 -|** "resultID"**| 1656436810005000001,|Unique ID of the Result
194 -|** "hotelID"**| 871186,|Unique ID of the hotel
195 -|** "providerID"**| 5,|provider id - (system internal)
196 -|** "roomCategoryCode"**| "ECO",|Special code for Room Category type
197 -|** "roomCategoryName"**| "Economic Room",|Name of the Room Category Type - definition of the ** "roomCategoryCode"**
198 -|** "mealPlanName"**| "BB",|Meal Plan code
199 -|** "placementType"**| 1,|Placement type code - in this case  1 means  single
200 -|** "placementTypeName"**| "1 Adult",|Placement type name - definition of the ** "placementType"**
201 -|** "priceCode"**| "BASERATE BB ECO",|price code for the current option
191 +|** "resultID"**| 1656436810005000001,|
192 +|** "hotelID"**| 871186,|
193 +|** "providerID"**| 5,|
194 +|** "roomCategoryCode"**| "ECO",|
195 +|** "roomCategoryName"**| "Economic Room",|
196 +|** "mealPlanName"**| "BB",|
197 +|** "placementType"**| 1,|
198 +|** "placementTypeName"**| "1 Adult",|
199 +|** "priceCode"**| "BASERATE BB ECO",|
202 202  |** "priceCurrency"**| "EUR",|
203 203  |** "priceCurrencySrc"**| "EUR",|
204 -|** "availability"**| 3,|Availability
205 -|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
202 +|** "availability"**| 3,|
203 +|** "availableRoomsCount"**| 1,|
206 206  |** "totalSellPriceSrc"**| 40.70,|
207 207  |** "totalSellPrice"**| 40.70,|
208 208  |** "totalPriceSurcharge"**| 0.00,|
209 -|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
207 +|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|
210 210  |** "cancellationPolicy"**| {|
211 211  |** "noShowChargeValue"**| 100.00,|
212 212  |** "noShowChargeValueType"**| "%",|
... ... @@ -222,64 +222,27 @@
222 222  |** }**| |
223 223  |** ]**| |
224 224  |** },**| |
225 -|** "searchId"**| 1656436810,|search id of the hotel
226 -|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
223 +|** "searchId"**| 1656436810,|
224 +|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|
227 227  |** "id"**| 1656436810005000001,|
228 228  |** "hotel"**| {|
229 -|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
230 -|** "hotelName"**| "Istanbul Holiday Hotel",|Full name of the Hotel
231 -|** "hotelClass"**| "~*~**",|Hotel Class in Stars
232 -|** "cityId"**| "e1344ba0-5273-4fc1-b6c4-72446260f430",|Code of the city where  hotel is located, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
233 -|** "cityName"**| "Istanbul",|Full Name of the City
234 -|** "countryCode"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
235 -|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|District unique code, where hotel is located.
236 -|** "districtName"**| "Fatih",|Full name of the District
237 -|** "note"**| ""|Hotel note - this is optional
227 +|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|
228 +|** "hotelName"**| "Istanbul Holiday Hotel",|
229 +|** "hotelClass"**| "~*~**",|
230 +|** "cityId"**| "e1344ba0-5273-4fc1-b6c4-72446260f430",|
231 +|** "cityName"**| "Istanbul",|
232 +|** "countryCode"**| "TR",|
233 +|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|
234 +|** "districtName"**| "Fatih",|
235 +|** "note"**| ""|
238 238  |** },**| |
239 -|** "adults"**| 1,|Number of the adults
240 -|** "children"**| 0,|Number of the children
241 -|** "childrenAges"**| "",|in case of children, here will be their ages
237 +|** "adults"**| 1,|
238 +|** "children"**| 0,|
239 +|** "childrenAges"**| "",|
242 242  |** "childrenExeptInfants"**| 0,|
243 -|** "checkInDate"**| "2024-05-06T00000",|date of the check in
244 -|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
241 +|** "checkInDate"**| "2024-05-06T00000",|
242 +|** "checkOutDate"**| "2024-05-07T00000",|
245 245  |** "includedExtrasAmount"**| 0,|
246 246  |** "extraServices"**| []|
247 247  |** },**| |
248 248  
249 -
250 -
251 -== Availability Filters ==
252 -
253 -
254 -==== 1. **FreeSale Parameter** ====
255 -
256 -* (((
257 -**Description**: The FreeSale parameter controls whether the response should include only "FreeSale" offers or not.
258 -
259 -* **Case 1**:
260 -** When "FreeSale": true is passed, the response will return **only** hotels and offers that are available as "FreeSale".
261 -* **Case 2**:
262 -** When "FreeSale": false is passed, there is no restriction based on "FreeSale" status, and the system will return all offers.
263 -* **Default Behavior**:
264 -** If the FreeSale parameter is not passed, the system will treat it as false by default.
265 -)))
266 -
267 -==== 2. **OnRequest Parameter** ====
268 -
269 -* (((
270 -**Description**: The OnRequest parameter works in combination with the FreeSale parameter to filter the response based on availability status.
271 -
272 -* **Behavior**:
273 -** When "OnRequest": true is passed, the system will return offers that are either "OnRequest" or "FreeSale", depending on the value of the FreeSale parameter.
274 -)))
275 -
276 -==== 3. **Filter Configuration** ====
277 -
278 -* **Note**: Whether the specific API endpoint or instance applies these filters depends on the system configuration. The ability to return only FreeSale offers or a combination of OnRequest and FreeSale is determined by the setup of each instance or endpoint.
279 -
280 -==== 4. **Example Usage** ====
281 -
282 -* If "FreeSale": true is passed, the system returns only FreeSale offers.
283 -* If "FreeSale": false or the parameter is omitted, the system returns all offers, including both FreeSale and non-FreeSale offers.
284 -
285 -