Changes for page 1. SearchTourPackages

Last modified by Giorgi Mdivnishvili on 2025/02/12 15:25

From 23.1 to 22.1 From 30.1 to 29.1

From version 29.1

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

Change comment: There is no comment for this version

To version 23.1

edited by Giorgi Mdivnishvili
on 2024/04/10 10:50

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -760,9 +760,8 @@
  == Definitions ==
++Request Parameters
--**Request Parameters **
--
  (% class="table-bordered" %)
  |=Field|=Type|=Description
  |departureCountryCode|string|The ISO 3166-1 alpha-2 country code for the departure country. For example, "KZ" for Kazakhstan.
@@ -796,75 +796,11 @@
  |pageNumber|integer|The page number for paginated results.
  |pageRowCount|integer|The number of rows per page for paginated results.
++
  (% class="wikigeneratedid" %)
--**Response Parameters**
++Request Parameters
--(% 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.
--===   ===
--
  === 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:
@@ -880,12 +880,10 @@
   }
  {{/code}}
--While making first search request, paging id should be empty,  "pageNumber":  and  "pageRowCount":10 means that, in response there will be returned maximum 10 packages per page.
--
  ==== Request with caching ====
--after receiving response from first search request, in the end we can see pagingId- number, wchich we can use for caching, and (pageinatoin) for switch pagenumbers, and displaying results as we whant. For cleaning cache, it's important to make new request without cllear pagingID, like this  "pagingId": "",
++as we receive response, in the end we can see pagingId- number, chich we can use for caching, and then just switch pagenumbers. for cleaning cache, it's important to make new request without pagingID
  {{code language="Json"}}
   {
@@ -896,7 +896,7 @@
  {{/code}}
--=== Search parameter options ===
++=== search parameter options ===
  in the request body it's available to filter search results with parameters. parameter examples:

Changes for page 1. SearchTourPackages

Summary

Details

Applications

Navigation