Changes for page SearchTourPackages - Basic Version
Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45
From version 7.1
edited by Giorgi Mdivnishvili
on 2024/04/11 11:05
on 2024/04/11 11:05
Change comment:
There is no comment for this version
To version 13.1
edited by Giorgi Mdivnishvili
on 2024/04/11 17:38
on 2024/04/11 17:38
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -SearchTourPackages - Basic version1 +SearchTourPackages - Basic Version - 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'spossiblereceivedata as current dates, alsoindate rangesusing parameter"stayDays": 0, "stayDaysTo": 0. themaximum difference between the dayscanbe 7.Below you cansee 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"}} ... ... @@ -812,6 +812,8 @@ 812 812 |totalCount|Number|The total count of packages. This is the total number of packages in all pages of results. 813 813 |error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages. 814 814 864 +==== ==== 865 + 815 815 ==== first request ==== 816 816 817 817 {{code language="Json"}} ... ... @@ -822,10 +822,12 @@ 822 822 } 823 823 {{/code}} 824 824 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. 825 825 878 + 826 826 ==== Request with caching ==== 827 827 828 -a s we receiveresponse, in the end we can see pagingId- number, chich we can use for caching, andthenjust switch pagenumbers.for cleaning cache, it's important to make new request without pagingID881 +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": "", 829 829 830 830 {{code language="Json"}} 831 831 { ... ... @@ -878,18 +878,18 @@ 878 878 == Important == 879 879 880 880 {{error}} 881 - It'sImportant to in every otherrequestheader, put Auth token934 +=== Implementing Authorization in Subsequent Requests === 882 882 883 - **Key**-Authorization936 +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: 884 884 885 -**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. 886 886 941 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers: 887 887 888 -**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. 889 889 890 -Content-Type - application/json 891 - 892 -**Key - **X-nugios-timezone 893 - 894 -**Value **- 240 947 +Incorporating these headers with their respective values is essential for the successful processing of your API requests. 895 895 {{/error}}