Changes for page 1. SearchHotelPrices

Last modified by Giorgi Mdivnishvili on 2024/11/06 10:47

From version 12.1
edited by Giorgi Mdivnishvili
on 2024/01/09 14:43
Change comment: There is no comment for this version
To version 14.1
edited by Giorgi Mdivnishvili
on 2024/04/11 17:55
Change comment: There is no comment for this version

Summary

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}}
... ... @@ -38,9 +38,9 @@
38 38   "tag": "string"
39 39   }
40 40   ],
41 - "checkInDate": "2023-12-14T08:09:42.770Z",
42 - "checkInDateTo": "2023-12-14T08:09:42.770Z",
43 - "checkOutDate": "2023-12-14T08:09:42.770Z",
65 + "checkInDate": "2023-12-14",
66 + "checkInDateTo": "2023-12-14",
67 + "checkOutDate": "2023-12-14",
44 44   "stayDays": 0,
45 45   "stayDaysTo": 0,
46 46   "adults": 0,
... ... @@ -82,8 +82,8 @@
82 82  {{code language="Json"}}
83 83  {
84 84   "countryCode": "AE",
85 - "checkInDate": "2024-02-15T08:00:00.000Z",
86 - "checkInDateTo": "2024-02-20T08:00:00.000Z",
109 + "checkInDate": "2024-02-15",
110 + "checkInDateTo": "2024-02-20",
87 87  
88 88   "stayDays": 4,
89 89   "stayDaysTo": 6,