Changes for page 1. SearchTourPackages

Last modified by Giorgi Mdivnishvili on 2025/02/12 15:25

From version 25.1
edited by Giorgi Mdivnishvili
on 2024/04/10 11:12
Change comment: There is no comment for this version
To version 37.1
edited by Giorgi Mdivnishvili
on 2024/04/11 17:29
Change comment: There is no comment for this version

Summary

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.
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.
10 10  
11 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 +** stayDays: 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 +** stayDaysTo: 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 +
14 14  == Endpoint URL - [POST] ==
15 15  
16 16  {{info}}
... ... @@ -760,7 +760,6 @@
760 760  
761 761  == Definitions ==
762 762  
763 -
764 764  **Request Parameters **
765 765  
766 766  (% class="table-bordered" %)
... ... @@ -796,7 +796,6 @@
796 796  |pageNumber|integer|The page number for paginated results.
797 797  |pageRowCount|integer|The number of rows per page for paginated results.
798 798  
799 -
800 800  (% class="wikigeneratedid" %)
801 801  **Response Parameters**
802 802  
... ... @@ -869,7 +869,7 @@
869 869  During the first request, Paging id must be  empty like this  ( "pagingId": "",)  pagenumber is the number of the page, pagerowcount means number of the given result in one page. So in the first request we can search like this:
870 870  
871 871  
872 -==== first request ====
891 +==== First request ====
873 873  
874 874  {{code language="Json"}}
875 875   {
... ... @@ -879,10 +879,12 @@
879 879   }
880 880  {{/code}}
881 881  
901 +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.
882 882  
903 +
883 883  ==== Request with caching ====
884 884  
885 -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
906 +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": "",
886 886  
887 887  {{code language="Json"}}
888 888   {
... ... @@ -893,7 +893,7 @@
893 893  {{/code}}
894 894  
895 895  
896 -=== search parameter options ===
917 +=== Search parameter options ===
897 897  
898 898  in the request body it's available to filter search results with parameters. parameter examples:
899 899  
... ... @@ -935,18 +935,18 @@
935 935  == Important ==
936 936  
937 937  {{error}}
938 -It's Important to in every other request header, put Auth token
959 +=== Implementing Authorization in Subsequent Requests ===
939 939  
940 -**Key **- Authorization
961 +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:
941 941  
942 -**Value **- Bearer Token what is given in this response.
963 +* **Header Key:** Authorization
964 +* **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.
943 943  
966 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
944 944  
945 -**also note in headers that:**
968 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
969 +* **Header Key:** X-nugios-timezone
970 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
946 946  
947 -Content-Type - application/json
948 -
949 -**Key - **X-nugios-timezone
950 -
951 -**Value **- 240
972 +Incorporating these headers with their respective values is essential for the successful processing of your API requests.
952 952  {{/error}}