Skip to Content

Changes for page 1. SearchTourPackages

Last modified by Giorgi Mdivnishvili on 2025/10/22 15:30
From version 49.1
edited by Giorgi Mdivnishvili
on 2025/10/13 18:16
Change comment: There is no comment for this version
To version 36.1
edited by Giorgi Mdivnishvili
on 2024/04/11 17:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,32 +6,11 @@
6 6  
7 7  = Method Description =
8 8  
9 -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.
9 +Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
10 10  
11 -It's possible to receive data as current dates, also in date ranges using parameter  "nights": 0,   "nightsTo ": 0. the maximum difference between the days can be 7. Below you can see examples.
11 +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.
12 12  
13 13  
14 -in more  details:
15 -
16 -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.
17 -
18 -**Data Retrieval Parameters:**
19 -
20 -* **Parameter Usage**: To query package data, the system utilizes the following parameters within the request payload:
21 -** nights: 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.
22 -** nightsTo: 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.
23 -
24 -**Constraints:**
25 -
26 -* 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.
27 -
28 -**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.
29 -
30 -(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.)
31 -
32 -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.
33 -
34 -
35 35  == Endpoint URL - [POST] ==
36 36  
37 37  {{info}}
... ... @@ -66,8 +66,8 @@
66 66   "checkInDate": "2023-12-14",
67 67   "checkInDateTo": "2023-12-14",
68 68   "checkOutDate": "2023-12-14",
69 - "nights": 0,
70 - "NightsTo": 0,
48 + "stayDays": 0,
49 + "stayDaysTo": 0,
71 71   "departureDate": "2023-12-14",
72 72   "returnDate": "2023-12-14",
73 73   "airlineCode": "string",
... ... @@ -177,6 +177,7 @@
177 177   "userErrorDescription": "string",
178 178   "packages": [
179 179   {
159 + "cacheKey": "string",
180 180   "id": "string",
181 181   "priceCurrency": "string",
182 182   "totalPrice": 0,
... ... @@ -351,6 +351,7 @@
351 351  {
352 352   "packages": [
353 353   {
334 + "cacheKey": "c705ab31e00e4f9a81c2fd46b2cdbb47f6fd9a6e16984236beb979b31aefafa4:{79}:i:10",
354 354   "id": "tour:b01c168e-2ea7-4ea6-b6e0-55abb8cab0a0:da894a1e-88c0-4877-b216-0eeeabe186f3:4298d06f-4344-4a39-ad98-071b7760cf30",
355 355   "priceCurrency": "USD",
356 356   "totalPrice": 1033.53,
... ... @@ -511,6 +511,8 @@
511 511  nullable: true
512 512  |packages|[
513 513  nullable: trueTourPackage{(((
495 +|cacheKey|string
496 +nullable: true
514 514  |id|string
515 515  nullable: true
516 516  |priceCurrency|string
... ... @@ -790,7 +790,7 @@
790 790  |stayDays|integer|The minimum number of days to stay.
791 791  |stayDaysTo|integer|The maximum number of days to stay.
792 792  |airlineCode|string|The code of the airline. This field can be empty.
793 -|ticketType|string|The type of the ticket. This field can be empty. definition of avia tickets classes. enum: F - First, B - Business, P = Premium, C - Coach
776 +|ticketType|string|The type of the ticket. This field can be empty.
794 794  |directFlightsOnly|boolean|Indicates whether to search for direct flights only.
795 795  |longConnectTime|boolean|Indicates whether to include flights with long connection times.
796 796  |adults|integer|The number of adults.
... ... @@ -818,8 +818,9 @@
818 818  (% class="table-bordered" %)
819 819  |=Field|=Type|=Description
820 820  |packages|array|An array of packages available. Each package contains:
804 +|cacheKey|string|A unique identifier for the cache.
821 821  |id|string|A unique identifier for the package.
822 -|priceCurrency|string|The currency in which the price is displayed. examples -  •   KZT - ₸ •   USD - $ •   RUB - ₽ •   EUR - € •   UZS - ЛВ •   AZN - ₼
806 +|priceCurrency|string|The currency in which the price is displayed.
823 823  |totalPrice|float|The total price of the package.
824 824  |agentCommissionPercent|float|The commission percentage for the agent.
825 825  |agentCommissionAmount|float|The commission amount for the agent.
... ... @@ -909,57 +909,6 @@
909 909  {{/code}}
910 910  
911 911  
912 -**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.
913 -
914 -**Initial Request:**
915 -
916 -* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
917 -* **Parameters**:
918 -** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
919 -** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
920 -** pageRowCount: Specifies the number of results to be included on each page.
921 -
922 -**Example - First Request**:
923 -
924 -{{{{
925 - "pagingId": "",
926 -  "pageNumber": 1,
927 -  "pageRowCount": 10
928 -}
929 -}}}
930 -
931 -
932 -**Subsequent Requests with Caching:**
933 -
934 -* **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.
935 -* **Cache Utilization**:
936 -** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
937 -** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
938 -** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
939 -
940 -**Example - Request with Caching**:
941 -
942 -{{{ {
943 - "pagingId": "80",
944 - "pageNumber": 2, // Adjusted to fetch the next page
945 - "pageRowCount": 10
946 - }
947 -}}}
948 -
949 -
950 -**Cache Management:**
951 -
952 -* 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.
953 -
954 -**Implementation Notes**:
955 -
956 -* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
957 -* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
958 -
959 -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.
960 -
961 -
962 -
963 963  === Search parameter options ===
964 964  
965 965  in the request body it's available to filter search results with parameters. parameter examples:
... ... @@ -998,16 +998,7 @@
998 998  {{/code}}
999 999  
1000 1000  
1001 -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.
1002 -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.
1003 -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.
1004 -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.
1005 -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). It is the most comprehensive meal plan, offering the greatest convenience and predictability in costs.
1006 1006  
1007 -**ticketType **definition of avia tickets classes.
1008 -
1009 -enum: F - First, B - Business, P = Premium, C - Coach.
1010 -
1011 1011  == Important ==
1012 1012  
1013 1013  {{error}}
... ... @@ -1026,14 +1026,3 @@
1026 1026  
1027 1027  Incorporating these headers with their respective values is essential for the successful processing of your API requests.
1028 1028  {{/error}}
1029 -
1030 -
1031 -
1032 -(% class="box errormessage" %)
1033 -(((
1034 -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:
1035 -
1036 -[[image:https://xwiki.nugios.com/xwiki/bin/download/APIs/Online%20API/TourPackages/WebHome/1713191255012-154.png?rev=1.1||alt="1713191255012-154.png"]]
1037 -
1038 -in the given example it means that insurance service is mandatory for the tourpackage.
1039 -)))