Last modified by Giorgi Mdivnishvili on 2025/10/22 13:39

From version 15.1
edited by Giorgi Mdivnishvili
on 2024/04/11 18:01
Change comment: There is no comment for this version
To version 7.1
edited by Giorgi Mdivnishvili
on 2024/04/11 11:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SearchTourPackages - Basic Version
1 +SearchTourPackages - Basic version
Content
... ... @@ -6,32 +6,11 @@
6 6  
7 7  = Method Description =
8 8  
9 +Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
9 9  
10 -=== Method Overview: Streamlined Tour Package Discovery and Booking ===
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.
11 11  
12 -**Purpose:** This method outlines the most efficient process for locating and subsequently booking a tour package utilizing a minimal set of required parameters. It is designed to simplify the user interaction by reducing the complexity and volume of input data necessary for operation.
13 13  
14 -**Procedure:**
15 -
16 -1. **Initialization**: Start by specifying the essential parameters. This approach is engineered to streamline the search and booking process, focusing on the core data elements critical for identifying suitable tour packages.
17 -1. **Search Execution**: Deploy the method with the specified parameters to initiate the search. The system is optimized to process these inputs, conducting a targeted query across available tour packages to identify matches that align with the user's criteria.
18 -1. **Selection and Booking**: Upon receiving search results, the user can select a desired tour package. The booking process is then initiated with the minimal parameters already provided, ensuring a seamless transition from selection to confirmation.
19 -
20 -**Parameter Details:**
21 -
22 -* The parameters required for this method are intentionally limited to essential elements only, aiming to expedite the search and booking phases while maintaining effectiveness. Details on these parameters, including data types and usage instructions, are documented separately.
23 -
24 -**Usage Notes:**
25 -
26 -* This method is particularly beneficial for users seeking a straightforward and efficient path to tour package booking, minimizing decision fatigue and enhancing user experience.
27 -
28 -**Examples:**
29 -
30 -* Code examples and detailed step-by-step instructions for utilizing this method are available in the subsequent sections, providing practical guidance on implementing the streamlined tour package discovery and booking process.
31 -
32 -This documentation segment aims to facilitate developers and users in leveraging a simplified method for tour package exploration and booking, ensuring an efficient and user-friendly interaction with the system.
33 -
34 -
35 35  == Endpoint URL - [POST] ==
36 36  
37 37  {{info}}
... ... @@ -67,35 +67,7 @@
67 67  }
68 68  {{/code}}
69 69  
70 -== Request example for 2Adults 2Child ==
71 71  
72 -{{code language="Json"}}
73 -{
74 - "departureCountryCode": "KZ",
75 - "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
76 - "arrivalCountryCode": "AE",
77 - "adults": 2,
78 - "children": 2,
79 - "childrenAges": [
80 - 4,
81 - 8
82 - ],
83 - "departureDate": "2024-05-26T00:00:00",
84 - "returnDate": "2024-06-02T00:00:00",
85 - "departureAndReturnDaysCount": 7,
86 - "checkInDate": "2024-05-26T00:00:00",
87 - "checkOutDate": "2024-06-02T00:00:00",
88 - "checkInAndCheckOutDaysCount": 7,
89 - "directFlightsOnly": true,
90 - "searchCurrency": "USD",
91 -
92 - "pagingId": "",
93 - "pageNumber": 1,
94 - "pageRowCount":5
95 -}
96 -{{/code}}
97 -
98 -
99 99  == Response Body ==
100 100  
101 101  {{code language="json"}}
... ... @@ -779,6 +779,8 @@
779 779  |pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
780 780  |searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
781 781  
733 +=== ===
734 +
782 782  === **Response Parameters** ===
783 783  
784 784  (% class="table-bordered" %)
... ... @@ -869,12 +869,10 @@
869 869   }
870 870  {{/code}}
871 871  
872 -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.
873 873  
874 -
875 875  ==== Request with caching ====
876 876  
877 -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": "",
828 +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
878 878  
879 879  {{code language="Json"}}
880 880   {
... ... @@ -885,57 +885,6 @@
885 885  {{/code}}
886 886  
887 887  
888 -**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.
889 -
890 -**Initial Request:**
891 -
892 -* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
893 -* **Parameters**:
894 -** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
895 -** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
896 -** pageRowCount: Specifies the number of results to be included on each page.
897 -
898 -**Example - First Request**:
899 -
900 -{{{{
901 - "pagingId": "",
902 -  "pageNumber": 1,
903 -  "pageRowCount": 10
904 -}
905 -}}}
906 -
907 -
908 -**Subsequent Requests with Caching:**
909 -
910 -* **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.
911 -* **Cache Utilization**:
912 -** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
913 -** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
914 -** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
915 -
916 -
917 -**Example - Request with Caching**:
918 -
919 -{{{ {
920 - "pagingId": "80",
921 - "pageNumber": 2, // Adjusted to fetch the next page
922 - "pageRowCount": 10
923 - }
924 -}}}
925 -
926 -
927 -**Cache Management:**
928 -
929 -* 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.
930 -
931 -**Implementation Notes**:
932 -
933 -* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
934 -* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
935 -
936 -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.
937 -
938 -
939 939  === search parameter options ===
940 940  
941 941  in the request body it's available to filter search results with parameters. parameter examples:
... ... @@ -974,21 +974,22 @@
974 974  {{/code}}
975 975  
976 976  
877 +
977 977  == Important ==
978 978  
979 979  {{error}}
980 -=== Implementing Authorization in Subsequent Requests ===
881 +It's Important to in every other request header, put Auth token
981 981  
982 -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:
883 +**Key **- Authorization
983 983  
984 -* **Header Key:** Authorization
985 -* **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.
885 +**Value **- Bearer Token what is given in this response.
986 986  
987 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
988 988  
989 -* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
990 -* **Header Key:** X-nugios-timezone
991 -* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
888 +**also note in headers that:**
992 992  
993 -Incorporating these headers with their respective values is essential for the successful processing of your API requests.
890 +Content-Type - application/json
891 +
892 +**Key - **X-nugios-timezone
893 +
894 +**Value **- 240
994 994  {{/error}}