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