Skip to Content

Wiki source code of CalcPackage

Version 2.1 by Giorgi Mdivnishvili on 2023/12/18 18:09
Show last authors
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 none{
31 "packageId": "string",
32 "extraServicePriceCodes": [
33 "string"
34 ]
35 }
36 {{/code}}
37
38 == (% id="cke_bm_10575S" style="display:none" %) (%%)Request Body example ==
39
40 {{code language="Json"}}
41 {
42 "packageId": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
43 "extraServicePriceCodes": [
44
45 ]
46 }
47 {{/code}}
48
49
50 == Response ==
51
52 {{code language="json"}}
53 {
54 "error": true,
55 "errorCode": "string",
56 "errorDescription": "string",
57 "userErrorDescription": "string",
58 "package": {
59 "id": "string",
60 "priceCurrency": "string",
61 "totalPrice": 0,
62 "agentCommissionPercent": 0,
63 "agentCommissionAmount": 0,
64 "hotel": {
65 "hotelPriceId": "string",
66 "providerId": 0,
67 "hotelName": "string",
68 "hotelCode": "string",
69 "nigths": 0,
70 "mealPlan": "string",
71 "hotelClass": "string",
72 "availabilityType": "OnRequest",
73 "availableRoomsCount": 0,
74 "fewRooms": true,
75 "roomCategoryCode": "string",
76 "roomCategoryName": "string",
77 "placementTypeName": "string",
78 "placementDescription": "string",
79 "checkInDate": "2023-12-14T08:49:36.703Z",
80 "checkOutDate": "2023-12-14T08:49:36.703Z",
81 "adults": 0,
82 "children": 0,
83 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84 "districtName": "string",
85 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
86 "cityName": "string",
87 "countryCode": "string",
88 "countryName": "string",
89 "hasAlcohol": true,
90 "hasFreeWifi": true,
91 "hasMetro": true,
92 "hasPool": true,
93 "hasMall": true,
94 "cancellationPolicyDescription": "string",
95 "cancellationPolicy": {
96 "cancellationPolicyCode": "string",
97 "noShowChargeValue": 0,
98 "noShowChargeValueType": "string",
99 "earlyDepartureChargeValue": 0,
100 "earlyDepartureChargeValueType": "string",
101 "conditions": [
102 {
103 "timeunits": 0,
104 "timeunitType": "string",
105 "timeOffsetTypeName": "string",
106 "chargeValue": 0,
107 "chargeValueType": "string"
108 }
109 ]
110 }
111 },
112 "extraServices": [
113 {
114 "extraServiceCode": "string",
115 "extraServiceTypeCode": "string",
116 "isMandatory": 0,
117 "extraServiceName": "string",
118 "minimalServiceAmount": 0,
119 "includedPriceCode": "string",
120 "prices": [
121 {
122 "extraServicePriceCode": "string",
123 "displayName": "string",
124 "restrictionInfo": "string",
125 "additionalInfo": "string",
126 "price": 0,
127 "extraPrice": 0,
128 "currency": "string"
129 }
130 ]
131 }
132 ]
133 }
134 }
135 {{/code}}
136
137
138 === Response example ===
139
140 {{code language="Json"}}
141 {
142 "package": {
143 "id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
144 "priceCurrency": "USD",
145 "totalPrice": 381.70,
146 "agentCommissionPercent": 0.00,
147 "agentCommissionAmount": 0.00,
148 "hotel": {
149 "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
150 "providerId": 13,
151 "hotelName": "Golden Tulip Al Barsha Hotel",
152 "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
153 "nigths": 4,
154 "mealPlan": "RO",
155 "hotelClass": "4",
156 "availabilityType": "FreeSale",
157 "availableRoomsCount": 0,
158 "fewRooms": true,
159 "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
160 "roomCategoryName": "Superior Twin",
161 "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
162 "checkInDate": "2024-02-17T08:00:00.000Z",
163 "checkOutDate": "2024-02-21T08:00:00.000Z",
164 "adults": 1,
165 "children": 1,
166 "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
167 "districtName": "Al Barsha",
168 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
169 "cityName": "Dubai",
170 "countryCode": "AE",
171 "countryName": "United Arab Emirates",
172 "hasAlcohol": true,
173 "hasFreeWifi": true,
174 "hasMetro": false,
175 "hasPool": true,
176 "hasMall": false,
177 "cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
178 "cancellationPolicy": {
179 "noShowChargeValue": 100.00,
180 "noShowChargeValueType": "%",
181 "earlyDepartureChargeValue": 100.00,
182 "earlyDepartureChargeValueType": "%",
183 "conditions": [
184 {
185 "timeunits": 15,
186 "timeunitType": "Day",
187 "timeOffsetTypeName": "Before Arrival",
188 "chargeValue": 100.00,
189 "chargeValueType": "%"
190 }
191 ]
192 }
193 },
194 "extraServices": []
195 },
196 "error": false
197 }
198 {{/code}}
199
200
201 === Schema ===
202
203 {{success}}
204 CalcOnlyHotelPackageResponse{
205
206 |error|boolean
207 |errorCode|string
208 nullable: true
209 |errorDescription|string
210 nullable: true
211 |userErrorDescription|string
212 nullable: true
213 |package|OnlyHotelPackage{(((
214 |id|string
215 nullable: true
216 |priceCurrency|string
217 nullable: true
218 |totalPrice|number($double)
219 |agentCommissionPercent|number($double)
220 |agentCommissionAmount|number($double)
221 |hotel|PackageHotel{(((
222 |hotelPriceId|string
223 nullable: true
224 |providerId|integer($int32)
225 |hotelName|string
226 nullable: true
227 |hotelCode|string
228 nullable: true
229 |nigths|integer($int32)
230 |mealPlan|string
231 nullable: true
232 |hotelClass|string
233 nullable: true
234 |availabilityType|RoomAvailabilityTypeEnumstringEnum:
235 [ OnRequest, FreeSale, StopSale ]
236 |availableRoomsCount|integer($int32)
237 |fewRooms|boolean
238 |roomCategoryCode|string
239 nullable: true
240 |roomCategoryName|string
241 nullable: true
242 |placementTypeName|string
243 nullable: true
244 |placementDescription|string
245 nullable: true
246 |checkInDate|string($date-time)
247 |checkOutDate|string($date-time)
248 |adults|integer($int32)
249 |children|integer($int32)
250 |districtUID|string($uuid)
251 nullable: true
252 |districtName|string
253 nullable: true
254 |cityUID|string($uuid)
255 nullable: true
256 |cityName|string
257 nullable: true
258 |countryCode|string
259 nullable: true
260 |countryName|string
261 nullable: true
262 |hasAlcohol|boolean
263 |hasFreeWifi|boolean
264 |hasMetro|boolean
265 |hasPool|boolean
266 |hasMall|boolean
267 |cancellationPolicyDescription|string
268 nullable: true
269 |cancellationPolicy|CancellationPolicyExchange{(((
270 |cancellationPolicyCode|string
271 nullable: true
272 |noShowChargeValue|number($double)
273 nullable: true
274 |noShowChargeValueType|string
275 nullable: true
276 |earlyDepartureChargeValue|number($double)
277 nullable: true
278 |earlyDepartureChargeValueType|string
279 nullable: true
280 |conditions|[
281 nullable: trueCancellationPolicyConditionExchange{(((
282 |timeunits|integer($int32)
283 |timeunitType|string
284 nullable: true
285 |timeOffsetTypeName|string
286 nullable: true
287 |chargeValue|number($double)
288 nullable: true
289 |chargeValueType|string
290 nullable: true
291
292 }]
293 )))
294
295 }
296 )))
297
298 }
299 )))
300 |extraServices|[
301 nullable: trueHotelExtraServiceBase{(((
302 |extraServiceCode|string
303 nullable: true
304 |extraServiceTypeCode|string
305 nullable: true
306 |isMandatory|integer($int32)
307 |extraServiceName|string
308 nullable: true
309 |minimalServiceAmount|number($double)
310 |includedPriceCode|string
311 nullable: true
312 |prices|[
313 nullable: trueHotelExtraServicePriceBase{(((
314 |extraServicePriceCode|string
315 nullable: true
316 |displayName|string
317 nullable: true
318 |restrictionInfo|string
319 nullable: true
320 |additionalInfo|string
321 nullable: true
322 |price|number($double)
323 |extraPrice|number($double)
324 |currency|string
325 nullable: true
326
327 }]
328 )))
329
330 }]
331 )))
332
333 }
334 )))
335
336 }
337 {{/success}}
338
339