Changes for page 1. SearchTourPackages

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

From 20.1 to 21.1 From 39.1 to 40.1

From version 21.1

edited by Giorgi Mdivnishvili
on 2024/01/10 17:51

Change comment: There is no comment for this version

To version 39.1

edited by Giorgi Mdivnishvili
on 2024/04/16 15:28

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -6,11 +6,32 @@
  = Method Description =
--Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
++Tour package mean, tour with hotel and flight  together In case of variation also with transfer option. Using this method gives data about full package availability with flight and hotel options.
  It's possible to receive data as current dates, also in date ranges using parameter  "stayDays": 0,   "stayDaysTo": 0. the maximum difference between the days can be 7. Below you can see examples.
++in more  details:
++
++A tour package encapsulates a bundled offering that includes both hotel accommodations and flight arrangements. In certain variations, it may also incorporate transfer options, providing a comprehensive travel solution. The method detailed herein facilitates the retrieval of data concerning the complete availability of such tour packages, including pertinent flight and hotel options.
++
++**Data Retrieval Parameters:**
++
++* **Parameter Usage**: To query package data, the system utilizes the following parameters within the request payload:
++** stayDays: Defines the minimum duration of stay (in days) as part of the tour package. The value is set to 0 by default, indicating no minimum duration constraint.
++** stayDaysTo: Specifies the maximum duration of stay (in days) allowable within the package offerings. A default value of 0 implies no maximum limit; however, the system enforces a maximum duration difference of 7 days between stayDays and stayDaysTo.
++
++**Constraints:**
++
++* The system imposes a constraint wherein the difference between stayDays and stayDaysTo cannot exceed 7 days. This limit is designed to refine search results and maintain query performance.
++
++**Example Requests:** Below are examples illustrating how to structure requests for retrieving tour package data, utilizing the stayDays and stayDaysTo parameters to define the desired range of stay durations.
++
++(Note: Actual example requests are not included in this response but should typically be provided here, showcasing the structure and format of API calls or query parameters used to fetch the tour package data.)
++
++This documentation aims to guide developers in effectively querying for tour package options, employing specified parameters to tailor the search according to the duration of stay requirements.
++
++
  == Endpoint URL - [POST] ==
  {{info}}
@@ -760,13 +760,114 @@
  == Definitions ==
++**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.
++|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.
++
++(% class="wikigeneratedid" %)
++**Response 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:
--==== first request ====
++==== First request ====
  {{code language="Json"}}
   {
@@ -776,10 +776,12 @@
   }
  {{/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 ====
--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
++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": "",
  {{code language="Json"}}
   {
@@ -790,8 +790,59 @@
  {{/code}}
--=== search parameter options ===
++**Overview:** The Paging and Caching mechanism is designed to efficiently manage data retrieval in a paginated format. This mechanism is essential for handling large datasets by dividing the data into manageable pages, thereby optimizing the performance and scalability of data retrieval operations.
++**Initial Request:**
++
++* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
++* **Parameters**:
++** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
++** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
++** pageRowCount: Specifies the number of results to be included on each page.
++
++**Example - First Request**:
++
++{{{{
++    "pagingId": "",
++    "pageNumber": 1,
++    "pageRowCount": 10
++}
++}}}
++
++
++**Subsequent Requests with Caching:**
++
++* **Purpose**: Following the initial data retrieval, subsequent requests utilize the pagingId obtained from the previous response. This pagingId serves as a cache identifier, enabling the system to quickly access the relevant dataset and efficiently paginate through the data.
++* **Cache Utilization**:
++** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
++** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
++** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
++
++**Example - Request with Caching**:
++
++{{{ {
++  "pagingId": "80",
++  "pageNumber": 2, // Adjusted to fetch the next page
++  "pageRowCount": 10
++ }
++}}}
++
++
++**Cache Management:**
++
++* Clearing the cache and fetching a fresh set of data requires sending a new request with the pagingId parameter omitted or set to an empty string. This action resets the pagination and caching context.
++
++**Implementation Notes**:
++
++* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
++* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
++
++This documentation outlines the procedural framework for implementing a robust paging and caching strategy within data retrieval systems, detailing parameter usage and operational best practices for both initial and subsequent data fetch operations.
++
++
++
++=== Search parameter options ===
++
  in the request body it's available to filter search results with parameters. parameter examples:
  {{code language="Json"}}
@@ -827,23 +827,39 @@
  }
  {{/code}}
++1. **RO (Room Only)**: This plan includes only the accommodation with no meals provided. Guests will need to arrange their own meals either outside the hotel or by purchasing them separately within the hotel.
++1. **BB (Bed and Breakfast)**: This plan includes accommodation along with breakfast served at the hotel. No other meals are included, which means guests need to arrange their own lunch and dinner.
++1. **HB (Half Board)**: This meal plan includes accommodation along with two meals a day, typically breakfast and either lunch or dinner. Guests can choose which two meals are most convenient for them based on the options provided by the hotel.
++1. **FB (Full Board)**: Under the full board plan, accommodation and all three meals (breakfast, lunch, and dinner) are included. This plan is convenient for guests who do not wish to worry about arranging meals during their stay.
++1. **AL (All Inclusive)**: The all-inclusive meal plan includes accommodation, all meals (breakfast, lunch, dinner), and usually includes a range of snacks and beverages (both alcoholic and non-alcoholic). This plan may also cover other amenities such as recreational activities, entertainment, and sometimes even certain off-site excursions. It is the most comprehensive meal plan, offering the greatest convenience and predictability in costs.
  == Important ==
  {{error}}
--It's Important to in every other request header, put Auth token
++=== Implementing Authorization in Subsequent Requests ===
--**Key **- Authorization
++For every API request after the initial authentication, it's crucial to include the authorization token in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token:
--**Value **- Bearer Token what is given in this response.
++* **Header Key:** Authorization
++* **Header Value:** Bearer [Your Token Here] - Use the bearer token provided in the initial authentication response. The authorization type should be specified as Bearer Token.
++Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
--**also note in headers that:**
++* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
++* **Header Key:** X-nugios-timezone
++* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
--Content-Type - application/json
++Incorporating these headers with their respective values is essential for the successful processing of your API requests.
++{{/error}}
--**Key - **X-nugios-timezone
--**Value **- 240
--{{/error}}
++
++(% class="box errormessage" %)
++(((
++Tour package requirements can vary based on the destination country, necessitating the inclusion of additional mandatory services such as Visa, Insurance, etc. When querying for tour packages through the API, the response payload will dynamically include fields indicating whether these services are mandatory. For instance, the API may return a structure like this:
++
++[[image:https://xwiki.nugios.com/xwiki/bin/download/APIs/Online%20API/TourPackages/WebHome/1713191255012-154.png?rev=1.1||alt="1713191255012-154.png"]]
++
++in the given example it means that insurance service is mandatory for the tourpackage.
++)))

Changes for page 1. SearchTourPackages

Summary

Details

Applications

Navigation