Changes for page 1. SearchHotelPrices

Last modified by Giorgi Mdivnishvili on 2024/11/06 10:47

From version 2.1
edited by Giorgi Mdivnishvili
on 2023/12/14 12:07
Change comment: There is no comment for this version
To version 4.1
edited by Giorgi Mdivnishvili
on 2023/12/14 12:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -9,10 +9,10 @@
9 9  The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods.
10 10  
11 11  
12 -== Endpoint URL - [GET] ==
12 +== Endpoint URL - [POST] ==
13 13  
14 14  {{info}}
15 -[[http:~~/~~/online-api.kazunion.com/api/Catalogue/GetHotels>>http://online-api.kazunion.com/api/Catalogue/GetHotels]]
15 +[[https:~~/~~/online-api.kazunion.com/api/OnlyHotelPackages/SearchHotelPrices>>https://online-api.kazunion.com/api/OnlyHotelPackages/SearchHotelPrices]]
16 16  {{/info}}
17 17  
18 18  
... ... @@ -20,22 +20,106 @@
20 20  
21 21  (% class="box infomessage" %)
22 22  (((
23 -
24 -
25 -|**Key**|**Value**|**Request URL**
26 -|CountryCode|AE|[[http:~~/~~/online-api.kazunion.com/api/Catalogue/GetHotels?countryCode=AE>>http://online-api.kazunion.com/api/Catalogue/GetHotels?countryCode=AE]]
27 -
28 -
23 +None
29 29  )))
30 30  
31 -
32 32  == Request Body ==
33 33  
34 34  {{code language="Json"}}
35 -none
29 +{
30 + "countryCode": "string",
31 + "locations": [
32 + {
33 + "type": "string",
34 + "parent": "string",
35 + "label": "string",
36 + "subLabel": "string",
37 + "value": "string",
38 + "tag": "string"
39 + }
40 + ],
41 + "checkInDate": "2023-12-14T08:09:42.770Z",
42 + "checkInDateTo": "2023-12-14T08:09:42.770Z",
43 + "checkOutDate": "2023-12-14T08:09:42.770Z",
44 + "stayDays": 0,
45 + "stayDaysTo": 0,
46 + "adults": 0,
47 + "children": 0,
48 + "childrenAges": [
49 + 0
50 + ],
51 + "extendedSearch": true,
52 + "totalPriceFrom": 0,
53 + "totalPriceTo": 0,
54 + "recommended": true,
55 + "popular": true,
56 + "freeSale": true,
57 + "groupByHotel": true,
58 + "hotelCodes": [
59 + "string"
60 + ],
61 + "mealPlans": [
62 + "string"
63 + ],
64 + "hotelClasses": [
65 + "string"
66 + ],
67 + "hotelTypes": [
68 + "CityHotel"
69 + ],
70 + "hotelServices": [
71 + "HasAlcohol"
72 + ],
73 + "pagingId": "string",
74 + "pageNumber": 0,
75 + "pageRowCount": 0
76 +}
36 36  {{/code}}
37 37  
79 +== Request Body example ==
38 38  
81 +
82 +{{code language="Json"}}
83 +{
84 + "countryCode": "AE",
85 + "checkInDate": "2024-02-15T08:00:00.000Z",
86 + "checkInDateTo": "2024-02-20T08:00:00.000Z",
87 +
88 + "stayDays": 4,
89 + "stayDaysTo": 6,
90 + "adults": 1,
91 + "children": 1,
92 + "childrenAges": [
93 + 1
94 + ],
95 + "extendedSearch": false,
96 + "totalPriceFrom": 10,
97 + "totalPriceTo": 10000,
98 + "recommended": false,
99 + "popular": true,
100 + "freeSale": true,
101 + "groupByHotel": true,
102 + "hotelCodes": [
103 +
104 + ],
105 + "mealPlans": [
106 +
107 + ],
108 + "hotelClasses": [
109 +
110 + ],
111 + "hotelTypes": [
112 +
113 + ],
114 + "hotelServices": [
115 +
116 + ],
117 + "pagingId": "",
118 + "pageNumber": 3,
119 + "pageRowCount": 10
120 +}
121 +{{/code}}
122 +
39 39  == Response Body ==
40 40  
41 41  {{code language="json"}}
... ... @@ -63,45 +63,65 @@
63 63  {{/code}}
64 64  
65 65  
66 -=== example ===
150 +=== Response Body example ===
67 67  
68 68  {{code language="Json"}}
69 69  {
70 - "hotelCode": "cfbca5b5-4090-4bcd-805a-463d83423b86",
71 - "hotelName": "Ramada Abu Dhabi Corniche",
72 - "hotelClass": "4",
73 - "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
74 - "countryCode": "AE",
75 - "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
76 - "cityName": "Abu Dhabi",
77 - "districtName": "Abu Dhabi",
78 - "hotelType": "CityHotel",
79 - "latitude": "24.503759",
80 - "longitude": "54.374577",
81 - "hasAlcohol": false,
82 - "hasFreeWifi": true,
83 - "hasMetro": false,
84 - "hasPool": true,
85 - "hasMall": false
86 - },
87 - {
88 - "hotelCode": "c64b6082-2337-4519-8c33-4bcdef76b16b",
89 - "hotelName": "Emirates Palace Mandarin Oriental, Abu Dhabi",
90 - "hotelClass": "5",
91 - "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
92 - "countryCode": "AE",
93 - "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
94 - "cityName": "Abu Dhabi",
95 - "districtName": "Abu Dhabi",
96 - "hotelType": "BeachHotel",
97 - "latitude": "24.461556",
98 - "longitude": "54.317404",
99 - "hasAlcohol": false,
100 - "hasFreeWifi": true,
101 - "hasMetro": false,
102 - "hasPool": true,
103 - "hasMall": false
104 - },
154 + "packages": [
155 + {
156 + "id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
157 + "priceCurrency": "USD",
158 + "totalPrice": 381.7,
159 + "agentCommissionPercent": 0.0,
160 + "agentCommissionAmount": 0.0,
161 + "hotel": {
162 + "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
163 + "providerId": 13,
164 + "hotelName": "Golden Tulip Al Barsha Hotel",
165 + "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
166 + "nigths": 4,
167 + "mealPlan": "RO",
168 + "hotelClass": "4",
169 + "availabilityType": "FreeSale",
170 + "availableRoomsCount": 0,
171 + "fewRooms": true,
172 + "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
173 + "roomCategoryName": "Superior Twin",
174 + "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
175 + "checkInDate": "2024-02-17T08:00:00.000Z",
176 + "checkOutDate": "2024-02-21T08:00:00.000Z",
177 + "adults": 1,
178 + "children": 1,
179 + "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
180 + "districtName": "Al Barsha",
181 + "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
182 + "cityName": "Dubai",
183 + "countryCode": "AE",
184 + "countryName": "United Arab Emirates",
185 + "hasAlcohol": true,
186 + "hasFreeWifi": true,
187 + "hasMetro": false,
188 + "hasPool": true,
189 + "hasMall": false,
190 + "cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
191 + "cancellationPolicy": {
192 + "noShowChargeValue": 100.0,
193 + "noShowChargeValueType": "%",
194 + "earlyDepartureChargeValue": 100.0,
195 + "earlyDepartureChargeValueType": "%",
196 + "conditions": [
197 + {
198 + "timeunits": 15,
199 + "timeunitType": "Day",
200 + "timeOffsetTypeName": "Before Arrival",
201 + "chargeValue": 100.0,
202 + "chargeValueType": "%"
203 + }
204 + ]
205 + }
206 + },
207 + "extraServices": []
208 + },
105 105  {{/code}}
106 106  
107 107  
... ... @@ -108,36 +108,126 @@
108 108  === Schema ===
109 109  
110 110  {{code language="none"}}
111 -[Hotel{
112 -hotelCode string
215 +SearchOnlyHotelPackagesResponse{
216 +packages [
113 113  nullable: true
218 +OnlyHotelPackage{
219 +id string
220 +nullable: true
221 +priceCurrency string
222 +nullable: true
223 +totalPrice number($double)
224 +agentCommissionPercent number($double)
225 +agentCommissionAmount number($double)
226 +hotel PackageHotel{
227 +hotelPriceId string
228 +nullable: true
229 +providerId integer($int32)
114 114  hotelName string
115 115  nullable: true
232 +hotelCode string
233 +nullable: true
234 +nigths integer($int32)
235 +mealPlan string
236 +nullable: true
116 116  hotelClass string
117 117  nullable: true
118 -cityUID string($uuid)
239 +availabilityType RoomAvailabilityTypeEnumstring
240 +Enum:
241 +[ OnRequest, FreeSale, StopSale ]
242 +availableRoomsCount integer($int32)
243 +fewRooms boolean
244 +roomCategoryCode string
119 119  nullable: true
120 -countryCode string
246 +roomCategoryName string
121 121  nullable: true
122 -countryName string
248 +placementTypeName string
123 123  nullable: true
250 +placementDescription string
251 +nullable: true
252 +checkInDate string($date-time)
253 +checkOutDate string($date-time)
254 +adults integer($int32)
255 +children integer($int32)
124 124  districtUID string($uuid)
125 125  nullable: true
126 -cityName string
127 -nullable: true
128 128  districtName string
129 129  nullable: true
130 -hotelType HotelTypeEnumstring
131 -Enum:
132 -[ CityHotel, BeachHotel, SecondLineBeach ]
133 -latitude string
260 +cityUID string($uuid)
134 134  nullable: true
135 -longitude string
262 +cityName string
136 136  nullable: true
264 +countryCode string
265 +nullable: true
266 +countryName string
267 +nullable: true
137 137  hasAlcohol boolean
138 138  hasFreeWifi boolean
139 139  hasMetro boolean
140 140  hasPool boolean
141 141  hasMall boolean
273 +cancellationPolicyDescription string
274 +nullable: true
275 +cancellationPolicy CancellationPolicyExchange{
276 +cancellationPolicyCode string
277 +nullable: true
278 +noShowChargeValue number($double)
279 +nullable: true
280 +noShowChargeValueType string
281 +nullable: true
282 +earlyDepartureChargeValue number($double)
283 +nullable: true
284 +earlyDepartureChargeValueType string
285 +nullable: true
286 +conditions [
287 +nullable: true
288 +CancellationPolicyConditionExchange{
289 +timeunits integer($int32)
290 +timeunitType string
291 +nullable: true
292 +timeOffsetTypeName string
293 +nullable: true
294 +chargeValue number($double)
295 +nullable: true
296 +chargeValueType string
297 +nullable: true
142 142  }]
299 +}
300 +}
301 +extraServices [
302 +nullable: true
303 +HotelExtraServiceBase{
304 +extraServiceCode string
305 +nullable: true
306 +extraServiceTypeCode string
307 +nullable: true
308 +isMandatory integer($int32)
309 +extraServiceName string
310 +nullable: true
311 +minimalServiceAmount number($double)
312 +includedPriceCode string
313 +nullable: true
314 +prices [
315 +nullable: true
316 +HotelExtraServicePriceBase{
317 +extraServicePriceCode string
318 +nullable: true
319 +displayName string
320 +nullable: true
321 +restrictionInfo string
322 +nullable: true
323 +additionalInfo string
324 +nullable: true
325 +price number($double)
326 +extraPrice number($double)
327 +currency string
328 +nullable: true
329 +}]
330 +}]
331 +}]
332 +pagingId string
333 +nullable: true
334 +pageNumber integer($int64)
335 +pageCount integer($int64)
336 +}
143 143  {{/code}}