Skip to Content

Wiki source code of 5. GetReservationDetails

Last modified by Giorgi Mdivnishvili on 2024/04/12 19:08
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
8
9
10 This API endpoint facilitates the retrieval of information pertaining to a previously booked reservation for data verification purposes.
11
12 To utilize this functionality, simply provide the reservationId parameter obtained following the initial reservation request and submit the API request.
13
14
15 == Endpoint URL - [POST] ==
16
17 {{info}}
18 [[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservationDetails>>https://integration.kazunion.com/api/Reservations/GetReservationDetails]]
19 {{/info}}
20
21
22 == Request Parameters ==
23
24 (% class="box infomessage" %)
25 (((
26 None
27 )))
28
29
30 == Request Body ==
31
32 {{code language="Json"}}
33 {"id":"e5955628-9fbb-4418-89e4-a928a6f92d59"}
34 {{/code}}
35
36 (% class="wikigeneratedid" id="HRequestBodyexample" %)
37 (% id="cke_bm_10575S" style="display:none" %)
38
39
40
41 == Request Body example ==
42
43 {{code language="Json"}}
44 {"id":"e5955628-9fbb-4418-89e4-a928a6f92d59"}
45 {{/code}}
46
47
48 == Response example ==
49
50 {{code language="Json"}}
51 {
52 "reservation": {
53 "id": "e5955628-9fbb-4418-89e4-a928a6f92d59",
54 "rfNumber": "314612 / 104586",
55 "contactNumber": "teeeest, for testing purpose !, Contact Number: 597101803",
56 "agentName": "Mr. Giorgi Mdivnishvili",
57 "totalPrice": 47,
58 "agentCommission": 0,
59 "currency": "USD",
60 "tourists": [
61 {
62 "id": "69c369ca-cc96-40a3-bc72-914570239d52",
63 "gender": "Male",
64 "ageCategory": "Adult",
65 "firstName": "Teeeest",
66 "lastName": "Teeeest",
67 "passportNumber": "123123",
68 "passportExpiryDate": "2025-09-23T00:00:00.000",
69 "citizenshipCountryCode": "KZ",
70 "citizenshipCountryName": "Kazakhstan",
71 "arrivalDate": "2024-06-30T00:00:00.000",
72 "arrivalTerminalCode": "DXB2",
73 "returnDate": "2024-07-01T00:00:00.000",
74 "returnTerminalCode": "DXB2",
75 "showReturn": true
76 },
77 {
78 "id": "22c86f25-0914-499e-86e8-f3da7cc1b6f4",
79 "gender": "Male",
80 "ageCategory": "Adult",
81 "firstName": "Teeeest",
82 "lastName": "Teeeest",
83 "birthDate": "1990-09-23T00:00:00.000",
84 "passportNumber": "1231233",
85 "passportExpiryDate": "2025-12-23T00:00:00.000",
86 "citizenshipCountryCode": "KZ",
87 "citizenshipCountryName": "Kazakhstan",
88 "arrivalDate": "2024-06-30T00:00:00.000",
89 "arrivalTerminalCode": "DXB2",
90 "returnDate": "2024-07-01T00:00:00.000",
91 "returnTerminalCode": "DXB2",
92 "showReturn": true
93 }
94 ],
95 "hotels": [
96 {
97 "id": "df273eac-855f-40da-b115-258647183adf",
98 "hotelName": "Royal Continental Hotel",
99 "cityName": "Dubai",
100 "hotelClass": "4",
101 "checkInDate": "2024-06-30T00:00:00.000",
102 "checkOutDate": "2024-07-01T00:00:00.000",
103 "roomCategoryName": "Superior King Room",
104 "placementName": "DBL",
105 "mealPlan": "RO"
106 }
107 ],
108 "flights": [],
109 "transfers": [],
110 "services": []
111 }
112 }
113 {{/code}}
114
115
116 === Schema ===
117
118 {{success}}
119 GetReservationDetailsResponse{
120
121 |reservation|ReservationDetails{(((
122 |id|string($uuid)
123 |rfNumber|string
124 nullable: true
125 |contactNumber|string
126 nullable: true
127 |agentName|string
128 nullable: true
129 |totalPrice|number($double)
130 |agentCommission|number($double)
131 |netPrice|number($double)
132 nullable: true
133 |currency|string
134 nullable: true
135 |tourists|[
136 nullable: trueResDetailsTourist{(((
137 |id|string($uuid)
138 |gender|GenderEnumstringEnum:
139 [ None, Male, Female ]
140 |ageCategory|AgeCategorystringEnum:
141 [ Adult, Infant, Child ]
142 |firstName|string
143 nullable: true
144 |lastName|string
145 nullable: true
146 |birthDate|string($date-time)
147 nullable: true
148 |passportNumber|string
149 nullable: true
150 |passportExpiryDate|string($date-time)
151 nullable: true
152 |tin|string
153 nullable: true
154 |citizenshipCountryCode|string
155 nullable: true
156 |citizenshipCountryName|string
157 nullable: true
158 |mobile|string
159 nullable: true
160 |email|string
161 nullable: true
162 |arrivalDate|string($date-time)
163 nullable: true
164 |arrivalFlightNumber|string
165 nullable: true
166 |arrivalTerminalCode|string
167 nullable: true
168 |returnDate|string($date-time)
169 nullable: true
170 |returnFlightNumber|string
171 nullable: true
172 |returnTerminalCode|string
173 nullable: true
174 |showReturn|boolean
175
176 }]
177 )))
178 |hotels|[
179 nullable: trueResDetailsHotel{(((
180 |id|string($uuid)
181 |hotelName|string
182 nullable: true
183 |cityName|string
184 nullable: true
185 |hotelClass|string
186 nullable: true
187 |checkInDate|string($date-time)
188 |checkOutDate|string($date-time)
189 |roomCategoryName|string
190 nullable: true
191 |placementName|string
192 nullable: true
193 |mealPlan|string
194 nullable: true
195 |agentConfirmationNumber|string
196 nullable: true
197
198 }]
199 )))
200 |flights|[
201 nullable: trueResDetailsFlight{(((
202 |id|string($uuid)
203 |isArrival|boolean
204 |touristId|string($uuid)
205 |touristName|string
206 nullable: true
207 |date|string($date-time)
208 |departureAirport|string
209 nullable: true
210 |departureTerminal|string
211 nullable: true
212 |arrivalAirport|string
213 nullable: true
214 |arrivalTerminal|string
215 nullable: true
216 |agentConfirmationNumber|string
217 nullable: true
218 |bookingConfirmationNumber|string
219 nullable: true
220 |note|string
221 nullable: true
222
223 }]
224 )))
225 |transfers|[
226 nullable: trueResDetailsTransfer{(((
227 |id|string($uuid)
228 |transferType|string
229 nullable: true
230 |vehicleName|string
231 nullable: true
232 |touristId|string($uuid)
233 |touristName|string
234 nullable: true
235 |date|string($date-time)
236 |fromTerminal|string
237 nullable: true
238 |fromCityName|string
239 nullable: true
240 |fromHotelName|string
241 nullable: true
242 |toHotelName|string
243 nullable: true
244 |toTerminal|string
245 nullable: true
246 |toCityName|string
247 nullable: true
248 |agentConfirmationNumber|string
249 nullable: true
250 |note|string
251 nullable: true
252
253 }]
254 )))
255 |services|[
256 nullable: trueResDetailsService{(((
257 |id|string($uuid)
258 |serviceDate|string($date-time)
259 |serviceName|string
260 nullable: true
261 |touristId|string($uuid)
262 |touristName|string
263 nullable: true
264 |note|string
265 nullable: true
266
267 }]
268 )))
269
270 }
271 )))
272
273 }
274 {{/success}}
275
276
277 == Description ==
278
279
280 (% class="table-bordered" %)
281 |=Parameter|=Value Type|=Description
282 |id|String|The unique identifier for the reservation, typically a UUID or similar.
283 |rfNumber|String|The reference number for the reservation, usually generated by the system.
284 |contactNumber|String|The contact number associated with the reservation, used for communication purposes.
285 |agentName|String|The name of the agent who made the reservation, useful for tracking and accountability.
286 |totalPrice|Number|The total price of the reservation, calculated based on the services and products included.
287 |agentCommission|Number|The commission earned by the agent for this reservation, calculated as a percentage of the total price.
288 |currency|String|The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR).
289 |tourists[].id|String|The unique identifier for each tourist, typically a UUID.
290 |tourists[].gender|String|The gender of the tourist, usually : [ None, Male, Female ]
291 |tourists[].ageCategory|String|The age category of the tourist, such as 'Adult', 'Child', or 'Infant'.
292 |tourists[].firstName|String|The first name of the tourist, as it appears on their passport.
293 |tourists[].lastName|String|The last name of the tourist, as it appears on their passport.
294 |tourists[].birthDate|String (Date)|The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD).
295 |tourists[].passportNumber|String|The passport number of the tourist, as it appears on their passport.
296 |tourists[].passportExpiryDate|String (Date)|The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD).
297 |tourists[].citizenshipCountryCode|String|The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB).
298 |tourists[].citizenshipCountryName|String|The full name of the tourist's country of citizenship.
299 |tourists[].arrivalDate|String (Date)|The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD).
300 |tourists[].arrivalFlightNumber|String|The flight number for the tourist's arrival, as provided by the airline.
301 |tourists[].arrivalTerminalCode|String|The terminal code for the tourist's arrival, as provided by the airport.
302 |tourists[].returnDate|String (Date)|The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD).
303 |tourists[].returnFlightNumber|String|The flight number for the tourist's return, as provided by the airline.
304 |tourists[].returnTerminalCode|String|The terminal code for the tourist's return, as provided by the airport.
305 |tourists[].showReturn|Boolean|A boolean indicating whether the return information should be displayed, useful for one-way trips.
306 |hotels[].id|String|The unique identifier for each hotel booking, typically a UUID or similar.
307 |hotels[].hotelName|String|The name of the hotel where the booking is made.
308 |hotels[].cityName|String|The city where the hotel is located.
309 |hotels[].hotelClass|String|The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc.
310 |hotels[].checkInDate|String (Date)|The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
311 |hotels[].checkOutDate|String (Date)|The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
312 |hotels[].roomCategoryName|String|The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc.
313 |hotels[].placementName|String|The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc.
314 |hotels[].mealPlan|String|The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc.
315 |flights[].id|String|The unique identifier for each flight, typically a UUID or similar.
316 |flights[].isArrival|Boolean|A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights.
317 |flights[].touristId|String|The id of the tourist taking this flight, linking the flight to a specific tourist.
318 |flights[].touristName|String|The name of the tourist taking this flight, useful for passenger lists.
319 |flights[].date|String (Date)|The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
320 |flights[].departureAirport|String|The IATA code of the airport from which the flight departs (e.g., JFK, LHR).
321 |flights[].departureTerminal|String|The terminal from which the flight departs, as provided by the airport.
322 |flights[].arrivalAirport|String|The IATA code of the airport at which the flight arrives (e.g., JFK, LHR).
323 |flights[].arrivalTerminal|String|The terminal at which the flight arrives, as provided by the airport.
324 |flights[].note|String|Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc.
325 |transfers[].id|String|The unique identifier for each transfer, typically a UUID or similar.
326 |transfers[].transferType|String|The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers.
327 |transfers[].vehicleName|String|The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc.
328 |transfers[].touristId|String|The id of the tourist using this transfer, linking the transfer to a specific tourist.
329 |transfers[].touristName|String|The name of the tourist using this transfer, useful for passenger lists.
330 |transfers[].date|String (Date)|The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
331 |transfers[].fromTerminal|String|The terminal from which the transfer starts, as provided by the airport or hotel.
332 |transfers[].fromCityName|String|The city from which the transfer starts.
333 |transfers[].toHotelName|String|The hotel to which the transfer goes.
334 |transfers[].toCityName|String|The city to which the transfer goes.
335 |transfers[].note|String|Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc.
336 |services[].id|String|The unique identifier for each service, typically a UUID or similar.
337 |services[].serviceDate|String (Date)|The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
338 |services[].serviceName|String|The name of the service, such as insurance in this example.
339 |services[].touristId|String|The id of the tourist using this service, linking the service to a specific tourist.
340 |services[].touristName|String|The name of the tourist using this service, useful for booking confirmations.