Changes for page 4. Hotel Search

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-4. Hotel Search
	1	+Hotel Search

Content

...	...	@@ -1,244 +2,30 @@
1		-{{box cssClass="floatinginfobox" title="**Contents**"}}
2	2
3	3
4		-{{toc/}}
5		-{{/box}}
6		-
7		-= Method Description =
8		-
9		-
10	10	With the parameters provided in GetHotels and GetCities reponse, it’s avaible to search hotels with the desired parameters in Hotels Search.
11	11
12	12
13		-endpoint : [[https:~~/~~/testapi.rustaronline.com/api/Hotels/Search>>url:https://testapi.rustaronline.com/api/Hotels/Search]]
14	14
15		-Method POST
16		-
17		-
18		-== **Request example:** ==
19		-
20		-{{code language="Json"}}
21		-{
22		- "MaxResultCount":2,
23		- "MaxHotelCount":2,
24		- "contragentContactUID": "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",
25		- "countryMask": "TR",
26		- "CheckInDate": "2024-05-06",
27		- "CheckOutDate": "2024-05-07",
28		- "Adults": 1,
29		- "Children": 0,
30		- "ChildrenAges": "",
31		-
	7	+Request example:{{code language="Json"}}{
	8	+ "MaxResultCount":50, <<< max result count in response
	9	+ "MaxHotelCount":10, <<< max hotel count with the cheapest to expensive
	10	+ "ProviderIds":[5], <<< Dynamic channel, which cheeks prices during search, if you change it to 13 request will be immediate, but prices wont be the latest and cheapest.
	11	+ "ContragentContactUID":"55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",
	12	+ "CheckInDate":"2023-12-25T00:00:00",
	13	+ "CheckOutDate":"2024-01-02T00:00:00",
	14	+ "Adults":1,
	15	+ "Children":0,
	16	+ "ChildrenAges":"", in case of several children, "5,10" numbers must be separated by comma
	17	+ "CountryMask":"AE", << country code
	18	+
32	32	"arrivalCities": [
33	33	{
34		- "cityUID": "e1344ba0-5273-4fc1-b6c4-72446260f430"
	21	+ "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2" << city UID where we are searching hotels
35	35
36	36	}
37	37	]
38		-}
39	39
40		-{{/code}}
41		-
42		-
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		-
56		-== ==
57		-
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.
60		-
61		-
62		-== Response Example ==
63		-
64		-
65		-{{code language="json"}}
66		-{
67		- "result": [
68		- {
69		- "resultID": 1656436810005000001,
70		- "hotelID": 871186,
71		- "providerID": 5,
72		- "roomCategoryCode": "ECO",
73		- "roomCategoryName": "Economic Room",
74		- "mealPlanName": "BB",
75		- "placementType": 1,
76		- "placementTypeName": "1 Adult",
77		- "priceCode": "BASERATE BB ECO",
78		- "priceCurrency": "EUR",
79		- "priceCurrencySrc": "EUR",
80		- "availability": 3,
81		- "availableRoomsCount": 1,
82		- "totalSellPriceSrc": 40.70,
83		- "totalSellPrice": 40.70,
84		- "totalPriceSurcharge": 0.00,
85		- "cancellationPolicyDescription": "Cancellation Policy: Non refundable",
86		- "cancellationPolicy": {
87		- "noShowChargeValue": 100.00,
88		- "noShowChargeValueType": "%",
89		- "earlyDepartureChargeValue": 100.00,
90		- "earlyDepartureChargeValueType": "%",
91		- "conditions": [
92		- {
93		- "timeunits": 365,
94		- "timeunitType": "Day",
95		- "timeOffsetTypeName": "Before Arrival",
96		- "chargeValue": 100.00,
97		- "chargeValueType": "%"
98		- }
99		- ]
100		- },
101		- "searchId": 1656436810,
102		- "hotelCode": "10b7bc34-2a03-495e-94bc-1092b07823f7",
103		- "id": 1656436810005000001,
104		- "hotel": {
105		- "hotelCode": "10b7bc34-2a03-495e-94bc-1092b07823f7",
106		- "hotelName": "Istanbul Holiday Hotel",
107		- "hotelClass": "***",
108		- "cityId": "e1344ba0-5273-4fc1-b6c4-72446260f430",
109		- "cityName": "Istanbul",
110		- "countryCode": "TR",
111		- "districtId": "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",
112		- "districtName": "Fatih",
113		- "note": ""
114		- },
115		- "adults": 1,
116		- "children": 0,
117		- "childrenAges": "",
118		- "childrenExeptInfants": 0,
119		- "checkInDate": "2024-05-06T00:00:00",
120		- "checkOutDate": "2024-05-07T00:00:00",
121		- "includedExtrasAmount": 0,
122		- "extraServices": []
123		- },
124		- {
125		- "resultID": 1656436810005000003,
126		- "hotelID": 871186,
127		- "providerID": 5,
128		- "roomCategoryCode": "STANDART-2",
129		- "roomCategoryName": "Standart Double or Twin Room",
130		- "mealPlanName": "BB",
131		- "placementType": 1,
132		- "placementTypeName": "1 Adult",
133		- "priceCode": "BASERATE BB STANDART",
134		- "priceCurrency": "EUR",
135		- "priceCurrencySrc": "EUR",
136		- "availability": 3,
137		- "availableRoomsCount": 1,
138		- "totalSellPriceSrc": 53.90,
139		- "totalSellPrice": 53.90,
140		- "totalPriceSurcharge": 0.00,
141		- "cancellationPolicyDescription": "Cancellation Policy: Non refundable",
142		- "cancellationPolicy": {
143		- "noShowChargeValue": 100.00,
144		- "noShowChargeValueType": "%",
145		- "earlyDepartureChargeValue": 100.00,
146		- "earlyDepartureChargeValueType": "%",
147		- "conditions": [
148		- {
149		- "timeunits": 365,
150		- "timeunitType": "Day",
151		- "timeOffsetTypeName": "Before Arrival",
152		- "chargeValue": 100.00,
153		- "chargeValueType": "%"
154		- }
155		- ]
156		- },
157		- "searchId": 1656436810,
158		- "hotelCode": "10b7bc34-2a03-495e-94bc-1092b07823f7",
159		- "id": 1656436810005000003,
160		- "hotel": {
161		- "hotelCode": "10b7bc34-2a03-495e-94bc-1092b07823f7",
162		- "hotelName": "Istanbul Holiday Hotel",
163		- "hotelClass": "***",
164		- "cityId": "e1344ba0-5273-4fc1-b6c4-72446260f430",
165		- "cityName": "Istanbul",
166		- "countryCode": "TR",
167		- "districtId": "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",
168		- "districtName": "Fatih",
169		- "note": ""
170		- },
171		- "adults": 1,
172		- "children": 0,
173		- "childrenAges": "",
174		- "childrenExeptInfants": 0,
175		- "checkInDate": "2024-05-06T00:00:00",
176		- "checkOutDate": "2024-05-07T00:00:00",
177		- "includedExtrasAmount": 0,
178		- "extraServices": []
179		- }
180		- ],
181		- "error": false
182	182	}
183	183	{{/code}}
184	184
185	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		-|** },**| |
	30	+