Wiki source code of 6. GetReservationDetails
Last modified by Giorgi Mdivnishvili on 2024/07/11 10:45
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 | |
| 9 | |||
| |
8.1 | 10 | This API endpoint facilitates the retrieval of information pertaining to a previously booked reservation for data verification purposes. |
| |
1.1 | 11 | |
| |
8.1 | 12 | To utilize this functionality, simply provide the reservationId parameter obtained following the initial reservation request and submit the API request. |
| 13 | |||
| 14 | |||
| |
2.1 | 15 | == Endpoint URL - [POST] == |
| |
1.1 | 16 | |
| |
2.1 | 17 | {{info}} |
| |
3.1 | 18 | [[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservationDetails>>https://integration.kazunion.com/api/Reservations/GetReservationDetails]] |
| |
2.1 | 19 | {{/info}} |
| |
1.1 | 20 | |
| 21 | |||
| |
2.1 | 22 | == Request Parameters == |
| |
1.1 | 23 | |
| |
2.1 | 24 | (% class="box infomessage" %) |
| 25 | ((( | ||
| 26 | None | ||
| 27 | ))) | ||
| |
1.1 | 28 | |
| 29 | |||
| |
2.1 | 30 | == Request Body == |
| |
1.1 | 31 | |
| |
2.1 | 32 | {{code language="Json"}} |
| |
9.1 | 33 | {"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"} |
| |
2.1 | 34 | {{/code}} |
| |
1.1 | 35 | |
| |
2.1 | 36 | (% class="wikigeneratedid" id="HRequestBodyexample" %) |
| 37 | (% id="cke_bm_10575S" style="display:none" %) | ||
| |
1.1 | 38 | |
| 39 | |||
| 40 | |||
| |
2.1 | 41 | == Request Body example == |
| 42 | |||
| 43 | {{code language="Json"}} | ||
| |
10.1 | 44 | {"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"} |
| |
2.1 | 45 | {{/code}} |
| 46 | |||
| 47 | |||
| 48 | == Response == | ||
| 49 | |||
| 50 | {{code language="json"}} | ||
| 51 | { | ||
| |
4.1 | 52 | "reservation": { |
| 53 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 54 | "rfNumber": "string", | ||
| 55 | "contactNumber": "string", | ||
| 56 | "agentName": "string", | ||
| |
2.1 | 57 | "totalPrice": 0, |
| |
4.1 | 58 | "agentCommission": 0, |
| 59 | "netPrice": 0, | ||
| 60 | "currency": "string", | ||
| 61 | "tourists": [ | ||
| |
2.1 | 62 | { |
| |
4.1 | 63 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", |
| 64 | "gender": "None", | ||
| 65 | "ageCategory": "Adult", | ||
| 66 | "firstName": "string", | ||
| 67 | "lastName": "string", | ||
| 68 | "birthDate": "2024-04-11T02:39:52.147Z", | ||
| 69 | "passportNumber": "string", | ||
| 70 | "passportExpiryDate": "2024-04-11T02:39:52.147Z", | ||
| 71 | "tin": "string", | ||
| 72 | "citizenshipCountryCode": "string", | ||
| 73 | "citizenshipCountryName": "string", | ||
| 74 | "mobile": "string", | ||
| 75 | "email": "string", | ||
| 76 | "arrivalDate": "2024-04-11T02:39:52.147Z", | ||
| 77 | "arrivalFlightNumber": "string", | ||
| 78 | "arrivalTerminalCode": "string", | ||
| 79 | "returnDate": "2024-04-11T02:39:52.147Z", | ||
| 80 | "returnFlightNumber": "string", | ||
| 81 | "returnTerminalCode": "string", | ||
| 82 | "showReturn": true | ||
| |
2.1 | 83 | } |
| 84 | ], | ||
| |
4.1 | 85 | "hotels": [ |
| 86 | { | ||
| 87 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| |
2.1 | 88 | "hotelName": "string", |
| |
4.1 | 89 | "cityName": "string", |
| |
2.1 | 90 | "hotelClass": "string", |
| |
4.1 | 91 | "checkInDate": "2024-04-11T02:39:52.147Z", |
| 92 | "checkOutDate": "2024-04-11T02:39:52.147Z", | ||
| |
2.1 | 93 | "roomCategoryName": "string", |
| |
4.1 | 94 | "placementName": "string", |
| 95 | "mealPlan": "string", | ||
| 96 | "agentConfirmationNumber": "string" | ||
| |
2.1 | 97 | } |
| |
4.1 | 98 | ], |
| 99 | "flights": [ | ||
| 100 | { | ||
| 101 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 102 | "isArrival": true, | ||
| 103 | "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 104 | "touristName": "string", | ||
| 105 | "date": "2024-04-11T02:39:52.147Z", | ||
| 106 | "departureAirport": "string", | ||
| 107 | "departureTerminal": "string", | ||
| 108 | "arrivalAirport": "string", | ||
| 109 | "arrivalTerminal": "string", | ||
| 110 | "agentConfirmationNumber": "string", | ||
| 111 | "bookingConfirmationNumber": "string", | ||
| 112 | "note": "string" | ||
| 113 | } | ||
| 114 | ], | ||
| 115 | "transfers": [ | ||
| 116 | { | ||
| 117 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 118 | "transferType": "string", | ||
| 119 | "vehicleName": "string", | ||
| 120 | "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 121 | "touristName": "string", | ||
| 122 | "date": "2024-04-11T02:39:52.147Z", | ||
| 123 | "fromTerminal": "string", | ||
| 124 | "fromCityName": "string", | ||
| 125 | "fromHotelName": "string", | ||
| 126 | "toHotelName": "string", | ||
| 127 | "toTerminal": "string", | ||
| 128 | "toCityName": "string", | ||
| 129 | "agentConfirmationNumber": "string", | ||
| 130 | "note": "string" | ||
| 131 | } | ||
| 132 | ], | ||
| 133 | "services": [ | ||
| 134 | { | ||
| 135 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 136 | "serviceDate": "2024-04-11T02:39:52.147Z", | ||
| 137 | "serviceName": "string", | ||
| 138 | "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 139 | "touristName": "string", | ||
| 140 | "note": "string" | ||
| 141 | } | ||
| 142 | ] | ||
| 143 | } | ||
| |
2.1 | 144 | } |
| 145 | {{/code}} | ||
| 146 | |||
| 147 | |||
| 148 | === Response example === | ||
| 149 | |||
| 150 | {{code language="Json"}} | ||
| 151 | { | ||
| |
3.1 | 152 | "reservation": { |
| 153 | "id": "3882a7ee-fec1-4bd3-9e73-ccc4613be36d", | ||
| 154 | "rfNumber": "314303 / 104429", | ||
| 155 | "contactNumber": "teeeest, for testing purpose !, Contact Number: 597101803", | ||
| 156 | "agentName": "Mr. Giorgi Mdivnishvili", | ||
| 157 | "totalPrice": 782, | ||
| 158 | "agentCommission": 0, | ||
| 159 | "currency": "USD", | ||
| 160 | "tourists": [ | ||
| 161 | { | ||
| 162 | "id": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 163 | "gender": "Male", | ||
| 164 | "ageCategory": "Adult", | ||
| 165 | "firstName": "Teeeeest", | ||
| 166 | "lastName": "Teest", | ||
| 167 | "birthDate": "1990-09-23T00:00:00.000", | ||
| 168 | "passportNumber": "1231233", | ||
| 169 | "passportExpiryDate": "2029-12-23T00:00:00.000", | ||
| 170 | "citizenshipCountryCode": "GE", | ||
| 171 | "citizenshipCountryName": "Georgia", | ||
| 172 | "arrivalDate": "2024-05-17T07:10:00.000", | ||
| 173 | "arrivalFlightNumber": "FZ1722", | ||
| 174 | "arrivalTerminalCode": "DXB3", | ||
| 175 | "returnDate": "2024-05-21T21:25:00.000", | ||
| 176 | "returnFlightNumber": "FZ1721", | ||
| 177 | "returnTerminalCode": "DXB3", | ||
| 178 | "showReturn": true | ||
| 179 | }, | ||
| 180 | { | ||
| 181 | "id": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 182 | "gender": "Male", | ||
| 183 | "ageCategory": "Adult", | ||
| 184 | "firstName": "Test", | ||
| 185 | "lastName": "Teeeest", | ||
| 186 | "birthDate": "1990-09-23T00:00:00.000", | ||
| 187 | "passportNumber": "123123", | ||
| 188 | "passportExpiryDate": "2029-12-23T00:00:00.000", | ||
| 189 | "citizenshipCountryCode": "GE", | ||
| 190 | "citizenshipCountryName": "Georgia", | ||
| 191 | "arrivalDate": "2024-05-17T07:10:00.000", | ||
| 192 | "arrivalFlightNumber": "FZ1722", | ||
| 193 | "arrivalTerminalCode": "DXB3", | ||
| 194 | "returnDate": "2024-05-21T21:25:00.000", | ||
| 195 | "returnFlightNumber": "FZ1721", | ||
| 196 | "returnTerminalCode": "DXB3", | ||
| 197 | "showReturn": true | ||
| |
2.1 | 198 | } |
| |
3.1 | 199 | ], |
| 200 | "hotels": [ | ||
| 201 | { | ||
| 202 | "id": "b768a900-bfc5-4dc4-958a-47a3bf92b6f8", | ||
| 203 | "hotelName": "Ibis Al Rigga", | ||
| |
2.1 | 204 | "cityName": "Dubai", |
| |
3.1 | 205 | "hotelClass": "3", |
| 206 | "checkInDate": "2024-05-17T00:00:00.000", | ||
| 207 | "checkOutDate": "2024-05-21T00:00:00.000", | ||
| 208 | "roomCategoryName": "Standard room with 1 double bed", | ||
| 209 | "placementName": "DBL", | ||
| 210 | "mealPlan": "RO" | ||
| 211 | } | ||
| 212 | ], | ||
| 213 | "flights": [ | ||
| 214 | { | ||
| 215 | "id": "5720af80-17de-4913-94c5-2e019c9fbb9c", | ||
| 216 | "isArrival": true, | ||
| 217 | "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 218 | "touristName": "Teeeeest Teest", | ||
| 219 | "date": "2024-05-17T07:10:00.000", | ||
| 220 | "departureAirport": "ALA", | ||
| 221 | "departureTerminal": "ALA", | ||
| 222 | "arrivalAirport": "DXB", | ||
| 223 | "arrivalTerminal": "DXB3", | ||
| 224 | "note": "Kazunion Block, Baggage Info: 20 Kg Included" | ||
| |
2.1 | 225 | }, |
| |
3.1 | 226 | { |
| 227 | "id": "81fce7ff-b359-46ea-ae66-1c41af7c347a", | ||
| 228 | "isArrival": false, | ||
| 229 | "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 230 | "touristName": "Teeeeest Teest", | ||
| 231 | "date": "2024-05-21T21:25:00.000", | ||
| 232 | "departureAirport": "DXB", | ||
| 233 | "departureTerminal": "DXB3", | ||
| 234 | "arrivalAirport": "ALA", | ||
| 235 | "arrivalTerminal": "ALA", | ||
| 236 | "note": "Kazunion Block, Baggage Info: 20 Kg Included" | ||
| |
2.1 | 237 | }, |
| |
3.1 | 238 | { |
| 239 | "id": "215d3de6-8969-4265-97bd-3d716a0d4415", | ||
| 240 | "isArrival": true, | ||
| 241 | "touristId": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 242 | "touristName": "Test Teeeest", | ||
| 243 | "date": "2024-05-17T07:10:00.000", | ||
| 244 | "departureAirport": "ALA", | ||
| 245 | "departureTerminal": "ALA", | ||
| 246 | "arrivalAirport": "DXB", | ||
| 247 | "arrivalTerminal": "DXB3", | ||
| 248 | "note": "Kazunion Block, Baggage Info: 20 Kg Included" | ||
| 249 | }, | ||
| 250 | { | ||
| 251 | "id": "8c6b26b3-5bb2-4fb9-b89c-2568b1f74b64", | ||
| 252 | "isArrival": false, | ||
| 253 | "touristId": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 254 | "touristName": "Test Teeeest", | ||
| 255 | "date": "2024-05-21T21:25:00.000", | ||
| 256 | "departureAirport": "DXB", | ||
| 257 | "departureTerminal": "DXB3", | ||
| 258 | "arrivalAirport": "ALA", | ||
| 259 | "arrivalTerminal": "ALA", | ||
| 260 | "note": "Kazunion Block, Baggage Info: 20 Kg Included" | ||
| |
2.1 | 261 | } |
| |
3.1 | 262 | ], |
| 263 | "transfers": [ | ||
| 264 | { | ||
| 265 | "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0", | ||
| 266 | "transferType": "ARRIVAL", | ||
| 267 | "vehicleName": "GROUP", | ||
| 268 | "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 269 | "touristName": "Teeeeest Teest", | ||
| 270 | "date": "2024-05-17T00:00:00.000", | ||
| 271 | "fromTerminal": "DXB", | ||
| 272 | "fromCityName": "Dubai", | ||
| 273 | "toHotelName": "Ibis Al Rigga", | ||
| 274 | "toCityName": "Dubai", | ||
| 275 | "note": "teeeest, for testing purpose !, Contact Number: 597101803" | ||
| 276 | }, | ||
| 277 | { | ||
| 278 | "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32", | ||
| 279 | "transferType": "DEPARTURE", | ||
| 280 | "vehicleName": "GROUP", | ||
| 281 | "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 282 | "touristName": "Teeeeest Teest", | ||
| 283 | "date": "2024-05-21T00:00:00.000", | ||
| 284 | "fromCityName": "Dubai", | ||
| 285 | "fromHotelName": "Ibis Al Rigga", | ||
| 286 | "toTerminal": "DXB", | ||
| 287 | "toCityName": "Dubai" | ||
| 288 | }, | ||
| 289 | { | ||
| 290 | "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0", | ||
| 291 | "transferType": "ARRIVAL", | ||
| 292 | "vehicleName": "GROUP", | ||
| 293 | "touristId": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 294 | "touristName": "Test Teeeest", | ||
| 295 | "date": "2024-05-17T00:00:00.000", | ||
| 296 | "fromTerminal": "DXB", | ||
| 297 | "fromCityName": "Dubai", | ||
| 298 | "toHotelName": "Ibis Al Rigga", | ||
| 299 | "toCityName": "Dubai", | ||
| 300 | "note": "teeeest, for testing purpose !, Contact Number: 597101803" | ||
| 301 | }, | ||
| 302 | { | ||
| 303 | "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32", | ||
| 304 | "transferType": "DEPARTURE", | ||
| 305 | "vehicleName": "GROUP", | ||
| 306 | "touristId": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 307 | "touristName": "Test Teeeest", | ||
| 308 | "date": "2024-05-21T00:00:00.000", | ||
| 309 | "fromCityName": "Dubai", | ||
| 310 | "fromHotelName": "Ibis Al Rigga", | ||
| 311 | "toTerminal": "DXB", | ||
| 312 | "toCityName": "Dubai" | ||
| 313 | } | ||
| 314 | ], | ||
| 315 | "services": [ | ||
| 316 | { | ||
| 317 | "id": "4c5d1e9c-2b87-4ec8-9bd8-96a270419322", | ||
| 318 | "serviceDate": "2024-05-17T07:10:00.000", | ||
| 319 | "serviceName": "Insurance", | ||
| 320 | "touristId": "27977a19-045e-4990-95a8-fbd7d49083de", | ||
| 321 | "touristName": "Test Teeeest" | ||
| 322 | }, | ||
| 323 | { | ||
| 324 | "id": "1e1ad6a2-ee59-4c8c-868c-34a25343e7ca", | ||
| 325 | "serviceDate": "2024-05-17T07:10:00.000", | ||
| 326 | "serviceName": "Insurance", | ||
| 327 | "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82", | ||
| 328 | "touristName": "Teeeeest Teest" | ||
| 329 | } | ||
| 330 | ] | ||
| 331 | } | ||
| 332 | } | ||
| |
2.1 | 333 | {{/code}} |
| 334 | |||
| 335 | |||
| 336 | === Schema === | ||
| 337 | |||
| 338 | {{success}} | ||
| |
3.1 | 339 | GetReservationDetailsResponse{ |
| |
2.1 | 340 | |
| |
3.1 | 341 | |reservation|ReservationDetails{((( |
| 342 | |id|string($uuid) | ||
| 343 | |rfNumber|string | ||
| |
2.1 | 344 | nullable: true |
| |
3.1 | 345 | |contactNumber|string |
| |
2.1 | 346 | nullable: true |
| |
3.1 | 347 | |agentName|string |
| |
2.1 | 348 | nullable: true |
| |
3.1 | 349 | |totalPrice|number($double) |
| 350 | |agentCommission|number($double) | ||
| 351 | |netPrice|number($double) | ||
| |
2.1 | 352 | nullable: true |
| |
3.1 | 353 | |currency|string |
| |
2.1 | 354 | nullable: true |
| |
3.1 | 355 | |tourists|[ |
| 356 | nullable: trueResDetailsTourist{((( | ||
| 357 | |id|string($uuid) | ||
| 358 | |gender|GenderEnumstringEnum: | ||
| 359 | [ None, Male, Female ] | ||
| 360 | |ageCategory|AgeCategorystringEnum: | ||
| 361 | [ Adult, Infant, Child ] | ||
| 362 | |firstName|string | ||
| |
2.1 | 363 | nullable: true |
| |
3.1 | 364 | |lastName|string |
| |
2.1 | 365 | nullable: true |
| |
3.1 | 366 | |birthDate|string($date-time) |
| |
2.1 | 367 | nullable: true |
| |
3.1 | 368 | |passportNumber|string |
| |
2.1 | 369 | nullable: true |
| |
3.1 | 370 | |passportExpiryDate|string($date-time) |
| |
2.1 | 371 | nullable: true |
| |
3.1 | 372 | |tin|string |
| |
2.1 | 373 | nullable: true |
| |
3.1 | 374 | |citizenshipCountryCode|string |
| |
2.1 | 375 | nullable: true |
| |
3.1 | 376 | |citizenshipCountryName|string |
| |
2.1 | 377 | nullable: true |
| |
3.1 | 378 | |mobile|string |
| |
2.1 | 379 | nullable: true |
| |
3.1 | 380 | |email|string |
| |
2.1 | 381 | nullable: true |
| |
3.1 | 382 | |arrivalDate|string($date-time) |
| |
2.1 | 383 | nullable: true |
| |
3.1 | 384 | |arrivalFlightNumber|string |
| |
2.1 | 385 | nullable: true |
| |
3.1 | 386 | |arrivalTerminalCode|string |
| 387 | nullable: true | ||
| 388 | |returnDate|string($date-time) | ||
| 389 | nullable: true | ||
| 390 | |returnFlightNumber|string | ||
| 391 | nullable: true | ||
| 392 | |returnTerminalCode|string | ||
| 393 | nullable: true | ||
| 394 | |showReturn|boolean | ||
| 395 | |||
| 396 | }] | ||
| 397 | ))) | ||
| 398 | |hotels|[ | ||
| 399 | nullable: trueResDetailsHotel{((( | ||
| 400 | |id|string($uuid) | ||
| 401 | |hotelName|string | ||
| 402 | nullable: true | ||
| |
2.1 | 403 | |cityName|string |
| 404 | nullable: true | ||
| |
3.1 | 405 | |hotelClass|string |
| |
2.1 | 406 | nullable: true |
| |
3.1 | 407 | |checkInDate|string($date-time) |
| 408 | |checkOutDate|string($date-time) | ||
| 409 | |roomCategoryName|string | ||
| |
2.1 | 410 | nullable: true |
| |
3.1 | 411 | |placementName|string |
| |
2.1 | 412 | nullable: true |
| |
3.1 | 413 | |mealPlan|string |
| |
2.1 | 414 | nullable: true |
| |
3.1 | 415 | |agentConfirmationNumber|string |
| |
2.1 | 416 | nullable: true |
| |
3.1 | 417 | |
| 418 | }] | ||
| 419 | ))) | ||
| 420 | |flights|[ | ||
| 421 | nullable: trueResDetailsFlight{((( | ||
| 422 | |id|string($uuid) | ||
| 423 | |isArrival|boolean | ||
| 424 | |touristId|string($uuid) | ||
| 425 | |touristName|string | ||
| |
2.1 | 426 | nullable: true |
| |
3.1 | 427 | |date|string($date-time) |
| 428 | |departureAirport|string | ||
| |
2.1 | 429 | nullable: true |
| |
3.1 | 430 | |departureTerminal|string |
| |
2.1 | 431 | nullable: true |
| |
3.1 | 432 | |arrivalAirport|string |
| |
2.1 | 433 | nullable: true |
| |
3.1 | 434 | |arrivalTerminal|string |
| |
2.1 | 435 | nullable: true |
| |
3.1 | 436 | |agentConfirmationNumber|string |
| |
2.1 | 437 | nullable: true |
| |
3.1 | 438 | |bookingConfirmationNumber|string |
| |
2.1 | 439 | nullable: true |
| |
3.1 | 440 | |note|string |
| 441 | nullable: true | ||
| |
2.1 | 442 | |
| 443 | }] | ||
| 444 | ))) | ||
| |
3.1 | 445 | |transfers|[ |
| 446 | nullable: trueResDetailsTransfer{((( | ||
| 447 | |id|string($uuid) | ||
| 448 | |transferType|string | ||
| |
2.1 | 449 | nullable: true |
| |
3.1 | 450 | |vehicleName|string |
| |
2.1 | 451 | nullable: true |
| |
3.1 | 452 | |touristId|string($uuid) |
| 453 | |touristName|string | ||
| |
2.1 | 454 | nullable: true |
| |
3.1 | 455 | |date|string($date-time) |
| 456 | |fromTerminal|string | ||
| |
2.1 | 457 | nullable: true |
| |
3.1 | 458 | |fromCityName|string |
| |
2.1 | 459 | nullable: true |
| |
3.1 | 460 | |fromHotelName|string |
| |
2.1 | 461 | nullable: true |
| |
3.1 | 462 | |toHotelName|string |
| |
2.1 | 463 | nullable: true |
| |
3.1 | 464 | |toTerminal|string |
| |
2.1 | 465 | nullable: true |
| |
3.1 | 466 | |toCityName|string |
| |
2.1 | 467 | nullable: true |
| |
3.1 | 468 | |agentConfirmationNumber|string |
| 469 | nullable: true | ||
| 470 | |note|string | ||
| 471 | nullable: true | ||
| |
2.1 | 472 | |
| 473 | }] | ||
| 474 | ))) | ||
| |
3.1 | 475 | |services|[ |
| 476 | nullable: trueResDetailsService{((( | ||
| 477 | |id|string($uuid) | ||
| 478 | |serviceDate|string($date-time) | ||
| 479 | |serviceName|string | ||
| 480 | nullable: true | ||
| 481 | |touristId|string($uuid) | ||
| 482 | |touristName|string | ||
| 483 | nullable: true | ||
| 484 | |note|string | ||
| 485 | nullable: true | ||
| |
2.1 | 486 | |
| 487 | }] | ||
| 488 | ))) | ||
| 489 | |||
| 490 | } | ||
| 491 | ))) | ||
| 492 | |||
| 493 | } | ||
| 494 | {{/success}} | ||
| |
5.1 | 495 | |
| 496 | |||
| 497 | == Description == | ||
| 498 | |||
| 499 | |||
| |
6.1 | 500 | (% class="table-bordered" %) |
| |
5.1 | 501 | |=Parameter|=Value Type|=Description |
| 502 | |id|String|The unique identifier for the reservation, typically a UUID or similar. | ||
| 503 | |rfNumber|String|The reference number for the reservation, usually generated by the system. | ||
| 504 | |contactNumber|String|The contact number associated with the reservation, used for communication purposes. | ||
| 505 | |agentName|String|The name of the agent who made the reservation, useful for tracking and accountability. | ||
| 506 | |totalPrice|Number|The total price of the reservation, calculated based on the services and products included. | ||
| 507 | |agentCommission|Number|The commission earned by the agent for this reservation, calculated as a percentage of the total price. | ||
| 508 | |currency|String|The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR). | ||
| |
7.1 | 509 | |tourists[].id|String|The unique identifier for each tourist, typically a UUID. |
| 510 | |tourists[].gender|String|The gender of the tourist, usually : [ None, Male, Female ] | ||
| |
5.1 | 511 | |tourists[].ageCategory|String|The age category of the tourist, such as 'Adult', 'Child', or 'Infant'. |
| 512 | |tourists[].firstName|String|The first name of the tourist, as it appears on their passport. | ||
| 513 | |tourists[].lastName|String|The last name of the tourist, as it appears on their passport. | ||
| 514 | |tourists[].birthDate|String (Date)|The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 515 | |tourists[].passportNumber|String|The passport number of the tourist, as it appears on their passport. | ||
| 516 | |tourists[].passportExpiryDate|String (Date)|The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 517 | |tourists[].citizenshipCountryCode|String|The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB). | ||
| 518 | |tourists[].citizenshipCountryName|String|The full name of the tourist's country of citizenship. | ||
| 519 | |tourists[].arrivalDate|String (Date)|The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 520 | |tourists[].arrivalFlightNumber|String|The flight number for the tourist's arrival, as provided by the airline. | ||
| 521 | |tourists[].arrivalTerminalCode|String|The terminal code for the tourist's arrival, as provided by the airport. | ||
| 522 | |tourists[].returnDate|String (Date)|The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 523 | |tourists[].returnFlightNumber|String|The flight number for the tourist's return, as provided by the airline. | ||
| 524 | |tourists[].returnTerminalCode|String|The terminal code for the tourist's return, as provided by the airport. | ||
| 525 | |tourists[].showReturn|Boolean|A boolean indicating whether the return information should be displayed, useful for one-way trips. | ||
| 526 | |hotels[].id|String|The unique identifier for each hotel booking, typically a UUID or similar. | ||
| 527 | |hotels[].hotelName|String|The name of the hotel where the booking is made. | ||
| 528 | |hotels[].cityName|String|The city where the hotel is located. | ||
| 529 | |hotels[].hotelClass|String|The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc. | ||
| 530 | |hotels[].checkInDate|String (Date)|The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 531 | |hotels[].checkOutDate|String (Date)|The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD). | ||
| 532 | |hotels[].roomCategoryName|String|The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc. | ||
| 533 | |hotels[].placementName|String|The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc. | ||
| 534 | |hotels[].mealPlan|String|The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc. | ||
| 535 | |flights[].id|String|The unique identifier for each flight, typically a UUID or similar. | ||
| 536 | |flights[].isArrival|Boolean|A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights. | ||
| 537 | |flights[].touristId|String|The id of the tourist taking this flight, linking the flight to a specific tourist. | ||
| 538 | |flights[].touristName|String|The name of the tourist taking this flight, useful for passenger lists. | ||
| 539 | |flights[].date|String (Date)|The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). | ||
| 540 | |flights[].departureAirport|String|The IATA code of the airport from which the flight departs (e.g., JFK, LHR). | ||
| 541 | |flights[].departureTerminal|String|The terminal from which the flight departs, as provided by the airport. | ||
| 542 | |flights[].arrivalAirport|String|The IATA code of the airport at which the flight arrives (e.g., JFK, LHR). | ||
| 543 | |flights[].arrivalTerminal|String|The terminal at which the flight arrives, as provided by the airport. | ||
| 544 | |flights[].note|String|Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc. | ||
| 545 | |transfers[].id|String|The unique identifier for each transfer, typically a UUID or similar. | ||
| 546 | |transfers[].transferType|String|The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers. | ||
| 547 | |transfers[].vehicleName|String|The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc. | ||
| 548 | |transfers[].touristId|String|The id of the tourist using this transfer, linking the transfer to a specific tourist. | ||
| 549 | |transfers[].touristName|String|The name of the tourist using this transfer, useful for passenger lists. | ||
| 550 | |transfers[].date|String (Date)|The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). | ||
| 551 | |transfers[].fromTerminal|String|The terminal from which the transfer starts, as provided by the airport or hotel. | ||
| 552 | |transfers[].fromCityName|String|The city from which the transfer starts. | ||
| 553 | |transfers[].toHotelName|String|The hotel to which the transfer goes. | ||
| 554 | |transfers[].toCityName|String|The city to which the transfer goes. | ||
| 555 | |transfers[].note|String|Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc. | ||
| 556 | |services[].id|String|The unique identifier for each service, typically a UUID or similar. | ||
| 557 | |services[].serviceDate|String (Date)|The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). | ||
| 558 | |services[].serviceName|String|The name of the service, such as insurance in this example. | ||
| 559 | |services[].touristId|String|The id of the tourist using this service, linking the service to a specific tourist. | ||
| 560 | |services[].touristName|String|The name of the tourist using this service, useful for booking confirmations. |