Changes for page 7. GetReservations

Last modified by Giorgi Mdivnishvili on 2024/08/16 18:29

From version 4.1
edited by Giorgi Mdivnishvili
on 2024/08/16 18:18
Change comment: There is no comment for this version
To version 1.1
edited by Giorgi Mdivnishvili
on 2024/08/16 17:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -7. GetReservations
1 +GetReservations
Content
... ... @@ -1,646 +1,32 @@
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 -
3 -
4 4  {{toc/}}
5 5  {{/box}}
6 6  
7 -= Method Description =
5 += Paragraph 1 =
8 8  
7 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
9 9  
10 -**Objective:** The GetReservations method is designed to retrieve a comprehensive list of past reservations along with detailed information associated with each reservation. This method is particularly useful for users who need to perform targeted data retrieval by applying specific filters. By enabling the use of parameters such as date ranges, reservation IDs, tourist information, and more, the GetReservations method allows for precise and efficient querying of reservation data. This capability streamlines the process of accessing relevant information, ensuring that users can quickly and accurately retrieve the exact data they need without sifting through unnecessary records.
9 +== Sub-paragraph ==
11 11  
11 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
12 12  
13 -== Endpoint URL - [POST] ==
13 +== Sub-paragraph ==
14 14  
15 -{{info}}
16 -[[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservations>>https://integration.kazunion.com/api/Reservations/GetReservations]]
17 -{{/info}}
15 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
18 18  
17 +=== Sub-sub paragraph ===
19 19  
20 -== Request Parameters ==
19 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
21 21  
22 -(% class="box infomessage" %)
23 -(((
24 -None
25 -)))
26 26  
22 += Paragraph 2 =
27 27  
28 -== Request Body ==
24 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
29 29  
30 -{{code language="Json"}}
31 -{
32 - "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
33 - "number": "string",
34 - "checkInStart": "2024-08-16T14:13:00.686Z",
35 - "checkInEnd": "2024-08-16T14:13:00.686Z",
36 - "checkOutStart": "2024-08-16T14:13:00.686Z",
37 - "checkOutEnd": "2024-08-16T14:13:00.686Z",
38 - "registrationDateStart": "2024-08-16T14:13:00.686Z",
39 - "registrationDateEnd": "2024-08-16T14:13:00.686Z",
40 - "statusForAgent": "New",
41 - "countryCode": "string",
42 - "touristLastName": "string"
43 -}
44 -{{/code}}
26 +== Sub-paragraph ==
45 45  
46 -(% class="wikigeneratedid" id="HRequestBodyexample" %)
47 -(% id="cke_bm_10575S" style="display:none" %)
28 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
48 48  
30 +== Sub-paragraph ==
49 49  
50 -
51 -== Request Body example ==
52 -
53 -{{code language="Json"}}
54 -{
55 -
56 - "registrationDateStart": "2024-06-16",
57 - "registrationDateEnd": "2024-09-16"
58 -
59 -}
60 -{{/code}}
61 -
62 -
63 -== Response ==
64 -
65 -{{code language="JSON"}}
66 -{
67 - "pageId": 0,
68 - "pagesCount": 0,
69 - "reservations": [
70 - {
71 - "id": "07fff3fd-7ae9-409f-b50b-2cc7a948b8d0",
72 - "number": "110576",
73 - "agentConfirmationNumber": "",
74 - "registrationDate": "2024-07-11T10:09:52.243",
75 - "packageType": "Package",
76 - "status": "Canceled",
77 - "statusForAgent": "Canceled",
78 - "departureToAirlineName": "N/A",
79 - "arrivalTime": "2024-09-23T07:15:00.000",
80 - "arrivalCountryName": "United Arab Emirates",
81 - "departureTime": "2024-09-29T21:30:00.000",
82 - "pickupPeriods": [],
83 - "driverMobile": "N/A",
84 - "paymentInOutInvCurrency": {
85 - "price": 952.90,
86 - "netPrice": 952.90,
87 - "paid": 0.00,
88 - "unpaid": 952.90,
89 - "comission": 0.00,
90 - "comissionPercent": 0
91 - },
92 - "paymentInSellCurrency": {
93 - "currencyCode": "USD",
94 - "price": 952.90,
95 - "netPrice": 952.90,
96 - "paid": 0.00,
97 - "unpaid": 952.90,
98 - "comission": 0.00,
99 - "comissionPercent": 0
100 - },
101 - "showDownloadDocuments": false,
102 - "guideMeetings": [],
103 - "services": [
104 - {
105 - "id": "00000000-0000-0000-0000-000000000000",
106 - "serviceDate": "0001-01-01T00:00:00.000",
107 - "type": "Hotel",
108 - "description": "N/A (N/A*) 23.09.2024 - 29.09.2024 / N/A N/A DBL",
109 - "touristIds": [
110 - "29236304-d23c-4999-88ec-76ac4b99b614",
111 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
112 - ]
113 - },
114 - {
115 - "id": "00000000-0000-0000-0000-000000000000",
116 - "serviceDate": "0001-01-01T00:00:00.000",
117 - "type": "AviaTicket",
118 - "touristIds": [
119 - "29236304-d23c-4999-88ec-76ac4b99b614",
120 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
121 - ],
122 - "serviceDetails": [
123 - {
124 - "flightCode": "FZ1721",
125 - "airlineName": "N/A",
126 - "departureTime": "2024-09-29T21:30:00.000",
127 - "departureCityName": "Almaty",
128 - "departureAirportCode": "ALA",
129 - "departureTerminalCode": "DXB3",
130 - "arrivalTime": "2024-09-23T07:15:00.000",
131 - "arrivalCityName": "Dubai",
132 - "arrivalAirportCode": "DXB",
133 - "isArrivalFlight": false
134 - }
135 - ]
136 - },
137 - {
138 - "id": "00000000-0000-0000-0000-000000000000",
139 - "serviceDate": "0001-01-01T00:00:00.000",
140 - "type": "AviaTicket",
141 - "touristIds": [
142 - "29236304-d23c-4999-88ec-76ac4b99b614",
143 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
144 - ],
145 - "serviceDetails": [
146 - {
147 - "flightCode": "FZ1721",
148 - "airlineName": "N/A",
149 - "departureTime": "2024-09-29T21:30:00.000",
150 - "departureCityName": "Dubai",
151 - "departureAirportCode": "DXB",
152 - "departureTerminalCode": "DXB3",
153 - "arrivalTime": "2024-09-30T02:40:00.000",
154 - "arrivalCityName": "Almaty",
155 - "arrivalAirportCode": "ALA",
156 - "isArrivalFlight": false
157 - }
158 - ]
159 - },
160 - {
161 - "id": "97ba44e6-9158-40fe-8ec5-49626d786446",
162 - "serviceDate": "0001-01-01T00:00:00.000",
163 - "type": "Transfer",
164 - "description": "Трансфер: Прилет Индивидуальный 23.09.2024 Dubai DXB -> Concorde Inn Hotel, Bur Dubai, United Arab Emirates",
165 - "touristIds": [
166 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c",
167 - "29236304-d23c-4999-88ec-76ac4b99b614"
168 - ]
169 - },
170 - {
171 - "id": "c404e59c-6cab-491c-a3ff-f712cf74103c",
172 - "serviceDate": "0001-01-01T00:00:00.000",
173 - "type": "Transfer",
174 - "description": "Трансфер: Вылет Индивидуальный 29.09.2024 с Concorde Inn Hotel -> DXB, Dubai United Arab Emirates",
175 - "touristIds": [
176 - "29236304-d23c-4999-88ec-76ac4b99b614",
177 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
178 - ]
179 - },
180 - {
181 - "id": "fb8c4e42-03e8-4bb7-8fc9-2783ae664510",
182 - "serviceDate": "0001-01-01T00:00:00.000",
183 - "type": "Insurance",
184 - "description": "Страхование: N/A (10000 USD) 23.09.2024 - 29.09.2024",
185 - "touristIds": [
186 - "29236304-d23c-4999-88ec-76ac4b99b614"
187 - ]
188 - },
189 - {
190 - "id": "97c32399-66b5-414b-bd88-d9c4584b22b1",
191 - "serviceDate": "0001-01-01T00:00:00.000",
192 - "type": "Insurance",
193 - "description": "Страхование: N/A (10000 USD) 23.09.2024 - 29.09.2024",
194 - "touristIds": [
195 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
196 - ]
197 - }
198 - ],
199 - "tourists": [
200 - {
201 - "id": "29236304-d23c-4999-88ec-76ac4b99b614",
202 - "gender": "Male",
203 - "ageCategory": "Adult",
204 - "title": "MR.",
205 - "firstName": "Teeeeest",
206 - "lastName": "Teeeest",
207 - "birthDate": "1990-09-23T00:00:00",
208 - "passportNumber": "1231233",
209 - "passportExpiryDate": "2029-12-23T00:00:00",
210 - "citizenshipCountryCode": "N/A",
211 - "canEdit": false
212 - },
213 - {
214 - "id": "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c",
215 - "gender": "Male",
216 - "ageCategory": "Adult",
217 - "title": "MR.",
218 - "firstName": "Test",
219 - "lastName": "Teeeest",
220 - "birthDate": "1990-09-23T00:00:00",
221 - "passportNumber": "123123",
222 - "passportExpiryDate": "2029-12-23T00:00:00",
223 - "citizenshipCountryCode": "N/A",
224 - "canEdit": false
225 - }
226 - ],
227 - "documents": []
228 - }
229 - ]
230 -}
231 -{{/code}}
232 -
233 -
234 -=== Response example ===
235 -
236 -{{code language="Json"}}
237 -{
238 - "reservation": {
239 - "id": "3882a7ee-fec1-4bd3-9e73-ccc4613be36d",
240 - "rfNumber": "314303 / 104429",
241 - "contactNumber": "teeeest, for testing purpose !, Contact Number: 597101803",
242 - "agentName": "Mr. Giorgi Mdivnishvili",
243 - "totalPrice": 782,
244 - "agentCommission": 0,
245 - "currency": "USD",
246 - "tourists": [
247 - {
248 - "id": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
249 - "gender": "Male",
250 - "ageCategory": "Adult",
251 - "firstName": "Teeeeest",
252 - "lastName": "Teest",
253 - "birthDate": "1990-09-23T00:00:00.000",
254 - "passportNumber": "1231233",
255 - "passportExpiryDate": "2029-12-23T00:00:00.000",
256 - "citizenshipCountryCode": "GE",
257 - "citizenshipCountryName": "Georgia",
258 - "arrivalDate": "2024-05-17T07:10:00.000",
259 - "arrivalFlightNumber": "FZ1722",
260 - "arrivalTerminalCode": "DXB3",
261 - "returnDate": "2024-05-21T21:25:00.000",
262 - "returnFlightNumber": "FZ1721",
263 - "returnTerminalCode": "DXB3",
264 - "showReturn": true
265 - },
266 - {
267 - "id": "27977a19-045e-4990-95a8-fbd7d49083de",
268 - "gender": "Male",
269 - "ageCategory": "Adult",
270 - "firstName": "Test",
271 - "lastName": "Teeeest",
272 - "birthDate": "1990-09-23T00:00:00.000",
273 - "passportNumber": "123123",
274 - "passportExpiryDate": "2029-12-23T00:00:00.000",
275 - "citizenshipCountryCode": "GE",
276 - "citizenshipCountryName": "Georgia",
277 - "arrivalDate": "2024-05-17T07:10:00.000",
278 - "arrivalFlightNumber": "FZ1722",
279 - "arrivalTerminalCode": "DXB3",
280 - "returnDate": "2024-05-21T21:25:00.000",
281 - "returnFlightNumber": "FZ1721",
282 - "returnTerminalCode": "DXB3",
283 - "showReturn": true
284 - }
285 - ],
286 - "hotels": [
287 - {
288 - "id": "b768a900-bfc5-4dc4-958a-47a3bf92b6f8",
289 - "hotelName": "Ibis Al Rigga",
290 - "cityName": "Dubai",
291 - "hotelClass": "3",
292 - "checkInDate": "2024-05-17T00:00:00.000",
293 - "checkOutDate": "2024-05-21T00:00:00.000",
294 - "roomCategoryName": "Standard room with 1 double bed",
295 - "placementName": "DBL",
296 - "mealPlan": "RO"
297 - }
298 - ],
299 - "flights": [
300 - {
301 - "id": "5720af80-17de-4913-94c5-2e019c9fbb9c",
302 - "isArrival": true,
303 - "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
304 - "touristName": "Teeeeest Teest",
305 - "date": "2024-05-17T07:10:00.000",
306 - "departureAirport": "ALA",
307 - "departureTerminal": "ALA",
308 - "arrivalAirport": "DXB",
309 - "arrivalTerminal": "DXB3",
310 - "note": "Kazunion Block, Baggage Info: 20 Kg Included"
311 - },
312 - {
313 - "id": "81fce7ff-b359-46ea-ae66-1c41af7c347a",
314 - "isArrival": false,
315 - "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
316 - "touristName": "Teeeeest Teest",
317 - "date": "2024-05-21T21:25:00.000",
318 - "departureAirport": "DXB",
319 - "departureTerminal": "DXB3",
320 - "arrivalAirport": "ALA",
321 - "arrivalTerminal": "ALA",
322 - "note": "Kazunion Block, Baggage Info: 20 Kg Included"
323 - },
324 - {
325 - "id": "215d3de6-8969-4265-97bd-3d716a0d4415",
326 - "isArrival": true,
327 - "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
328 - "touristName": "Test Teeeest",
329 - "date": "2024-05-17T07:10:00.000",
330 - "departureAirport": "ALA",
331 - "departureTerminal": "ALA",
332 - "arrivalAirport": "DXB",
333 - "arrivalTerminal": "DXB3",
334 - "note": "Kazunion Block, Baggage Info: 20 Kg Included"
335 - },
336 - {
337 - "id": "8c6b26b3-5bb2-4fb9-b89c-2568b1f74b64",
338 - "isArrival": false,
339 - "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
340 - "touristName": "Test Teeeest",
341 - "date": "2024-05-21T21:25:00.000",
342 - "departureAirport": "DXB",
343 - "departureTerminal": "DXB3",
344 - "arrivalAirport": "ALA",
345 - "arrivalTerminal": "ALA",
346 - "note": "Kazunion Block, Baggage Info: 20 Kg Included"
347 - }
348 - ],
349 - "transfers": [
350 - {
351 - "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0",
352 - "transferType": "ARRIVAL",
353 - "vehicleName": "GROUP",
354 - "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
355 - "touristName": "Teeeeest Teest",
356 - "date": "2024-05-17T00:00:00.000",
357 - "fromTerminal": "DXB",
358 - "fromCityName": "Dubai",
359 - "toHotelName": "Ibis Al Rigga",
360 - "toCityName": "Dubai",
361 - "note": "teeeest, for testing purpose !, Contact Number: 597101803"
362 - },
363 - {
364 - "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32",
365 - "transferType": "DEPARTURE",
366 - "vehicleName": "GROUP",
367 - "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
368 - "touristName": "Teeeeest Teest",
369 - "date": "2024-05-21T00:00:00.000",
370 - "fromCityName": "Dubai",
371 - "fromHotelName": "Ibis Al Rigga",
372 - "toTerminal": "DXB",
373 - "toCityName": "Dubai"
374 - },
375 - {
376 - "id": "8c9e4c18-f849-45d9-940b-69eebd67edb0",
377 - "transferType": "ARRIVAL",
378 - "vehicleName": "GROUP",
379 - "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
380 - "touristName": "Test Teeeest",
381 - "date": "2024-05-17T00:00:00.000",
382 - "fromTerminal": "DXB",
383 - "fromCityName": "Dubai",
384 - "toHotelName": "Ibis Al Rigga",
385 - "toCityName": "Dubai",
386 - "note": "teeeest, for testing purpose !, Contact Number: 597101803"
387 - },
388 - {
389 - "id": "654df3d5-a6ed-42e6-af61-47a6b5a85f32",
390 - "transferType": "DEPARTURE",
391 - "vehicleName": "GROUP",
392 - "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
393 - "touristName": "Test Teeeest",
394 - "date": "2024-05-21T00:00:00.000",
395 - "fromCityName": "Dubai",
396 - "fromHotelName": "Ibis Al Rigga",
397 - "toTerminal": "DXB",
398 - "toCityName": "Dubai"
399 - }
400 - ],
401 - "services": [
402 - {
403 - "id": "4c5d1e9c-2b87-4ec8-9bd8-96a270419322",
404 - "serviceDate": "2024-05-17T07:10:00.000",
405 - "serviceName": "Insurance",
406 - "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
407 - "touristName": "Test Teeeest"
408 - },
409 - {
410 - "id": "1e1ad6a2-ee59-4c8c-868c-34a25343e7ca",
411 - "serviceDate": "2024-05-17T07:10:00.000",
412 - "serviceName": "Insurance",
413 - "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
414 - "touristName": "Teeeeest Teest"
415 - }
416 - ]
417 - }
418 -}
419 -{{/code}}
420 -
421 -
422 -=== Schema ===
423 -
424 -{{success}}
425 -GetReservationDetailsResponse{
426 -
427 -|reservation|ReservationDetails{(((
428 -|id|string($uuid)
429 -|rfNumber|string
430 -nullable: true
431 -|contactNumber|string
432 -nullable: true
433 -|agentName|string
434 -nullable: true
435 -|totalPrice|number($double)
436 -|agentCommission|number($double)
437 -|netPrice|number($double)
438 -nullable: true
439 -|currency|string
440 -nullable: true
441 -|tourists|[
442 -nullable: trueResDetailsTourist{(((
443 -|id|string($uuid)
444 -|gender|GenderEnumstringEnum:
445 -[ None, Male, Female ]
446 -|ageCategory|AgeCategorystringEnum:
447 -[ Adult, Infant, Child ]
448 -|firstName|string
449 -nullable: true
450 -|lastName|string
451 -nullable: true
452 -|birthDate|string($date-time)
453 -nullable: true
454 -|passportNumber|string
455 -nullable: true
456 -|passportExpiryDate|string($date-time)
457 -nullable: true
458 -|tin|string
459 -nullable: true
460 -|citizenshipCountryCode|string
461 -nullable: true
462 -|citizenshipCountryName|string
463 -nullable: true
464 -|mobile|string
465 -nullable: true
466 -|email|string
467 -nullable: true
468 -|arrivalDate|string($date-time)
469 -nullable: true
470 -|arrivalFlightNumber|string
471 -nullable: true
472 -|arrivalTerminalCode|string
473 -nullable: true
474 -|returnDate|string($date-time)
475 -nullable: true
476 -|returnFlightNumber|string
477 -nullable: true
478 -|returnTerminalCode|string
479 -nullable: true
480 -|showReturn|boolean
481 -
482 -}]
483 -)))
484 -|hotels|[
485 -nullable: trueResDetailsHotel{(((
486 -|id|string($uuid)
487 -|hotelName|string
488 -nullable: true
489 -|cityName|string
490 -nullable: true
491 -|hotelClass|string
492 -nullable: true
493 -|checkInDate|string($date-time)
494 -|checkOutDate|string($date-time)
495 -|roomCategoryName|string
496 -nullable: true
497 -|placementName|string
498 -nullable: true
499 -|mealPlan|string
500 -nullable: true
501 -|agentConfirmationNumber|string
502 -nullable: true
503 -
504 -}]
505 -)))
506 -|flights|[
507 -nullable: trueResDetailsFlight{(((
508 -|id|string($uuid)
509 -|isArrival|boolean
510 -|touristId|string($uuid)
511 -|touristName|string
512 -nullable: true
513 -|date|string($date-time)
514 -|departureAirport|string
515 -nullable: true
516 -|departureTerminal|string
517 -nullable: true
518 -|arrivalAirport|string
519 -nullable: true
520 -|arrivalTerminal|string
521 -nullable: true
522 -|agentConfirmationNumber|string
523 -nullable: true
524 -|bookingConfirmationNumber|string
525 -nullable: true
526 -|note|string
527 -nullable: true
528 -
529 -}]
530 -)))
531 -|transfers|[
532 -nullable: trueResDetailsTransfer{(((
533 -|id|string($uuid)
534 -|transferType|string
535 -nullable: true
536 -|vehicleName|string
537 -nullable: true
538 -|touristId|string($uuid)
539 -|touristName|string
540 -nullable: true
541 -|date|string($date-time)
542 -|fromTerminal|string
543 -nullable: true
544 -|fromCityName|string
545 -nullable: true
546 -|fromHotelName|string
547 -nullable: true
548 -|toHotelName|string
549 -nullable: true
550 -|toTerminal|string
551 -nullable: true
552 -|toCityName|string
553 -nullable: true
554 -|agentConfirmationNumber|string
555 -nullable: true
556 -|note|string
557 -nullable: true
558 -
559 -}]
560 -)))
561 -|services|[
562 -nullable: trueResDetailsService{(((
563 -|id|string($uuid)
564 -|serviceDate|string($date-time)
565 -|serviceName|string
566 -nullable: true
567 -|touristId|string($uuid)
568 -|touristName|string
569 -nullable: true
570 -|note|string
571 -nullable: true
572 -
573 -}]
574 -)))
575 -
576 -}
577 -)))
578 -
579 -}
580 -{{/success}}
581 -
582 -
583 -== Description ==
584 -
585 -
586 -(% class="table-bordered" %)
587 -|=Parameter|=Value Type|=Description
588 -|id|String|The unique identifier for the reservation, typically a UUID or similar.
589 -|rfNumber|String|The reference number for the reservation, usually generated by the system.
590 -|contactNumber|String|The contact number associated with the reservation, used for communication purposes.
591 -|agentName|String|The name of the agent who made the reservation, useful for tracking and accountability.
592 -|totalPrice|Number|The total price of the reservation, calculated based on the services and products included.
593 -|agentCommission|Number|The commission earned by the agent for this reservation, calculated as a percentage of the total price.
594 -|currency|String|The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR).
595 -|tourists[].id|String|The unique identifier for each tourist, typically a UUID.
596 -|tourists[].gender|String|The gender of the tourist, usually : [ None, Male, Female ]
597 -|tourists[].ageCategory|String|The age category of the tourist, such as 'Adult', 'Child', or 'Infant'.
598 -|tourists[].firstName|String|The first name of the tourist, as it appears on their passport.
599 -|tourists[].lastName|String|The last name of the tourist, as it appears on their passport.
600 -|tourists[].birthDate|String (Date)|The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD).
601 -|tourists[].passportNumber|String|The passport number of the tourist, as it appears on their passport.
602 -|tourists[].passportExpiryDate|String (Date)|The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD).
603 -|tourists[].citizenshipCountryCode|String|The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB).
604 -|tourists[].citizenshipCountryName|String|The full name of the tourist's country of citizenship.
605 -|tourists[].arrivalDate|String (Date)|The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD).
606 -|tourists[].arrivalFlightNumber|String|The flight number for the tourist's arrival, as provided by the airline.
607 -|tourists[].arrivalTerminalCode|String|The terminal code for the tourist's arrival, as provided by the airport.
608 -|tourists[].returnDate|String (Date)|The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD).
609 -|tourists[].returnFlightNumber|String|The flight number for the tourist's return, as provided by the airline.
610 -|tourists[].returnTerminalCode|String|The terminal code for the tourist's return, as provided by the airport.
611 -|tourists[].showReturn|Boolean|A boolean indicating whether the return information should be displayed, useful for one-way trips.
612 -|hotels[].id|String|The unique identifier for each hotel booking, typically a UUID or similar.
613 -|hotels[].hotelName|String|The name of the hotel where the booking is made.
614 -|hotels[].cityName|String|The city where the hotel is located.
615 -|hotels[].hotelClass|String|The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc.
616 -|hotels[].checkInDate|String (Date)|The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
617 -|hotels[].checkOutDate|String (Date)|The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
618 -|hotels[].roomCategoryName|String|The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc.
619 -|hotels[].placementName|String|The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc.
620 -|hotels[].mealPlan|String|The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc.
621 -|flights[].id|String|The unique identifier for each flight, typically a UUID or similar.
622 -|flights[].isArrival|Boolean|A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights.
623 -|flights[].touristId|String|The id of the tourist taking this flight, linking the flight to a specific tourist.
624 -|flights[].touristName|String|The name of the tourist taking this flight, useful for passenger lists.
625 -|flights[].date|String (Date)|The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
626 -|flights[].departureAirport|String|The IATA code of the airport from which the flight departs (e.g., JFK, LHR).
627 -|flights[].departureTerminal|String|The terminal from which the flight departs, as provided by the airport.
628 -|flights[].arrivalAirport|String|The IATA code of the airport at which the flight arrives (e.g., JFK, LHR).
629 -|flights[].arrivalTerminal|String|The terminal at which the flight arrives, as provided by the airport.
630 -|flights[].note|String|Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc.
631 -|transfers[].id|String|The unique identifier for each transfer, typically a UUID or similar.
632 -|transfers[].transferType|String|The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers.
633 -|transfers[].vehicleName|String|The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc.
634 -|transfers[].touristId|String|The id of the tourist using this transfer, linking the transfer to a specific tourist.
635 -|transfers[].touristName|String|The name of the tourist using this transfer, useful for passenger lists.
636 -|transfers[].date|String (Date)|The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
637 -|transfers[].fromTerminal|String|The terminal from which the transfer starts, as provided by the airport or hotel.
638 -|transfers[].fromCityName|String|The city from which the transfer starts.
639 -|transfers[].toHotelName|String|The hotel to which the transfer goes.
640 -|transfers[].toCityName|String|The city to which the transfer goes.
641 -|transfers[].note|String|Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc.
642 -|services[].id|String|The unique identifier for each service, typically a UUID or similar.
643 -|services[].serviceDate|String (Date)|The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
644 -|services[].serviceName|String|The name of the service, such as insurance in this example.
645 -|services[].touristId|String|The id of the tourist using this service, linking the service to a specific tourist.
646 -|services[].touristName|String|The name of the tourist using this service, useful for booking confirmations.
32 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.