Skip to Content

Changes for page 1. Hotels

Last modified by Giorgi Mdivnishvili on 2024/02/29 10:01
From version 1.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:05
Change comment: There is no comment for this version
To version 12.1
edited by Giorgi Mdivnishvili
on 2024/02/26 17:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Hotels
1 +1. Hotels
Content
... ... @@ -1,157 +1,116 @@
1 -**https:~/~/restapi.rustaronline.com/v1.01/api/hotels**
1 +{{box cssClass="floatinginfobox" title="**Contents**"}}
2 +
2 2  
3 -Method: GET
4 +{{toc/}}
5 +{{/box}}
4 4  
7 += Method Description =
8 +
9 +The method returns the list of hotels with the statuses and timestamps of the prices
10 +
11 +
12 +== Endpoint URL - [Method - GET] ==
13 +
14 +{{info}}
15 +[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels>>https://restapi.rustaronline.com/v1.01/api/hotels]]
16 +{{/info}}
17 +
18 +
5 5  Parameters to pass: agentid and agentpassword
6 6  
7 -Sample URL: **https:~/~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd**
21 +== Request Parameters ==
8 8  
23 +(% class="box infomessage" %)
24 +(((
25 +|**Key**|**Value**|**Request URL**
26 +|agentid|test.test|[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd>>https://restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd]]
27 +|agentpassword|[[TestP@ssw0rd>>mailto:TestP@ssw0rd]]|[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd>>https://restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd]]
28 +)))
9 9  
10 -The method returns the list of hotels with the statuses and timestamps of the prices
11 11  
12 12  Return value example:
13 13  
14 -{
33 +== Response Body ==
15 15  
35 +{{code language="json"}}
36 +{
16 16   "Code": "00",
17 -
18 18   "Message": "",
19 -
20 20   "Timestamp": "2016-06-27T19:20:00.7512185+04:00",
21 -
22 22   "Version": “1.01”,
23 -
24 24   "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d",
25 -
26 26   "Data": [
27 -
28 28   {
29 -
30 30   "hotelid": "d6f9299f-5d94-4955-85e7-003e0383023c",
31 -
32 32   "hotelname": "Summer Land Motel - Sharjah",
33 -
34 34   "pricestatus": "ready",
35 -
36 36   "cityid": "f78ac3bc-f040-46d0-8319-2c52083080a6",
37 -
38 38   "cityname": "Sharjah",
39 -
40 40   "districtid": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b",
41 -
42 42   "districtname": "Sharjah",
43 -
44 44   "hasalcohol": false,
45 -
46 46   "hasfreewifi": true,
47 -
48 48   "hasmall": false,
49 -
50 50   "hasmetro": false,
51 -
52 52   "haspool": true,
53 -
54 - "hotelclass": "~*~**",
55 -
56 + "hotelclass": "***",
56 56   "hoteltype": "City",
57 -
58 58   "popular": false,
59 -
60 60   "recommended": false,
61 -
62 62   "priceupdated": "2016-04-24T11:12:09.66",
63 -
64 - "note": "Check-in time is 14:00 hrs, Check-out time is 12:00 hrs\r\n\r\n\r\nHotel guests can  access the pool and beach of Beach Hotel Sharjah hotel - AED 20.00 ($5.50) for 1 person a day.          \r\nHotel guests can access the pool and beach of Sharjah Carlton Hotel hotel - AED 20.00 ($5.50) for 1 person a day.          \r\nHotel guests can  access the pool and beach of Golden Beach Motel hotel - AED 15.00 ($4.10) for 1 person a day.          \r\nThe hotel provides a group transfer to Dubai (Naser Square).\r\n\r\n\r\n",
65 -
66 - "imageurl": "https:~/~/www.rustaronline.com/images/pages/hotels/thumbnail/F2EB7838-B479-4A81-BE9A-8113E06C70B5.jpg"
67 -
61 + "note": "Check-in time is 14:00 hrs, Check-out time is 12:00 hrs\r\n\r\n\r\nHotel guests can access the pool and beach of Beach Hotel Sharjah hotel - AED 20.00 ($5.50) for 1 person a day. \r\nHotel guests can access the pool and beach of Sharjah Carlton Hotel hotel - AED 20.00 ($5.50) for 1 person a day. \r\nHotel guests can access the pool and beach of Golden Beach Motel hotel - AED 15.00 ($4.10) for 1 person a day. \r\nThe hotel provides a group transfer to Dubai (Naser Square).\r\n\r\n\r\n",
62 + "imageurl": "https://www.rustaronline.com/images/pages/hotels/thumbnail/F2EB7838-B479-4A81-BE9A-8113E06C70B5.jpg"
68 68   },
69 -
70 70   {
71 -
72 72   "hotelid": "60d6bb96-a8ba-4c14-908e-7a9227c34bf3",
73 -
74 74   "hotelname": "Burj Al Arab",
75 -
76 76   "pricestatus": "ready",
77 -
78 78   "cityid": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
79 -
80 80   "cityname": "Dubai",
81 -
82 82   "districtid": "e6f59e6e-4747-4c14-9b6b-a709cce36c33",
83 -
84 84   "districtname": "Jumeirah",
85 -
86 86   "hasalcohol": true,
87 -
88 88   "hasfreewifi": true,
89 -
90 90   "hasmall": false,
91 -
92 92   "hasmetro": false,
93 -
94 94   "haspool": true,
95 -
96 - "hotelclass": "~*~*~*~**",
97 -
77 + "hotelclass": "*****",
98 98   "hoteltype": "Beach",
99 -
100 100   "popular": false,
101 -
102 102   "recommended": false,
103 -
104 104   "priceupdated": "2016-06-19T14:17:39.65",
105 -
106 106   "note": null,
107 -
108 108  "imageurl": ""
109 -
110 110   }
111 -
112 112   ]
113 -
114 114  }
115 115  
116 116  
89 +{{/code}}
117 117  
118 118  
119 -**hotelid:**              GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
92 +=== ===
120 120  
121 -**hotelname:**        string. Name of the hotel
94 +== Definitions ==
122 122  
123 -**pricestatus:**       string. "ready" or "pending". “ready” means that prices are ready to be downloaded. “pending” means that price registration is under processing and not all prices are available for the hotel. In case of “pending” the prices should be downloaded later when the status is changed to “ready”.
96 +|**hotelid**| GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
97 +|**hotelname**|String. Name of the hotel
98 +|**pricestatus**|String. "ready" or "pending". “ready” means that prices are ready to be downloaded. “pending” means that price registration is under processing and not all prices are available for the hotel. In case of “pending” the prices should be downloaded later when the status is changed to “ready”.
99 +|**cityid**|GUID of the City where the hotel is located.
100 +|**cityname**|String. Name of the city
101 +|**districtid**|GUID of the district, where the hotel is located
102 +|**districtname**|String. Name of the district
103 +|**hasalcohol**|Boolean parameter. Describes whether hotel serves alcohol or not
104 +|**hasfreewifi**|Boolean parameter. Describes whether free wifi is available in the rooms
105 +|**hasmall**|Boolean parameter. Describes whether there is a shopping mall near the hotel
106 +|**hasmetro**| Boolean parameter. Describes whether there is a metro station near the hotel
107 +|**haspool**| Boolean parameter. Describes whether there is swimming pool in the hotel
108 +|**hotelclass**|string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
109 +|**hoteltype**|string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
110 +|**popular**|Boolean. Describes if the hotel was popular last 7 days
111 +|**recommended**|Boolean. True if the hotel is recommended by Rustar
112 +|**priceupdated**|DateTime of the last price update
113 +|**note**|String. Free formed text
114 +|**imageurl**|String. Optional. Points the URL for the image of the hotel if any.
124 124  
125 -**cityid:**                GUID of the City where the hotel is located.
126 -
127 -**cityname:**          string. Name of the city
128 -
129 -**districtid:**          GUID of the district, where the hotel is located
130 -
131 -**districtname: ** string. Name of the district
132 -
133 -**hasalcohol:**        Boolean parameter. Describes whether hotel serves alcohol or not
134 -
135 -**hasfreewifi:**       Boolean parameter. Describes whether free wifi is available in the rooms
136 -
137 -**hasmall:**            Boolean parameter. Describes whether there is a shopping mall near the hotel
138 -
139 -**hasmetro:**          Boolean parameter. Describes whether there is a metro station near the hotel
140 -
141 -**haspool:**            Boolean parameter. Describes whether there is swimming pool in the hotel
142 -
143 -**hotelclass:**         string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
144 -
145 -**hoteltype:**          string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
146 -
147 -**popular:**            Boolean. Describes if the hotel was popular last 7 days
148 -
149 -**recommended:**   Boolean. True if the hotel is recommended by Rustar
150 -
151 -**priceupdated:**    DateTime of the last price update
152 -
153 -**note:**                  string. Free formed text
154 -
155 -**imageurl:**           string. Optional. Points the URL for the image of the hotel if any.
156 -
157 157