Skip to Content

Changes for page 4. Hotel Search

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

Summary

Details

Page properties
Content
... ... @@ -15,7 +15,6 @@
15 15  Method POST
16 16  
17 17  
18 -
19 19  == **Request example:** ==
20 20  
21 21  {{code language="Json"}}
... ... @@ -41,6 +41,8 @@
41 41  {{/code}}
42 42  
43 43  
43 +== Definition of Request Parameters ==
44 +
44 44  (% class="table-bordered" %)
45 45  (% class="info" %)|**Parameter**|**Value**|**Description**
46 46  |** "MaxResultCount"**|2,|Maximum number of results to display
... ... @@ -62,7 +62,6 @@
62 62  
63 63  == Response Example ==
64 64  
65 -
66 66  {{code language="json"}}
67 67  {
68 68   "result": [
... ... @@ -184,27 +184,28 @@
184 184  {{/code}}
185 185  
186 186  
187 +== Definition of Response Parameters ==
187 187  
188 188  (% class="table-bordered" %)
189 189  (% class="info" %)|**Parameter**|**value**|**Description**
190 190  |**{**| |
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",|
192 +|** "resultID"**| 1656436810005000001,|Unique ID of the Result
193 +|** "hotelID"**| 871186,|Unique ID of the hotel
194 +|** "providerID"**| 5,|provider id - (system internal)
195 +|** "roomCategoryCode"**| "ECO",|Special code for Room Category type
196 +|** "roomCategoryName"**| "Economic Room",|Name of the Room Category Type - definition of the ** "roomCategoryCode"**
197 +|** "mealPlanName"**| "BB",|Meal Plan code
198 +|** "placementType"**| 1,|Placement type code - in this case  1 means  single
199 +|** "placementTypeName"**| "1 Adult",|Placement type name - definition of the ** "placementType"**
200 +|** "priceCode"**| "BASERATE BB ECO",|price code for the current option
200 200  |** "priceCurrency"**| "EUR",|
201 201  |** "priceCurrencySrc"**| "EUR",|
202 -|** "availability"**| 3,|
203 -|** "availableRoomsCount"**| 1,|
203 +|** "availability"**| 3,|Availability
204 +|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
204 204  |** "totalSellPriceSrc"**| 40.70,|
205 205  |** "totalSellPrice"**| 40.70,|
206 206  |** "totalPriceSurcharge"**| 0.00,|
207 -|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|
208 +|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
208 208  |** "cancellationPolicy"**| {|
209 209  |** "noShowChargeValue"**| 100.00,|
210 210  |** "noShowChargeValueType"**| "%",|
... ... @@ -220,27 +220,26 @@
220 220  |** }**| |
221 221  |** ]**| |
222 222  |** },**| |
223 -|** "searchId"**| 1656436810,|
224 -|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|
224 +|** "searchId"**| 1656436810,|search id of the hotel
225 +|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
225 225  |** "id"**| 1656436810005000001,|
226 226  |** "hotel"**| {|
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"**| ""|
228 +|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
229 +|** "hotelName"**| "Istanbul Holiday Hotel",|Full name of the Hotel
230 +|** "hotelClass"**| "~*~**",|Hotel Class in Stars
231 +|** "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]
232 +|** "cityName"**| "Istanbul",|Full Name of the City
233 +|** "countryCode"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
234 +|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|District unique code, where hotel is located.
235 +|** "districtName"**| "Fatih",|Full name of the District
236 +|** "note"**| ""|Hotel note - this is optional
236 236  |** },**| |
237 -|** "adults"**| 1,|
238 -|** "children"**| 0,|
239 -|** "childrenAges"**| "",|
238 +|** "adults"**| 1,|Number of the adults
239 +|** "children"**| 0,|Number of the children
240 +|** "childrenAges"**| "",|in case of children, here will be their ages
240 240  |** "childrenExeptInfants"**| 0,|
241 -|** "checkInDate"**| "2024-05-06T00000",|
242 -|** "checkOutDate"**| "2024-05-07T00000",|
242 +|** "checkInDate"**| "2024-05-06T00000",|date of the check in
243 +|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
243 243  |** "includedExtrasAmount"**| 0,|
244 244  |** "extraServices"**| []|
245 245  |** },**| |
246 -