Skip to Content

Changes for page 7. GetReservations

Last modified by Giorgi Mdivnishvili on 2024/08/16 18:29
From version 7.1
edited by Giorgi Mdivnishvili
on 2024/08/16 18:25
Change comment: There is no comment for this version
To version 3.1
edited by Giorgi Mdivnishvili
on 2024/08/16 17:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,13 +7,15 @@
7 7  = Method Description =
8 8  
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.
10 +This API endpoint facilitates the retrieval of information pertaining to a previously booked reservation for data verification purposes.
11 11  
12 +To utilize this functionality, simply provide the reservationId parameter obtained following the initial reservation request and submit the API request.
12 12  
14 +
13 13  == Endpoint URL - [POST] ==
14 14  
15 15  {{info}}
16 -[[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservations>>https://integration.kazunion.com/api/Reservations/GetReservations]]
18 +[[https:~~/~~/integration.kazunion.com/api/Reservations/GetReservationDetails>>https://integration.kazunion.com/api/Reservations/GetReservationDetails]]
17 17  {{/info}}
18 18  
19 19  
... ... @@ -28,19 +28,7 @@
28 28  == Request Body ==
29 29  
30 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 -}
33 +{"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"}
44 44  {{/code}}
45 45  
46 46  (% class="wikigeneratedid" id="HRequestBodyexample" %)
... ... @@ -51,133 +51,107 @@
51 51  == Request Body example ==
52 52  
53 53  {{code language="Json"}}
54 -{
55 -
56 - "registrationDateStart": "2024-06-16",
57 - "registrationDateEnd": "2024-09-16"
58 -
59 -}
44 +{"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"}
60 60  {{/code}}
61 61  
62 62  
63 63  == Response ==
64 64  
65 -{{code language="JSON"}}
50 +{{code language="json"}}
66 66  {
67 - "pageId": 0,
68 - "pagesCount": 0,
69 - "reservations": [
70 - {
71 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
72 - "number": "string",
73 - "agentConfirmationNumber": "string",
74 - "registrationDate": "2024-08-16T14:13:00.703Z",
75 - "packageType": "Package",
76 - "status": "NotConfirmed",
77 - "statusForAgent": "New",
78 - "departureToCityName": "string",
79 - "departureToAirlineName": "string",
80 - "arrivalTime": "2024-08-16T14:13:00.703Z",
81 - "arrivalCountryName": "string",
82 - "departureTime": "2024-08-16T14:13:00.703Z",
83 - "pickupPeriods": [
84 - "string"
85 - ],
86 - "driverMobile": "string",
87 - "paymentInOutInvCurrency": {
88 - "currencyCode": "string",
89 - "price": 0,
90 - "netPrice": 0,
91 - "paid": 0,
92 - "unpaid": 0,
93 - "comission": 0,
94 - "comissionPercent": 0
95 - },
96 - "paymentInSellCurrency": {
97 - "currencyCode": "string",
98 - "price": 0,
99 - "netPrice": 0,
100 - "paid": 0,
101 - "unpaid": 0,
102 - "comission": 0,
103 - "comissionPercent": 0
104 - },
105 - "showDownloadDocuments": true,
106 - "guideMeetings": [
107 - {
108 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
109 - "meetingStartTime": "2024-08-16T14:13:00.703Z",
110 - "meetingEndTime": "2024-08-16T14:13:00.703Z",
111 - "hotelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
112 - "hotelName": "string",
113 - "guides": [
114 - {
115 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
116 - "name": "string",
117 - "mobile": "string"
118 - }
119 - ]
120 - }
121 - ],
122 - "services": [
123 - {
124 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
125 - "serviceDate": "2024-08-16T14:13:00.703Z",
126 - "type": "Arrival",
127 - "description": "string",
128 - "touristIds": [
129 - "string"
130 - ],
131 - "serviceDetails": [
132 - {
133 - "flightCode": "string",
134 - "airlineName": "string",
135 - "departureTime": "2024-08-16T14:13:00.703Z",
136 - "departureCityName": "string",
137 - "departureAirportCode": "string",
138 - "departureTerminalCode": "string",
139 - "arrivalTime": "2024-08-16T14:13:00.703Z",
140 - "arrivalCityName": "string",
141 - "arrivalAirportCode": "string",
142 - "arrivalTerminalCode": "string",
143 - "isArrivalFlight": true
144 - }
145 - ]
146 - }
147 - ],
148 - "tourists": [
149 - {
150 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
151 - "gender": "None",
152 - "ageCategory": "Adult",
153 - "title": "string",
154 - "firstName": "string",
155 - "lastName": "string",
156 - "birthDate": "2024-08-16",
157 - "passportNumber": "string",
158 - "passportExpiryDate": "2024-08-16",
159 - "tin": "string",
160 - "citizenshipCountryCode": "string",
161 - "canEdit": true
162 - }
163 - ],
164 - "documents": [
165 - {
166 - "type": "None",
167 - "descriptions": [
168 - "string"
169 - ],
170 - "url": "string"
171 - }
172 - ],
173 - "invoiceUrl": "string"
174 - }
175 - ]
52 + "reservation": {
53 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
54 + "rfNumber": "string",
55 + "contactNumber": "string",
56 + "agentName": "string",
57 + "totalPrice": 0,
58 + "agentCommission": 0,
59 + "netPrice": 0,
60 + "currency": "string",
61 + "tourists": [
62 + {
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
83 + }
84 + ],
85 + "hotels": [
86 + {
87 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
88 + "hotelName": "string",
89 + "cityName": "string",
90 + "hotelClass": "string",
91 + "checkInDate": "2024-04-11T02:39:52.147Z",
92 + "checkOutDate": "2024-04-11T02:39:52.147Z",
93 + "roomCategoryName": "string",
94 + "placementName": "string",
95 + "mealPlan": "string",
96 + "agentConfirmationNumber": "string"
97 + }
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 + }
176 176  }
177 -No links
178 -
179 -POST
180 -/api/Reservations/GetReser
181 181  {{/code}}
182 182  
183 183  
... ... @@ -185,169 +185,186 @@
185 185  
186 186  {{code language="Json"}}
187 187  {
188 - "pageId": 0,
189 - "pagesCount": 0,
190 - "reservations": [
191 - {
192 - "id": "07fff3fd-7ae9-409f-b50b-2cc7a948b8d0",
193 - "number": "110576",
194 - "agentConfirmationNumber": "",
195 - "registrationDate": "2024-07-11T10:09:52.243",
196 - "packageType": "Package",
197 - "status": "Canceled",
198 - "statusForAgent": "Canceled",
199 - "departureToAirlineName": "N/A",
200 - "arrivalTime": "2024-09-23T07:15:00.000",
201 - "arrivalCountryName": "United Arab Emirates",
202 - "departureTime": "2024-09-29T21:30:00.000",
203 - "pickupPeriods": [],
204 - "driverMobile": "N/A",
205 - "paymentInOutInvCurrency": {
206 - "price": 952.90,
207 - "netPrice": 952.90,
208 - "paid": 0.00,
209 - "unpaid": 952.90,
210 - "comission": 0.00,
211 - "comissionPercent": 0
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
212 212   },
213 - "paymentInSellCurrency": {
214 - "currencyCode": "USD",
215 - "price": 952.90,
216 - "netPrice": 952.90,
217 - "paid": 0.00,
218 - "unpaid": 952.90,
219 - "comission": 0.00,
220 - "comissionPercent": 0
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
198 + }
199 + ],
200 + "hotels": [
201 + {
202 + "id": "b768a900-bfc5-4dc4-958a-47a3bf92b6f8",
203 + "hotelName": "Ibis Al Rigga",
204 + "cityName": "Dubai",
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"
221 221   },
222 - "showDownloadDocuments": false,
223 - "guideMeetings": [],
224 - "services": [
225 - {
226 - "id": "00000000-0000-0000-0000-000000000000",
227 - "serviceDate": "0001-01-01T00:00:00.000",
228 - "type": "Hotel",
229 - "description": "N/A (N/A*) 23.09.2024 - 29.09.2024 / N/A N/A DBL",
230 - "touristIds": [
231 - "29236304-d23c-4999-88ec-76ac4b99b614",
232 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
233 - ]
234 - },
235 - {
236 - "id": "00000000-0000-0000-0000-000000000000",
237 - "serviceDate": "0001-01-01T00:00:00.000",
238 - "type": "AviaTicket",
239 - "touristIds": [
240 - "29236304-d23c-4999-88ec-76ac4b99b614",
241 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
242 - ],
243 - "serviceDetails": [
244 - {
245 - "flightCode": "FZ1721",
246 - "airlineName": "N/A",
247 - "departureTime": "2024-09-29T21:30:00.000",
248 - "departureCityName": "Almaty",
249 - "departureAirportCode": "ALA",
250 - "departureTerminalCode": "DXB3",
251 - "arrivalTime": "2024-09-23T07:15:00.000",
252 - "arrivalCityName": "Dubai",
253 - "arrivalAirportCode": "DXB",
254 - "isArrivalFlight": false
255 - }
256 - ]
257 - },
258 - {
259 - "id": "00000000-0000-0000-0000-000000000000",
260 - "serviceDate": "0001-01-01T00:00:00.000",
261 - "type": "AviaTicket",
262 - "touristIds": [
263 - "29236304-d23c-4999-88ec-76ac4b99b614",
264 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
265 - ],
266 - "serviceDetails": [
267 - {
268 - "flightCode": "FZ1721",
269 - "airlineName": "N/A",
270 - "departureTime": "2024-09-29T21:30:00.000",
271 - "departureCityName": "Dubai",
272 - "departureAirportCode": "DXB",
273 - "departureTerminalCode": "DXB3",
274 - "arrivalTime": "2024-09-30T02:40:00.000",
275 - "arrivalCityName": "Almaty",
276 - "arrivalAirportCode": "ALA",
277 - "isArrivalFlight": false
278 - }
279 - ]
280 - },
281 - {
282 - "id": "97ba44e6-9158-40fe-8ec5-49626d786446",
283 - "serviceDate": "0001-01-01T00:00:00.000",
284 - "type": "Transfer",
285 - "description": "Трансфер: Прилет Индивидуальный 23.09.2024 Dubai DXB -> Concorde Inn Hotel, Bur Dubai, United Arab Emirates",
286 - "touristIds": [
287 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c",
288 - "29236304-d23c-4999-88ec-76ac4b99b614"
289 - ]
290 - },
291 - {
292 - "id": "c404e59c-6cab-491c-a3ff-f712cf74103c",
293 - "serviceDate": "0001-01-01T00:00:00.000",
294 - "type": "Transfer",
295 - "description": "Трансфер: Вылет Индивидуальный 29.09.2024 с Concorde Inn Hotel -> DXB, Dubai United Arab Emirates",
296 - "touristIds": [
297 - "29236304-d23c-4999-88ec-76ac4b99b614",
298 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
299 - ]
300 - },
301 - {
302 - "id": "fb8c4e42-03e8-4bb7-8fc9-2783ae664510",
303 - "serviceDate": "0001-01-01T00:00:00.000",
304 - "type": "Insurance",
305 - "description": "Страхование: N/A (10000 USD) 23.09.2024 - 29.09.2024",
306 - "touristIds": [
307 - "29236304-d23c-4999-88ec-76ac4b99b614"
308 - ]
309 - },
310 - {
311 - "id": "97c32399-66b5-414b-bd88-d9c4584b22b1",
312 - "serviceDate": "0001-01-01T00:00:00.000",
313 - "type": "Insurance",
314 - "description": "Страхование: N/A (10000 USD) 23.09.2024 - 29.09.2024",
315 - "touristIds": [
316 - "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"
317 - ]
318 - }
319 - ],
320 - "tourists": [
321 - {
322 - "id": "29236304-d23c-4999-88ec-76ac4b99b614",
323 - "gender": "Male",
324 - "ageCategory": "Adult",
325 - "title": "MR.",
326 - "firstName": "Teeeeest",
327 - "lastName": "Teeeest",
328 - "birthDate": "1990-09-23T00:00:00",
329 - "passportNumber": "1231233",
330 - "passportExpiryDate": "2029-12-23T00:00:00",
331 - "citizenshipCountryCode": "N/A",
332 - "canEdit": false
333 - },
334 - {
335 - "id": "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c",
336 - "gender": "Male",
337 - "ageCategory": "Adult",
338 - "title": "MR.",
339 - "firstName": "Test",
340 - "lastName": "Teeeest",
341 - "birthDate": "1990-09-23T00:00:00",
342 - "passportNumber": "123123",
343 - "passportExpiryDate": "2029-12-23T00:00:00",
344 - "citizenshipCountryCode": "N/A",
345 - "canEdit": false
346 - }
347 - ],
348 - "documents": []
349 - }
350 - ]
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"
237 + },
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"
261 + }
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 + }
351 351  }
352 352  {{/code}}
353 353  
... ... @@ -355,130 +355,161 @@
355 355  === Schema ===
356 356  
357 357  {{success}}
358 -GetReservationsResponse{
339 +GetReservationDetailsResponse{
359 359  
360 -|pageId|integer($int32)
361 -|pagesCount|integer($int32)
362 -|reservations|[
363 -nullable: trueReservation{(((
341 +|reservation|ReservationDetails{(((
364 364  |id|string($uuid)
365 -|number|string
343 +|rfNumber|string
366 366  nullable: true
367 -|agentConfirmationNumber|string
345 +|contactNumber|string
368 368  nullable: true
369 -|registrationDate|string($date-time)
370 -|packageType|PackageTypeEnumstringEnum:
371 -[ Package, OnlyHotel, OnlyAvia ]
372 -|status|ReservationStatusEnumstringEnum:
373 -[ NotConfirmed, ConfirmedAndNotPaid, ConfirmedAndPaid, Overdued, Canceled ]
374 -|statusForAgent|StatusForAgentEnumstringEnum:
375 -[ New, OnProcess, Confirmed, Pending, Overdued, Delete, Draft, Canceled ]
376 -|departureToCityName|string
347 +|agentName|string
377 377  nullable: true
378 -|departureToAirlineName|string
349 +|totalPrice|number($double)
350 +|agentCommission|number($double)
351 +|netPrice|number($double)
379 379  nullable: true
380 -|arrivalTime|string($date-time)
381 -|arrivalCountryName|string
353 +|currency|string
382 382  nullable: true
383 -|departureTime|string($date-time)
384 -|pickupPeriods|[
385 -nullable: truestring]
386 -|driverMobile|string
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
387 387  nullable: true
388 -|paymentInOutInvCurrency|ReservationPaymentDetails{(((
389 -|currencyCode|string
364 +|lastName|string
390 390  nullable: true
391 -|price|number($double)
392 -|netPrice|number($double)
393 -|paid|number($double)
394 -|unpaid|number($double)
395 -|comission|number($double)
396 -|comissionPercent|number($double)
397 -
398 -}
399 -)))
400 -|paymentInSellCurrency|ReservationPaymentDetails{(((
401 -|currencyCode|string
366 +|birthDate|string($date-time)
402 402  nullable: true
403 -|price|number($double)
404 -|netPrice|number($double)
405 -|paid|number($double)
406 -|unpaid|number($double)
407 -|comission|number($double)
408 -|comissionPercent|number($double)
409 -
410 -}
411 -)))
412 -|showDownloadDocuments|boolean
413 -|guideMeetings|[
414 -nullable: trueGuideMeeting{(((
415 -|id|string($uuid)
416 -|meetingStartTime|string($date-time)
417 -|meetingEndTime|string($date-time)
368 +|passportNumber|string
418 418  nullable: true
419 -|hotelId|string($uuid)
420 -|hotelName|string
370 +|passportExpiryDate|string($date-time)
421 421  nullable: true
422 -|guides|[
423 -nullable: trueGuide{(((
424 -|id|string($uuid)
425 -|name|string
372 +|tin|string
426 426  nullable: true
374 +|citizenshipCountryCode|string
375 +nullable: true
376 +|citizenshipCountryName|string
377 +nullable: true
427 427  |mobile|string
428 428  nullable: true
380 +|email|string
381 +nullable: true
382 +|arrivalDate|string($date-time)
383 +nullable: true
384 +|arrivalFlightNumber|string
385 +nullable: true
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
429 429  
430 430  }]
431 431  )))
398 +|hotels|[
399 +nullable: trueResDetailsHotel{(((
400 +|id|string($uuid)
401 +|hotelName|string
402 +nullable: true
403 +|cityName|string
404 +nullable: true
405 +|hotelClass|string
406 +nullable: true
407 +|checkInDate|string($date-time)
408 +|checkOutDate|string($date-time)
409 +|roomCategoryName|string
410 +nullable: true
411 +|placementName|string
412 +nullable: true
413 +|mealPlan|string
414 +nullable: true
415 +|agentConfirmationNumber|string
416 +nullable: true
432 432  
433 433  }]
434 434  )))
435 -|services|[
436 -nullable: trueReservationService{...}]
437 -|tourists|[
438 -nullable: trueReservationTourist{(((
439 -|id|[...]
440 -|gender|GenderEnumstringEnum:
441 -[ None, Male, Female ]
442 -|ageCategory|AgeCategorystringEnum:
443 -[ Adult, Infant, Child ]
444 -|title|string
420 +|flights|[
421 +nullable: trueResDetailsFlight{(((
422 +|id|string($uuid)
423 +|isArrival|boolean
424 +|touristId|string($uuid)
425 +|touristName|string
445 445  nullable: true
446 -|firstName|string
427 +|date|string($date-time)
428 +|departureAirport|string
447 447  nullable: true
448 -|lastName|string
430 +|departureTerminal|string
449 449  nullable: true
450 -|birthDate|string($date)
432 +|arrivalAirport|string
451 451  nullable: true
452 -|passportNumber|string
434 +|arrivalTerminal|string
453 453  nullable: true
454 -|passportExpiryDate|string($date)
436 +|agentConfirmationNumber|string
455 455  nullable: true
456 -|tin|string
438 +|bookingConfirmationNumber|string
457 457  nullable: true
458 -|citizenshipCountryCode|string
440 +|note|string
459 459  nullable: true
460 -|canEdit|boolean
461 461  
462 462  }]
463 463  )))
464 -|documents|[
465 -nullable: trueReservationDocument{(((
466 -|type|ReservationDocumentTypeEnumstringEnum:
467 -[ None, HotelVoucher, Invoice, AviaTicketVoucher, Insurance ]
468 -|descriptions|[
469 -nullable: truestring]
470 -|url|string
445 +|transfers|[
446 +nullable: trueResDetailsTransfer{(((
447 +|id|string($uuid)
448 +|transferType|string
471 471  nullable: true
450 +|vehicleName|string
451 +nullable: true
452 +|touristId|string($uuid)
453 +|touristName|string
454 +nullable: true
455 +|date|string($date-time)
456 +|fromTerminal|string
457 +nullable: true
458 +|fromCityName|string
459 +nullable: true
460 +|fromHotelName|string
461 +nullable: true
462 +|toHotelName|string
463 +nullable: true
464 +|toTerminal|string
465 +nullable: true
466 +|toCityName|string
467 +nullable: true
468 +|agentConfirmationNumber|string
469 +nullable: true
470 +|note|string
471 +nullable: true
472 472  
473 473  }]
474 474  )))
475 -|invoiceUrl|string
475 +|services|[
476 +nullable: trueResDetailsService{(((
477 +|id|string($uuid)
478 +|serviceDate|string($date-time)
479 +|serviceName|string
476 476  nullable: true
481 +|touristId|string($uuid)
482 +|touristName|string
483 +nullable: true
484 +|note|string
485 +nullable: true
477 477  
478 478  }]
479 479  )))
480 480  
481 481  }
491 +)))
492 +
493 +}
482 482  {{/success}}
483 483  
484 484  
... ... @@ -485,57 +485,64 @@
485 485  == Description ==
486 486  
487 487  
488 -|=**Parameter Name**|=**Type**|=**Description**|=**Example**
489 -|**pageId**|integer|Represents the current page of the results returned. Used for pagination.|0
490 -|**pagesCount**|integer|Indicates the total number of pages available based on the query filters applied.|0
491 -|**reservations**|array|An array containing details of each reservation matching the query parameters. Each entry in this array is a JSON object with multiple fields related to a single reservation.|[ {...}, {...} ]
492 -|**reservations[].id**|string|The unique identifier for the reservation.|"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"
493 -|**reservations[].number**|string|The reservation number, typically used as a reference by agents and customers.|"110576"
494 -|**reservations[].agentConfirmationNumber**|string|A confirmation number provided by the agent. It can be empty if not applicable.|""
495 -|**reservations[].registrationDate**|datetime|The date and time when the reservation was registered in the system.|"2024-07-11T10:09:52.243"
496 -|**reservations[].packageType**|string|Specifies the type of package associated with the reservation (e.g., "Package").|"Package"
497 -|**reservations[].status**|string|The current status of the reservation (e.g., "Canceled", "Confirmed").|"Canceled"
498 -|**reservations[].statusForAgent**|string|The reservation status as seen from the agent's perspective.|"Canceled"
499 -|**reservations[].departureToAirlineName**|string|The name of the airline for the departure flight. If not applicable, it will be "N/A".|"N/A"
500 -|**reservations[].arrivalTime**|datetime|The scheduled arrival time for the trip.|"2024-09-23T07:15:00.000"
501 -|**reservations[].arrivalCountryName**|string|The name of the country where the trip is scheduled to arrive.|"United Arab Emirates"
502 -|**reservations[].departureTime**|datetime|The scheduled departure time for the return trip.|"2024-09-29T21:30:00.000"
503 -|**reservations[].pickupPeriods**|array|An array of pickup periods, detailing the times when pickup services are scheduled. This can be empty if no pickup services are associated with the reservation.|[]
504 -|**reservations[].driverMobile**|string|The mobile number of the driver assigned for transfer services. It can be "N/A" if not applicable.|"N/A"
505 -|**reservations[].paymentInOutInvCurrency**|object|Contains payment details in the invoice currency.|{...}
506 -|**reservations[].paymentInOutInvCurrency.price**|decimal|Total price in the invoice currency.|952.90
507 -|**reservations[].paymentInOutInvCurrency.netPrice**|decimal|Net price after any discounts in the invoice currency.|952.90
508 -|**reservations[].paymentInOutInvCurrency.paid**|decimal|Amount already paid.|0.00
509 -|**reservations[].paymentInOutInvCurrency.unpaid**|decimal|Amount that is still unpaid.|952.90
510 -|**reservations[].paymentInOutInvCurrency.comission**|decimal|Commission amount, if applicable.|0.00
511 -|**reservations[].paymentInOutInvCurrency.comissionPercent**|integer|Percentage of the commission.|0
512 -|**reservations[].paymentInSellCurrency**|object|Similar to paymentInOutInvCurrency, but in the selling currency.|{...}
513 -|**reservations[].paymentInSellCurrency.currencyCode**|string|The code of the currency (e.g., "USD").|"USD"
514 -|**reservations[].paymentInSellCurrency.price**|decimal|Total price in the selling currency.|952.90
515 -|**reservations[].paymentInSellCurrency.netPrice**|decimal|Net price after any discounts in the selling currency.|952.90
516 -|**reservations[].paymentInSellCurrency.paid**|decimal|Amount already paid.|0.00
517 -|**reservations[].paymentInSellCurrency.unpaid**|decimal|Amount that is still unpaid.|952.90
518 -|**reservations[].paymentInSellCurrency.comission**|decimal|Commission amount, if applicable.|0.00
519 -|**reservations[].paymentInSellCurrency.comissionPercent**|integer|Percentage of the commission.|0
520 -|**reservations[].showDownloadDocuments**|boolean|Indicates whether documents related to the reservation can be downloaded.|false
521 -|**reservations[].guideMeetings**|array|An array of guide meeting details. This can be empty if no guide meetings are associated with the reservation.|[]
522 -|**reservations[].services**|array|An array of services associated with the reservation. Each service contains details such as service type, description, associated tourist IDs, and service-specific details (e.g., flight details).|[ {...}, {...} ]
523 -|**reservations[].services[].id**|string|The unique identifier for the service.|"00000000-0000-0000-0000-000000000000"
524 -|**reservations[].services[].serviceDate**|datetime|The date of the service.|"0001-01-01T00:00:00.000"
525 -|**reservations[].services[].type**|string|The type of service (e.g., "Hotel", "AviaTicket").|"Hotel"
526 -|**reservations[].services[].description**|string|A textual description of the service.|"N/A (N/A*) 23.09.2024 - 29.09.2024 / N/A N/A DBL"
527 -|**reservations[].services[].touristIds**|array|An array of tourist IDs associated with the service.|["29236304-d23c-4999-88ec-76ac4b99b614", "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"]
528 -|**reservations[].services[].serviceDetails**|array|Additional details specific to the service type, such as flight details.|[ {...}, {...} ]
529 -|**reservations[].tourists**|array|An array of tourists associated with the reservation. Each tourist object contains personal details such as name, gender, passport information, and more.|[ {...}, {...} ]
530 -|**reservations[].tourists[].id**|string|The unique identifier for the tourist.|"29236304-d23c-4999-88ec-76ac4b99b614"
531 -|**reservations[].tourists[].gender**|string|The gender of the tourist.|"Male"
532 -|**reservations[].tourists[].ageCategory**|string|The age category of the tourist (e.g., "Adult").|"Adult"
533 -|**reservations[].tourists[].title**|string|The title of the tourist (e.g., "MR.").|"MR."
534 -|**reservations[].tourists[].firstName**|string|The first name of the tourist.|"Teeeeest"
535 -|**reservations[].tourists[].lastName**|string|The last name of the tourist.|"Teeeest"
536 -|**reservations[].tourists[].birthDate**|datetime|The birth date of the tourist.|"1990-09-23T00:00:00"
537 -|**reservations[].tourists[].passportNumber**|string|The passport number of the tourist.|"1231233"
538 -|**reservations[].tourists[].passportExpiryDate**|datetime|The expiration date of the tourist's passport.|"2029-12-23T00:00:00"
539 -|**reservations[].tourists[].citizenshipCountryCode**|string|The citizenship country code of the tourist.|"N/A"
540 -|**reservations[].tourists[].canEdit**|boolean|Indicates whether the tourist’s details can be edited.|false
541 -|**reservations[].documents**|array|An array containing document details associated with the reservation.|[]
500 +(% class="table-bordered" %)
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).
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 ]
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.