Skip to Content

Changes for page 6. GetReservationDetails

Last modified by Giorgi Mdivnishvili on 2024/07/11 10:45
From version 7.1
edited by Giorgi Mdivnishvili
on 2024/04/11 07:12
Change comment: There is no comment for this version
To version 3.1
edited by Giorgi Mdivnishvili
on 2024/04/11 06:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -46,98 +46,357 @@
46 46  
47 47  {{code language="json"}}
48 48  {
49 - "reservation": {
50 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
51 - "rfNumber": "string",
52 - "contactNumber": "string",
53 - "agentName": "string",
49 + "error": true,
50 + "errorCode": "string",
51 + "errorDescription": "string",
52 + "userErrorDescription": "string",
53 + "package": {
54 + "cacheKey": "string",
55 + "id": "string",
56 + "priceCurrency": "string",
54 54   "totalPrice": 0,
55 - "agentCommission": 0,
56 - "netPrice": 0,
57 - "currency": "string",
58 - "tourists": [
58 + "agentCommissionPercent": 0,
59 + "agentCommissionAmount": 0,
60 + "includedExtrasAmount": 0,
61 + "priceDifference": 0,
62 + "hotel": {
63 + "hotelPriceId": "string",
64 + "providerId": 0,
65 + "hotelName": "string",
66 + "hotelCode": "string",
67 + "nigths": 0,
68 + "mealPlan": "string",
69 + "hotelClass": "string",
70 + "availabilityType": "OnRequest",
71 + "availableRoomsCount": 0,
72 + "fewRooms": true,
73 + "roomCategoryCode": "string",
74 + "roomCategoryName": "string",
75 + "placementTypeName": "string",
76 + "placementDescription": "string",
77 + "checkInDate": "2023-12-26T12:55:59.433Z",
78 + "checkOutDate": "2023-12-26T12:55:59.433Z",
79 + "adults": 0,
80 + "children": 0,
81 + "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
82 + "districtName": "string",
83 + "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84 + "cityName": "string",
85 + "countryCode": "string",
86 + "countryName": "string",
87 + "hasAlcohol": true,
88 + "hasFreeWifi": true,
89 + "hasMetro": true,
90 + "hasPool": true,
91 + "hasMall": true,
92 + "cancellationPolicyDescription": "string",
93 + "cancellationPolicy": {
94 + "cancellationPolicyCode": "string",
95 + "noShowChargeValue": 0,
96 + "noShowChargeValueType": "string",
97 + "earlyDepartureChargeValue": 0,
98 + "earlyDepartureChargeValueType": "string",
99 + "conditions": [
100 + {
101 + "timeunits": 0,
102 + "timeunitType": "string",
103 + "timeOffsetTypeName": "string",
104 + "chargeValue": 0,
105 + "chargeValueType": "string"
106 + }
107 + ]
108 + }
109 + },
110 + "flight": {
111 + "id": "string",
112 + "departureDate": "2023-12-26T12:55:59.433Z",
113 + "returnDate": "2023-12-26T12:55:59.433Z",
114 + "departureTicketsLeft": 0,
115 + "returnTicketsLeft": 0,
116 + "departureAvailabilityType": "OnRequest",
117 + "returnAvailabilityType": "OnRequest",
118 + "isTwoWay": true,
119 + "sameBaggageForAll": true,
120 + "totalBaggage": true,
121 + "departureSegments": [
122 + {
123 + "airlineCode": "string",
124 + "airlineName": "string",
125 + "flightCode": "string",
126 + "class": "string",
127 + "lugageWeight": 0,
128 + "handLugageWeight": 0,
129 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
130 + "departureCountryName": "string",
131 + "departureCityName": "string",
132 + "departureAirportCode": "string",
133 + "departureAirportName": "string",
134 + "departureTerminalCode": "string",
135 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
136 + "arrivalCountryName": "string",
137 + "arrivalCityName": "string",
138 + "arrivalAirportCode": "string",
139 + "arrivalAirportName": "string",
140 + "arrivalTerminalCode": "string",
141 + "flightDuration": "string"
142 + }
143 + ],
144 + "returnSegments": [
145 + {
146 + "airlineCode": "string",
147 + "airlineName": "string",
148 + "flightCode": "string",
149 + "class": "string",
150 + "lugageWeight": 0,
151 + "handLugageWeight": 0,
152 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
153 + "departureCountryName": "string",
154 + "departureCityName": "string",
155 + "departureAirportCode": "string",
156 + "departureAirportName": "string",
157 + "departureTerminalCode": "string",
158 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
159 + "arrivalCountryName": "string",
160 + "arrivalCityName": "string",
161 + "arrivalAirportCode": "string",
162 + "arrivalAirportName": "string",
163 + "arrivalTerminalCode": "string",
164 + "flightDuration": "string"
165 + }
166 + ],
167 + "passengers": [
168 + {
169 + "id": "string",
170 + "isAdult": true,
171 + "selectedForwardBaggageCode": "string",
172 + "selectedBackwardBaggageCode": "string",
173 + "forwardBaggages": [
174 + {
175 + "baggageCode": "string",
176 + "description": "string",
177 + "price": 0,
178 + "currency": "string",
179 + "included": true
180 + }
181 + ],
182 + "backwardBaggages": [
183 + {
184 + "baggageCode": "string",
185 + "description": "string",
186 + "price": 0,
187 + "currency": "string",
188 + "included": true
189 + }
190 + ]
191 + }
192 + ]
193 + },
194 + "extraServices": [
59 59   {
60 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
61 - "gender": "None",
62 - "ageCategory": "Adult",
63 - "firstName": "string",
64 - "lastName": "string",
65 - "birthDate": "2024-04-11T02:39:52.147Z",
66 - "passportNumber": "string",
67 - "passportExpiryDate": "2024-04-11T02:39:52.147Z",
68 - "tin": "string",
69 - "citizenshipCountryCode": "string",
70 - "citizenshipCountryName": "string",
71 - "mobile": "string",
72 - "email": "string",
73 - "arrivalDate": "2024-04-11T02:39:52.147Z",
74 - "arrivalFlightNumber": "string",
75 - "arrivalTerminalCode": "string",
76 - "returnDate": "2024-04-11T02:39:52.147Z",
77 - "returnFlightNumber": "string",
78 - "returnTerminalCode": "string",
79 - "showReturn": true
196 + "extraServiceCode": "string",
197 + "extraServiceTypeCode": "string",
198 + "isMandatory": 0,
199 + "extraServiceName": "string",
200 + "minimalServiceAmount": 0,
201 + "includedPriceCode": "string",
202 + "prices": [
203 + {
204 + "extraServicePriceCode": "string",
205 + "displayName": "string",
206 + "restrictionInfo": "string",
207 + "additionalInfo": "string",
208 + "price": 0,
209 + "extraPrice": 0,
210 + "currency": "string"
211 + }
212 + ]
80 80   }
81 81   ],
82 - "hotels": [
83 - {
84 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
215 + "insurancePrice": {
216 + "name": "string",
217 + "price": 0,
218 + "priceSurcarge": 0,
219 + "actualStartDate": "2023-12-26T12:55:59.433Z",
220 + "actualEndDate": "2023-12-26T12:55:59.433Z",
221 + "optional": true,
222 + "includedInPackagePrice": true
223 + }
224 + },
225 + "altPackages": [
226 + {
227 + "cacheKey": "string",
228 + "id": "string",
229 + "priceCurrency": "string",
230 + "totalPrice": 0,
231 + "agentCommissionPercent": 0,
232 + "agentCommissionAmount": 0,
233 + "includedExtrasAmount": 0,
234 + "priceDifference": 0,
235 + "hotel": {
236 + "hotelPriceId": "string",
237 + "providerId": 0,
85 85   "hotelName": "string",
86 - "cityName": "string",
239 + "hotelCode": "string",
240 + "nigths": 0,
241 + "mealPlan": "string",
87 87   "hotelClass": "string",
88 - "checkInDate": "2024-04-11T02:39:52.147Z",
89 - "checkOutDate": "2024-04-11T02:39:52.147Z",
243 + "availabilityType": "OnRequest",
244 + "availableRoomsCount": 0,
245 + "fewRooms": true,
246 + "roomCategoryCode": "string",
90 90   "roomCategoryName": "string",
91 - "placementName": "string",
92 - "mealPlan": "string",
93 - "agentConfirmationNumber": "string"
248 + "placementTypeName": "string",
249 + "placementDescription": "string",
250 + "checkInDate": "2023-12-26T12:55:59.433Z",
251 + "checkOutDate": "2023-12-26T12:55:59.433Z",
252 + "adults": 0,
253 + "children": 0,
254 + "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
255 + "districtName": "string",
256 + "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
257 + "cityName": "string",
258 + "countryCode": "string",
259 + "countryName": "string",
260 + "hasAlcohol": true,
261 + "hasFreeWifi": true,
262 + "hasMetro": true,
263 + "hasPool": true,
264 + "hasMall": true,
265 + "cancellationPolicyDescription": "string",
266 + "cancellationPolicy": {
267 + "cancellationPolicyCode": "string",
268 + "noShowChargeValue": 0,
269 + "noShowChargeValueType": "string",
270 + "earlyDepartureChargeValue": 0,
271 + "earlyDepartureChargeValueType": "string",
272 + "conditions": [
273 + {
274 + "timeunits": 0,
275 + "timeunitType": "string",
276 + "timeOffsetTypeName": "string",
277 + "chargeValue": 0,
278 + "chargeValueType": "string"
279 + }
280 + ]
281 + }
282 + },
283 + "flight": {
284 + "id": "string",
285 + "departureDate": "2023-12-26T12:55:59.433Z",
286 + "returnDate": "2023-12-26T12:55:59.433Z",
287 + "departureTicketsLeft": 0,
288 + "returnTicketsLeft": 0,
289 + "departureAvailabilityType": "OnRequest",
290 + "returnAvailabilityType": "OnRequest",
291 + "isTwoWay": true,
292 + "sameBaggageForAll": true,
293 + "totalBaggage": true,
294 + "departureSegments": [
295 + {
296 + "airlineCode": "string",
297 + "airlineName": "string",
298 + "flightCode": "string",
299 + "class": "string",
300 + "lugageWeight": 0,
301 + "handLugageWeight": 0,
302 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
303 + "departureCountryName": "string",
304 + "departureCityName": "string",
305 + "departureAirportCode": "string",
306 + "departureAirportName": "string",
307 + "departureTerminalCode": "string",
308 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
309 + "arrivalCountryName": "string",
310 + "arrivalCityName": "string",
311 + "arrivalAirportCode": "string",
312 + "arrivalAirportName": "string",
313 + "arrivalTerminalCode": "string",
314 + "flightDuration": "string"
315 + }
316 + ],
317 + "returnSegments": [
318 + {
319 + "airlineCode": "string",
320 + "airlineName": "string",
321 + "flightCode": "string",
322 + "class": "string",
323 + "lugageWeight": 0,
324 + "handLugageWeight": 0,
325 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
326 + "departureCountryName": "string",
327 + "departureCityName": "string",
328 + "departureAirportCode": "string",
329 + "departureAirportName": "string",
330 + "departureTerminalCode": "string",
331 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
332 + "arrivalCountryName": "string",
333 + "arrivalCityName": "string",
334 + "arrivalAirportCode": "string",
335 + "arrivalAirportName": "string",
336 + "arrivalTerminalCode": "string",
337 + "flightDuration": "string"
338 + }
339 + ],
340 + "passengers": [
341 + {
342 + "id": "string",
343 + "isAdult": true,
344 + "selectedForwardBaggageCode": "string",
345 + "selectedBackwardBaggageCode": "string",
346 + "forwardBaggages": [
347 + {
348 + "baggageCode": "string",
349 + "description": "string",
350 + "price": 0,
351 + "currency": "string",
352 + "included": true
353 + }
354 + ],
355 + "backwardBaggages": [
356 + {
357 + "baggageCode": "string",
358 + "description": "string",
359 + "price": 0,
360 + "currency": "string",
361 + "included": true
362 + }
363 + ]
364 + }
365 + ]
366 + },
367 + "extraServices": [
368 + {
369 + "extraServiceCode": "string",
370 + "extraServiceTypeCode": "string",
371 + "isMandatory": 0,
372 + "extraServiceName": "string",
373 + "minimalServiceAmount": 0,
374 + "includedPriceCode": "string",
375 + "prices": [
376 + {
377 + "extraServicePriceCode": "string",
378 + "displayName": "string",
379 + "restrictionInfo": "string",
380 + "additionalInfo": "string",
381 + "price": 0,
382 + "extraPrice": 0,
383 + "currency": "string"
384 + }
385 + ]
386 + }
387 + ],
388 + "insurancePrice": {
389 + "name": "string",
390 + "price": 0,
391 + "priceSurcarge": 0,
392 + "actualStartDate": "2023-12-26T12:55:59.433Z",
393 + "actualEndDate": "2023-12-26T12:55:59.433Z",
394 + "optional": true,
395 + "includedInPackagePrice": true
94 94   }
95 - ],
96 - "flights": [
97 - {
98 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
99 - "isArrival": true,
100 - "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
101 - "touristName": "string",
102 - "date": "2024-04-11T02:39:52.147Z",
103 - "departureAirport": "string",
104 - "departureTerminal": "string",
105 - "arrivalAirport": "string",
106 - "arrivalTerminal": "string",
107 - "agentConfirmationNumber": "string",
108 - "bookingConfirmationNumber": "string",
109 - "note": "string"
110 - }
111 - ],
112 - "transfers": [
113 - {
114 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
115 - "transferType": "string",
116 - "vehicleName": "string",
117 - "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
118 - "touristName": "string",
119 - "date": "2024-04-11T02:39:52.147Z",
120 - "fromTerminal": "string",
121 - "fromCityName": "string",
122 - "fromHotelName": "string",
123 - "toHotelName": "string",
124 - "toTerminal": "string",
125 - "toCityName": "string",
126 - "agentConfirmationNumber": "string",
127 - "note": "string"
128 - }
129 - ],
130 - "services": [
131 - {
132 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
133 - "serviceDate": "2024-04-11T02:39:52.147Z",
134 - "serviceName": "string",
135 - "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
136 - "touristName": "string",
137 - "note": "string"
138 - }
139 - ]
140 - }
397 + }
398 + ],
399 + "refreshPriceResult": "Success"
141 141  }
142 142  {{/code}}
143 143  
... ... @@ -489,69 +489,3 @@
489 489  
490 490  }
491 491  {{/success}}
492 -
493 -
494 -== Description ==
495 -
496 -
497 -(% class="table-bordered" %)
498 -|=Parameter|=Value Type|=Description
499 -|id|String|The unique identifier for the reservation, typically a UUID or similar.
500 -|rfNumber|String|The reference number for the reservation, usually generated by the system.
501 -|contactNumber|String|The contact number associated with the reservation, used for communication purposes.
502 -|agentName|String|The name of the agent who made the reservation, useful for tracking and accountability.
503 -|totalPrice|Number|The total price of the reservation, calculated based on the services and products included.
504 -|agentCommission|Number|The commission earned by the agent for this reservation, calculated as a percentage of the total price.
505 -|currency|String|The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR).
506 -|tourists[].id|String|The unique identifier for each tourist, typically a UUID.
507 -|tourists[].gender|String|The gender of the tourist, usually : [ None, Male, Female ]
508 -|tourists[].ageCategory|String|The age category of the tourist, such as 'Adult', 'Child', or 'Infant'.
509 -|tourists[].firstName|String|The first name of the tourist, as it appears on their passport.
510 -|tourists[].lastName|String|The last name of the tourist, as it appears on their passport.
511 -|tourists[].birthDate|String (Date)|The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD).
512 -|tourists[].passportNumber|String|The passport number of the tourist, as it appears on their passport.
513 -|tourists[].passportExpiryDate|String (Date)|The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD).
514 -|tourists[].citizenshipCountryCode|String|The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB).
515 -|tourists[].citizenshipCountryName|String|The full name of the tourist's country of citizenship.
516 -|tourists[].arrivalDate|String (Date)|The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD).
517 -|tourists[].arrivalFlightNumber|String|The flight number for the tourist's arrival, as provided by the airline.
518 -|tourists[].arrivalTerminalCode|String|The terminal code for the tourist's arrival, as provided by the airport.
519 -|tourists[].returnDate|String (Date)|The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD).
520 -|tourists[].returnFlightNumber|String|The flight number for the tourist's return, as provided by the airline.
521 -|tourists[].returnTerminalCode|String|The terminal code for the tourist's return, as provided by the airport.
522 -|tourists[].showReturn|Boolean|A boolean indicating whether the return information should be displayed, useful for one-way trips.
523 -|hotels[].id|String|The unique identifier for each hotel booking, typically a UUID or similar.
524 -|hotels[].hotelName|String|The name of the hotel where the booking is made.
525 -|hotels[].cityName|String|The city where the hotel is located.
526 -|hotels[].hotelClass|String|The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc.
527 -|hotels[].checkInDate|String (Date)|The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
528 -|hotels[].checkOutDate|String (Date)|The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
529 -|hotels[].roomCategoryName|String|The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc.
530 -|hotels[].placementName|String|The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc.
531 -|hotels[].mealPlan|String|The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc.
532 -|flights[].id|String|The unique identifier for each flight, typically a UUID or similar.
533 -|flights[].isArrival|Boolean|A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights.
534 -|flights[].touristId|String|The id of the tourist taking this flight, linking the flight to a specific tourist.
535 -|flights[].touristName|String|The name of the tourist taking this flight, useful for passenger lists.
536 -|flights[].date|String (Date)|The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
537 -|flights[].departureAirport|String|The IATA code of the airport from which the flight departs (e.g., JFK, LHR).
538 -|flights[].departureTerminal|String|The terminal from which the flight departs, as provided by the airport.
539 -|flights[].arrivalAirport|String|The IATA code of the airport at which the flight arrives (e.g., JFK, LHR).
540 -|flights[].arrivalTerminal|String|The terminal at which the flight arrives, as provided by the airport.
541 -|flights[].note|String|Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc.
542 -|transfers[].id|String|The unique identifier for each transfer, typically a UUID or similar.
543 -|transfers[].transferType|String|The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers.
544 -|transfers[].vehicleName|String|The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc.
545 -|transfers[].touristId|String|The id of the tourist using this transfer, linking the transfer to a specific tourist.
546 -|transfers[].touristName|String|The name of the tourist using this transfer, useful for passenger lists.
547 -|transfers[].date|String (Date)|The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
548 -|transfers[].fromTerminal|String|The terminal from which the transfer starts, as provided by the airport or hotel.
549 -|transfers[].fromCityName|String|The city from which the transfer starts.
550 -|transfers[].toHotelName|String|The hotel to which the transfer goes.
551 -|transfers[].toCityName|String|The city to which the transfer goes.
552 -|transfers[].note|String|Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc.
553 -|services[].id|String|The unique identifier for each service, typically a UUID or similar.
554 -|services[].serviceDate|String (Date)|The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
555 -|services[].serviceName|String|The name of the service, such as insurance in this example.
556 -|services[].touristId|String|The id of the tourist using this service, linking the service to a specific tourist.
557 -|services[].touristName|String|The name of the tourist using this service, useful for booking confirmations.