Skip to Content
Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45
From version 14.1
edited by Giorgi Mdivnishvili
on 2024/04/11 17:40
Change comment: There is no comment for this version
To version 20.3
edited by Giorgi Mdivnishvili
on 2024/04/16 16:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -779,7 +779,6 @@
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 -
783 783  === **Response Parameters** ===
784 784  
785 785  (% class="table-bordered" %)
... ... @@ -786,7 +786,7 @@
786 786  |=Key|=Type|=Description
787 787  |packages|Array|An array of travel packages. Each package includes various details about the package.
788 788  |packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
789 -|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
788 +|packages[].priceCurrency|String|The currency in which the price is denoted. This could be •   KZT - ₸ •   USD - $ •   RUB - ₽ •   EUR - € •   UZS - ЛВ •   AZN - ₼.
790 790  |packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
791 791  |packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
792 792  |packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
... ... @@ -841,7 +841,7 @@
841 841  |packages[].flight.isTwoWay|Boolean|A boolean indicating if the flight is two-way. If true, it means that the flight includes both departure and return.
842 842  |packages[].flight.sameBaggageForAll|Boolean|A boolean indicating if the same baggage is for all. If true, it means that the same baggage allowance applies to all passengers.
843 843  |packages[].flight.totalBaggage|Boolean|A boolean indicating if total baggage is included. If true, it means that the total baggage allowance is included in the price.
844 -|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is blocked. If true, it means that the flight is currently blocked and cannot be booked.
843 +|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is block or not. If true, it means that the flight is currently block of flights
845 845  |packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
846 846  |packages[].flight.departureSegments|Array|An array containing details about the departure segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
847 847  |packages[].flight.returnSegments|Array|An array containing details about the return segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
... ... @@ -860,7 +860,6 @@
860 860  |totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
861 861  |error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
862 862  
863 -
864 864  ==== first request ====
865 865  
866 866  {{code language="Json"}}
... ... @@ -887,6 +887,56 @@
887 887  {{/code}}
888 888  
889 889  
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 +
890 890  === search parameter options ===
891 891  
892 892  in the request body it's available to filter search results with parameters. parameter examples:
... ... @@ -925,6 +925,18 @@
925 925  {{/code}}
926 926  
927 927  
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 +
987 +
928 928  == Important ==
929 929  
930 930  {{error}}
... ... @@ -943,3 +943,14 @@
943 943  
944 944  Incorporating these headers with their respective values is essential for the successful processing of your API requests.
945 945  {{/error}}
1006 +
1007 +
1008 +
1009 +(% class="box errormessage" %)
1010 +(((
1011 +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:
1012 +
1013 +[[image:https://xwiki.nugios.com/xwiki/bin/download/APIs/Online%20API/TourPackages/WebHome/1713191255012-154.png?rev=1.1||alt="1713191255012-154.png"]]
1014 +
1015 +in the given example it means that insurance service is mandatory for the tourpackage.
1016 +)))