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