Changes for page SearchTourPackages - Basic Version

Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45

From 3.1 to 4.1 From 5.1 to 6.1

From version 4.1

edited by Giorgi Mdivnishvili
on 2024/04/11 09:35

Change comment: There is no comment for this version

To version 5.1

edited by Giorgi Mdivnishvili
on 2024/04/11 09:45

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -711,108 +711,127 @@
  == Definitions ==
--**Request Parameters **
++=== **Request Parameters ** ===
--(% class="table-bordered" %)
++|=Key|=Type|=Nullable|=Description
++|departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
++|departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
++|arrivalCountryCode|String|No|The ISO 3166-1 alpha-2 code of the arrival country. For example, "AE" for United Arab Emirates.
++|adults|Integer|No|The number of adults for the trip. For example, 2 for two adults.
++|children|Integer|No|The number of children for the trip. For example, 0 for no children.
++|departureDate|String (date-time)|No|The departure date in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
++|returnDate|String (date-time)|No|The return date in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
++|departureAndReturnDaysCount|Integer|No|The total number of days for the departure and return trip. For example, 7 for a week-long trip.
++|checkInDate|String (date-time)|No|The check-in date at the hotel in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
++|checkOutDate|String (date-time)|No|The check-out date from the hotel in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
++|checkInAndCheckOutDaysCount|Integer|No|The total number of days for the hotel stay. For example, 7 for a week-long stay.
++|directFlightsOnly|Boolean|No|Whether to search for direct flights only. For example, true to only search for direct flights.
++|pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
++|searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
++
++
++=== **Response Parameters**  ===
++
++=== Packages ===
++
  |=Field|=Type|=Description
--|departureCountryCode|string|The ISO 3166-1 alpha-2 country code for the departure country. For example, "KZ" for Kazakhstan.
--|departureCityUID|string|The unique identifier for the departure city.
--|arrivalCountryCode|string|The ISO 3166-1 alpha-2 country code for the arrival country. For example, "AE" for United Arab Emirates.
--|arrivalLocations|array|An array of objects, each representing an arrival location. Each object contains: type (string) - The type of the location. This can be "city". label (string) - The name of the location. value (string) - The unique identifier for the location. tag (string) - A tag for the location.
--|checkInDate|string|The check-in date in ISO 8601 format.
--|checkInDateTo|string|The latest possible check-in date in ISO 8601 format.
--|stayDays|integer|The minimum number of days to stay.
--|stayDaysTo|integer|The maximum number of days to stay.
--|airlineCode|string|The code of the airline. This field can be empty.
--|ticketType|string|The type of the ticket. This field can be empty.
--|directFlightsOnly|boolean|Indicates whether to search for direct flights only.
--|longConnectTime|boolean|Indicates whether to include flights with long connection times.
--|adults|integer|The number of adults.
--|children|integer|The number of children.
--|childrenAges|array|An array of integers, each representing the age of a child.
--|extendedSearch|boolean|Indicates whether to perform an extended search.
--|totalPriceFrom|float|The minimum total price.
--|totalPriceTo|float|The maximum total price.
--|recommended|boolean|Indicates whether to include recommended packages.
--|popular|boolean|Indicates whether to include popular packages.
--|freeSale|boolean|Indicates whether to include free sale packages.
--|groupByHotel|boolean|Indicates whether to group the results by hotel.
--|hotelCodes|array|An array of strings, each representing a hotel code. This field can be empty.
--|mealPlans|array|An array of meal plans. This field can be empty.
--|hotelClasses|array|An array of hotel classes. This field can be empty.
--|hotelTypes|array|An array of hotel types. This field can be empty.
--|hotelServices|array|An array of hotel services. This field can be empty.
--|pagingId|string|The paging ID for paginated results. This field can be empty.
--|pageNumber|integer|The page number for paginated results.
--|pageRowCount|integer|The number of rows per page for paginated results.
++|id|string|Unique identifier for the package
++|priceCurrency|string|Currency for the price
++|totalPrice|number|Total price of the package
++|agentCommissionPercent|number|Commission percentage for the agent
++|agentCommissionAmount|number|Commission amount for the agent
++|includedExtrasAmount|integer|Amount of included extras
++|priceDifference|integer|Price difference
++|hotel|object|Details about the hotel
++|flight|object|Details about the flight
++|extraServices|array|Extra services included in the package
++|insurancePrice|object|Details about the insurance price
++|cacheKey|string|Cache key
++|sortCheckInOut|string|Sorting parameter based on check-in and check-out dates
++|sortAirline|string|Sorting parameter based on airline
++|sortHotelName|string|Sorting parameter based on hotel name
++|sortDetails|string|Sorting parameter based on details
++|sortPlacement|string|Sorting parameter based on placement
--(% class="wikigeneratedid" %)
--**Response Parameters**
++=== Hotel ===
--(% class="table-bordered" %)
  |=Field|=Type|=Description
--|packages|array|An array of packages available. Each package contains:
--|cacheKey|string|A unique identifier for the cache.
--|id|string|A unique identifier for the package.
--|priceCurrency|string|The currency in which the price is displayed.
--|totalPrice|float|The total price of the package.
--|agentCommissionPercent|float|The commission percentage for the agent.
--|agentCommissionAmount|float|The commission amount for the agent.
--|includedExtrasAmount|integer|The amount of extras included in the package.
--|priceDifference|integer|The difference in price from the original price.
--|hotel|object|An object containing details about the hotel.
--|hotelPriceId|string|A unique identifier for the hotel price.
--|providerId|integer|A unique identifier for the provider.
--|hotelName|string|The name of the hotel.
--|hotelCode|string|A unique code for the hotel.
--|nigths|integer|The number of nights for the stay.
--|mealPlan|string|The meal plan for the stay.
--|hotelClass|string|The class or rating of the hotel.
--|availabilityType|string|The availability type of the hotel.
--|availableRoomsCount|integer|The number of available rooms in the hotel.
--|fewRooms|boolean|Indicates whether there are few rooms left.
--|roomCategoryCode|string|A unique code for the room category.
--|roomCategoryName|string|The name of the room category.
--|placementTypeName|string|The name of the placement type.
--|checkInDate|string|The check-in date in ISO 8601 format.
--|checkOutDate|string|The check-out date in ISO 8601 format.
--|adults|integer|The number of adults for the stay.
--|children|integer|The number of children for the stay.
--|districtUID|string|A unique identifier for the district.
--|districtName|string|The name of the district.
--|cityUID|string|A unique identifier for the city.
--|cityName|string|The name of the city.
--|countryCode|string|The ISO 3166-1 alpha-2 country code.
--|countryName|string|The name of the country.
--|hasAlcohol|boolean|Indicates whether the hotel serves alcohol.
--|hasFreeWifi|boolean|Indicates whether the hotel offers free Wi-Fi.
--|hasMetro|boolean|Indicates whether the hotel is near a metro station.
--|hasPool|boolean|Indicates whether the hotel has a pool.
--|hasMall|boolean|Indicates whether the hotel is near a shopping mall.
--|cancellationPolicyDescription|string|The description of the cancellation policy.
--|cancellationPolicy|object|An object containing details about the cancellation policy.
--|flight|object|An object containing details about the flight.
--|id|string|A unique identifier for the flight.
--|departureDate|string|The departure date in ISO 8601 format.
--|returnDate|string|The return date in ISO 8601 format.
--|departureTicketsLeft|integer|The number of departure tickets left.
--|returnTicketsLeft|integer|The number of return tickets left.
--|departureAvailabilityType|string|The availability type of the departure flight.
--|returnAvailabilityType|string|The availability type of the return flight.
--|isTwoWay|boolean|Indicates whether the flight is two-way.
--|sameBaggageForAll|boolean|Indicates whether the same baggage is applicable for all passengers.
--|totalBaggage|boolean|Indicates whether total baggage is included.
--|departureSegments|array|An array of objects, each representing a departure segment.
--|returnSegments|array|An array of objects, each representing a return segment.
--|passengers|array|An array of objects, each representing a passenger.
--|extraServices|array|An array of extra services included in the package.
--|insurancePrice|object|An object containing details about the insurance price.
--|pagingId|string|The paging ID for paginated results.
--|pageNumber|integer|The page number for paginated results.
--|pageCount|integer|The total number of pages.
--|totalCount|integer|The total count of packages.
--|error|boolean|Indicates whether there was an error.
++|hotelPriceId|string|Unique identifier for the hotel price
++|hotelName|string|Name of the hotel
++|hotelCode|string|Code of the hotel
++|nights|integer|Number of nights
++|mealPlan|string|Meal plan
++|hotelClass|string|Class of the hotel
++|hotelColor|string|Color associated with the hotel
++|availabilityType|string|Availability type of the hotel
++|availableRoomsCount|integer|Number of available rooms
++|fewRooms|boolean|Whether there are few rooms left
++|roomCategoryCode|string|Code of the room category
++|roomCategoryName|string|Name of the room category
++|placementTypeName|string|Name of the placement type
++|placementDescription|string|Description of the placement
++|checkInDate|string|Check-in date
++|checkOutDate|string|Check-out date
++|adults|integer|Number of adults
++|children|integer|Number of children
++|districtUID|string|Unique identifier for the district
++|districtName|string|Name of the district
++|cityUID|string|Unique identifier for the city
++|cityName|string|Name of the city
++|countryCode|string|Country code
++|countryName|string|Name of the country
++|hasAlcohol|boolean|Whether the hotel has alcohol
++|hasFreeWifi|boolean|Whether the hotel has free Wi-Fi
++|hasMetro|boolean|Whether the hotel is near a metro
++|hasPool|boolean|Whether the hotel has a pool
++|hasMall|boolean|Whether the hotel is near a mall
++|infantMaxAge|number|Maximum age for an infant
++|childMinAge|number|Minimum age for a child
++|childMaxAge|number|Maximum age for a child
++|teenMinAge|number|Minimum age for a teen
++|teenMaxAge|number|Maximum age for a teen
++|adultMinAge|number|Minimum age for an adult
++|cancellationPolicyDescription|string|Description of the cancellation policy
++|cancellationPolicy|object|Details about the cancellation policy
++=== Flight ===
++
++|=Field|=Type|=Description
++|id|string|Unique identifier for the flight
++|departureDate|string|Departure date
++|returnDate|string|Return date
++|departureTicketsLeft|integer|Number of departure tickets left
++|returnTicketsLeft|integer|Number of return tickets left
++|departureAvailabilityType|string|Availability type for the departure
++|returnAvailabilityType|string|Availability type for the return
++|isTwoWay|boolean|Whether the flight is two-way
++|sameBaggageForAll|boolean|Whether the same baggage is for all
++|totalBaggage|boolean|Whether the total baggage is included
++|isBlock|boolean|Whether the flight is blocked
++|class|string|Class of the flight
++|departureSegments|array|Details about the departure segments
++|returnSegments|array|Details about the return segments
++|passengers|array|Details about the passengers
++
++=== InsurancePrice ===
++
++|=Field|=Type|=Description
++|name|string|Name of the insurance
++|price|number|Price of the insurance
++|actualStartDate|string|Start date of the insurance
++|actualEndDate|string|End date of the insurance
++|optional|boolean|Whether the insurance is optional
++|includedInPackagePrice|boolean|Whether the insurance is included in the package price
++
++=== Paging ===
++
++|=Field|=Type|=Description
++|pagingId|string|Unique identifier for the paging
++|pageNumber|integer|Current page number
++|pageCount|integer|Total number of pages
++|totalCount|integer|Total count of items
++|error|boolean|Whether there is an error
++
  === Paging and Caching ===
  During the first request, Paging id must be  empty like this  ( "pagingId": "",)  pagenumber is the number of the page, pagerowcount means number of the given result in one page. So in the first request we can search like this:

Changes for page SearchTourPackages - Basic Version

Summary

Details

Applications

Navigation