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 38.1
edited by Giorgi Mdivnishvili
on 2024/04/11 18:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -914,6 +914,58 @@
914 914  {{/code}}
915 915  
916 916  
917 +**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.
918 +
919 +**Initial Request:**
920 +
921 +* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
922 +* **Parameters**:
923 +** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
924 +** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
925 +** pageRowCount: Specifies the number of results to be included on each page.
926 +
927 +**Example - First Request**:
928 +
929 +{{{{
930 + "pagingId": "",
931 +  "pageNumber": 1,
932 +  "pageRowCount": 10
933 +}
934 +}}}
935 +
936 +
937 +**Subsequent Requests with Caching:**
938 +
939 +* **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.
940 +* **Cache Utilization**:
941 +** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
942 +** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
943 +** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
944 +
945 +
946 +**Example - Request with Caching**:
947 +
948 +{{{ {
949 + "pagingId": "80",
950 + "pageNumber": 2, // Adjusted to fetch the next page
951 + "pageRowCount": 10
952 + }
953 +}}}
954 +
955 +
956 +**Cache Management:**
957 +
958 +* 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.
959 +
960 +**Implementation Notes**:
961 +
962 +* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
963 +* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
964 +
965 +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.
966 +
967 +
968 +
917 917  === Search parameter options ===
918 918  
919 919  in the request body it's available to filter search results with parameters. parameter examples: