Changes for page 4. Hotel Search

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

From version 22.1
edited by Giorgi Mdivnishvili
on 2024/02/29 11:19
Change comment: There is no comment for this version
To version 13.1
edited by Giorgi Mdivnishvili
on 2024/02/29 10:05
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,29 +40,22 @@
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
48 48  |** "MaxHotelCount"**|2,|Maximum number of hotels to display results
49 49  |** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|A unique code assigned to each application user
50 -|** "countryMask"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
49 +|** "countryMask"**| "TR",|Country code ISO3 standard
51 51  |** "CheckInDate"**| "2024-05-06",|Check in date "YY-MM-DD"
52 52  |** "CheckOutDate"**| "2024-05-07",|Check out date "YY-MM-DD"
53 53  |** "Adults"**| 1,|number of Adults
54 54  |** "Children"**| 0,|Number of children
55 55  |** "ChildrenAges"**| "",|children ages, the must be separated with ","
56 -|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
55 +|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[GetCities>>GetCities]]
57 57  
58 -== ==
59 -
60 -(% class="wikigeneratedid" %)
61 -In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
62 -
63 -
64 64  == Response Example ==
65 65  
59 +
66 66  {{code language="json"}}
67 67  {
68 68   "result": [
... ... @@ -183,64 +183,4 @@
183 183  }
184 184  {{/code}}
185 185  
186 -
187 -== Definition of Response Parameters ==
188 -
189 -(% class="table-bordered" %)
190 -(% class="info" %)|**Parameter**|**value**|**Description**
191 -|**{**| |
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
201 -|** "priceCurrency"**| "EUR",|
202 -|** "priceCurrencySrc"**| "EUR",|
203 -|** "availability"**| 3,|Availability
204 -|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
205 -|** "totalSellPriceSrc"**| 40.70,|
206 -|** "totalSellPrice"**| 40.70,|
207 -|** "totalPriceSurcharge"**| 0.00,|
208 -|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
209 -|** "cancellationPolicy"**| {|
210 -|** "noShowChargeValue"**| 100.00,|
211 -|** "noShowChargeValueType"**| "%",|
212 -|** "earlyDepartureChargeValue"**| 100.00,|
213 -|** "earlyDepartureChargeValueType"**| "%",|
214 -|** "conditions"**| [|
215 -|** {**| |
216 -|** "timeunits"**| 365,|
217 -|** "timeunitType"**| "Day",|
218 -|** "timeOffsetTypeName"**| "Before Arrival",|
219 -|** "chargeValue"**| 100.00,|
220 -|** "chargeValueType"**| "%"|
221 -|** }**| |
222 -|** ]**| |
223 -|** },**| |
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
226 -|** "id"**| 1656436810005000001,|
227 -|** "hotel"**| {|
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
237 -|** },**| |
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
241 -|** "childrenExeptInfants"**| 0,|
242 -|** "checkInDate"**| "2024-05-06T00000",|date of the check in
243 -|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
244 -|** "includedExtrasAmount"**| 0,|
245 -|** "extraServices"**| []|
246 -|** },**| |
180 +