Wiki source code of Schemas General

Version 7.1 by Giorgi Mdivnishvili on 2023/12/15 14:19

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = AgeCategory =
6
7 {{info}}
8 [ Adult, Infant, Child ]
9 {{/info}}
10
11
12 = Airline =
13
14 {{info}}
15 {
16
17 |airlineCode|string
18 nullable: true
19 readOnly: true
20 |iataCode|string
21 nullable: true
22 |icaoCode|string
23 nullable: true
24 |airlineName|string
25 nullable: true
26 |note|string
27 nullable: true
28 |infantMaxAge|number($double)
29 |childMaxAge|number($double)
30
31 }
32 {{/info}}
33
34
35 = AuthRequest =
36
37 {{info}}
38 {
39
40 |login|string
41 nullable: true
42 |password|string
43 nullable: true
44
45 }
46 {{/info}}
47
48
49 = AuthResponse =
50
51 {{info}}
52 {
53
54 |accessToken|string
55 nullable: true
56
57 }
58 {{/info}}
59
60
61 = Baggage =
62
63 {{info}}
64 {
65
66 |baggageCode|string
67 nullable: true
68 |description|string
69 nullable: true
70 |price|number($double)
71 |currency|string
72 nullable: true
73 |included|boolean
74
75 }
76 {{/info}}
77
78
79 = CalcOnlyAviaPackageRequest =
80
81 {{info}}
82 {
83
84 |packageId|string
85 nullable: true
86
87 }
88 {{/info}}
89
90
91 = CalcOnlyAviaPackageResponse =
92
93 {{info}}
94 {
95
96 |error|boolean
97 |errorCode|string
98 nullable: true
99 |errorDescription|string
100 nullable: true
101 |userErrorDescription|string
102 nullable: true
103 |package|OnlyAviaPackage{(((
104 |id|string
105 nullable: true
106 |priceCurrency|string
107 nullable: true
108 |totalPrice|number($double)
109 |flight|PackageFlight{(((
110 |id|string
111 nullable: true
112 |departureDate|string($date-time)
113 |returnDate|string($date-time)
114 nullable: true
115 |departureTicketsLeft|integer($int32)
116 |returnTicketsLeft|integer($int32)
117 |departureAvailabilityType|FlightAvailabilityTypestringEnum:
118 [ OnRequest, FreeSale, FewPlaces, StopSale ]
119 |returnAvailabilityType|FlightAvailabilityTypestringEnum:
120 [ OnRequest, FreeSale, FewPlaces, StopSale ]
121 |isTwoWay|boolean
122 |departureSegments|[
123 nullable: trueFlightSegment{(((
124 |airlineCode|string
125 nullable: true
126 |airlineName|string
127 nullable: true
128 |flightCode|string
129 nullable: true
130 |class|string
131 nullable: true
132 |lugageWeight|number($double)
133 |handLugageWeight|number($double)
134 |departureFlightDate|string($date-time)
135 |departureCountryName|string
136 nullable: true
137 |departureCityName|string
138 nullable: true
139 |departureAirportCode|string
140 nullable: true
141 |departureAirportName|string
142 nullable: true
143 |departureTerminalCode|string
144 nullable: true
145 |arrivalFlightDate|string($date-time)
146 |arrivalCountryName|string
147 nullable: true
148 |arrivalCityName|string
149 nullable: true
150 |arrivalAirportCode|string
151 nullable: true
152 |arrivalAirportName|string
153 nullable: true
154 |arrivalTerminalCode|string
155 nullable: true
156 |flightDuration|string
157 nullable: true
158 |baggages|[
159 nullable: trueBaggage{(((
160 |baggageCode|string
161 nullable: true
162 |description|string
163 nullable: true
164 |price|number($double)
165 |currency|string
166 nullable: true
167 |included|boolean
168
169 }]
170 )))
171
172 }]
173 )))
174 |returnSegments|[
175 nullable: trueFlightSegment{(((
176 |airlineCode|string
177 nullable: true
178 |airlineName|string
179 nullable: true
180 |flightCode|string
181 nullable: true
182 |class|string
183 nullable: true
184 |lugageWeight|number($double)
185 |handLugageWeight|number($double)
186 |departureFlightDate|string($date-time)
187 |departureCountryName|string
188 nullable: true
189 |departureCityName|string
190 nullable: true
191 |departureAirportCode|string
192 nullable: true
193 |departureAirportName|string
194 nullable: true
195 |departureTerminalCode|string
196 nullable: true
197 |arrivalFlightDate|string($date-time)
198 |arrivalCountryName|string
199 nullable: true
200 |arrivalCityName|string
201 nullable: true
202 |arrivalAirportCode|string
203 nullable: true
204 |arrivalAirportName|string
205 nullable: true
206 |arrivalTerminalCode|string
207 nullable: true
208 |flightDuration|string
209 nullable: true
210 |baggages|[
211 nullable: trueBaggage{(((
212 |baggageCode|string
213 nullable: true
214 |description|string
215 nullable: true
216 |price|number($double)
217 |currency|string
218 nullable: true
219 |included|boolean
220
221 }]
222 )))
223
224 }]
225 )))
226
227 }
228 )))
229
230 }
231 )))
232
233 }
234 {{/info}}
235
236
237 = CalcOnlyHotelPackageRequest =
238
239 {{info}}
240 {
241
242 |packageId|string
243 nullable: true
244 |extraServicePriceCodes|[
245 nullable: truestring]
246
247 }
248 {{/info}}
249
250
251 = CalcOnlyHotelPackageResponse =
252
253 {{info}}
254 {
255
256 |error|boolean
257 |errorCode|string
258 nullable: true
259 |errorDescription|string
260 nullable: true
261 |userErrorDescription|string
262 nullable: true
263 |package|OnlyHotelPackage{(((
264 |id|string
265 nullable: true
266 |priceCurrency|string
267 nullable: true
268 |totalPrice|number($double)
269 |agentCommissionPercent|number($double)
270 |agentCommissionAmount|number($double)
271 |hotel|PackageHotel{(((
272 |hotelPriceId|string
273 nullable: true
274 |providerId|integer($int32)
275 |hotelName|string
276 nullable: true
277 |hotelCode|string
278 nullable: true
279 |nigths|integer($int32)
280 |mealPlan|string
281 nullable: true
282 |hotelClass|string
283 nullable: true
284 |availabilityType|RoomAvailabilityTypeEnumstringEnum:
285 [ OnRequest, FreeSale, StopSale ]
286 |availableRoomsCount|integer($int32)
287 |fewRooms|boolean
288 |roomCategoryCode|string
289 nullable: true
290 |roomCategoryName|string
291 nullable: true
292 |placementTypeName|string
293 nullable: true
294 |placementDescription|string
295 nullable: true
296 |checkInDate|string($date-time)
297 |checkOutDate|string($date-time)
298 |adults|integer($int32)
299 |children|integer($int32)
300 |districtUID|string($uuid)
301 nullable: true
302 |districtName|string
303 nullable: true
304 |cityUID|string($uuid)
305 nullable: true
306 |cityName|string
307 nullable: true
308 |countryCode|string
309 nullable: true
310 |countryName|string
311 nullable: true
312 |hasAlcohol|boolean
313 |hasFreeWifi|boolean
314 |hasMetro|boolean
315 |hasPool|boolean
316 |hasMall|boolean
317 |cancellationPolicyDescription|string
318 nullable: true
319 |cancellationPolicy|CancellationPolicyExchange{(((
320 |cancellationPolicyCode|string
321 nullable: true
322 |noShowChargeValue|number($double)
323 nullable: true
324 |noShowChargeValueType|string
325 nullable: true
326 |earlyDepartureChargeValue|number($double)
327 nullable: true
328 |earlyDepartureChargeValueType|string
329 nullable: true
330 |conditions|[
331 nullable: trueCancellationPolicyConditionExchange{(((
332 |timeunits|integer($int32)
333 |timeunitType|string
334 nullable: true
335 |timeOffsetTypeName|string
336 nullable: true
337 |chargeValue|number($double)
338 nullable: true
339 |chargeValueType|string
340 nullable: true
341
342 }]
343 )))
344
345 }
346 )))
347
348 }
349 )))
350 |extraServices|[
351 nullable: trueHotelExtraServiceBase{(((
352 |extraServiceCode|string
353 nullable: true
354 |extraServiceTypeCode|string
355 nullable: true
356 |isMandatory|integer($int32)
357 |extraServiceName|string
358 nullable: true
359 |minimalServiceAmount|number($double)
360 |includedPriceCode|string
361 nullable: true
362 |prices|[
363 nullable: trueHotelExtraServicePriceBase{(((
364 |extraServicePriceCode|string
365 nullable: true
366 |displayName|string
367 nullable: true
368 |restrictionInfo|string
369 nullable: true
370 |additionalInfo|string
371 nullable: true
372 |price|number($double)
373 |extraPrice|number($double)
374 |currency|string
375 nullable: true
376
377 }]
378 )))
379
380 }]
381 )))
382
383 }
384 )))
385
386 }
387 {{/info}}
388
389
390 = CalcTourPackageRequest =
391
392 {{info}}
393 {
394
395 |packageId|string
396 nullable: true
397 |extraServicePriceCodes|[
398 nullable: truestring]
399 |includeInsurance|boolean
400
401 }
402 {{/info}}
403
404
405 = CalcTourPackageResponse =
406
407 {{info}}
408 {
409
410 |error|boolean
411 |errorCode|string
412 nullable: true
413 |errorDescription|string
414 nullable: true
415 |userErrorDescription|string
416 nullable: true
417 |package|TourPackage{(((
418 |cacheKey|string
419 nullable: true
420 |id|string
421 nullable: true
422 |priceCurrency|string
423 nullable: true
424 |totalPrice|number($double)
425 |agentCommissionPercent|number($double)
426 |agentCommissionAmount|number($double)
427 |includedExtrasAmount|number($double)
428 |priceDifference|number($double)
429 |hotel|PackageHotel{(((
430 |hotelPriceId|string
431 nullable: true
432 |providerId|integer($int32)
433 |hotelName|string
434 nullable: true
435 |hotelCode|string
436 nullable: true
437 |nigths|integer($int32)
438 |mealPlan|string
439 nullable: true
440 |hotelClass|string
441 nullable: true
442 |availabilityType|RoomAvailabilityTypeEnum[...]
443 |availableRoomsCount|integer($int32)
444 |fewRooms|boolean
445 |roomCategoryCode|string
446 nullable: true
447 |roomCategoryName|string
448 nullable: true
449 |placementTypeName|string
450 nullable: true
451 |placementDescription|string
452 nullable: true
453 |checkInDate|string($date-time)
454 |checkOutDate|string($date-time)
455 |adults|integer($int32)
456 |children|integer($int32)
457 |districtUID|string($uuid)
458 nullable: true
459 |districtName|string
460 nullable: true
461 |cityUID|string($uuid)
462 nullable: true
463 |cityName|string
464 nullable: true
465 |countryCode|string
466 nullable: true
467 |countryName|string
468 nullable: true
469 |hasAlcohol|boolean
470 |hasFreeWifi|boolean
471 |hasMetro|boolean
472 |hasPool|boolean
473 |hasMall|boolean
474 |cancellationPolicyDescription|string
475 nullable: true
476 |cancellationPolicy|CancellationPolicyExchange{(((
477 |cancellationPolicyCode|string
478 nullable: true
479 |noShowChargeValue|number($double)
480 nullable: true
481 |noShowChargeValueType|string
482 nullable: true
483 |earlyDepartureChargeValue|number($double)
484 nullable: true
485 |earlyDepartureChargeValueType|string
486 nullable: true
487 |conditions|[
488 nullable: trueCancellationPolicyConditionExchange{(((
489 |timeunits|integer($int32)
490 |timeunitType|string
491 nullable: true
492 |timeOffsetTypeName|string
493 nullable: true
494 |chargeValue|number($double)
495 nullable: true
496 |chargeValueType|string
497 nullable: true
498
499 }]
500 )))
501
502 }
503 )))
504
505 }
506 )))
507 |flight|PackageFlight{(((
508 |id|string
509 nullable: true
510 |departureDate|string($date-time)
511 |returnDate|string($date-time)
512 nullable: true
513 |departureTicketsLeft|integer($int32)
514 |returnTicketsLeft|integer($int32)
515 |departureAvailabilityType|FlightAvailabilityTypestringEnum:
516 [ OnRequest, FreeSale, FewPlaces, StopSale ]
517 |returnAvailabilityType|FlightAvailabilityTypestringEnum:
518 [ OnRequest, FreeSale, FewPlaces, StopSale ]
519 |isTwoWay|boolean
520 |departureSegments|[
521 nullable: trueFlightSegment{(((
522 |airlineCode|string
523 nullable: true
524 |airlineName|string
525 nullable: true
526 |flightCode|string
527 nullable: true
528 |class|string
529 nullable: true
530 |lugageWeight|number($double)
531 |handLugageWeight|number($double)
532 |departureFlightDate|string($date-time)
533 |departureCountryName|string
534 nullable: true
535 |departureCityName|string
536 nullable: true
537 |departureAirportCode|string
538 nullable: true
539 |departureAirportName|string
540 nullable: true
541 |departureTerminalCode|string
542 nullable: true
543 |arrivalFlightDate|string($date-time)
544 |arrivalCountryName|string
545 nullable: true
546 |arrivalCityName|string
547 nullable: true
548 |arrivalAirportCode|string
549 nullable: true
550 |arrivalAirportName|string
551 nullable: true
552 |arrivalTerminalCode|string
553 nullable: true
554 |flightDuration|string
555 nullable: true
556 |baggages|[
557 nullable: trueBaggage{(((
558 |baggageCode|string
559 nullable: true
560 |description|string
561 nullable: true
562 |price|number($double)
563 |currency|string
564 nullable: true
565 |included|boolean
566
567 }]
568 )))
569
570 }]
571 )))
572 |returnSegments|[
573 nullable: trueFlightSegment{(((
574 |airlineCode|string
575 nullable: true
576 |airlineName|string
577 nullable: true
578 |flightCode|string
579 nullable: true
580 |class|string
581 nullable: true
582 |lugageWeight|number($double)
583 |handLugageWeight|number($double)
584 |departureFlightDate|string($date-time)
585 |departureCountryName|string
586 nullable: true
587 |departureCityName|string
588 nullable: true
589 |departureAirportCode|string
590 nullable: true
591 |departureAirportName|string
592 nullable: true
593 |departureTerminalCode|string
594 nullable: true
595 |arrivalFlightDate|string($date-time)
596 |arrivalCountryName|string
597 nullable: true
598 |arrivalCityName|string
599 nullable: true
600 |arrivalAirportCode|string
601 nullable: true
602 |arrivalAirportName|string
603 nullable: true
604 |arrivalTerminalCode|string
605 nullable: true
606 |flightDuration|string
607 nullable: true
608 |baggages|[
609 nullable: trueBaggage{(((
610 |baggageCode|string
611 nullable: true
612 |description|string
613 nullable: true
614 |price|number($double)
615 |currency|string
616 nullable: true
617 |included|boolean
618
619 }]
620 )))
621
622 }]
623 )))
624
625 }
626 )))
627 |extraServices|[
628 nullable: trueHotelExtraServiceBase{(((
629 |extraServiceCode|string
630 nullable: true
631 |extraServiceTypeCode|string
632 nullable: true
633 |isMandatory|integer($int32)
634 |extraServiceName|string
635 nullable: true
636 |minimalServiceAmount|number($double)
637 |includedPriceCode|string
638 nullable: true
639 |prices|[
640 nullable: trueHotelExtraServicePriceBase{(((
641 |extraServicePriceCode|string
642 nullable: true
643 |displayName|string
644 nullable: true
645 |restrictionInfo|string
646 nullable: true
647 |additionalInfo|string
648 nullable: true
649 |price|number($double)
650 |extraPrice|number($double)
651 |currency|string
652 nullable: true
653
654 }]
655 )))
656
657 }]
658 )))
659 |insurancePrice|InsurancePrice{(((
660 |name|string
661 nullable: true
662 |price|number($double)
663 |priceSurcarge|number($double)
664 |actualStartDate|string($date-time)
665 |actualEndDate|string($date-time)
666 |optional|boolean
667 |includedInPackagePrice|boolean
668
669 }
670 )))
671
672 }
673 )))
674
675 }
676 {{/info}}
677
678
679 = CancellationPolicyConditionExchange =
680
681 {{info}}
682 {
683
684 |timeunits|integer($int32)
685 |timeunitType|string
686 nullable: true
687 |timeOffsetTypeName|string
688 nullable: true
689 |chargeValue|number($double)
690 nullable: true
691 |chargeValueType|string
692 nullable: true
693
694 }
695 {{/info}}
696
697
698 = CancellationPolicyExchange =
699
700 {{info}}
701 {
702
703 |cancellationPolicyCode|string
704 nullable: true
705 |noShowChargeValue|number($double)
706 nullable: true
707 |noShowChargeValueType|string
708 nullable: true
709 |earlyDepartureChargeValue|number($double)
710 nullable: true
711 |earlyDepartureChargeValueType|string
712 nullable: true
713 |conditions|[
714 nullable: trueCancellationPolicyConditionExchange{(((
715 |timeunits|integer($int32)
716 |timeunitType|string
717 nullable: true
718 |timeOffsetTypeName|string
719 nullable: true
720 |chargeValue|number($double)
721 nullable: true
722 |chargeValueType|string
723 nullable: true
724
725 }]
726 )))
727
728 }
729 {{/info}}
730
731
732 = City =
733
734 {{info}}
735 {
736
737 |cityUID|string($uuid)
738 |cityName|string
739 nullable: true
740 |state|string
741 nullable: true
742 |note|string
743 nullable: true
744 |countryCode|string
745 nullable: true
746 |iataCode|string
747 nullable: true
748 |timeZoneOffset|integer($int32)
749 nullable: true
750
751 }
752 {{/info}}
753
754
755 = CitySelectorOption =
756
757 {{info}}
758 {
759
760 |value|string
761 nullable: true
762 |text|string
763 nullable: true
764 |countryCode|string
765 nullable: true
766
767 }
768 {{/info}}
769
770
771 = Country =
772
773 {{info}}
774 {
775
776 |countryCode|string
777 nullable: true
778 readOnly: true
779 |countryName|string
780 nullable: true
781 |note|string
782 nullable: true
783 |phoneCode|string
784 nullable: true
785 |isO2|string
786 nullable: true
787 |isO3|string
788 nullable: true
789 |status|integer($int32)
790 |sortingOrder|integer($int32)
791 |sellCurrency|string
792 nullable: true
793
794 }
795 {{/info}}
796
797
798 = Currency =
799
800 {{info}}
801 {
802
803 |code|string
804 nullable: true
805 |symbol|string
806 nullable: true
807
808 }
809 {{/info}}
810
811
812 = District =
813
814 {{info}}
815 {
816
817 |districtUID|string($uuid)
818 |districtName|string
819 nullable: true
820 |note|string
821 nullable: true
822 |cityUID|string($uuid)
823 |countryCode|string
824 nullable: true
825
826 }
827 {{/info}}
828
829
830 = Hotel =
831
832 {{info}}
833 {
834
835 |hotelCode|string
836 nullable: true
837 |hotelName|string
838 nullable: true
839 |hotelClass|string
840 nullable: true
841 |cityUID|string($uuid)
842 nullable: true
843 |countryCode|string
844 nullable: true
845 |countryName|string
846 nullable: true
847 |districtUID|string($uuid)
848 nullable: true
849 |cityName|string
850 nullable: true
851 |districtName|string
852 nullable: true
853 |hotelType|HotelTypeEnumstringEnum:
854 [ CityHotel, BeachHotel, SecondLineBeach ]
855 |latitude|string
856 nullable: true
857 |longitude|string
858 nullable: true
859 |hasAlcohol|boolean
860 |hasFreeWifi|boolean
861 |hasMetro|boolean
862 |hasPool|boolean
863 |hasMall|boolean
864
865 }
866 {{/info}}
867
868
869 = HotelExtraServiceBase =
870
871 {{info}}
872 {
873
874 |extraServiceCode|string
875 nullable: true
876 |extraServiceTypeCode|string
877 nullable: true
878 |isMandatory|integer($int32)
879 |extraServiceName|string
880 nullable: true
881 |minimalServiceAmount|number($double)
882 |includedPriceCode|string
883 nullable: true
884 |prices|[
885 nullable: trueHotelExtraServicePriceBase{(((
886 |extraServicePriceCode|string
887 nullable: true
888 |displayName|string
889 nullable: true
890 |restrictionInfo|string
891 nullable: true
892 |additionalInfo|string
893 nullable: true
894 |price|number($double)
895 |extraPrice|number($double)
896 |currency|string
897 nullable: true
898
899 }]
900 )))
901
902 }
903 {{/info}}
904
905
906 = HotelExtraServicePriceBase =
907
908 {{info}}
909 {
910
911 |extraServicePriceCode|string
912 nullable: true
913 |displayName|string
914 nullable: true
915 |restrictionInfo|string
916 nullable: true
917 |additionalInfo|string
918 nullable: true
919 |price|number($double)
920 |extraPrice|number($double)
921 |currency|string
922 nullable: true
923
924 }
925 {{/info}}
926
927
928 = HotelServiceEnum =
929
930 {{info}}
931 stringEnum:
932 [ HasAlcohol, HasFreeWifi, HasMetro, HasPool, HasMall ]Type your information message here.
933 {{/info}}
934
935
936 = HotelType =
937
938 {{info}}
939 {
940
941 |categoryId|integer($int32)
942 |displayName|string
943 nullable: true
944
945 }
946 {{/info}}
947
948
949 = HotelTypeEnum =
950
951 {{info}}
952 stringEnum:
953 [ CityHotel, BeachHotel, SecondLineBeach ]
954 {{/info}}
955
956