Skip to Content
Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45
From version 19.1
edited by Giorgi Mdivnishvili
on 2024/04/16 16:37
Change comment: There is no comment for this version
To version 13.2
edited by Giorgi Mdivnishvili
on 2024/04/11 17:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -779,6 +779,7 @@
779 779  |pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
780 780  |searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
781 781  
782 +
782 782  === **Response Parameters** ===
783 783  
784 784  (% class="table-bordered" %)
... ... @@ -859,6 +859,7 @@
859 859  |totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
860 860  |error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
861 861  
863 +
862 862  ==== first request ====
863 863  
864 864  {{code language="Json"}}
... ... @@ -885,56 +885,6 @@
885 885  {{/code}}
886 886  
887 887  
888 -**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.
889 -
890 -**Initial Request:**
891 -
892 -* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
893 -* **Parameters**:
894 -** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
895 -** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
896 -** pageRowCount: Specifies the number of results to be included on each page.
897 -
898 -**Example - First Request**:
899 -
900 -{{{{
901 - "pagingId": "",
902 -  "pageNumber": 1,
903 -  "pageRowCount": 10
904 -}
905 -}}}
906 -
907 -
908 -**Subsequent Requests with Caching:**
909 -
910 -* **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.
911 -* **Cache Utilization**:
912 -** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
913 -** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
914 -** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
915 -
916 -**Example - Request with Caching**:
917 -
918 -{{{ {
919 - "pagingId": "80",
920 - "pageNumber": 2, // Adjusted to fetch the next page
921 - "pageRowCount": 10
922 - }
923 -}}}
924 -
925 -
926 -**Cache Management:**
927 -
928 -* 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.
929 -
930 -**Implementation Notes**:
931 -
932 -* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
933 -* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
934 -
935 -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.
936 -
937 -
938 938  === search parameter options ===
939 939  
940 940  in the request body it's available to filter search results with parameters. parameter examples:
... ... @@ -973,20 +973,7 @@
973 973  {{/code}}
974 974  
975 975  
976 -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.
977 -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.
978 -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.
979 -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.
980 -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.
981 -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.
982 -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.
983 -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.
984 -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.
985 -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.
986 986  
987 -
988 -
989 -
990 990  == Important ==
991 991  
992 992  {{error}}
... ... @@ -1005,14 +1005,3 @@
1005 1005  
1006 1006  Incorporating these headers with their respective values is essential for the successful processing of your API requests.
1007 1007  {{/error}}
1008 -
1009 -
1010 -
1011 -(% class="box errormessage" %)
1012 -(((
1013 -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:
1014 -
1015 -[[image:https://xwiki.nugios.com/xwiki/bin/download/APIs/Online%20API/TourPackages/WebHome/1713191255012-154.png?rev=1.1||alt="1713191255012-154.png"]]
1016 -
1017 -in the given example it means that insurance service is mandatory for the tourpackage.
1018 -)))