Changes for page 1. SearchHotelPrices

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -402,22 +402,71 @@
402	402	{{/code}}
403	403
404	404
	405	+**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.
405	405
406		-== Important ==
	407	+**Initial Request:**
407	407
408		-{{error}}
409		-It's Important to in every other request header, put Auth token
	409	+* **Purpose**: The first request initiates the paging process and is designed to fetch the initial set of data without utilizing a pagingId.
	410	+* **Parameters**:
	411	+** pagingId: Should be set to an empty string ("") to indicate that this is the initial request.
	412	+** pageNumber: Indicates the specific page of data to retrieve, starting with 1.
	413	+** pageRowCount: Specifies the number of results to be included on each page.
410	410
411		-**Key **- Authorization
	415	+**Example - First Request**:
412	412
413		-**Value **- Bearer Token what is given in this response.
	417	+{{{{
	418	+ "pagingId": "",
	419	+  "pageNumber": 1,
	420	+  "pageRowCount": 10
	421	+}
	422	+}}}
414	414
415	415
416		-**also note in headers that:**
	425	+**Subsequent Requests with Caching:**
417	417
418		-Content-Type - application/json
	427	+* **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.
	428	+* **Cache Utilization**:
	429	+** Upon receiving a response, a pagingId value is provided. This pagingId should be used in subsequent requests to reference the cached data.
	430	+** To navigate through the dataset, adjust the pageNumber while keeping the pagingId constant.
	431	+** To refresh the dataset and clear the cache, initiate a new request without a pagingId.
419	419
420		-**Key - **X-nugios-timezone
	433	+**Example - Request with Caching**:
421	421
422		-**Value **- 240
	435	+{{{ {
	436	+ "pagingId": "80",
	437	+ "pageNumber": 2, // Adjusted to fetch the next page
	438	+ "pageRowCount": 10
	439	+ }
	440	+}}}
	441	+
	442	+
	443	+**Cache Management:**
	444	+
	445	+* 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.
	446	+
	447	+**Implementation Notes**:
	448	+
	449	+* The paging and caching mechanism significantly enhances data retrieval efficiency by minimizing server load and optimizing response times.
	450	+* Developers should ensure that the pagingId is correctly managed between requests to maintain session continuity and data consistency.
	451	+
	452	+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.
	453	+
	454	+
	455	+== Important ==
	456	+
	457	+{{error}}
	458	+=== Implementing Authorization in Subsequent Requests ===
	459	+
	460	+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:
	461	+
	462	+* **Header Key:** Authorization
	463	+* **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.
	464	+
	465	+Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
	466	+
	467	+* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
	468	+* **Header Key:** X-nugios-timezone
	469	+* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
	470	+
	471	+Incorporating these headers with their respective values is essential for the successful processing of your API requests.
423	423	{{/error}}