Wiki source code of 6. GetReservationDetails

Version 3.1 by Giorgi Mdivnishvili on 2024/04/11 06:44

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
8
9 This method is used to calculate full package with hotels and flights, to recheck prices, availability, prices and cancelation policy before book.
10
11
12 == Endpoint URL - [POST] ==
13
14 {{info}}
15 [[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservationDetails>>https://integration.kazunion.com/api/Reservations/GetReservationDetails]]
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 {"id":"3882a7ee-fec1-4bd3-9e73-ccc4613be36d"}
31 {{/code}}
32
33 (% class="wikigeneratedid" id="HRequestBodyexample" %)
34 (% id="cke_bm_10575S" style="display:none" %)
35
36
37
38 == Request Body example ==
39
40 {{code language="Json"}}
41 {"id":"3882a7ee-fec1-4bd3-9e73-ccc4613be36d"}
42 {{/code}}
43
44
45 == Response ==
46
47 {{code language="json"}}
48 {
49 "error": true,
50 "errorCode": "string",
51 "errorDescription": "string",
52 "userErrorDescription": "string",
53 "package": {
54 "cacheKey": "string",
55 "id": "string",
56 "priceCurrency": "string",
57 "totalPrice": 0,
58 "agentCommissionPercent": 0,
59 "agentCommissionAmount": 0,
60 "includedExtrasAmount": 0,
61 "priceDifference": 0,
62 "hotel": {
63 "hotelPriceId": "string",
64 "providerId": 0,
65 "hotelName": "string",
66 "hotelCode": "string",
67 "nigths": 0,
68 "mealPlan": "string",
69 "hotelClass": "string",
70 "availabilityType": "OnRequest",
71 "availableRoomsCount": 0,
72 "fewRooms": true,
73 "roomCategoryCode": "string",
74 "roomCategoryName": "string",
75 "placementTypeName": "string",
76 "placementDescription": "string",
77 "checkInDate": "2023-12-26T12:55:59.433Z",
78 "checkOutDate": "2023-12-26T12:55:59.433Z",
79 "adults": 0,
80 "children": 0,
81 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
82 "districtName": "string",
83 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84 "cityName": "string",
85 "countryCode": "string",
86 "countryName": "string",
87 "hasAlcohol": true,
88 "hasFreeWifi": true,
89 "hasMetro": true,
90 "hasPool": true,
91 "hasMall": true,
92 "cancellationPolicyDescription": "string",
93 "cancellationPolicy": {
94 "cancellationPolicyCode": "string",
95 "noShowChargeValue": 0,
96 "noShowChargeValueType": "string",
97 "earlyDepartureChargeValue": 0,
98 "earlyDepartureChargeValueType": "string",
99 "conditions": [
100 {
101 "timeunits": 0,
102 "timeunitType": "string",
103 "timeOffsetTypeName": "string",
104 "chargeValue": 0,
105 "chargeValueType": "string"
106 }
107 ]
108 }
109 },
110 "flight": {
111 "id": "string",
112 "departureDate": "2023-12-26T12:55:59.433Z",
113 "returnDate": "2023-12-26T12:55:59.433Z",
114 "departureTicketsLeft": 0,
115 "returnTicketsLeft": 0,
116 "departureAvailabilityType": "OnRequest",
117 "returnAvailabilityType": "OnRequest",
118 "isTwoWay": true,
119 "sameBaggageForAll": true,
120 "totalBaggage": true,
121 "departureSegments": [
122 {
123 "airlineCode": "string",
124 "airlineName": "string",
125 "flightCode": "string",
126 "class": "string",
127 "lugageWeight": 0,
128 "handLugageWeight": 0,
129 "departureFlightDate": "2023-12-26T12:55:59.433Z",
130 "departureCountryName": "string",
131 "departureCityName": "string",
132 "departureAirportCode": "string",
133 "departureAirportName": "string",
134 "departureTerminalCode": "string",
135 "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
136 "arrivalCountryName": "string",
137 "arrivalCityName": "string",
138 "arrivalAirportCode": "string",
139 "arrivalAirportName": "string",
140 "arrivalTerminalCode": "string",
141 "flightDuration": "string"
142 }
143 ],
144 "returnSegments": [
145 {
146 "airlineCode": "string",
147 "airlineName": "string",
148 "flightCode": "string",
149 "class": "string",
150 "lugageWeight": 0,
151 "handLugageWeight": 0,
152 "departureFlightDate": "2023-12-26T12:55:59.433Z",
153 "departureCountryName": "string",
154 "departureCityName": "string",
155 "departureAirportCode": "string",
156 "departureAirportName": "string",
157 "departureTerminalCode": "string",
158 "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
159 "arrivalCountryName": "string",
160 "arrivalCityName": "string",
161 "arrivalAirportCode": "string",
162 "arrivalAirportName": "string",
163 "arrivalTerminalCode": "string",
164 "flightDuration": "string"
165 }
166 ],
167 "passengers": [
168 {
169 "id": "string",
170 "isAdult": true,
171 "selectedForwardBaggageCode": "string",
172 "selectedBackwardBaggageCode": "string",
173 "forwardBaggages": [
174 {
175 "baggageCode": "string",
176 "description": "string",
177 "price": 0,
178 "currency": "string",
179 "included": true
180 }
181 ],
182 "backwardBaggages": [
183 {
184 "baggageCode": "string",
185 "description": "string",
186 "price": 0,
187 "currency": "string",
188 "included": true
189 }
190 ]
191 }
192 ]
193 },
194 "extraServices": [
195 {
196 "extraServiceCode": "string",
197 "extraServiceTypeCode": "string",
198 "isMandatory": 0,
199 "extraServiceName": "string",
200 "minimalServiceAmount": 0,
201 "includedPriceCode": "string",
202 "prices": [
203 {
204 "extraServicePriceCode": "string",
205 "displayName": "string",
206 "restrictionInfo": "string",
207 "additionalInfo": "string",
208 "price": 0,
209 "extraPrice": 0,
210 "currency": "string"
211 }
212 ]
213 }
214 ],
215 "insurancePrice": {
216 "name": "string",
217 "price": 0,
218 "priceSurcarge": 0,
219 "actualStartDate": "2023-12-26T12:55:59.433Z",
220 "actualEndDate": "2023-12-26T12:55:59.433Z",
221 "optional": true,
222 "includedInPackagePrice": true
223 }
224 },
225 "altPackages": [
226 {
227 "cacheKey": "string",
228 "id": "string",
229 "priceCurrency": "string",
230 "totalPrice": 0,
231 "agentCommissionPercent": 0,
232 "agentCommissionAmount": 0,
233 "includedExtrasAmount": 0,
234 "priceDifference": 0,
235 "hotel": {
236 "hotelPriceId": "string",
237 "providerId": 0,
238 "hotelName": "string",
239 "hotelCode": "string",
240 "nigths": 0,
241 "mealPlan": "string",
242 "hotelClass": "string",
243 "availabilityType": "OnRequest",
244 "availableRoomsCount": 0,
245 "fewRooms": true,
246 "roomCategoryCode": "string",
247 "roomCategoryName": "string",
248 "placementTypeName": "string",
249 "placementDescription": "string",
250 "checkInDate": "2023-12-26T12:55:59.433Z",
251 "checkOutDate": "2023-12-26T12:55:59.433Z",
252 "adults": 0,
253 "children": 0,
254 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
255 "districtName": "string",
256 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
257 "cityName": "string",
258 "countryCode": "string",
259 "countryName": "string",
260 "hasAlcohol": true,
261 "hasFreeWifi": true,
262 "hasMetro": true,
263 "hasPool": true,
264 "hasMall": true,
265 "cancellationPolicyDescription": "string",
266 "cancellationPolicy": {
267 "cancellationPolicyCode": "string",
268 "noShowChargeValue": 0,
269 "noShowChargeValueType": "string",
270 "earlyDepartureChargeValue": 0,
271 "earlyDepartureChargeValueType": "string",
272 "conditions": [
273 {
274 "timeunits": 0,
275 "timeunitType": "string",
276 "timeOffsetTypeName": "string",
277 "chargeValue": 0,
278 "chargeValueType": "string"
279 }
280 ]
281 }
282 },
283 "flight": {
284 "id": "string",
285 "departureDate": "2023-12-26T12:55:59.433Z",
286 "returnDate": "2023-12-26T12:55:59.433Z",
287 "departureTicketsLeft": 0,
288 "returnTicketsLeft": 0,
289 "departureAvailabilityType": "OnRequest",
290 "returnAvailabilityType": "OnRequest",
291 "isTwoWay": true,
292 "sameBaggageForAll": true,
293 "totalBaggage": true,
294 "departureSegments": [
295 {
296 "airlineCode": "string",
297 "airlineName": "string",
298 "flightCode": "string",
299 "class": "string",
300 "lugageWeight": 0,
301 "handLugageWeight": 0,
302 "departureFlightDate": "2023-12-26T12:55:59.433Z",
303 "departureCountryName": "string",
304 "departureCityName": "string",
305 "departureAirportCode": "string",
306 "departureAirportName": "string",
307 "departureTerminalCode": "string",
308 "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
309 "arrivalCountryName": "string",
310 "arrivalCityName": "string",
311 "arrivalAirportCode": "string",
312 "arrivalAirportName": "string",
313 "arrivalTerminalCode": "string",
314 "flightDuration": "string"
315 }
316 ],
317 "returnSegments": [
318 {
319 "airlineCode": "string",
320 "airlineName": "string",
321 "flightCode": "string",
322 "class": "string",
323 "lugageWeight": 0,
324 "handLugageWeight": 0,
325 "departureFlightDate": "2023-12-26T12:55:59.433Z",
326 "departureCountryName": "string",
327 "departureCityName": "string",
328 "departureAirportCode": "string",
329 "departureAirportName": "string",
330 "departureTerminalCode": "string",
331 "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
332 "arrivalCountryName": "string",
333 "arrivalCityName": "string",
334 "arrivalAirportCode": "string",
335 "arrivalAirportName": "string",
336 "arrivalTerminalCode": "string",
337 "flightDuration": "string"
338 }
339 ],
340 "passengers": [
341 {
342 "id": "string",
343 "isAdult": true,
344 "selectedForwardBaggageCode": "string",
345 "selectedBackwardBaggageCode": "string",
346 "forwardBaggages": [
347 {
348 "baggageCode": "string",
349 "description": "string",
350 "price": 0,
351 "currency": "string",
352 "included": true
353 }
354 ],
355 "backwardBaggages": [
356 {
357 "baggageCode": "string",
358 "description": "string",
359 "price": 0,
360 "currency": "string",
361 "included": true
362 }
363 ]
364 }
365 ]
366 },
367 "extraServices": [
368 {
369 "extraServiceCode": "string",
370 "extraServiceTypeCode": "string",
371 "isMandatory": 0,
372 "extraServiceName": "string",
373 "minimalServiceAmount": 0,
374 "includedPriceCode": "string",
375 "prices": [
376 {
377 "extraServicePriceCode": "string",
378 "displayName": "string",
379 "restrictionInfo": "string",
380 "additionalInfo": "string",
381 "price": 0,
382 "extraPrice": 0,
383 "currency": "string"
384 }
385 ]
386 }
387 ],
388 "insurancePrice": {
389 "name": "string",
390 "price": 0,
391 "priceSurcarge": 0,
392 "actualStartDate": "2023-12-26T12:55:59.433Z",
393 "actualEndDate": "2023-12-26T12:55:59.433Z",
394 "optional": true,
395 "includedInPackagePrice": true
396 }
397 }
398 ],
399 "refreshPriceResult": "Success"
400 }
401 {{/code}}
402
403
404 === Response example ===
405
406 {{code language="Json"}}
407 {
408 "reservation": {
409 "id": "3882a7ee-fec1-4bd3-9e73-ccc4613be36d",
410 "rfNumber": "314303 / 104429",
411 "contactNumber": "teeeest, for testing purpose !, Contact Number: 597101803",
412 "agentName": "Mr. Giorgi Mdivnishvili",
413 "totalPrice": 782,
414 "agentCommission": 0,
415 "currency": "USD",
416 "tourists": [
417 {
418 "id": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
419 "gender": "Male",
420 "ageCategory": "Adult",
421 "firstName": "Teeeeest",
422 "lastName": "Teest",
423 "birthDate": "1990-09-23T00:00:00.000",
424 "passportNumber": "1231233",
425 "passportExpiryDate": "2029-12-23T00:00:00.000",
426 "citizenshipCountryCode": "GE",
427 "citizenshipCountryName": "Georgia",
428 "arrivalDate": "2024-05-17T07:10:00.000",
429 "arrivalFlightNumber": "FZ1722",
430 "arrivalTerminalCode": "DXB3",
431 "returnDate": "2024-05-21T21:25:00.000",
432 "returnFlightNumber": "FZ1721",
433 "returnTerminalCode": "DXB3",
434 "showReturn": true
435 },
436 {
437 "id": "27977a19-045e-4990-95a8-fbd7d49083de",
438 "gender": "Male",
439 "ageCategory": "Adult",
440 "firstName": "Test",
441 "lastName": "Teeeest",
442 "birthDate": "1990-09-23T00:00:00.000",
443 "passportNumber": "123123",
444 "passportExpiryDate": "2029-12-23T00:00:00.000",
445 "citizenshipCountryCode": "GE",
446 "citizenshipCountryName": "Georgia",
447 "arrivalDate": "2024-05-17T07:10:00.000",
448 "arrivalFlightNumber": "FZ1722",
449 "arrivalTerminalCode": "DXB3",
450 "returnDate": "2024-05-21T21:25:00.000",
451 "returnFlightNumber": "FZ1721",
452 "returnTerminalCode": "DXB3",
453 "showReturn": true
454 }
455 ],
456 "hotels": [
457 {
458 "id": "b768a900-bfc5-4dc4-958a-47a3bf92b6f8",
459 "hotelName": "Ibis Al Rigga",
460 "cityName": "Dubai",
461 "hotelClass": "3",
462 "checkInDate": "2024-05-17T00:00:00.000",
463 "checkOutDate": "2024-05-21T00:00:00.000",
464 "roomCategoryName": "Standard room with 1 double bed",
465 "placementName": "DBL",
466 "mealPlan": "RO"
467 }
468 ],
469 "flights": [
470 {
471 "id": "5720af80-17de-4913-94c5-2e019c9fbb9c",
472 "isArrival": true,
473 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
474 "touristName": "Teeeeest Teest",
475 "date": "2024-05-17T07:10:00.000",
476 "departureAirport": "ALA",
477 "departureTerminal": "ALA",
478 "arrivalAirport": "DXB",
479 "arrivalTerminal": "DXB3",
480 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
481 },
482 {
483 "id": "81fce7ff-b359-46ea-ae66-1c41af7c347a",
484 "isArrival": false,
485 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
486 "touristName": "Teeeeest Teest",
487 "date": "2024-05-21T21:25:00.000",
488 "departureAirport": "DXB",
489 "departureTerminal": "DXB3",
490 "arrivalAirport": "ALA",
491 "arrivalTerminal": "ALA",
492 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
493 },
494 {
495 "id": "215d3de6-8969-4265-97bd-3d716a0d4415",
496 "isArrival": true,
497 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
498 "touristName": "Test Teeeest",
499 "date": "2024-05-17T07:10:00.000",
500 "departureAirport": "ALA",
501 "departureTerminal": "ALA",
502 "arrivalAirport": "DXB",
503 "arrivalTerminal": "DXB3",
504 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
505 },
506 {
507 "id": "8c6b26b3-5bb2-4fb9-b89c-2568b1f74b64",
508 "isArrival": false,
509 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
510 "touristName": "Test Teeeest",
511 "date": "2024-05-21T21:25:00.000",
512 "departureAirport": "DXB",
513 "departureTerminal": "DXB3",
514 "arrivalAirport": "ALA",
515 "arrivalTerminal": "ALA",
516 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
517 }
518 ],
519 "transfers": [
520 {
521 "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0",
522 "transferType": "ARRIVAL",
523 "vehicleName": "GROUP",
524 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
525 "touristName": "Teeeeest Teest",
526 "date": "2024-05-17T00:00:00.000",
527 "fromTerminal": "DXB",
528 "fromCityName": "Dubai",
529 "toHotelName": "Ibis Al Rigga",
530 "toCityName": "Dubai",
531 "note": "teeeest, for testing purpose !, Contact Number: 597101803"
532 },
533 {
534 "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32",
535 "transferType": "DEPARTURE",
536 "vehicleName": "GROUP",
537 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
538 "touristName": "Teeeeest Teest",
539 "date": "2024-05-21T00:00:00.000",
540 "fromCityName": "Dubai",
541 "fromHotelName": "Ibis Al Rigga",
542 "toTerminal": "DXB",
543 "toCityName": "Dubai"
544 },
545 {
546 "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0",
547 "transferType": "ARRIVAL",
548 "vehicleName": "GROUP",
549 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
550 "touristName": "Test Teeeest",
551 "date": "2024-05-17T00:00:00.000",
552 "fromTerminal": "DXB",
553 "fromCityName": "Dubai",
554 "toHotelName": "Ibis Al Rigga",
555 "toCityName": "Dubai",
556 "note": "teeeest, for testing purpose !, Contact Number: 597101803"
557 },
558 {
559 "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32",
560 "transferType": "DEPARTURE",
561 "vehicleName": "GROUP",
562 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
563 "touristName": "Test Teeeest",
564 "date": "2024-05-21T00:00:00.000",
565 "fromCityName": "Dubai",
566 "fromHotelName": "Ibis Al Rigga",
567 "toTerminal": "DXB",
568 "toCityName": "Dubai"
569 }
570 ],
571 "services": [
572 {
573 "id": "4c5d1e9c-2b87-4ec8-9bd8-96a270419322",
574 "serviceDate": "2024-05-17T07:10:00.000",
575 "serviceName": "Insurance",
576 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
577 "touristName": "Test Teeeest"
578 },
579 {
580 "id": "1e1ad6a2-ee59-4c8c-868c-34a25343e7ca",
581 "serviceDate": "2024-05-17T07:10:00.000",
582 "serviceName": "Insurance",
583 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
584 "touristName": "Teeeeest Teest"
585 }
586 ]
587 }
588 }
589 {{/code}}
590
591
592 === Schema ===
593
594 {{success}}
595 GetReservationDetailsResponse{
596
597 |reservation|ReservationDetails{(((
598 |id|string($uuid)
599 |rfNumber|string
600 nullable: true
601 |contactNumber|string
602 nullable: true
603 |agentName|string
604 nullable: true
605 |totalPrice|number($double)
606 |agentCommission|number($double)
607 |netPrice|number($double)
608 nullable: true
609 |currency|string
610 nullable: true
611 |tourists|[
612 nullable: trueResDetailsTourist{(((
613 |id|string($uuid)
614 |gender|GenderEnumstringEnum:
615 [ None, Male, Female ]
616 |ageCategory|AgeCategorystringEnum:
617 [ Adult, Infant, Child ]
618 |firstName|string
619 nullable: true
620 |lastName|string
621 nullable: true
622 |birthDate|string($date-time)
623 nullable: true
624 |passportNumber|string
625 nullable: true
626 |passportExpiryDate|string($date-time)
627 nullable: true
628 |tin|string
629 nullable: true
630 |citizenshipCountryCode|string
631 nullable: true
632 |citizenshipCountryName|string
633 nullable: true
634 |mobile|string
635 nullable: true
636 |email|string
637 nullable: true
638 |arrivalDate|string($date-time)
639 nullable: true
640 |arrivalFlightNumber|string
641 nullable: true
642 |arrivalTerminalCode|string
643 nullable: true
644 |returnDate|string($date-time)
645 nullable: true
646 |returnFlightNumber|string
647 nullable: true
648 |returnTerminalCode|string
649 nullable: true
650 |showReturn|boolean
651
652 }]
653 )))
654 |hotels|[
655 nullable: trueResDetailsHotel{(((
656 |id|string($uuid)
657 |hotelName|string
658 nullable: true
659 |cityName|string
660 nullable: true
661 |hotelClass|string
662 nullable: true
663 |checkInDate|string($date-time)
664 |checkOutDate|string($date-time)
665 |roomCategoryName|string
666 nullable: true
667 |placementName|string
668 nullable: true
669 |mealPlan|string
670 nullable: true
671 |agentConfirmationNumber|string
672 nullable: true
673
674 }]
675 )))
676 |flights|[
677 nullable: trueResDetailsFlight{(((
678 |id|string($uuid)
679 |isArrival|boolean
680 |touristId|string($uuid)
681 |touristName|string
682 nullable: true
683 |date|string($date-time)
684 |departureAirport|string
685 nullable: true
686 |departureTerminal|string
687 nullable: true
688 |arrivalAirport|string
689 nullable: true
690 |arrivalTerminal|string
691 nullable: true
692 |agentConfirmationNumber|string
693 nullable: true
694 |bookingConfirmationNumber|string
695 nullable: true
696 |note|string
697 nullable: true
698
699 }]
700 )))
701 |transfers|[
702 nullable: trueResDetailsTransfer{(((
703 |id|string($uuid)
704 |transferType|string
705 nullable: true
706 |vehicleName|string
707 nullable: true
708 |touristId|string($uuid)
709 |touristName|string
710 nullable: true
711 |date|string($date-time)
712 |fromTerminal|string
713 nullable: true
714 |fromCityName|string
715 nullable: true
716 |fromHotelName|string
717 nullable: true
718 |toHotelName|string
719 nullable: true
720 |toTerminal|string
721 nullable: true
722 |toCityName|string
723 nullable: true
724 |agentConfirmationNumber|string
725 nullable: true
726 |note|string
727 nullable: true
728
729 }]
730 )))
731 |services|[
732 nullable: trueResDetailsService{(((
733 |id|string($uuid)
734 |serviceDate|string($date-time)
735 |serviceName|string
736 nullable: true
737 |touristId|string($uuid)
738 |touristName|string
739 nullable: true
740 |note|string
741 nullable: true
742
743 }]
744 )))
745
746 }
747 )))
748
749 }
750 {{/success}}