Changes for page 5. ConfirmCheckout

Last modified by Giorgi Mdivnishvili on 2024/08/30 12:58

From version 6.1
edited by Giorgi Mdivnishvili
on 2024/04/11 09:19
Change comment: There is no comment for this version
To version 10.1
edited by Giorgi Mdivnishvili
on 2024/04/11 13:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -990,7 +990,7 @@
990 990  === Schema ===
991 991  
992 992  {{success}}
993 -CalcOnlyHotelPackageResponse{
993 +CheckoutFormOut{
994 994  
995 995  |error|boolean
996 996  |errorCode|string
... ... @@ -999,128 +999,287 @@
999 999  nullable: true
1000 1000  |userErrorDescription|string
1001 1001  nullable: true
1002 -|package|OnlyHotelPackage{(((
1003 -|id|string
1004 -nullable: true
1005 1005  |priceCurrency|string
1006 1006  nullable: true
1007 1007  |totalPrice|number($double)
1008 1008  |agentCommissionPercent|number($double)
1009 1009  |agentCommissionAmount|number($double)
1010 -|hotel|PackageHotel{(((
1007 +|requiredCitizenIdentifiers|[
1008 +nullable: trueCitizenIdentifier{(((
1009 +|countryCode|string
1010 +nullable: true
1011 +|identifierType|IdentifierTypeEnumstringEnum:
1012 +[ TIN, FIN ]
1013 +
1014 +}]
1015 +)))
1016 +|hotels|[
1017 +nullable: trueCheckoutHotelOut{(((
1011 1011  |hotelPriceId|string
1012 1012  nullable: true
1013 -|providerId|integer($int32)
1014 -|hotelName|string
1020 +|touristIds|[
1021 +nullable: truestring($uuid)]
1022 +|errorCode|string
1015 1015  nullable: true
1016 -|hotelCode|string
1024 +|errorMessage|string
1017 1017  nullable: true
1018 -|nigths|integer($int32)
1019 -|mealPlan|string
1026 +|description|string
1020 1020  nullable: true
1021 -|hotelClass|string
1028 +
1029 +}]
1030 +)))
1031 +|tourists|[
1032 +nullable: trueCheckoutTouristOut{(((
1033 +|id|string($uuid)
1034 +|age|integer($int32)
1022 1022  nullable: true
1023 -|availabilityType|RoomAvailabilityTypeEnumstringEnum:
1024 -[ OnRequest, FreeSale, StopSale ]
1025 -|availableRoomsCount|integer($int32)
1026 -|fewRooms|boolean
1027 -|roomCategoryCode|string
1036 +|isAdult|boolean
1037 +|flightIds|[
1038 +nullable: truestring]
1039 +|flights|[
1040 +nullable: trueCheckoutFlightOut{(((
1041 +|flightId|string
1028 1028  nullable: true
1029 -|roomCategoryName|string
1043 +|note|string
1030 1030  nullable: true
1031 -|placementTypeName|string
1045 +
1046 +}]
1047 +)))
1048 +|arrivalFlightInfo|ManualFlightInfo{(((
1049 +|flightNumber|string
1032 1032  nullable: true
1033 -|placementDescription|string
1051 +|terminalCode|string
1034 1034  nullable: true
1035 -|checkInDate|string($date-time)
1036 -|checkOutDate|string($date-time)
1037 -|adults|integer($int32)
1038 -|children|integer($int32)
1039 -|districtUID|string($uuid)
1053 +|date|string($date-time)
1040 1040  nullable: true
1041 -|districtName|string
1055 +|time|string
1042 1042  nullable: true
1043 -|cityUID|string($uuid)
1057 +
1058 +}
1059 +)))
1060 +|departureFlightInfo|ManualFlightInfo{(((
1061 +|flightNumber|string
1044 1044  nullable: true
1045 -|cityName|string
1063 +|terminalCode|string
1046 1046  nullable: true
1047 -|countryCode|string
1065 +|date|string($date-time)
1048 1048  nullable: true
1049 -|countryName|string
1067 +|time|string
1050 1050  nullable: true
1051 -|hasAlcohol|boolean
1052 -|hasFreeWifi|boolean
1053 -|hasMetro|boolean
1054 -|hasPool|boolean
1055 -|hasMall|boolean
1056 -|cancellationPolicyDescription|string
1069 +
1070 +}
1071 +)))
1072 +|insurancePrice|InsurancePriceForTourist{(((
1073 +|insuranceId|string($uuid)
1074 +|insuranceServiceId|string($uuid)
1075 +|insurancePriceId|string($uuid)
1076 +|touristId|string($uuid)
1077 +|insuranceName|string
1057 1057  nullable: true
1058 -|cancellationPolicy|CancellationPolicyExchange{(((
1059 -|cancellationPolicyCode|string
1079 +|insuranceDescription|string
1060 1060  nullable: true
1061 -|noShowChargeValue|number($double)
1081 +|contragentName|string
1062 1062  nullable: true
1063 -|noShowChargeValueType|string
1083 +|contragentFullName|string
1064 1064  nullable: true
1065 -|earlyDepartureChargeValue|number($double)
1085 +|actualStartDate|string($date-time)
1086 +|actualEndDate|string($date-time)
1087 +|costCurrencyCode|string
1066 1066  nullable: true
1067 -|earlyDepartureChargeValueType|string
1089 +|costAmount|number($double)
1090 +|priceCurrencyCode|string
1068 1068  nullable: true
1069 -|conditions|[
1070 -nullable: trueCancellationPolicyConditionExchange{(((
1071 -|timeunits|integer($int32)
1072 -|timeunitType|string
1092 +|priceAmount|number($double)
1093 +|coverageCurrencyCode|string
1073 1073  nullable: true
1074 -|timeOffsetTypeName|string
1095 +|coverageAmount|number($double)
1096 +
1097 +}
1098 +)))
1099 +|selectedVisaId|string
1075 1075  nullable: true
1076 -|chargeValue|number($double)
1101 +|transfers|[
1102 +nullable: trueCheckoutTransferOut{(((
1103 +|id|string
1077 1077  nullable: true
1078 -|chargeValueType|string
1105 +|type|CheckoutTransferTypeEnumstringEnum:
1106 +[ Arrival, Departure, HotelToHotel ]
1107 +|flightId|string
1079 1079  nullable: true
1109 +|flightInfo|ManualFlightInfo{(((
1110 +|flightNumber|string
1111 +nullable: true
1112 +|terminalCode|string
1113 +nullable: true
1114 +|date|string($date-time)
1115 +nullable: true
1116 +|time|string
1117 +nullable: true
1080 1080  
1081 -}]
1082 -)))
1083 -
1084 1084  }
1085 1085  )))
1086 -
1087 -}
1088 -)))
1089 -|extraServices|[
1090 -nullable: trueHotelExtraServiceBase{(((
1091 -|extraServiceCode|string
1121 +|checkInHotelId|string
1092 1092  nullable: true
1093 -|extraServiceTypeCode|string
1123 +|checkOutHotelId|string
1094 1094  nullable: true
1095 -|isMandatory|integer($int32)
1096 -|extraServiceName|string
1125 +|selectedTransferPriceId|string
1097 1097  nullable: true
1098 -|minimalServiceAmount|number($double)
1099 -|includedPriceCode|string
1127 +|transferPrices|[
1128 +nullable: trueCheckoutTransferPrice{(((
1129 +|id|string
1100 1100  nullable: true
1101 -|prices|[
1102 -nullable: trueHotelExtraServicePriceBase{(((
1103 -|extraServicePriceCode|string
1131 +|name|string
1104 1104  nullable: true
1105 -|displayName|string
1133 +|adultPlaces|integer($int32)
1134 +|childPlaces|integer($int32)
1135 +|perPersonPrice|boolean
1136 +|adultPrice|number($double)
1137 +|childPrice|number($double)
1138 +
1139 +}]
1140 +)))
1141 +
1142 +}]
1143 +)))
1144 +|errorCode|string
1106 1106  nullable: true
1107 -|restrictionInfo|string
1146 +|errorMessage|string
1108 1108  nullable: true
1109 -|additionalInfo|string
1148 +|description|string
1110 1110  nullable: true
1111 -|price|number($double)
1112 -|extraPrice|number($double)
1113 -|currency|string
1114 -nullable: true
1115 1115  
1116 1116  }]
1117 1117  )))
1153 +|visas|[
1154 +nullable: trueServicePrice{(((
1155 +|prid|string($uuid)
1156 +|prName|string
1157 +nullable: true
1158 +|prValue|number($double)
1159 +|sortingOrder|integer($int32)
1118 1118  
1119 1119  }]
1120 1120  )))
1163 +|terminals|[
1164 +nullable: trueTerminal{(((
1165 +|terminalCode|string
1166 +nullable: true
1167 +|cityUID|string($uuid)
1168 +nullable: true
1169 +|districtUID|string($uuid)
1170 +nullable: true
1171 +|terminalName|string
1172 +nullable: true
1173 +|countryCode|string
1174 +nullable: true
1175 +|note|string
1176 +nullable: true
1121 1121  
1122 -}
1178 +}]
1123 1123  )))
1180 +|containsError|boolean
1181 +|refreshPriceResult|RefreshPriceResultEnumstringEnum:
1182 +[ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ]
1183 +|reservationId|string($uuid)
1184 +|reservationDetailsUnavailable|boolean
1124 1124  
1125 1125  }
1126 1126  {{/success}}
1188 +
1189 +
1190 +
1191 +== Description ==
1192 +
1193 +
1194 +=== Request ===
1195 +
1196 +(% class="table-bordered" %)
1197 +|=Field Path|=Data Type|=Description
1198 +|calcTourPackageRequests[*].refreshPrices|Boolean|Indicates whether to refresh the prices for the tour package.
1199 +|calcTourPackageRequests[*].packageId|String|Unique identifier for the tour package.
1200 +|calcTourPackageRequests[*].flightPassengers[*].id|String|Unique identifier for a flight passenger within the package.
1201 +|calcTourPackageRequests[*].flightPassengers[*].selectedForwardBaggageCode|String|Code indicating the baggage option selected for the forward journey.
1202 +|calcTourPackageRequests[*].flightPassengers[*].selectedBackwardBaggageCode|String|Code indicating the baggage option selected for the return journey.
1203 +|calcTourPackageRequests[*].extraServicePriceCodes|Array|An array of codes for extra services priced within the package.
1204 +|calcTourPackageRequests[*].includeInsurance|Boolean|Indicates if insurance is included in the tour package.
1205 +|calcOnlyHotelPackageRequests|Array|Details about hotel-only package requests, if applicable.
1206 +|calcOnlyAviaPackageRequests|Array|Details about avia-only package requests, if applicable.
1207 +|hotels[*].note|String|Additional notes regarding the hotel booking.
1208 +|hotels[*].agentConfirmationNumber|String|Confirmation number provided by the agent for the hotel booking.
1209 +|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
1210 +|hotels[*].touristIds[*]|String|List of IDs for tourists staying at the hotel.
1211 +|tourists[*].id|String|Unique identifier for the tourist.
1212 +|tourists[*].isMale|Boolean|Indicates if the tourist is male.
1213 +|tourists[*].firstName|String|First name of the tourist.
1214 +|tourists[*].lastName|String|Last name of the tourist.
1215 +|tourists[*].birthDate|String|Birth date of the tourist.
1216 +|tourists[*].citizenship|String|Citizenship of the tourist.
1217 +|tourists[*].passportNumber|String|Passport number of the tourist.
1218 +|tourists[*].passportIssue|String|Issue date of the tourist's passport.
1219 +|tourists[*].passportExpiry|String|Expiry date of the tourist's passport.
1220 +|tourists[*].tin|String|Tax identification number of the tourist, if applicable.
1221 +|tourists[*].selectedVisaId|String|ID of the selected visa option for the tourist.
1222 +|tourists[*].flights[*].flightId|String|Identifier for flights associated with the tourist.
1223 +|tourists[*].flights[*].note|String|Additional notes or details about the flight.
1224 +|tourists[*].flightIds[*]|String|Array of flight IDs associated with the tourist.
1225 +|tourists[*].insurancePrice.insuranceId|String|Identifier for the insurance plan selected for the tourist.
1226 +|...|...|Additional fields for insurancePrice as detailed in previous responses.
1227 +|tourists[*].departureFlightInfo.date|String|Departure date for the tourist's flight, if applicable.
1228 +|tourists[*].departureFlightInfo.time|String|Departure time for the tourist's flight, if applicable.
1229 +|tourists[*].departureFlightInfo.flightNumber|String|Flight number for the tourist's departure flight, if applicable.
1230 +|tourists[*].departureFlightInfo.terminalCode|String|Terminal code for the tourist's departure flight, if applicable.
1231 +|tourists[*].arrivalFlightInfo.date|String|Arrival date for the tourist's flight, if applicable.
1232 +|tourists[*].arrivalFlightInfo.time|String|Arrival time for the tourist's flight, if applicable.
1233 +|tourists[*].arrivalFlightInfo.flightNumber|String|Flight number for the tourist's arrival flight, if applicable.
1234 +|tourists[*].arrivalFlightInfo.terminalCode|String|Terminal code for the tourist's arrival flight, if applicable.
1235 +|tourists[*].transfers[*].id|String|Unique identifier for a transfer service associated with the tourist.
1236 +|tourists[*].transfers[*].selectedTransferPriceId|String|ID of the selected pricing option for the transfer.
1237 +|note|String|General note regarding the reservation, intended for testing or additional information.
1238 +|contactPhone|String|Contact phone number associated with the reservation.
1239 +|reservationId|String|Unique identifier for the entire reservation.
1240 +
1241 +=== Response ===
1242 +
1243 +(% class="table-bordered" %)
1244 +|=Field Path|=Data Type|=Description
1245 +|priceCurrency|String|Currency code (ISO 4217) for all transactional amounts mentioned in the response.
1246 +|totalPrice|Number|Total price of the reservation.
1247 +|agentCommissionPercent|Number|The percentage of the total price allocated as commission for the agent.
1248 +|agentCommissionAmount|Number|The total commission amount in priceCurrency.
1249 +|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code for which an identifier is required.
1250 +|requiredCitizenIdentifiers[*].identifierType|String|Type of identifier required (e.g., "TIN", "FIN").
1251 +|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
1252 +|hotels[*].touristIds[*]|Array|List of tourist IDs that are booked in this hotel.
1253 +|hotels[*].description|String|Description of the hotel booking.
1254 +|tourists[*].id|String|Unique identifier for a tourist.
1255 +|tourists[*].age|Number|Age of the tourist.
1256 +|tourists[*].isAdult|Boolean|Indicates whether the tourist is an adult.
1257 +|tourists[*].flightIds[*]|Array|List of flight IDs associated with the tourist.
1258 +|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
1259 +|tourists[*].flights[*].note|String|Notes or additional information about the flight.
1260 +|tourists[*].insurancePrice.*|Various|Detailed information about the insurance price, including ID, name, coverage, and cost details.
1261 +|tourists[*].selectedVisaId|String|Identifier for the selected visa option for the tourist.
1262 +|tourists[*].transfers[*].id|String|Unique identifier for the transfer.
1263 +|tourists[*].transfers[*].type|String|Type of transfer (e.g., "Arrival", "Departure").
1264 +|tourists[*].transfers[*].flightId|String|The flight ID associated with the transfer.
1265 +|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with the transfer.
1266 +|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with the transfer.
1267 +|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
1268 +|tourists[*].transfers[*].transferPrices[*].*|Various|Detailed information about each transfer price option, including ID, name, and cost details.
1269 +|visas[*].prid|String|Unique identifier for a visa option.
1270 +|visas[*].prName|String|Name of the visa option.
1271 +|visas[*].prValue|Number|The cost associated with this visa option.
1272 +|visas[*].sortingOrder|Number|Sorting order for the visa options.
1273 +|terminals[*].terminalCode|String|Code representing the terminal.
1274 +|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
1275 +|terminals[*].districtUID|String|Unique identifier for the district of the terminal.
1276 +|terminals[*].terminalName|String|Name of the terminal.
1277 +|terminals[*].countryCode|String|The ISO 3166-1 alpha-2 country code for the terminal's country.
1278 +|terminals[*].note|String|Additional notes or information about the terminal.
1279 +|containsError|Boolean|Indicates if the response contains any errors.
1280 +|refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
1281 +|reservationId|String|Unique identifier for the reservation.
1282 +|reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
1283 +|error|Boolean|A generic error indicator, presumably redundant with containsError.
1284 +
1285 +