Skip to Content

Wiki source code of 6. GetReservationDetails

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