Changes for page SearchTourPackages - Basic Version

Summary

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

Details

Page properties

Content

...	...	@@ -6,11 +6,32 @@
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.
10	10
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.
	10	+=== Method Overview: Streamlined Tour Package Discovery and Booking ===
12	12
	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	+
14	14	== Endpoint URL - [POST] ==
15	15
16	16	{{info}}
...	...	@@ -46,7 +46,35 @@
46	46	}
47	47	{{/code}}
48	48
	70	+== Request example for 2Adults 2Child ==
49	49
	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	+
50	50	== Response Body ==
51	51
52	52	{{code language="json"}}
...	...	@@ -713,6 +713,7 @@
713	713
714	714	=== **Request Parameters ** ===
715	715
	765	+(% class="table-bordered" %)
716	716	|=Key|=Type|=Nullable|=Description
717	717	|departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
718	718	|departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
...	...	@@ -733,6 +733,7 @@
733	733
734	734	=== **Response Parameters** ===
735	735
	786	+(% class="table-bordered" %)
736	736	|=Key|=Type|=Description
737	737	|packages|Array|An array of travel packages. Each package includes various details about the package.
738	738	|packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
...	...	@@ -810,6 +810,7 @@
810	810	|totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
811	811	|error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
812	812
	864	+==== ====
813	813
814	814	==== first request ====
815	815
...	...	@@ -821,10 +821,12 @@
821	821	}
822	822	{{/code}}
823	823
	876	+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.
824	824
	878	+
825	825	==== Request with caching ====
826	826
827		-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
	881	+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	828
829	829	{{code language="Json"}}
830	830	{
...	...	@@ -877,18 +877,18 @@
877	877	== Important ==
878	878
879	879	{{error}}
880		-It's Important to in every other request header, put Auth token
	934	+=== Implementing Authorization in Subsequent Requests ===
881	881
882		-**Key **- Authorization
	936	+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	883
884		-**Value **- Bearer Token what is given in this response.
	938	+* **Header Key:** Authorization
	939	+* **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	885
	941	+Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
886	886
887		-**also note in headers that:**
	943	+* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
	944	+* **Header Key:** X-nugios-timezone
	945	+* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
888	888
889		-Content-Type - application/json
890		-
891		-**Key - **X-nugios-timezone
892		-
893		-**Value **- 240
	947	+Incorporating these headers with their respective values is essential for the successful processing of your API requests.
894	894	{{/error}}