Wiki source code of 3. Room Availabilities
Last modified by Giorgi Mdivnishvili on 2024/02/27 22:04
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | **https:~/~/restapi.rustaronline.com/v1.01/api/roomavailabilities** | ||
2 | |||
3 | Method: GET | ||
4 | |||
5 | Parameters to pass: agentid, agentpassword and hotelid | ||
6 | |||
7 | Sample URL: | ||
8 | |||
9 | **https:~/~/restapi.rustaronline.com/v1.01/api/roomavailabilities?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=44EDF1C4-BFE0-4CA0-8091-014CF5C68A79** | ||
10 | |||
11 | |||
12 | The method returns the list of stop sales or other statuses by room categories and dates for specified hotelid | ||
13 | |||
14 | Return value example: | ||
15 | |||
16 | |||
17 | |||
18 | {{code language="json"}} | ||
19 | { | ||
20 | "Code": "00", | ||
21 | "Message": "", | ||
22 | "Timestamp": "2016-06-27T19:20:00.7512185+04:00", | ||
23 | "Version": “1.01”, | ||
24 | "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d", | ||
25 | "Data": [ | ||
26 | { | ||
27 | "hotelid": "44edf1c4-bfe0-4ca0-8091-014cf5c68a79", | ||
28 | "roomcategory": "3691e0db-b5e0-411f-b14d-aa46ba90e8f1", | ||
29 | "roomcategorytype": "8f3c7364-46fa-4226-8582-ec3c3d54cd7e", | ||
30 | "roomcategoryname": "Family Room ", | ||
31 | "startdate": "2016-07-06T00:00:00", | ||
32 | "enddate": "2016-10-31T00:00:00", | ||
33 | "note": null, | ||
34 | "availability": "REQUEST" | ||
35 | }, | ||
36 | { | ||
37 | "hotelid": "44edf1c4-bfe0-4ca0-8091-014cf5c68a79", | ||
38 | "roomcategory": "7bb7c883-b107-4223-9047-80686f6b3d52", | ||
39 | "roomcategoryname": "Classic Room", | ||
40 | "startdate": "2016-07-06T00:00:00", | ||
41 | "enddate": "2016-10-31T00:00:00", | ||
42 | "note": null, | ||
43 | "availability": "REQUEST" | ||
44 | } | ||
45 | ] | ||
46 | } | ||
47 | |||
48 | {{/code}} | ||
49 | |||
50 | |||
51 | |||
52 | (% class="table-bordered" %) | ||
53 | (% class="info" %)|**Value**|**Description** | ||
54 | |**hotelid**|GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel | ||
55 | |**roomcategory**|GUID of the Room category | ||
56 | |**roomcategorytype**|GUID of the Room category type. Unique by description of the room | ||
57 | |**roomcategoryname**|string. The name of the room category | ||
58 | |**startdate**|Date. Start date of the limit period | ||
59 | |**enddate**|Date. End date of the limit period | ||
60 | |**note**|string. Free formed text | ||
61 | |**pricestatus**|string. Values can be | ||
62 | |||
63 | (% class="box errormessage" %) | ||
64 | ((( | ||
65 | "STOP" – means STOP SALE. The room is not available for specified period | ||
66 | ))) | ||
67 | |||
68 | (% class="box errormessage" %) | ||
69 | ((( | ||
70 | "REQUEST" – means“ON REQUEST”. The availability must be checked for specified period. | ||
71 | ))) | ||
72 | |||
73 | (% class="box errormessage" %) | ||
74 | ((( | ||
75 | "FREE" – this status is optional. Means FREE SALE. | ||
76 | ))) |