Wiki source code of 1. SearchTourPackages
Version 17.1 by Giorgi Mdivnishvili on 2023/12/26 15:34
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| |
2.1 | 2 | |
| 3 | |||
| |
1.1 | 4 | {{toc/}} |
| 5 | {{/box}} | ||
| 6 | |||
| |
2.1 | 7 | = Method Description = |
| |
1.1 | 8 | |
| |
2.1 | 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. |
| |
1.1 | 10 | |
| 11 | |||
| |
3.1 | 12 | == Endpoint URL - [POST] == |
| |
1.1 | 13 | |
| |
2.1 | 14 | {{info}} |
| |
11.1 | 15 | [[https:~~/~~/online-api.kazunion.com/api/TourPackages/SearchTourPackages>>https://online-api.kazunion.com/api/TourPackages/SearchTourPackages]] |
| |
2.1 | 16 | {{/info}} |
| |
1.1 | 17 | |
| |
2.1 | 18 | == Request Parameters == |
| |
1.1 | 19 | |
| |
2.1 | 20 | (% class="box infomessage" %) |
| 21 | ((( | ||
| |
11.1 | 22 | None |
| |
2.1 | 23 | ))) |
| |
1.1 | 24 | |
| 25 | |||
| |
2.1 | 26 | == Request Body == |
| |
1.1 | 27 | |
| |
2.1 | 28 | {{code language="Json"}} |
| |
3.1 | 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 | } | ||
| |
2.1 | 85 | {{/code}} |
| |
1.1 | 86 | |
| 87 | |||
| |
14.1 | 88 | == Request example == |
| 89 | |||
| 90 | {{code language="Json"}} | ||
| 91 | { | ||
| 92 | "departureCountryCode": "KZ", | ||
| 93 | "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8", | ||
| 94 | "arrivalCountryCode": "AE", | ||
| 95 | "arrivalLocations": [ | ||
| 96 | { | ||
| 97 | "type": "city", | ||
| 98 | "label": "Dubai", | ||
| 99 | "value": "f5185fa3-3f56-44ed-bf6b-80386a33caa2", | ||
| 100 | "tag": "Dubai" | ||
| 101 | } | ||
| 102 | ], | ||
| 103 | "checkInDate": "2024-02-05T20:00:00.000Z", | ||
| 104 | "checkInDateTo": "2024-02-10T20:00:00.000Z", | ||
| 105 | |||
| 106 | "stayDays": 3, | ||
| 107 | "stayDaysTo": 6, | ||
| 108 | |||
| 109 | "airlineCode": "", | ||
| 110 | "ticketType": "", | ||
| 111 | "directFlightsOnly": true, | ||
| 112 | "longConnectTime": true, | ||
| 113 | "adults": 1, | ||
| 114 | "children": 1, | ||
| 115 | "childrenAges": [ | ||
| 116 | 2 | ||
| 117 | ], | ||
| 118 | "extendedSearch": false, | ||
| 119 | "totalPriceFrom": 100, | ||
| 120 | "totalPriceTo": 15000, | ||
| 121 | "recommended": true, | ||
| 122 | "popular": true, | ||
| 123 | "freeSale": true, | ||
| 124 | "groupByHotel": true, | ||
| 125 | "hotelCodes": [ | ||
| 126 | |||
| 127 | ], | ||
| 128 | "mealPlans": [ | ||
| 129 | |||
| 130 | ], | ||
| 131 | "hotelClasses": [ | ||
| 132 | |||
| 133 | ], | ||
| 134 | "hotelTypes": [ | ||
| 135 | |||
| 136 | ], | ||
| 137 | "hotelServices": [ | ||
| 138 | |||
| 139 | ], | ||
| 140 | "pagingId": "", | ||
| 141 | "pageNumber": 10, | ||
| 142 | "pageRowCount": 10 | ||
| 143 | } | ||
| 144 | {{/code}} | ||
| 145 | |||
| 146 | |||
| |
2.1 | 147 | == Response Body == |
| 148 | |||
| 149 | {{code language="json"}} | ||
| |
3.1 | 150 | { |
| 151 | "error": true, | ||
| 152 | "errorCode": "string", | ||
| 153 | "errorDescription": "string", | ||
| 154 | "userErrorDescription": "string", | ||
| 155 | "packages": [ | ||
| 156 | { | ||
| 157 | "cacheKey": "string", | ||
| 158 | "id": "string", | ||
| 159 | "priceCurrency": "string", | ||
| 160 | "totalPrice": 0, | ||
| 161 | "agentCommissionPercent": 0, | ||
| 162 | "agentCommissionAmount": 0, | ||
| 163 | "includedExtrasAmount": 0, | ||
| 164 | "priceDifference": 0, | ||
| 165 | "hotel": { | ||
| 166 | "hotelPriceId": "string", | ||
| 167 | "providerId": 0, | ||
| 168 | "hotelName": "string", | ||
| 169 | "hotelCode": "string", | ||
| 170 | "nigths": 0, | ||
| 171 | "mealPlan": "string", | ||
| 172 | "hotelClass": "string", | ||
| 173 | "availabilityType": "OnRequest", | ||
| 174 | "availableRoomsCount": 0, | ||
| 175 | "fewRooms": true, | ||
| 176 | "roomCategoryCode": "string", | ||
| 177 | "roomCategoryName": "string", | ||
| 178 | "placementTypeName": "string", | ||
| 179 | "placementDescription": "string", | ||
| 180 | "checkInDate": "2023-12-14T13:47:13.396Z", | ||
| 181 | "checkOutDate": "2023-12-14T13:47:13.396Z", | ||
| 182 | "adults": 0, | ||
| 183 | "children": 0, | ||
| 184 | "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 185 | "districtName": "string", | ||
| 186 | "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 187 | "cityName": "string", | ||
| 188 | "countryCode": "string", | ||
| 189 | "countryName": "string", | ||
| 190 | "hasAlcohol": true, | ||
| 191 | "hasFreeWifi": true, | ||
| 192 | "hasMetro": true, | ||
| 193 | "hasPool": true, | ||
| 194 | "hasMall": true, | ||
| 195 | "cancellationPolicyDescription": "string", | ||
| 196 | "cancellationPolicy": { | ||
| 197 | "cancellationPolicyCode": "string", | ||
| 198 | "noShowChargeValue": 0, | ||
| 199 | "noShowChargeValueType": "string", | ||
| 200 | "earlyDepartureChargeValue": 0, | ||
| 201 | "earlyDepartureChargeValueType": "string", | ||
| 202 | "conditions": [ | ||
| 203 | { | ||
| 204 | "timeunits": 0, | ||
| 205 | "timeunitType": "string", | ||
| 206 | "timeOffsetTypeName": "string", | ||
| 207 | "chargeValue": 0, | ||
| 208 | "chargeValueType": "string" | ||
| 209 | } | ||
| 210 | ] | ||
| 211 | } | ||
| 212 | }, | ||
| 213 | "flight": { | ||
| 214 | "id": "string", | ||
| 215 | "departureDate": "2023-12-14T13:47:13.396Z", | ||
| 216 | "returnDate": "2023-12-14T13:47:13.396Z", | ||
| 217 | "departureTicketsLeft": 0, | ||
| 218 | "returnTicketsLeft": 0, | ||
| 219 | "departureAvailabilityType": "OnRequest", | ||
| 220 | "returnAvailabilityType": "OnRequest", | ||
| 221 | "isTwoWay": true, | ||
| 222 | "departureSegments": [ | ||
| 223 | { | ||
| 224 | "airlineCode": "string", | ||
| 225 | "airlineName": "string", | ||
| 226 | "flightCode": "string", | ||
| 227 | "class": "string", | ||
| 228 | "lugageWeight": 0, | ||
| 229 | "handLugageWeight": 0, | ||
| 230 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 231 | "departureCountryName": "string", | ||
| 232 | "departureCityName": "string", | ||
| 233 | "departureAirportCode": "string", | ||
| 234 | "departureAirportName": "string", | ||
| 235 | "departureTerminalCode": "string", | ||
| 236 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 237 | "arrivalCountryName": "string", | ||
| 238 | "arrivalCityName": "string", | ||
| 239 | "arrivalAirportCode": "string", | ||
| 240 | "arrivalAirportName": "string", | ||
| 241 | "arrivalTerminalCode": "string", | ||
| 242 | "flightDuration": "string", | ||
| 243 | "baggages": [ | ||
| 244 | { | ||
| 245 | "baggageCode": "string", | ||
| 246 | "description": "string", | ||
| 247 | "price": 0, | ||
| 248 | "currency": "string", | ||
| 249 | "included": true | ||
| 250 | } | ||
| 251 | ] | ||
| 252 | } | ||
| 253 | ], | ||
| 254 | "returnSegments": [ | ||
| 255 | { | ||
| 256 | "airlineCode": "string", | ||
| 257 | "airlineName": "string", | ||
| 258 | "flightCode": "string", | ||
| 259 | "class": "string", | ||
| 260 | "lugageWeight": 0, | ||
| 261 | "handLugageWeight": 0, | ||
| 262 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 263 | "departureCountryName": "string", | ||
| 264 | "departureCityName": "string", | ||
| 265 | "departureAirportCode": "string", | ||
| 266 | "departureAirportName": "string", | ||
| 267 | "departureTerminalCode": "string", | ||
| 268 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 269 | "arrivalCountryName": "string", | ||
| 270 | "arrivalCityName": "string", | ||
| 271 | "arrivalAirportCode": "string", | ||
| 272 | "arrivalAirportName": "string", | ||
| 273 | "arrivalTerminalCode": "string", | ||
| 274 | "flightDuration": "string", | ||
| 275 | "baggages": [ | ||
| 276 | { | ||
| 277 | "baggageCode": "string", | ||
| 278 | "description": "string", | ||
| 279 | "price": 0, | ||
| 280 | "currency": "string", | ||
| 281 | "included": true | ||
| 282 | } | ||
| 283 | ] | ||
| 284 | } | ||
| 285 | ] | ||
| 286 | }, | ||
| 287 | "extraServices": [ | ||
| 288 | { | ||
| 289 | "extraServiceCode": "string", | ||
| 290 | "extraServiceTypeCode": "string", | ||
| 291 | "isMandatory": 0, | ||
| 292 | "extraServiceName": "string", | ||
| 293 | "minimalServiceAmount": 0, | ||
| 294 | "includedPriceCode": "string", | ||
| 295 | "prices": [ | ||
| 296 | { | ||
| 297 | "extraServicePriceCode": "string", | ||
| 298 | "displayName": "string", | ||
| 299 | "restrictionInfo": "string", | ||
| 300 | "additionalInfo": "string", | ||
| 301 | "price": 0, | ||
| 302 | "extraPrice": 0, | ||
| 303 | "currency": "string" | ||
| 304 | } | ||
| 305 | ] | ||
| 306 | } | ||
| 307 | ], | ||
| 308 | "insurancePrice": { | ||
| 309 | "name": "string", | ||
| 310 | "price": 0, | ||
| 311 | "priceSurcarge": 0, | ||
| 312 | "actualStartDate": "2023-12-14T13:47:13.396Z", | ||
| 313 | "actualEndDate": "2023-12-14T13:47:13.396Z", | ||
| 314 | "optional": true, | ||
| 315 | "includedInPackagePrice": true | ||
| 316 | } | ||
| 317 | } | ||
| 318 | ], | ||
| 319 | "pagingId": "string", | ||
| 320 | "pageNumber": 0, | ||
| 321 | "pageCount": 0 | ||
| 322 | } | ||
| |
2.1 | 323 | {{/code}} |
| 324 | |||
| 325 | |||
| |
14.1 | 326 | == Response example == |
| |
2.1 | 327 | |
| 328 | {{code language="Json"}} | ||
| |
14.1 | 329 | { |
| 330 | "packages": [ | ||
| 331 | { | ||
| 332 | "cacheKey": "c705ab31e00e4f9a81c2fd46b2cdbb47f6fd9a6e16984236beb979b31aefafa4:{79}:i:10", | ||
| 333 | "id": "tour:b01c168e-2ea7-4ea6-b6e0-55abb8cab0a0:da894a1e-88c0-4877-b216-0eeeabe186f3:4298d06f-4344-4a39-ad98-071b7760cf30", | ||
| 334 | "priceCurrency": "USD", | ||
| 335 | "totalPrice": 1033.53, | ||
| 336 | "agentCommissionPercent": 0.0, | ||
| 337 | "agentCommissionAmount": 0.0, | ||
| 338 | "includedExtrasAmount": 0, | ||
| 339 | "priceDifference": 0, | ||
| 340 | "hotel": { | ||
| 341 | "hotelPriceId": "da894a1e-88c0-4877-b216-0eeeabe186f3", | ||
| 342 | "providerId": 13, | ||
| 343 | "hotelName": "Mercure Dubai Barsha Heights Suites Apartments", | ||
| 344 | "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14", | ||
| 345 | "nigths": 3, | ||
| 346 | "mealPlan": "BB", | ||
| 347 | "hotelClass": "4", | ||
| 348 | "availabilityType": "FreeSale", | ||
| 349 | "availableRoomsCount": 0, | ||
| 350 | "fewRooms": true, | ||
| 351 | "roomCategoryCode": "bc5f2224-bd4c-49b2-ab57-01eb7fa80d41", | ||
| 352 | "roomCategoryName": "1 B/R Suite City View", | ||
| 353 | "placementTypeName": "DBL", | ||
| 354 | "checkInDate": "2024-02-09T20:00:00.000Z", | ||
| 355 | "checkOutDate": "2024-02-12T20:00:00.000Z", | ||
| 356 | "adults": 1, | ||
| 357 | "children": 1, | ||
| 358 | "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e", | ||
| 359 | "districtName": "Al Barsha", | ||
| 360 | "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2", | ||
| 361 | "cityName": "Dubai", | ||
| 362 | "countryCode": "AE", | ||
| 363 | "countryName": "United Arab Emirates", | ||
| 364 | "hasAlcohol": false, | ||
| 365 | "hasFreeWifi": true, | ||
| 366 | "hasMetro": true, | ||
| 367 | "hasPool": true, | ||
| 368 | "hasMall": false, | ||
| 369 | "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %", | ||
| 370 | "cancellationPolicy": { | ||
| 371 | "noShowChargeValue": 100.0, | ||
| 372 | "noShowChargeValueType": "%", | ||
| 373 | "earlyDepartureChargeValue": 100.0, | ||
| 374 | "earlyDepartureChargeValueType": "%", | ||
| 375 | "conditions": [ | ||
| 376 | { | ||
| 377 | "timeunits": 5, | ||
| 378 | "timeunitType": "Day", | ||
| 379 | "timeOffsetTypeName": "Before Arrival", | ||
| 380 | "chargeValue": 100.0, | ||
| 381 | "chargeValueType": "%" | ||
| 382 | } | ||
| 383 | ] | ||
| 384 | } | ||
| 385 | }, | ||
| 386 | "flight": { | ||
| 387 | "id": "4298d06f-4344-4a39-ad98-071b7760cf30", | ||
| 388 | "departureDate": "2024-02-09T20:00:00.000Z", | ||
| 389 | "returnDate": "2024-02-12T20:00:00.000Z", | ||
| 390 | "departureTicketsLeft": 7, | ||
| 391 | "returnTicketsLeft": 7, | ||
| 392 | "departureAvailabilityType": "FewPlaces", | ||
| 393 | "returnAvailabilityType": "FewPlaces", | ||
| 394 | "isTwoWay": true, | ||
| 395 | "sameBaggageForAll": false, | ||
| 396 | "totalBaggage": false, | ||
| 397 | "departureSegments": [ | ||
| 398 | { | ||
| 399 | "airlineCode": "KC", | ||
| 400 | "airlineName": "Air Astana-", | ||
| 401 | "flightCode": "KC897", | ||
| 402 | "class": "econom", | ||
| 403 | "lugageWeight": 20, | ||
| 404 | "handLugageWeight": 6, | ||
| 405 | "departureFlightDate": "2024-02-09T20:00:00.000Z", | ||
| 406 | "departureCountryName": "Kazakhstan", | ||
| 407 | "departureCityName": "Almaty", | ||
| 408 | "departureAirportCode": "ALA", | ||
| 409 | "departureAirportName": "Almaty Intl Airport", | ||
| 410 | "departureTerminalCode": "ALA", | ||
| 411 | "arrivalFlightDate": "2024-02-09T20:00:00.000Z", | ||
| 412 | "arrivalCountryName": "United Arab Emirates", | ||
| 413 | "arrivalCityName": "Dubai", | ||
| 414 | "arrivalAirportCode": "DXB", | ||
| 415 | "arrivalAirportName": "Dubai Intl Airport", | ||
| 416 | "arrivalTerminalCode": "DXB1", | ||
| 417 | "flightDuration": "0h 50m" | ||
| 418 | } | ||
| 419 | ], | ||
| 420 | "returnSegments": [ | ||
| 421 | { | ||
| 422 | "airlineCode": "KC", | ||
| 423 | "airlineName": "Air Astana-", | ||
| 424 | "flightCode": "KC900", | ||
| 425 | "class": "econom", | ||
| 426 | "lugageWeight": 20, | ||
| 427 | "handLugageWeight": 6, | ||
| 428 | "departureFlightDate": "2024-02-12T20:00:00.000Z", | ||
| 429 | "departureCountryName": "United Arab Emirates", | ||
| 430 | "departureCityName": "Dubai", | ||
| 431 | "departureAirportCode": "DXB", | ||
| 432 | "departureAirportName": "Dubai Intl Airport", | ||
| 433 | "departureTerminalCode": "DXB1", | ||
| 434 | "arrivalFlightDate": "2024-02-12T20:00:00.000Z", | ||
| 435 | "arrivalCountryName": "Kazakhstan", | ||
| 436 | "arrivalCityName": "Almaty", | ||
| 437 | "arrivalAirportCode": "ALA", | ||
| 438 | "arrivalAirportName": "Almaty Intl Airport", | ||
| 439 | "arrivalTerminalCode": "ALA", | ||
| 440 | "flightDuration": "8h 15m" | ||
| 441 | } | ||
| 442 | ], | ||
| 443 | "passengers": [ | ||
| 444 | { | ||
| 445 | "id": "42768722011000004-A1", | ||
| 446 | "isAdult": true, | ||
| 447 | "forwardBaggages": [], | ||
| 448 | "backwardBaggages": [] | ||
| 449 | }, | ||
| 450 | { | ||
| 451 | "id": "42768722011000004-C1", | ||
| 452 | "isAdult": false, | ||
| 453 | "forwardBaggages": [], | ||
| 454 | "backwardBaggages": [] | ||
| 455 | } | ||
| 456 | ] | ||
| 457 | }, | ||
| 458 | "extraServices": [], | ||
| 459 | "insurancePrice": { | ||
| 460 | "name": "Medical INS (N10000)", | ||
| 461 | "price": 17.92, | ||
| 462 | "priceSurcarge": 0.0, | ||
| 463 | "actualStartDate": "2024-02-09T20:00:00.000Z", | ||
| 464 | "actualEndDate": "2024-02-12T20:00:00.000Z", | ||
| 465 | "optional": false, | ||
| 466 | "includedInPackagePrice": true | ||
| 467 | } | ||
| 468 | } | ||
| 469 | ], | ||
| 470 | "pagingId": "79", | ||
| 471 | "pageNumber": 10, | ||
| 472 | "pageCount": 2452, | ||
| 473 | "totalCount": 2452, | ||
| 474 | "error": false | ||
| 475 | } | ||
| |
2.1 | 476 | {{/code}} |
| 477 | |||
| 478 | |||
| 479 | === Schema === | ||
| 480 | |||
| |
12.1 | 481 | {{success}} |
| |
4.1 | 482 | SearchTourPackagesResponse{ |
| |
12.1 | 483 | |
| 484 | |error|boolean | ||
| 485 | |errorCode|string | ||
| 486 | nullable: true | ||
| 487 | |errorDescription|string | ||
| 488 | nullable: true | ||
| 489 | |userErrorDescription|string | ||
| 490 | nullable: true | ||
| 491 | |packages|[ | ||
| 492 | nullable: trueTourPackage{((( | ||
| 493 | |cacheKey|string | ||
| 494 | nullable: true | ||
| 495 | |id|string | ||
| 496 | nullable: true | ||
| 497 | |priceCurrency|string | ||
| 498 | nullable: true | ||
| 499 | |totalPrice|number($double) | ||
| 500 | |agentCommissionPercent|number($double) | ||
| 501 | |agentCommissionAmount|number($double) | ||
| 502 | |includedExtrasAmount|number($double) | ||
| 503 | |priceDifference|number($double) | ||
| 504 | |hotel|PackageHotel{((( | ||
| 505 | |hotelPriceId|string | ||
| 506 | nullable: true | ||
| 507 | |providerId|integer($int32) | ||
| 508 | |hotelName|string | ||
| 509 | nullable: true | ||
| 510 | |hotelCode|string | ||
| 511 | nullable: true | ||
| 512 | |nigths|integer($int32) | ||
| 513 | |mealPlan|string | ||
| 514 | nullable: true | ||
| 515 | |hotelClass|string | ||
| 516 | nullable: true | ||
| 517 | |availabilityType|RoomAvailabilityTypeEnumstringEnum: | ||
| 518 | [ OnRequest, FreeSale, StopSale ] | ||
| 519 | |availableRoomsCount|integer($int32) | ||
| 520 | |fewRooms|boolean | ||
| 521 | |roomCategoryCode|string | ||
| 522 | nullable: true | ||
| 523 | |roomCategoryName|string | ||
| 524 | nullable: true | ||
| 525 | |placementTypeName|string | ||
| 526 | nullable: true | ||
| 527 | |placementDescription|string | ||
| 528 | nullable: true | ||
| 529 | |checkInDate|string($date-time) | ||
| 530 | |checkOutDate|string($date-time) | ||
| 531 | |adults|integer($int32) | ||
| 532 | |children|integer($int32) | ||
| 533 | |districtUID|string($uuid) | ||
| 534 | nullable: true | ||
| 535 | |districtName|string | ||
| 536 | nullable: true | ||
| 537 | |cityUID|string($uuid) | ||
| 538 | nullable: true | ||
| 539 | |cityName|string | ||
| 540 | nullable: true | ||
| 541 | |countryCode|string | ||
| 542 | nullable: true | ||
| 543 | |countryName|string | ||
| 544 | nullable: true | ||
| 545 | |hasAlcohol|boolean | ||
| 546 | |hasFreeWifi|boolean | ||
| 547 | |hasMetro|boolean | ||
| 548 | |hasPool|boolean | ||
| 549 | |hasMall|boolean | ||
| 550 | |cancellationPolicyDescription|string | ||
| 551 | nullable: true | ||
| 552 | |cancellationPolicy|CancellationPolicyExchange{((( | ||
| 553 | |cancellationPolicyCode|string | ||
| 554 | nullable: true | ||
| 555 | |noShowChargeValue|number($double) | ||
| 556 | nullable: true | ||
| 557 | |noShowChargeValueType|string | ||
| 558 | nullable: true | ||
| 559 | |earlyDepartureChargeValue|number($double) | ||
| 560 | nullable: true | ||
| 561 | |earlyDepartureChargeValueType|string | ||
| 562 | nullable: true | ||
| 563 | |conditions|[ | ||
| 564 | nullable: trueCancellationPolicyConditionExchange{((( | ||
| 565 | |timeunits|integer($int32) | ||
| 566 | |timeunitType|string | ||
| 567 | nullable: true | ||
| 568 | |timeOffsetTypeName|string | ||
| 569 | nullable: true | ||
| 570 | |chargeValue|number($double) | ||
| 571 | nullable: true | ||
| 572 | |chargeValueType|string | ||
| 573 | nullable: true | ||
| 574 | |||
| |
2.1 | 575 | }] |
| |
12.1 | 576 | ))) |
| 577 | |||
| |
4.1 | 578 | } |
| |
12.1 | 579 | ))) |
| 580 | |||
| |
4.1 | 581 | } |
| |
12.1 | 582 | ))) |
| 583 | |flight|PackageFlight{((( | ||
| 584 | |id|string | ||
| 585 | nullable: true | ||
| 586 | |departureDate|string($date-time) | ||
| 587 | |returnDate|string($date-time) | ||
| 588 | nullable: true | ||
| 589 | |departureTicketsLeft|integer($int32) | ||
| 590 | |returnTicketsLeft|integer($int32) | ||
| 591 | |departureAvailabilityType|FlightAvailabilityTypestringEnum: | ||
| 592 | [ OnRequest, FreeSale, FewPlaces, StopSale ] | ||
| 593 | |returnAvailabilityType|FlightAvailabilityTypestringEnum: | ||
| 594 | [ OnRequest, FreeSale, FewPlaces, StopSale ] | ||
| 595 | |isTwoWay|boolean | ||
| 596 | |departureSegments|[ | ||
| 597 | nullable: trueFlightSegment{((( | ||
| 598 | |airlineCode|string | ||
| 599 | nullable: true | ||
| 600 | |airlineName|string | ||
| 601 | nullable: true | ||
| 602 | |flightCode|string | ||
| 603 | nullable: true | ||
| 604 | |class|string | ||
| 605 | nullable: true | ||
| 606 | |lugageWeight|number($double) | ||
| 607 | |handLugageWeight|number($double) | ||
| 608 | |departureFlightDate|string($date-time) | ||
| 609 | |departureCountryName|string | ||
| 610 | nullable: true | ||
| 611 | |departureCityName|string | ||
| 612 | nullable: true | ||
| 613 | |departureAirportCode|string | ||
| 614 | nullable: true | ||
| 615 | |departureAirportName|string | ||
| 616 | nullable: true | ||
| 617 | |departureTerminalCode|string | ||
| 618 | nullable: true | ||
| 619 | |arrivalFlightDate|string($date-time) | ||
| 620 | |arrivalCountryName|string | ||
| 621 | nullable: true | ||
| 622 | |arrivalCityName|string | ||
| 623 | nullable: true | ||
| 624 | |arrivalAirportCode|string | ||
| 625 | nullable: true | ||
| 626 | |arrivalAirportName|string | ||
| 627 | nullable: true | ||
| 628 | |arrivalTerminalCode|string | ||
| 629 | nullable: true | ||
| 630 | |flightDuration|string | ||
| 631 | nullable: true | ||
| 632 | |baggages|[ | ||
| 633 | nullable: trueBaggage{((( | ||
| 634 | |baggageCode|string | ||
| 635 | nullable: true | ||
| 636 | |description|string | ||
| 637 | nullable: true | ||
| 638 | |price|number($double) | ||
| 639 | |currency|string | ||
| 640 | nullable: true | ||
| 641 | |included|boolean | ||
| 642 | |||
| |
4.1 | 643 | }] |
| |
12.1 | 644 | ))) |
| 645 | |||
| |
4.1 | 646 | }] |
| |
12.1 | 647 | ))) |
| 648 | |returnSegments|[ | ||
| 649 | nullable: trueFlightSegment{((( | ||
| 650 | |airlineCode|string | ||
| 651 | nullable: true | ||
| 652 | |airlineName|string | ||
| 653 | nullable: true | ||
| 654 | |flightCode|string | ||
| 655 | nullable: true | ||
| 656 | |class|string | ||
| 657 | nullable: true | ||
| 658 | |lugageWeight|number($double) | ||
| 659 | |handLugageWeight|number($double) | ||
| 660 | |departureFlightDate|string($date-time) | ||
| 661 | |departureCountryName|string | ||
| 662 | nullable: true | ||
| 663 | |departureCityName|string | ||
| 664 | nullable: true | ||
| 665 | |departureAirportCode|string | ||
| 666 | nullable: true | ||
| 667 | |departureAirportName|string | ||
| 668 | nullable: true | ||
| 669 | |departureTerminalCode|string | ||
| 670 | nullable: true | ||
| 671 | |arrivalFlightDate|string($date-time) | ||
| 672 | |arrivalCountryName|string | ||
| 673 | nullable: true | ||
| 674 | |arrivalCityName|string | ||
| 675 | nullable: true | ||
| 676 | |arrivalAirportCode|string | ||
| 677 | nullable: true | ||
| 678 | |arrivalAirportName|string | ||
| 679 | nullable: true | ||
| 680 | |arrivalTerminalCode|string | ||
| 681 | nullable: true | ||
| 682 | |flightDuration|string | ||
| 683 | nullable: true | ||
| 684 | |baggages|[ | ||
| 685 | nullable: trueBaggage{((( | ||
| 686 | |baggageCode|string | ||
| 687 | nullable: true | ||
| 688 | |description|string | ||
| 689 | nullable: true | ||
| 690 | |price|number($double) | ||
| 691 | |currency|string | ||
| 692 | nullable: true | ||
| 693 | |included|boolean | ||
| 694 | |||
| |
4.1 | 695 | }] |
| |
12.1 | 696 | ))) |
| 697 | |||
| |
4.1 | 698 | }] |
| |
12.1 | 699 | ))) |
| 700 | |||
| |
4.1 | 701 | } |
| |
12.1 | 702 | ))) |
| 703 | |extraServices|[ | ||
| 704 | nullable: trueHotelExtraServiceBase{((( | ||
| 705 | |extraServiceCode|string | ||
| 706 | nullable: true | ||
| 707 | |extraServiceTypeCode|string | ||
| 708 | nullable: true | ||
| 709 | |isMandatory|integer($int32) | ||
| 710 | |extraServiceName|string | ||
| 711 | nullable: true | ||
| 712 | |minimalServiceAmount|number($double) | ||
| 713 | |includedPriceCode|string | ||
| 714 | nullable: true | ||
| 715 | |prices|[ | ||
| 716 | nullable: trueHotelExtraServicePriceBase{((( | ||
| 717 | |extraServicePriceCode|string | ||
| 718 | nullable: true | ||
| 719 | |displayName|string | ||
| 720 | nullable: true | ||
| 721 | |restrictionInfo|string | ||
| 722 | nullable: true | ||
| 723 | |additionalInfo|string | ||
| 724 | nullable: true | ||
| 725 | |price|number($double) | ||
| 726 | |extraPrice|number($double) | ||
| 727 | |currency|string | ||
| 728 | nullable: true | ||
| 729 | |||
| |
4.1 | 730 | }] |
| |
12.1 | 731 | ))) |
| 732 | |||
| |
4.1 | 733 | }] |
| |
12.1 | 734 | ))) |
| 735 | |insurancePrice|InsurancePrice{((( | ||
| 736 | |name|string | ||
| 737 | nullable: true | ||
| 738 | |price|number($double) | ||
| 739 | |priceSurcarge|number($double) | ||
| 740 | |actualStartDate|string($date-time) | ||
| 741 | |actualEndDate|string($date-time) | ||
| 742 | |optional|boolean | ||
| 743 | |includedInPackagePrice|boolean | ||
| 744 | |||
| |
4.1 | 745 | } |
| |
12.1 | 746 | ))) |
| 747 | |||
| |
4.1 | 748 | }] |
| |
12.1 | 749 | ))) |
| 750 | |pagingId|string | ||
| 751 | nullable: true | ||
| 752 | |pageNumber|integer($int64) | ||
| 753 | |pageCount|integer($int64) | ||
| 754 | |||
| |
4.1 | 755 | } |
| |
12.1 | 756 | {{/success}} |
| 757 | |||
| |
15.1 | 758 | |
| 759 | == Definitions == | ||
| 760 | |||
| 761 | |||
| 762 | === Paging and Caching === | ||
| 763 | |||
| |
17.1 | 764 | During the first request, Paging id must be empty like this ( "pagingId": "",) pagenumber is the number of the page, pagerowcount means number of the given result in one page. So in the first request we can search like this: |
| |
15.1 | 765 | |
| 766 | |||
| 767 | ==== first request ==== | ||
| 768 | |||
| 769 | {{code language="Json"}} | ||
| 770 | { | ||
| 771 | "pagingId": "", | ||
| 772 | "pageNumber": 1, | ||
| 773 | "pageRowCount":10 | ||
| 774 | } | ||
| 775 | {{/code}} | ||
| 776 | |||
| 777 | |||
| 778 | ==== Request with caching ==== | ||
| 779 | |||
| |
17.1 | 780 | as we receive response, in the end we can see pagingId- number, chich we can use for caching, and then just switch pagenumbers. for cleaning cache, it's important to make new request without pagingID |
| 781 | |||
| |
15.1 | 782 | {{code language="Json"}} |
| 783 | { | ||
| 784 | "pagingId": "80", | ||
| 785 | "pageNumber": 1, | ||
| 786 | "pageRowCount":10 | ||
| 787 | } | ||
| 788 | {{/code}} | ||
| 789 | |||
| 790 | |||
| 791 | === search parameter options === | ||
| 792 | |||
| 793 | in the request body it's available to filter search results with parameters. parameter examples: | ||
| 794 | |||
| 795 | {{code language="Json"}} | ||
| 796 | { "totalPriceFrom": 500, | ||
| 797 | "totalPriceTo": 10000, | ||
| 798 | "hotelTypes": [ | ||
| 799 | "CityHotel", | ||
| 800 | "BeachHotel", | ||
| 801 | "SecondLineBeach" | ||
| 802 | ], | ||
| 803 | "hotelClasses": [ | ||
| 804 | "1", | ||
| 805 | "2", | ||
| 806 | "3", | ||
| 807 | "4", | ||
| 808 | "5", | ||
| 809 | "6" | ||
| 810 | ], | ||
| 811 | "hotelServices": [ | ||
| 812 | "HasAlcohol", | ||
| 813 | "HasFreeWifi", | ||
| 814 | "HasMetro", | ||
| 815 | "HasPool", | ||
| 816 | "HasMall" | ||
| 817 | ], | ||
| 818 | "mealPlans": [ | ||
| 819 | "RO", | ||
| 820 | "BB", | ||
| 821 | "HB", | ||
| 822 | "FB", | ||
| 823 | "AL" | ||
| 824 | ] | ||
| 825 | } | ||
| 826 | {{/code}} | ||
| 827 | |||
| 828 | |||
| |
16.1 | 829 | |
| |
17.1 | 830 | == Important == |
| |
16.1 | 831 | |
| 832 | {{error}} | ||
| 833 | It's Important to in every other request header, put Auth token | ||
| 834 | |||
| 835 | **Key **- Authorization | ||
| 836 | |||
| 837 | **Value **- Bearer Token what is given in this response. | ||
| 838 | |||
| 839 | |||
| 840 | **also note in headers that:** | ||
| 841 | |||
| 842 | Content-Type - application/json | ||
| 843 | |||
| 844 | **Key - **X-nugios-timezone | ||
| 845 | |||
| 846 | **Value **- 240 | ||
| 847 | {{/error}} |