Skip to Content

Changes for page 1. Hotels

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -1. Hotels
1 +Hotels
Content
... ... @@ -1,118 +1,157 @@
1 -{{box cssClass="floatinginfobox" title="**Contents**"}}
2 -
1 +**https:~/~/restapi.rustaronline.com/v1.01/api/hotels**
3 3  
4 -{{toc/}}
5 -{{/box}}
3 +Method: GET
6 6  
7 -= Method Description =
5 +Parameters to pass: agentid and agentpassword
8 8  
9 -**GetDestinationCountries **method is used to get all destination countries list, which is provided by Nugios.
7 +Sample URL: **https:~/~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd**
10 10  
11 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 -
19 -== Request Parameters ==
20 -
21 -(% class="box infomessage" %)
22 -(((
23 -|**Key**|**Value**|**Request URL**
24 -|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]]
25 -|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]]
26 -)))
27 -
28 -Parameters to pass: agentid and agentpassword
29 -
30 30  The method returns the list of hotels with the statuses and timestamps of the prices
31 31  
32 -
33 33  Return value example:
34 34  
35 -== Response Body ==
36 -
37 -{{code language="json"}}
38 38  {
15 +
39 39   "Code": "00",
17 +
40 40   "Message": "",
19 +
41 41   "Timestamp": "2016-06-27T19:20:00.7512185+04:00",
21 +
42 42   "Version": “1.01”,
23 +
43 43   "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d",
25 +
44 44   "Data": [
27 +
45 45   {
29 +
46 46   "hotelid": "d6f9299f-5d94-4955-85e7-003e0383023c",
31 +
47 47   "hotelname": "Summer Land Motel - Sharjah",
33 +
48 48   "pricestatus": "ready",
35 +
49 49   "cityid": "f78ac3bc-f040-46d0-8319-2c52083080a6",
37 +
50 50   "cityname": "Sharjah",
39 +
51 51   "districtid": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b",
41 +
52 52   "districtname": "Sharjah",
43 +
53 53   "hasalcohol": false,
45 +
54 54   "hasfreewifi": true,
47 +
55 55   "hasmall": false,
49 +
56 56   "hasmetro": false,
51 +
57 57   "haspool": true,
58 - "hotelclass": "***",
53 +
54 + "hotelclass": "~*~**",
55 +
59 59   "hoteltype": "City",
57 +
60 60   "popular": false,
59 +
61 61   "recommended": false,
61 +
62 62   "priceupdated": "2016-04-24T11:12:09.66",
63 - "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",
64 - "imageurl": "https://www.rustaronline.com/images/pages/hotels/thumbnail/F2EB7838-B479-4A81-BE9A-8113E06C70B5.jpg"
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 +
65 65   },
69 +
66 66   {
71 +
67 67   "hotelid": "60d6bb96-a8ba-4c14-908e-7a9227c34bf3",
73 +
68 68   "hotelname": "Burj Al Arab",
75 +
69 69   "pricestatus": "ready",
77 +
70 70   "cityid": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
79 +
71 71   "cityname": "Dubai",
81 +
72 72   "districtid": "e6f59e6e-4747-4c14-9b6b-a709cce36c33",
83 +
73 73   "districtname": "Jumeirah",
85 +
74 74   "hasalcohol": true,
87 +
75 75   "hasfreewifi": true,
89 +
76 76   "hasmall": false,
91 +
77 77   "hasmetro": false,
93 +
78 78   "haspool": true,
79 - "hotelclass": "*****",
95 +
96 + "hotelclass": "~*~*~*~**",
97 +
80 80   "hoteltype": "Beach",
99 +
81 81   "popular": false,
101 +
82 82   "recommended": false,
103 +
83 83   "priceupdated": "2016-06-19T14:17:39.65",
105 +
84 84   "note": null,
107 +
85 85  "imageurl": ""
109 +
86 86   }
111 +
87 87   ]
113 +
88 88  }
89 89  
90 90  
91 -{{/code}}
92 92  
93 93  
94 -=== ===
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
95 95  
96 -== Definitions ==
121 +**hotelname:**        string. Name of the hotel
97 97  
98 -|**hotelid**| GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
99 -|**hotelname**|String. Name of the hotel
100 -|**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”.
101 -|**cityid**|GUID of the City where the hotel is located.
102 -|**cityname**|String. Name of the city
103 -|**districtid**|GUID of the district, where the hotel is located
104 -|**districtname**|String. Name of the district
105 -|**hasalcohol**|Boolean parameter. Describes whether hotel serves alcohol or not
106 -|**hasfreewifi**|Boolean parameter. Describes whether free wifi is available in the rooms
107 -|**hasmall**|Boolean parameter. Describes whether there is a shopping mall near the hotel
108 -|**hasmetro**| Boolean parameter. Describes whether there is a metro station near the hotel
109 -|**haspool**| Boolean parameter. Describes whether there is swimming pool in the hotel
110 -|**hotelclass**|string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
111 -|**hoteltype**|string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
112 -|**popular**|Boolean. Describes if the hotel was popular last 7 days
113 -|**recommended**|Boolean. True if the hotel is recommended by Rustar
114 -|**priceupdated**|DateTime of the last price update
115 -|**note**|String. Free formed text
116 -|**imageurl**|String. Optional. Points the URL for the image of the hotel if any.
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”.
117 117  
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 +
118 118