Wiki source code of SearchOnlyAviaPackages
Version 3.1 by Giorgi Mdivnishvili on 2023/12/14 16:22
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 | 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 | ~{~{code language="none"}} | ||
204 | CalcOnlyHotelPackageResponse{ | ||
205 | error boolean | ||
206 | errorCode string | ||
207 | nullable: true | ||
208 | errorDescription string | ||
209 | nullable: true | ||
210 | userErrorDescription string | ||
211 | nullable: true | ||
212 | package OnlyHotelPackage{ | ||
213 | id string | ||
214 | nullable: true | ||
215 | priceCurrency string | ||
216 | nullable: true | ||
217 | totalPrice number($double) | ||
218 | agentCommissionPercent number($double) | ||
219 | agentCommissionAmount number($double) | ||
220 | hotel PackageHotel{...} | ||
221 | extraServices [ | ||
222 | nullable: true | ||
223 | HotelExtraServiceBase{ | ||
224 | extraServiceCode string | ||
225 | nullable: true | ||
226 | extraServiceTypeCode string | ||
227 | nullable: true | ||
228 | isMandatory integer($int32) | ||
229 | extraServiceName string | ||
230 | nullable: true | ||
231 | minimalServiceAmount number($double) | ||
232 | includedPriceCode string | ||
233 | nullable: true | ||
234 | prices [ | ||
235 | nullable: true | ||
236 | HotelExtraServicePriceBase{ | ||
237 | extraServicePriceCode string | ||
238 | nullable: true | ||
239 | displayName string | ||
240 | nullable: true | ||
241 | restrictionInfo string | ||
242 | nullable: true | ||
243 | additionalInfo string | ||
244 | nullable: true | ||
245 | price number($double) | ||
246 | extraPrice number($double) | ||
247 | currency string | ||
248 | nullable: true | ||
249 | }] | ||
250 | }] | ||
251 | } | ||
252 | } | ||
253 | ~{~{/code}} |