Changes for page SearchTourPackages - Basic Version

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

From 5.1 to 6.1 From 20.2 to 20.3

From version 6.1

edited by Giorgi Mdivnishvili
on 2024/04/11 10:33

Change comment: There is no comment for this version

To version 20.2

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--SearchTourPackages - Basic version
++SearchTourPackages - Basic Version

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.
--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.
++=== Method Overview: Streamlined Tour Package Discovery and Booking ===
++**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.
++**Procedure:**
++
++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.
++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.
++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.
++
++**Parameter Details:**
++
++* 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.
++
++**Usage Notes:**
++
++* This method is particularly beneficial for users seeking a straightforward and efficient path to tour package booking, minimizing decision fatigue and enhancing user experience.
++
++**Examples:**
++
++* 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.
++
++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.
++
++
  == Endpoint URL - [POST] ==
  {{info}}
@@ -46,7 +46,35 @@
  }
  {{/code}}
++== Request example for 2Adults 2Child ==
++{{code language="Json"}}
++{
++    "departureCountryCode": "KZ",
++    "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
++    "arrivalCountryCode": "AE",
++    "adults": 2,
++    "children": 2,
++    "childrenAges": [
++        4,
++        8
++    ],
++    "departureDate": "2024-05-26T00:00:00",
++    "returnDate": "2024-06-02T00:00:00",
++    "departureAndReturnDaysCount": 7,
++    "checkInDate": "2024-05-26T00:00:00",
++    "checkOutDate": "2024-06-02T00:00:00",
++    "checkInAndCheckOutDaysCount": 7,
++    "directFlightsOnly": true,
++    "searchCurrency": "USD",
++
++    "pagingId": "",
++    "pageNumber": 1,
++    "pageRowCount":5
++}
++{{/code}}
++
++
  == Response Body ==
  {{code language="json"}}
@@ -713,6 +713,7 @@
  === **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".
@@ -729,14 +729,13 @@
  |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** ===
++(% class="table-bordered" %)
  |=Key|=Type|=Description
  |packages|Array|An array of travel packages. Each package includes various details about the package.
  |packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
--|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
++|packages[].priceCurrency|String|The currency in which the price is denoted. This could be •    KZT - ₸ •    USD - $ •    RUB - ₽ •    EUR - € •    UZS - ЛВ •    AZN - ₼.
  |packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
  |packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
  |packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
@@ -791,7 +791,7 @@
  |packages[].flight.isTwoWay|Boolean|A boolean indicating if the flight is two-way. If true, it means that the flight includes both departure and return.
  |packages[].flight.sameBaggageForAll|Boolean|A boolean indicating if the same baggage is for all. If true, it means that the same baggage allowance applies to all passengers.
  |packages[].flight.totalBaggage|Boolean|A boolean indicating if total baggage is included. If true, it means that the total baggage allowance is included in the price.
--|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is blocked. If true, it means that the flight is currently blocked and cannot be booked.
++|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is block or not. If true, it means that the flight is currently block of flights
  |packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
  |packages[].flight.departureSegments|Array|An array containing details about the departure segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
  |packages[].flight.returnSegments|Array|An array containing details about the return segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
@@ -810,7 +810,6 @@
  |totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
  |error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
--
  ==== first request ====
  {{code language="Json"}}
@@ -821,10 +821,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"}}
   {
@@ -835,6 +835,56 @@
  {{/code}}
++**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:
@@ -873,22 +873,44 @@
  {{/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).  It is the most comprehensive meal plan, offering the greatest convenience and predictability in costs.
++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).  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 SearchTourPackages - Basic Version

Summary

Details

Applications

Navigation