Changes for page 4. Hotel Search

Last modified by Giorgi Mdivnishvili on 2024/09/04 09:58

From version 10.1
edited by Giorgi Mdivnishvili
on 2024/02/29 09:49
Change comment: There is no comment for this version
To version 21.1
edited by Giorgi Mdivnishvili
on 2024/02/29 11:18
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,20 +41,25 @@
41 41  {{/code}}
42 42  
43 43  
44 -(% class="info" %)|**Parameter**|**value**|**Description**
45 -|** "MaxResultCount"**|2,|
46 -|** "MaxHotelCount"**|2,|
47 -|** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|
48 -|** "countryMask"**| "TR",|
49 -|** "CheckInDate"**| "2024-05-06",|
50 -|** "CheckOutDate"**| "2024-05-07",|
51 -|** "Adults"**| 1,|
52 -|** "Children"**| 0,|
53 -|** "ChildrenAges"**| "",|
54 -|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|
43 +(% class="table-bordered" %)
44 +(% class="info" %)|**Parameter**|**Value**|**Description**
45 +|** "MaxResultCount"**|2,|Maximum number of results to display
46 +|** "MaxHotelCount"**|2,|Maximum number of hotels to display results
47 +|** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|A unique code assigned to each application user
48 +|** "countryMask"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
49 +|** "CheckInDate"**| "2024-05-06",|Check in date "YY-MM-DD"
50 +|** "CheckOutDate"**| "2024-05-07",|Check out date "YY-MM-DD"
51 +|** "Adults"**| 1,|number of Adults
52 +|** "Children"**| 0,|Number of children
53 +|** "ChildrenAges"**| "",|children ages, the must be separated with ","
54 +|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
55 55  
56 +== ==
56 56  
58 +(% class="wikigeneratedid" %)
59 +In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
57 57  
61 +
58 58  == Response Example ==
59 59  
60 60  
... ... @@ -178,4 +178,63 @@
178 178  }
179 179  {{/code}}
180 180  
181 -
185 +
186 +
187 +(% class="table-bordered" %)
188 +(% class="info" %)|**Parameter**|**value**|**Description**
189 +|**{**| |
190 +|** "resultID"**| 1656436810005000001,|Unique ID of the Result
191 +|** "hotelID"**| 871186,|Unique ID of the hotel
192 +|** "providerID"**| 5,|provider id - (system internal)
193 +|** "roomCategoryCode"**| "ECO",|Special code for Room Category type
194 +|** "roomCategoryName"**| "Economic Room",|Name of the Room Category Type - definition of the ** "roomCategoryCode"**
195 +|** "mealPlanName"**| "BB",|Meal Plan code
196 +|** "placementType"**| 1,|Placement type code - in this case  1 means  single
197 +|** "placementTypeName"**| "1 Adult",|Placement type name - definition of the ** "placementType"**
198 +|** "priceCode"**| "BASERATE BB ECO",|price code for the current option
199 +|** "priceCurrency"**| "EUR",|
200 +|** "priceCurrencySrc"**| "EUR",|
201 +|** "availability"**| 3,|Availability
202 +|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
203 +|** "totalSellPriceSrc"**| 40.70,|
204 +|** "totalSellPrice"**| 40.70,|
205 +|** "totalPriceSurcharge"**| 0.00,|
206 +|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
207 +|** "cancellationPolicy"**| {|
208 +|** "noShowChargeValue"**| 100.00,|
209 +|** "noShowChargeValueType"**| "%",|
210 +|** "earlyDepartureChargeValue"**| 100.00,|
211 +|** "earlyDepartureChargeValueType"**| "%",|
212 +|** "conditions"**| [|
213 +|** {**| |
214 +|** "timeunits"**| 365,|
215 +|** "timeunitType"**| "Day",|
216 +|** "timeOffsetTypeName"**| "Before Arrival",|
217 +|** "chargeValue"**| 100.00,|
218 +|** "chargeValueType"**| "%"|
219 +|** }**| |
220 +|** ]**| |
221 +|** },**| |
222 +|** "searchId"**| 1656436810,|search id of the hotel
223 +|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
224 +|** "id"**| 1656436810005000001,|
225 +|** "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
227 +|** "hotelName"**| "Istanbul Holiday Hotel",|Full name of the Hotel
228 +|** "hotelClass"**| "~*~**",|Hotel Class in Stars
229 +|** "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]
230 +|** "cityName"**| "Istanbul",|Full Name of the City
231 +|** "countryCode"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
232 +|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|District unique code, where hotel is located.
233 +|** "districtName"**| "Fatih",|Full name of the District
234 +|** "note"**| ""|Hotel note - this is optional
235 +|** },**| |
236 +|** "adults"**| 1,|Number of the adults
237 +|** "children"**| 0,|Number of the children
238 +|** "childrenAges"**| "",|in case of children, here will be their ages
239 +|** "childrenExeptInfants"**| 0,|
240 +|** "checkInDate"**| "2024-05-06T00000",|date of the check in
241 +|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
242 +|** "includedExtrasAmount"**| 0,|
243 +|** "extraServices"**| []|
244 +|** },**| |