Changes for page 1. SearchTourPackages

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

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

Summary

Details

Page properties
Content
... ... @@ -6,32 +6,11 @@
6 6  
7 7  = Method Description =
8 8  
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.
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 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 -
35 35  == Endpoint URL - [POST] ==
36 36  
37 37  {{info}}
... ... @@ -781,7 +781,7 @@
781 781  
782 782  == Definitions ==
783 783  
784 -**Request Parameters **
763 +Request Parameters
785 785  
786 786  (% class="table-bordered" %)
787 787  |=Field|=Type|=Description
... ... @@ -816,9 +816,13 @@
816 816  |pageNumber|integer|The page number for paginated results.
817 817  |pageRowCount|integer|The number of rows per page for paginated results.
818 818  
798 +
819 819  (% class="wikigeneratedid" %)
820 -**Response Parameters**
800 +Response Parameters
821 821  
802 +
803 +
804 +
822 822  (% class="table-bordered" %)
823 823  |=Field|=Type|=Description
824 824  |packages|array|An array of packages available. Each package contains:
... ... @@ -888,7 +888,7 @@
888 888  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:
889 889  
890 890  
891 -==== First request ====
874 +==== first request ====
892 892  
893 893  {{code language="Json"}}
894 894   {
... ... @@ -898,12 +898,10 @@
898 898   }
899 899  {{/code}}
900 900  
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.
902 902  
903 -
904 904  ==== Request with caching ====
905 905  
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": "",
887 +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
907 907  
908 908  {{code language="Json"}}
909 909   {
... ... @@ -914,7 +914,7 @@
914 914  {{/code}}
915 915  
916 916  
917 -=== Search parameter options ===
898 +=== search parameter options ===
918 918  
919 919  in the request body it's available to filter search results with parameters. parameter examples:
920 920  
... ... @@ -956,18 +956,18 @@
956 956  == Important ==
957 957  
958 958  {{error}}
959 -=== Implementing Authorization in Subsequent Requests ===
940 +It's Important to in every other request header, put Auth token
960 960  
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:
942 +**Key **- Authorization
962 962  
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.
944 +**Value **- Bearer Token what is given in this response.
965 965  
966 -Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
967 967  
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.
947 +**also note in headers that:**
971 971  
972 -Incorporating these headers with their respective values is essential for the successful processing of your API requests.
949 +Content-Type - application/json
950 +
951 +**Key - **X-nugios-timezone
952 +
953 +**Value **- 240
973 973  {{/error}}