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 4.1
edited by Giorgi Mdivnishvili
on 2024/08/16 18:18
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" %)
... ... @@ -41,106 +41,182 @@
41 41  == Request Body example ==
42 42  
43 43  {{code language="Json"}}
44 -{"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"}
54 +{
55 +
56 + "registrationDateStart": "2024-06-16",
57 + "registrationDateEnd": "2024-09-16"
58 +
59 +}
45 45  {{/code}}
46 46  
47 47  
48 48  == Response ==
49 49  
50 -{{code language="json"}}
65 +{{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 - }
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 + }
142 142   ]
143 - }
144 144  }
145 145  {{/code}}
146 146