Skip to Content

Changes for page 4. Hotel Search

Last modified by Giorgi Mdivnishvili on 2024/09/04 09:58
From version 21.1
edited by Giorgi Mdivnishvili
on 2024/02/29 11:18
Change comment: There is no comment for this version
To version 25.1
edited by Giorgi Mdivnishvili
on 2024/09/04 09:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -40,6 +40,8 @@
40 40  {{/code}}
41 41  
42 42  
43 +== Definition of Request Parameters ==
44 +
43 43  (% class="table-bordered" %)
44 44  (% class="info" %)|**Parameter**|**Value**|**Description**
45 45  |** "MaxResultCount"**|2,|Maximum number of results to display
... ... @@ -53,7 +53,6 @@
53 53  |** "ChildrenAges"**| "",|children ages, the must be separated with ","
54 54  |** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
55 55  
56 -== ==
57 57  
58 58  (% class="wikigeneratedid" %)
59 59  In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
... ... @@ -61,7 +61,6 @@
61 61  
62 62  == Response Example ==
63 63  
64 -
65 65  {{code language="json"}}
66 66  {
67 67   "result": [
... ... @@ -183,7 +183,10 @@
183 183  {{/code}}
184 184  
185 185  
186 +== Definition of Response Parameters ==
186 186  
188 +
189 +
187 187  (% class="table-bordered" %)
188 188  (% class="info" %)|**Parameter**|**value**|**Description**
189 189  |**{**| |
... ... @@ -242,3 +242,41 @@
242 242  |** "includedExtrasAmount"**| 0,|
243 243  |** "extraServices"**| []|
244 244  |** },**| |
248 +
249 +
250 +
251 +== Availability Filters ==
252 +
253 +
254 +==== 1. **FreeSale Parameter** ====
255 +
256 +* (((
257 +**Description**: The FreeSale parameter controls whether the response should include only "FreeSale" offers or not.
258 +
259 +* **Case 1**:
260 +** When "FreeSale": true is passed, the response will return **only** hotels and offers that are available as "FreeSale".
261 +* **Case 2**:
262 +** When "FreeSale": false is passed, there is no restriction based on "FreeSale" status, and the system will return all offers.
263 +* **Default Behavior**:
264 +** If the FreeSale parameter is not passed, the system will treat it as false by default.
265 +)))
266 +
267 +==== 2. **OnRequest Parameter** ====
268 +
269 +* (((
270 +**Description**: The OnRequest parameter works in combination with the FreeSale parameter to filter the response based on availability status.
271 +
272 +* **Behavior**:
273 +** When "OnRequest": true is passed, the system will return offers that are either "OnRequest" or "FreeSale", depending on the value of the FreeSale parameter.
274 +)))
275 +
276 +==== 3. **Filter Configuration** ====
277 +
278 +* **Note**: Whether the specific API endpoint or instance applies these filters depends on the system configuration. The ability to return only FreeSale offers or a combination of OnRequest and FreeSale is determined by the setup of each instance or endpoint.
279 +
280 +==== 4. **Example Usage** ====
281 +
282 +* If "FreeSale": true is passed, the system returns only FreeSale offers.
283 +* If "FreeSale": false or the parameter is omitted, the system returns all offers, including both FreeSale and non-FreeSale offers.
284 +
285 +