Wiki source code of 3. CalcPackage

Version 5.1 by Giorgi Mdivnishvili on 2023/12/26 09:08

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
8
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
11
12 == Endpoint URL - [POST] ==
13
14 {{info}}
15 [[https:~~/~~/online-api.kazunion.com/api/OnlyHotelPackages/CalcPackage>>https://online-api.kazunion.com/api/OnlyHotelPackages/CalcPackage]]
16 {{/info}}
17
18
19 == Request Parameters ==
20
21 (% class="box infomessage" %)
22 (((
23 None
24 )))
25
26
27 == Request Body ==
28
29 {{code language="Json"}}
30 {
31 "packageId": "string",
32 "extraServicePriceCodes": [
33 "string"
34 ],
35 "includeInsurance": true
36 }
37 {{/code}}
38
39 (% class="wikigeneratedid" id="HRequestBodyexample" %)
40 (% id="cke_bm_10575S" style="display:none" %)
41
42 == Request Body example ==
43
44 {{code language="Json"}}
45 {
46 "packageId": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
47 "extraServicePriceCodes": [
48
49 ]
50 }
51 {{/code}}
52
53
54 == Response ==
55
56 {{code language="json"}}
57 {
58 "error": true,
59 "errorCode": "string",
60 "errorDescription": "string",
61 "userErrorDescription": "string",
62 "package": {
63 "id": "string",
64 "priceCurrency": "string",
65 "totalPrice": 0,
66 "agentCommissionPercent": 0,
67 "agentCommissionAmount": 0,
68 "includedExtrasAmount": 0,
69 "priceDifference": 0,
70 "hotel": {
71 "hotelPriceId": "string",
72 "providerId": 0,
73 "hotelName": "string",
74 "hotelCode": "string",
75 "nigths": 0,
76 "mealPlan": "string",
77 "hotelClass": "string",
78 "availabilityType": "OnRequest",
79 "availableRoomsCount": 0,
80 "fewRooms": true,
81 "roomCategoryCode": "string",
82 "roomCategoryName": "string",
83 "placementTypeName": "string",
84 "placementDescription": "string",
85 "checkInDate": "2023-12-18T14:09:48.103Z",
86 "checkOutDate": "2023-12-18T14:09:48.103Z",
87 "adults": 0,
88 "children": 0,
89 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
90 "districtName": "string",
91 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
92 "cityName": "string",
93 "countryCode": "string",
94 "countryName": "string",
95 "hasAlcohol": true,
96 "hasFreeWifi": true,
97 "hasMetro": true,
98 "hasPool": true,
99 "hasMall": true,
100 "cancellationPolicyDescription": "string",
101 "cancellationPolicy": {
102 "cancellationPolicyCode": "string",
103 "noShowChargeValue": 0,
104 "noShowChargeValueType": "string",
105 "earlyDepartureChargeValue": 0,
106 "earlyDepartureChargeValueType": "string",
107 "conditions": [
108 {
109 "timeunits": 0,
110 "timeunitType": "string",
111 "timeOffsetTypeName": "string",
112 "chargeValue": 0,
113 "chargeValueType": "string"
114 }
115 ]
116 }
117 },
118 "flight": {
119 "id": "string",
120 "departureDate": "2023-12-18T14:09:48.103Z",
121 "returnDate": "2023-12-18T14:09:48.103Z",
122 "departureTicketsLeft": 0,
123 "returnTicketsLeft": 0,
124 "departureAvailabilityType": "OnRequest",
125 "returnAvailabilityType": "OnRequest",
126 "isTwoWay": true,
127 "departureSegments": [
128 {
129 "airlineCode": "string",
130 "airlineName": "string",
131 "flightCode": "string",
132 "class": "string",
133 "lugageWeight": 0,
134 "handLugageWeight": 0,
135 "departureFlightDate": "2023-12-18T14:09:48.103Z",
136 "departureCountryName": "string",
137 "departureCityName": "string",
138 "departureAirportCode": "string",
139 "departureAirportName": "string",
140 "departureTerminalCode": "string",
141 "arrivalFlightDate": "2023-12-18T14:09:48.103Z",
142 "arrivalCountryName": "string",
143 "arrivalCityName": "string",
144 "arrivalAirportCode": "string",
145 "arrivalAirportName": "string",
146 "arrivalTerminalCode": "string",
147 "flightDuration": "string",
148 "baggages": [
149 {
150 "baggageCode": "string",
151 "description": "string",
152 "price": 0,
153 "currency": "string",
154 "included": true
155 }
156 ]
157 }
158 ],
159 "returnSegments": [
160 {
161 "airlineCode": "string",
162 "airlineName": "string",
163 "flightCode": "string",
164 "class": "string",
165 "lugageWeight": 0,
166 "handLugageWeight": 0,
167 "departureFlightDate": "2023-12-18T14:09:48.103Z",
168 "departureCountryName": "string",
169 "departureCityName": "string",
170 "departureAirportCode": "string",
171 "departureAirportName": "string",
172 "departureTerminalCode": "string",
173 "arrivalFlightDate": "2023-12-18T14:09:48.103Z",
174 "arrivalCountryName": "string",
175 "arrivalCityName": "string",
176 "arrivalAirportCode": "string",
177 "arrivalAirportName": "string",
178 "arrivalTerminalCode": "string",
179 "flightDuration": "string",
180 "baggages": [
181 {
182 "baggageCode": "string",
183 "description": "string",
184 "price": 0,
185 "currency": "string",
186 "included": true
187 }
188 ]
189 }
190 ]
191 },
192 "extraServices": [
193 {
194 "extraServiceCode": "string",
195 "extraServiceTypeCode": "string",
196 "isMandatory": 0,
197 "extraServiceName": "string",
198 "minimalServiceAmount": 0,
199 "includedPriceCode": "string",
200 "prices": [
201 {
202 "extraServicePriceCode": "string",
203 "displayName": "string",
204 "restrictionInfo": "string",
205 "additionalInfo": "string",
206 "price": 0,
207 "extraPrice": 0,
208 "currency": "string"
209 }
210 ]
211 }
212 ],
213 "insurancePrice": {
214 "name": "string",
215 "price": 0,
216 "priceSurcarge": 0,
217 "actualStartDate": "2023-12-18T14:09:48.103Z",
218 "actualEndDate": "2023-12-18T14:09:48.103Z",
219 "optional": true,
220 "includedInPackagePrice": true
221 },
222 "cacheKey": "string"
223 }
224 }
225 {{/code}}
226
227
228 === Response example ===
229
230 {{code language="Json"}}{{/code}}
231
232
233 === Schema ===
234
235 {{success}}
236 CalcOnlyHotelPackageResponse{
237
238 |error|boolean
239 |errorCode|string
240 nullable: true
241 |errorDescription|string
242 nullable: true
243 |userErrorDescription|string
244 nullable: true
245 |package|OnlyHotelPackage{(((
246 |id|string
247 nullable: true
248 |priceCurrency|string
249 nullable: true
250 |totalPrice|number($double)
251 |agentCommissionPercent|number($double)
252 |agentCommissionAmount|number($double)
253 |hotel|PackageHotel{(((
254 |hotelPriceId|string
255 nullable: true
256 |providerId|integer($int32)
257 |hotelName|string
258 nullable: true
259 |hotelCode|string
260 nullable: true
261 |nigths|integer($int32)
262 |mealPlan|string
263 nullable: true
264 |hotelClass|string
265 nullable: true
266 |availabilityType|RoomAvailabilityTypeEnumstringEnum:
267 [ OnRequest, FreeSale, StopSale ]
268 |availableRoomsCount|integer($int32)
269 |fewRooms|boolean
270 |roomCategoryCode|string
271 nullable: true
272 |roomCategoryName|string
273 nullable: true
274 |placementTypeName|string
275 nullable: true
276 |placementDescription|string
277 nullable: true
278 |checkInDate|string($date-time)
279 |checkOutDate|string($date-time)
280 |adults|integer($int32)
281 |children|integer($int32)
282 |districtUID|string($uuid)
283 nullable: true
284 |districtName|string
285 nullable: true
286 |cityUID|string($uuid)
287 nullable: true
288 |cityName|string
289 nullable: true
290 |countryCode|string
291 nullable: true
292 |countryName|string
293 nullable: true
294 |hasAlcohol|boolean
295 |hasFreeWifi|boolean
296 |hasMetro|boolean
297 |hasPool|boolean
298 |hasMall|boolean
299 |cancellationPolicyDescription|string
300 nullable: true
301 |cancellationPolicy|CancellationPolicyExchange{(((
302 |cancellationPolicyCode|string
303 nullable: true
304 |noShowChargeValue|number($double)
305 nullable: true
306 |noShowChargeValueType|string
307 nullable: true
308 |earlyDepartureChargeValue|number($double)
309 nullable: true
310 |earlyDepartureChargeValueType|string
311 nullable: true
312 |conditions|[
313 nullable: trueCancellationPolicyConditionExchange{(((
314 |timeunits|integer($int32)
315 |timeunitType|string
316 nullable: true
317 |timeOffsetTypeName|string
318 nullable: true
319 |chargeValue|number($double)
320 nullable: true
321 |chargeValueType|string
322 nullable: true
323
324 }]
325 )))
326
327 }
328 )))
329
330 }
331 )))
332 |extraServices|[
333 nullable: trueHotelExtraServiceBase{(((
334 |extraServiceCode|string
335 nullable: true
336 |extraServiceTypeCode|string
337 nullable: true
338 |isMandatory|integer($int32)
339 |extraServiceName|string
340 nullable: true
341 |minimalServiceAmount|number($double)
342 |includedPriceCode|string
343 nullable: true
344 |prices|[
345 nullable: trueHotelExtraServicePriceBase{(((
346 |extraServicePriceCode|string
347 nullable: true
348 |displayName|string
349 nullable: true
350 |restrictionInfo|string
351 nullable: true
352 |additionalInfo|string
353 nullable: true
354 |price|number($double)
355 |extraPrice|number($double)
356 |currency|string
357 nullable: true
358
359 }]
360 )))
361
362 }]
363 )))
364
365 }
366 )))
367
368 }
369 {{/success}}
370
371