Skip to Content

Wiki source code of SearchTourPackages

Version 11.1 by Giorgi Mdivnishvili on 2023/12/15 12:22
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/TourPackages/SearchTourPackages>>https://online-api.kazunion.com/api/TourPackages/SearchTourPackages]]
16 {{/info}}
17
18 == Request Parameters ==
19
20 (% class="box infomessage" %)
21 (((
22 None 
23 )))
24
25
26 == Request Body ==
27
28 {{code language="Json"}}
29 {
30 "departureCountryCode": "string",
31 "departureCityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
32 "arrivalCountryCode": "string",
33 "arrivalLocations": [
34 {
35 "type": "string",
36 "parent": "string",
37 "label": "string",
38 "subLabel": "string",
39 "value": "string",
40 "tag": "string"
41 }
42 ],
43 "checkInDate": "2023-12-14T13:43:54.766Z",
44 "checkInDateTo": "2023-12-14T13:43:54.766Z",
45 "checkOutDate": "2023-12-14T13:43:54.766Z",
46 "stayDays": 0,
47 "stayDaysTo": 0,
48 "departureDate": "2023-12-14T13:43:54.766Z",
49 "returnDate": "2023-12-14T13:43:54.766Z",
50 "airlineCode": "string",
51 "ticketType": "string",
52 "directFlightsOnly": true,
53 "longConnectTime": true,
54 "adults": 0,
55 "children": 0,
56 "childrenAges": [
57 0
58 ],
59 "extendedSearch": true,
60 "totalPriceFrom": 0,
61 "totalPriceTo": 0,
62 "recommended": true,
63 "popular": true,
64 "freeSale": true,
65 "groupByHotel": true,
66 "hotelCodes": [
67 "string"
68 ],
69 "mealPlans": [
70 "string"
71 ],
72 "hotelClasses": [
73 "string"
74 ],
75 "hotelTypes": [
76 "CityHotel"
77 ],
78 "hotelServices": [
79 "HasAlcohol"
80 ],
81 "pagingId": "string",
82 "pageNumber": 0,
83 "pageRowCount": 0
84 }
85 {{/code}}
86
87
88 == Response Body ==
89
90 {{code language="json"}}
91 {
92 "error": true,
93 "errorCode": "string",
94 "errorDescription": "string",
95 "userErrorDescription": "string",
96 "packages": [
97 {
98 "cacheKey": "string",
99 "id": "string",
100 "priceCurrency": "string",
101 "totalPrice": 0,
102 "agentCommissionPercent": 0,
103 "agentCommissionAmount": 0,
104 "includedExtrasAmount": 0,
105 "priceDifference": 0,
106 "hotel": {
107 "hotelPriceId": "string",
108 "providerId": 0,
109 "hotelName": "string",
110 "hotelCode": "string",
111 "nigths": 0,
112 "mealPlan": "string",
113 "hotelClass": "string",
114 "availabilityType": "OnRequest",
115 "availableRoomsCount": 0,
116 "fewRooms": true,
117 "roomCategoryCode": "string",
118 "roomCategoryName": "string",
119 "placementTypeName": "string",
120 "placementDescription": "string",
121 "checkInDate": "2023-12-14T13:47:13.396Z",
122 "checkOutDate": "2023-12-14T13:47:13.396Z",
123 "adults": 0,
124 "children": 0,
125 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
126 "districtName": "string",
127 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
128 "cityName": "string",
129 "countryCode": "string",
130 "countryName": "string",
131 "hasAlcohol": true,
132 "hasFreeWifi": true,
133 "hasMetro": true,
134 "hasPool": true,
135 "hasMall": true,
136 "cancellationPolicyDescription": "string",
137 "cancellationPolicy": {
138 "cancellationPolicyCode": "string",
139 "noShowChargeValue": 0,
140 "noShowChargeValueType": "string",
141 "earlyDepartureChargeValue": 0,
142 "earlyDepartureChargeValueType": "string",
143 "conditions": [
144 {
145 "timeunits": 0,
146 "timeunitType": "string",
147 "timeOffsetTypeName": "string",
148 "chargeValue": 0,
149 "chargeValueType": "string"
150 }
151 ]
152 }
153 },
154 "flight": {
155 "id": "string",
156 "departureDate": "2023-12-14T13:47:13.396Z",
157 "returnDate": "2023-12-14T13:47:13.396Z",
158 "departureTicketsLeft": 0,
159 "returnTicketsLeft": 0,
160 "departureAvailabilityType": "OnRequest",
161 "returnAvailabilityType": "OnRequest",
162 "isTwoWay": true,
163 "departureSegments": [
164 {
165 "airlineCode": "string",
166 "airlineName": "string",
167 "flightCode": "string",
168 "class": "string",
169 "lugageWeight": 0,
170 "handLugageWeight": 0,
171 "departureFlightDate": "2023-12-14T13:47:13.396Z",
172 "departureCountryName": "string",
173 "departureCityName": "string",
174 "departureAirportCode": "string",
175 "departureAirportName": "string",
176 "departureTerminalCode": "string",
177 "arrivalFlightDate": "2023-12-14T13:47:13.396Z",
178 "arrivalCountryName": "string",
179 "arrivalCityName": "string",
180 "arrivalAirportCode": "string",
181 "arrivalAirportName": "string",
182 "arrivalTerminalCode": "string",
183 "flightDuration": "string",
184 "baggages": [
185 {
186 "baggageCode": "string",
187 "description": "string",
188 "price": 0,
189 "currency": "string",
190 "included": true
191 }
192 ]
193 }
194 ],
195 "returnSegments": [
196 {
197 "airlineCode": "string",
198 "airlineName": "string",
199 "flightCode": "string",
200 "class": "string",
201 "lugageWeight": 0,
202 "handLugageWeight": 0,
203 "departureFlightDate": "2023-12-14T13:47:13.396Z",
204 "departureCountryName": "string",
205 "departureCityName": "string",
206 "departureAirportCode": "string",
207 "departureAirportName": "string",
208 "departureTerminalCode": "string",
209 "arrivalFlightDate": "2023-12-14T13:47:13.396Z",
210 "arrivalCountryName": "string",
211 "arrivalCityName": "string",
212 "arrivalAirportCode": "string",
213 "arrivalAirportName": "string",
214 "arrivalTerminalCode": "string",
215 "flightDuration": "string",
216 "baggages": [
217 {
218 "baggageCode": "string",
219 "description": "string",
220 "price": 0,
221 "currency": "string",
222 "included": true
223 }
224 ]
225 }
226 ]
227 },
228 "extraServices": [
229 {
230 "extraServiceCode": "string",
231 "extraServiceTypeCode": "string",
232 "isMandatory": 0,
233 "extraServiceName": "string",
234 "minimalServiceAmount": 0,
235 "includedPriceCode": "string",
236 "prices": [
237 {
238 "extraServicePriceCode": "string",
239 "displayName": "string",
240 "restrictionInfo": "string",
241 "additionalInfo": "string",
242 "price": 0,
243 "extraPrice": 0,
244 "currency": "string"
245 }
246 ]
247 }
248 ],
249 "insurancePrice": {
250 "name": "string",
251 "price": 0,
252 "priceSurcarge": 0,
253 "actualStartDate": "2023-12-14T13:47:13.396Z",
254 "actualEndDate": "2023-12-14T13:47:13.396Z",
255 "optional": true,
256 "includedInPackagePrice": true
257 }
258 }
259 ],
260 "pagingId": "string",
261 "pageNumber": 0,
262 "pageCount": 0
263 }
264 {{/code}}
265
266
267 === example ===
268
269 {{code language="Json"}}
270 X
271 {{/code}}
272
273
274 === Schema ===
275
276 {{code language="none"}}
277 SearchTourPackagesResponse{
278 error boolean
279 errorCode string
280 nullable: true
281 errorDescription string
282 nullable: true
283 userErrorDescription string
284 nullable: true
285 packages [
286 nullable: true
287 TourPackage{
288 cacheKey string
289 nullable: true
290 id string
291 nullable: true
292 priceCurrency string
293 nullable: true
294 totalPrice number($double)
295 agentCommissionPercent number($double)
296 agentCommissionAmount number($double)
297 includedExtrasAmount number($double)
298 priceDifference number($double)
299 hotel PackageHotel{
300 hotelPriceId string
301 nullable: true
302 providerId integer($int32)
303 hotelName string
304 nullable: true
305 hotelCode string
306 nullable: true
307 nigths integer($int32)
308 mealPlan string
309 nullable: true
310 hotelClass string
311 nullable: true
312 availabilityType RoomAvailabilityTypeEnum[...]
313 availableRoomsCount integer($int32)
314 fewRooms boolean
315 roomCategoryCode string
316 nullable: true
317 roomCategoryName string
318 nullable: true
319 placementTypeName string
320 nullable: true
321 placementDescription string
322 nullable: true
323 checkInDate string($date-time)
324 checkOutDate string($date-time)
325 adults integer($int32)
326 children integer($int32)
327 districtUID string($uuid)
328 nullable: true
329 districtName string
330 nullable: true
331 cityUID string($uuid)
332 nullable: true
333 cityName string
334 nullable: true
335 countryCode string
336 nullable: true
337 countryName string
338 nullable: true
339 hasAlcohol boolean
340 hasFreeWifi boolean
341 hasMetro boolean
342 hasPool boolean
343 hasMall boolean
344 cancellationPolicyDescription string
345 nullable: true
346 cancellationPolicy CancellationPolicyExchange{
347 cancellationPolicyCode string
348 nullable: true
349 noShowChargeValue number($double)
350 nullable: true
351 noShowChargeValueType string
352 nullable: true
353 earlyDepartureChargeValue number($double)
354 nullable: true
355 earlyDepartureChargeValueType string
356 nullable: true
357 conditions [
358 nullable: true
359 CancellationPolicyConditionExchange{
360 timeunits integer($int32)
361 timeunitType string
362 nullable: true
363 timeOffsetTypeName string
364 nullable: true
365 chargeValue number($double)
366 nullable: true
367 chargeValueType string
368 nullable: true
369 }]
370 }
371 }
372 flight PackageFlight{
373 id string
374 nullable: true
375 departureDate string($date-time)
376 returnDate string($date-time)
377 nullable: true
378 departureTicketsLeft integer($int32)
379 returnTicketsLeft integer($int32)
380 departureAvailabilityType FlightAvailabilityTypestring
381 Enum:
382 [ OnRequest, FreeSale, FewPlaces, StopSale ]
383 returnAvailabilityType FlightAvailabilityTypestring
384 Enum:
385 [ OnRequest, FreeSale, FewPlaces, StopSale ]
386 isTwoWay boolean
387 departureSegments [
388 nullable: true
389 FlightSegment{
390 airlineCode string
391 nullable: true
392 airlineName string
393 nullable: true
394 flightCode string
395 nullable: true
396 class string
397 nullable: true
398 lugageWeight number($double)
399 handLugageWeight number($double)
400 departureFlightDate string($date-time)
401 departureCountryName string
402 nullable: true
403 departureCityName string
404 nullable: true
405 departureAirportCode string
406 nullable: true
407 departureAirportName string
408 nullable: true
409 departureTerminalCode string
410 nullable: true
411 arrivalFlightDate string($date-time)
412 arrivalCountryName string
413 nullable: true
414 arrivalCityName string
415 nullable: true
416 arrivalAirportCode string
417 nullable: true
418 arrivalAirportName string
419 nullable: true
420 arrivalTerminalCode string
421 nullable: true
422 flightDuration string
423 nullable: true
424 baggages [
425 nullable: true
426 Baggage{
427 baggageCode string
428 nullable: true
429 description string
430 nullable: true
431 price number($double)
432 currency string
433 nullable: true
434 included boolean
435 }]
436 }]
437 returnSegments [
438 nullable: true
439 FlightSegment{
440 airlineCode string
441 nullable: true
442 airlineName string
443 nullable: true
444 flightCode string
445 nullable: true
446 class string
447 nullable: true
448 lugageWeight number($double)
449 handLugageWeight number($double)
450 departureFlightDate string($date-time)
451 departureCountryName string
452 nullable: true
453 departureCityName string
454 nullable: true
455 departureAirportCode string
456 nullable: true
457 departureAirportName string
458 nullable: true
459 departureTerminalCode string
460 nullable: true
461 arrivalFlightDate string($date-time)
462 arrivalCountryName string
463 nullable: true
464 arrivalCityName string
465 nullable: true
466 arrivalAirportCode string
467 nullable: true
468 arrivalAirportName string
469 nullable: true
470 arrivalTerminalCode string
471 nullable: true
472 flightDuration string
473 nullable: true
474 baggages [
475 nullable: true
476 Baggage{
477 baggageCode string
478 nullable: true
479 description string
480 nullable: true
481 price number($double)
482 currency string
483 nullable: true
484 included boolean
485 }]
486 }]
487 }
488 extraServices [
489 nullable: true
490 HotelExtraServiceBase{
491 extraServiceCode string
492 nullable: true
493 extraServiceTypeCode string
494 nullable: true
495 isMandatory integer($int32)
496 extraServiceName string
497 nullable: true
498 minimalServiceAmount number($double)
499 includedPriceCode string
500 nullable: true
501 prices [
502 nullable: true
503 HotelExtraServicePriceBase{
504 extraServicePriceCode string
505 nullable: true
506 displayName string
507 nullable: true
508 restrictionInfo string
509 nullable: true
510 additionalInfo string
511 nullable: true
512 price number($double)
513 extraPrice number($double)
514 currency string
515 nullable: true
516 }]
517 }]
518 insurancePrice InsurancePrice{
519 name string
520 nullable: true
521 price number($double)
522 priceSurcarge number($double)
523 actualStartDate string($date-time)
524 actualEndDate string($date-time)
525 optional boolean
526 includedInPackagePrice boolean
527 }
528 }]
529 pagingId string
530 nullable: true
531 pageNumber integer($int64)
532 pageCount integer($int64)
533 }
534 {{/code}}