Skip to Content

Changes for page 7. GetReservations

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

Summary

Details

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