Skip to Content
Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45
From version 15.1
edited by Giorgi Mdivnishvili
on 2024/04/11 18:01
Change comment: There is no comment for this version
To version 13.1
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,8 @@
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 +
782 782  === **Response Parameters** ===
783 783  
784 784  (% class="table-bordered" %)
... ... @@ -859,6 +859,8 @@
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  
864 +==== ====
865 +
862 862  ==== first request ====
863 863  
864 864  {{code language="Json"}}
... ... @@ -885,57 +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 -
917 -**Example - Request with Caching**:
918 -
919 -{{{ {
920 - "pagingId": "80",
921 - "pageNumber": 2, // Adjusted to fetch the next page
922 - "pageRowCount": 10
923 - }
924 -}}}
925 -
926 -
927 -**Cache Management:**
928 -
929 -* 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.
930 -
931 -**Implementation Notes**:
932 -
933 -* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
934 -* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
935 -
936 -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.
937 -
938 -
939 939  === search parameter options ===
940 940  
941 941  in the request body it's available to filter search results with parameters. parameter examples:
... ... @@ -974,6 +974,7 @@
974 974  {{/code}}
975 975  
976 976  
930 +
977 977  == Important ==
978 978  
979 979  {{error}}