Changes for page 1. SearchHotelPrices

Summary

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

Details

Page properties

Content

...	...	@@ -6,9 +6,33 @@
6	6
7	7	= Method Description =
8	8
9		-This method is used to retrieve only hotel prices. It's possible to receive data as current dates, also in date ranges using parameter  "stayDays": 0,   "stayDaysTo": 0. the maximum difference between the days can be 7. Below you can see examples.
10	10
	10	+This method is specifically designed for the retrieval of hotel pricing information. It supports queries for both current date prices and for prices over a specified date range.
11	11
	12	+**Parameters:**
	13	+
	14	+* stayDays (integer): Indicates the starting point of the stay duration in days. A default value of 0 signifies immediate date pricing retrieval.
	15	+* stayDaysTo (integer): Specifies the endpoint of the stay duration in days. The initial value is set to 0, indicating the system will fetch prices for the immediate date by default.
	16	+
	17	+**Constraints:**
	18	+
	19	+* The difference between stayDays and stayDaysTo must not exceed 7 days. This limitation is imposed to optimize the query performance and ensure the relevance of the returned data.
	20	+
	21	+**Implementation:**
	22	+
	23	+1. **Query Initialization**: Begin by defining the stayDays and stayDaysTo parameters to frame your search criteria. These parameters enable the system to understand the desired duration for which the hotel pricing information is required.
	24	+1. **Data Retrieval**: Execute the method with the provided parameters. The system processes the input and queries the database for hotel prices that match the specified duration, taking into account the constraint on the maximum duration difference.
	25	+1. **Result Processing**: Upon successful retrieval, the system presents the hotel pricing data. This data is either for the current date (when both parameters are set to 0) or for the defined date range, adhering to the specified duration constraints.
	26	+
	27	+**Example Usage:** (Examples of API calls or function usage would typically be provided here, demonstrating how to correctly implement the method to retrieve hotel prices based on immediate dates or a specified date range.)
	28	+
	29	+**Notes:**
	30	+
	31	+* This method ensures efficient access to hotel pricing information, catering to both immediate and short-term planning needs by leveraging a simple, parameter-driven query mechanism.
	32	+
	33	+This documentation provides a detailed guide for developers on utilizing the hotel pricing retrieval method, emphasizing parameter usage, operational constraints, and the process flow for executing queries and handling results.
	34	+
	35	+
12	12	== Endpoint URL - [POST] ==
13	13
14	14	{{info}}
...	...	@@ -378,22 +378,71 @@
378	378	{{/code}}
379	379
380	380
	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.
381	381
382		-== Important ==
	407	+**Initial Request:**
383	383
384		-{{error}}
385		-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.
386	386
387		-**Key **- Authorization
	415	+**Example - First Request**:
388	388
389		-**Value **- Bearer Token what is given in this response.
	417	+{{{{
	418	+ "pagingId": "",
	419	+  "pageNumber": 1,
	420	+  "pageRowCount": 10
	421	+}
	422	+}}}
390	390
391	391
392		-**also note in headers that:**
	425	+**Subsequent Requests with Caching:**
393	393
394		-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.
395	395
396		-**Key - **X-nugios-timezone
	433	+**Example - Request with Caching**:
397	397
398		-**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.
399	399	{{/error}}