Changes for page 4. CalcCheckout

Last modified by Giorgi Mdivnishvili on 2024/04/11 16:59

From version 6.1
edited by Giorgi Mdivnishvili
on 2024/04/11 09:05
Change comment: There is no comment for this version
To version 7.1
edited by Giorgi Mdivnishvili
on 2024/04/11 12:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -820,3 +820,71 @@
820 820  
821 821  }
822 822  {{/success}}
823 +
824 +
825 +== Descriptions ==
826 +
827 +=== ===
828 +
829 +=== Request ===
830 +
831 +Here's a table describing each parameter of the JSON request:
832 +
833 +|=Parameter|=Data Type|=Description
834 +|calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
835 +|refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
836 +|packageId|String|A unique identifier for the tour package.
837 +|flightPassengers|Array|An array of objects, each representing a flight passenger.
838 +|id|String|A unique identifier for each flight passenger.
839 +|selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
840 +|selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
841 +|extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
842 +|includeInsurance|Boolean|If true, insurance will be included in the tour package.
843 +|calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
844 +|calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
845 +
846 +=== ===
847 +
848 +=== Response ===
849 +
850 +|=Parameter|=Data Type|=Description
851 +|priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
852 +|totalPrice|Number|The total price of the booking.
853 +|agentCommissionPercent|Number|The commission percentage for the agent.
854 +|agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
855 +|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
856 +|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
857 +|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
858 +|hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
859 +|hotels[*].description|String|A brief description of the hotel.
860 +|tourists[*].id|String|Unique identifier for the tourist.
861 +|tourists[*].isAdult|Boolean|Indicates if the tourist is an adult.
862 +|tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist.
863 +|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
864 +|tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance.
865 +|tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product.
866 +|tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider.
867 +|...|...|Additional fields for insurancePrice as detailed previously.
868 +|tourists[*].transfers[*].id|String|Unique identifier for the transfer service.
869 +|tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure").
870 +|tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer.
871 +|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type).
872 +|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type).
873 +|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
874 +|tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option.
875 +|tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN").
876 +|...|...|Additional fields for transferPrices as detailed previously.
877 +|visas[*].prid|String|Unique identifier for the visa option.
878 +|visas[*].prName|String|The name of the visa option.
879 +|visas[*].prValue|Number|The cost associated with this visa option.
880 +|visas[*].sortingOrder|Number|Used to sort visa options in the response or UI.
881 +|terminals[*].terminalCode|String|The code representing the terminal.
882 +|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
883 +|...|...|Additional fields for terminals as detailed previously.
884 +|containsError|Boolean|Indicates if the response contains any errors.
885 +|refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
886 +|reservationId|String|Unique identifier for the reservation.
887 +|reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
888 +|error|Boolean|A generic error indicator, presumably redundant with containsError.
889 +
890 +