Wiki source code of SearchTourPackages
Version 3.1 by Giorgi Mdivnishvili on 2023/12/14 17:47
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}} |
![]() |
3.1 | 15 | {{{https://online-api.kazunion.com/api/TourPackages/SearchTourPackages}}} |
![]() |
2.1 | 16 | {{/info}} |
![]() |
1.1 | 17 | |
18 | |||
![]() |
2.1 | 19 | == Request Parameters == |
![]() |
1.1 | 20 | |
![]() |
2.1 | 21 | (% class="box infomessage" %) |
22 | ((( | ||
![]() |
3.1 | 23 | None |
![]() |
2.1 | 24 | ))) |
![]() |
1.1 | 25 | |
26 | |||
![]() |
2.1 | 27 | == Request Body == |
![]() |
1.1 | 28 | |
![]() |
2.1 | 29 | {{code language="Json"}} |
![]() |
3.1 | 30 | { |
31 | "departureCountryCode": "string", | ||
32 | "departureCityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
33 | "arrivalCountryCode": "string", | ||
34 | "arrivalLocations": [ | ||
35 | { | ||
36 | "type": "string", | ||
37 | "parent": "string", | ||
38 | "label": "string", | ||
39 | "subLabel": "string", | ||
40 | "value": "string", | ||
41 | "tag": "string" | ||
42 | } | ||
43 | ], | ||
44 | "checkInDate": "2023-12-14T13:43:54.766Z", | ||
45 | "checkInDateTo": "2023-12-14T13:43:54.766Z", | ||
46 | "checkOutDate": "2023-12-14T13:43:54.766Z", | ||
47 | "stayDays": 0, | ||
48 | "stayDaysTo": 0, | ||
49 | "departureDate": "2023-12-14T13:43:54.766Z", | ||
50 | "returnDate": "2023-12-14T13:43:54.766Z", | ||
51 | "airlineCode": "string", | ||
52 | "ticketType": "string", | ||
53 | "directFlightsOnly": true, | ||
54 | "longConnectTime": true, | ||
55 | "adults": 0, | ||
56 | "children": 0, | ||
57 | "childrenAges": [ | ||
58 | 0 | ||
59 | ], | ||
60 | "extendedSearch": true, | ||
61 | "totalPriceFrom": 0, | ||
62 | "totalPriceTo": 0, | ||
63 | "recommended": true, | ||
64 | "popular": true, | ||
65 | "freeSale": true, | ||
66 | "groupByHotel": true, | ||
67 | "hotelCodes": [ | ||
68 | "string" | ||
69 | ], | ||
70 | "mealPlans": [ | ||
71 | "string" | ||
72 | ], | ||
73 | "hotelClasses": [ | ||
74 | "string" | ||
75 | ], | ||
76 | "hotelTypes": [ | ||
77 | "CityHotel" | ||
78 | ], | ||
79 | "hotelServices": [ | ||
80 | "HasAlcohol" | ||
81 | ], | ||
82 | "pagingId": "string", | ||
83 | "pageNumber": 0, | ||
84 | "pageRowCount": 0 | ||
85 | } | ||
![]() |
2.1 | 86 | {{/code}} |
![]() |
1.1 | 87 | |
88 | |||
![]() |
2.1 | 89 | == Response Body == |
90 | |||
91 | {{code language="json"}} | ||
![]() |
3.1 | 92 | { |
93 | "error": true, | ||
94 | "errorCode": "string", | ||
95 | "errorDescription": "string", | ||
96 | "userErrorDescription": "string", | ||
97 | "packages": [ | ||
98 | { | ||
99 | "cacheKey": "string", | ||
100 | "id": "string", | ||
101 | "priceCurrency": "string", | ||
102 | "totalPrice": 0, | ||
103 | "agentCommissionPercent": 0, | ||
104 | "agentCommissionAmount": 0, | ||
105 | "includedExtrasAmount": 0, | ||
106 | "priceDifference": 0, | ||
107 | "hotel": { | ||
108 | "hotelPriceId": "string", | ||
109 | "providerId": 0, | ||
110 | "hotelName": "string", | ||
111 | "hotelCode": "string", | ||
112 | "nigths": 0, | ||
113 | "mealPlan": "string", | ||
114 | "hotelClass": "string", | ||
115 | "availabilityType": "OnRequest", | ||
116 | "availableRoomsCount": 0, | ||
117 | "fewRooms": true, | ||
118 | "roomCategoryCode": "string", | ||
119 | "roomCategoryName": "string", | ||
120 | "placementTypeName": "string", | ||
121 | "placementDescription": "string", | ||
122 | "checkInDate": "2023-12-14T13:47:13.396Z", | ||
123 | "checkOutDate": "2023-12-14T13:47:13.396Z", | ||
124 | "adults": 0, | ||
125 | "children": 0, | ||
126 | "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
127 | "districtName": "string", | ||
128 | "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
129 | "cityName": "string", | ||
130 | "countryCode": "string", | ||
131 | "countryName": "string", | ||
132 | "hasAlcohol": true, | ||
133 | "hasFreeWifi": true, | ||
134 | "hasMetro": true, | ||
135 | "hasPool": true, | ||
136 | "hasMall": true, | ||
137 | "cancellationPolicyDescription": "string", | ||
138 | "cancellationPolicy": { | ||
139 | "cancellationPolicyCode": "string", | ||
140 | "noShowChargeValue": 0, | ||
141 | "noShowChargeValueType": "string", | ||
142 | "earlyDepartureChargeValue": 0, | ||
143 | "earlyDepartureChargeValueType": "string", | ||
144 | "conditions": [ | ||
145 | { | ||
146 | "timeunits": 0, | ||
147 | "timeunitType": "string", | ||
148 | "timeOffsetTypeName": "string", | ||
149 | "chargeValue": 0, | ||
150 | "chargeValueType": "string" | ||
151 | } | ||
152 | ] | ||
153 | } | ||
154 | }, | ||
155 | "flight": { | ||
156 | "id": "string", | ||
157 | "departureDate": "2023-12-14T13:47:13.396Z", | ||
158 | "returnDate": "2023-12-14T13:47:13.396Z", | ||
159 | "departureTicketsLeft": 0, | ||
160 | "returnTicketsLeft": 0, | ||
161 | "departureAvailabilityType": "OnRequest", | ||
162 | "returnAvailabilityType": "OnRequest", | ||
163 | "isTwoWay": true, | ||
164 | "departureSegments": [ | ||
165 | { | ||
166 | "airlineCode": "string", | ||
167 | "airlineName": "string", | ||
168 | "flightCode": "string", | ||
169 | "class": "string", | ||
170 | "lugageWeight": 0, | ||
171 | "handLugageWeight": 0, | ||
172 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
173 | "departureCountryName": "string", | ||
174 | "departureCityName": "string", | ||
175 | "departureAirportCode": "string", | ||
176 | "departureAirportName": "string", | ||
177 | "departureTerminalCode": "string", | ||
178 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
179 | "arrivalCountryName": "string", | ||
180 | "arrivalCityName": "string", | ||
181 | "arrivalAirportCode": "string", | ||
182 | "arrivalAirportName": "string", | ||
183 | "arrivalTerminalCode": "string", | ||
184 | "flightDuration": "string", | ||
185 | "baggages": [ | ||
186 | { | ||
187 | "baggageCode": "string", | ||
188 | "description": "string", | ||
189 | "price": 0, | ||
190 | "currency": "string", | ||
191 | "included": true | ||
192 | } | ||
193 | ] | ||
194 | } | ||
195 | ], | ||
196 | "returnSegments": [ | ||
197 | { | ||
198 | "airlineCode": "string", | ||
199 | "airlineName": "string", | ||
200 | "flightCode": "string", | ||
201 | "class": "string", | ||
202 | "lugageWeight": 0, | ||
203 | "handLugageWeight": 0, | ||
204 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
205 | "departureCountryName": "string", | ||
206 | "departureCityName": "string", | ||
207 | "departureAirportCode": "string", | ||
208 | "departureAirportName": "string", | ||
209 | "departureTerminalCode": "string", | ||
210 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
211 | "arrivalCountryName": "string", | ||
212 | "arrivalCityName": "string", | ||
213 | "arrivalAirportCode": "string", | ||
214 | "arrivalAirportName": "string", | ||
215 | "arrivalTerminalCode": "string", | ||
216 | "flightDuration": "string", | ||
217 | "baggages": [ | ||
218 | { | ||
219 | "baggageCode": "string", | ||
220 | "description": "string", | ||
221 | "price": 0, | ||
222 | "currency": "string", | ||
223 | "included": true | ||
224 | } | ||
225 | ] | ||
226 | } | ||
227 | ] | ||
228 | }, | ||
229 | "extraServices": [ | ||
230 | { | ||
231 | "extraServiceCode": "string", | ||
232 | "extraServiceTypeCode": "string", | ||
233 | "isMandatory": 0, | ||
234 | "extraServiceName": "string", | ||
235 | "minimalServiceAmount": 0, | ||
236 | "includedPriceCode": "string", | ||
237 | "prices": [ | ||
238 | { | ||
239 | "extraServicePriceCode": "string", | ||
240 | "displayName": "string", | ||
241 | "restrictionInfo": "string", | ||
242 | "additionalInfo": "string", | ||
243 | "price": 0, | ||
244 | "extraPrice": 0, | ||
245 | "currency": "string" | ||
246 | } | ||
247 | ] | ||
248 | } | ||
249 | ], | ||
250 | "insurancePrice": { | ||
251 | "name": "string", | ||
252 | "price": 0, | ||
253 | "priceSurcarge": 0, | ||
254 | "actualStartDate": "2023-12-14T13:47:13.396Z", | ||
255 | "actualEndDate": "2023-12-14T13:47:13.396Z", | ||
256 | "optional": true, | ||
257 | "includedInPackagePrice": true | ||
258 | } | ||
259 | } | ||
260 | ], | ||
261 | "pagingId": "string", | ||
262 | "pageNumber": 0, | ||
263 | "pageCount": 0 | ||
264 | } | ||
![]() |
2.1 | 265 | {{/code}} |
266 | |||
267 | |||
268 | === example === | ||
269 | |||
270 | {{code language="Json"}} | ||
![]() |
3.1 | 271 | X |
![]() |
2.1 | 272 | {{/code}} |
273 | |||
274 | |||
275 | === Schema === | ||
276 | |||
277 | {{code language="none"}} | ||
278 | [Hotel{ | ||
279 | hotelCode string | ||
280 | nullable: true | ||
281 | hotelName string | ||
282 | nullable: true | ||
283 | hotelClass string | ||
284 | nullable: true | ||
285 | cityUID string($uuid) | ||
286 | nullable: true | ||
287 | countryCode string | ||
288 | nullable: true | ||
289 | countryName string | ||
290 | nullable: true | ||
291 | districtUID string($uuid) | ||
292 | nullable: true | ||
293 | cityName string | ||
294 | nullable: true | ||
295 | districtName string | ||
296 | nullable: true | ||
297 | hotelType HotelTypeEnumstring | ||
298 | Enum: | ||
299 | [ CityHotel, BeachHotel, SecondLineBeach ] | ||
300 | latitude string | ||
301 | nullable: true | ||
302 | longitude string | ||
303 | nullable: true | ||
304 | hasAlcohol boolean | ||
305 | hasFreeWifi boolean | ||
306 | hasMetro boolean | ||
307 | hasPool boolean | ||
308 | hasMall boolean | ||
309 | }] | ||
310 | {{/code}} |