Skip to Content

Changes for page 1. Hotels

Last modified by Giorgi Mdivnishvili on 2024/02/29 10:01
From version 6.1
edited by Giorgi Mdivnishvili
on 2024/02/26 16:09
Change comment: There is no comment for this version
To version 15.1
edited by Giorgi Mdivnishvili
on 2024/02/27 09:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,16 +1,36 @@
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  
33 +== Response Body ==
14 14  
15 15  {{code language="json"}}
16 16  {
... ... @@ -65,61 +65,32 @@
65 65   ]
66 66  }
67 67  
88 +
68 68  {{/code}}
69 69  
70 70  
71 71  
93 +== Definitions ==
72 72  
73 -**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 +(% class="info" %)|Parameter|Description
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.
74 74  
75 -**hotelname:**        string. Name of the hotel
76 -
77 -**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”.
78 -
79 -**cityid:**                GUID of the City where the hotel is located.
80 -
81 -**cityname:**          string. Name of the city
82 -
83 -**districtid:**          GUID of the district, where the hotel is located
84 -
85 -**districtname: ** string. Name of the district
86 -
87 -**hasalcohol:**        Boolean parameter. Describes whether hotel serves alcohol or not
88 -
89 -**hasfreewifi:**       Boolean parameter. Describes whether free wifi is available in the rooms
90 -
91 -**hasmall:**            Boolean parameter. Describes whether there is a shopping mall near the hotel
92 -
93 -**hasmetro:**          Boolean parameter. Describes whether there is a metro station near the hotel
94 -
95 -**haspool:**            Boolean parameter. Describes whether there is swimming pool in the hotel
96 -
97 -**hotelclass:**         string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
98 -
99 -**hoteltype:**          string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
100 -
101 -**popular:**            Boolean. Describes if the hotel was popular last 7 days
102 -
103 -**recommended:**   Boolean. True if the hotel is recommended by Rustar
104 -
105 -**priceupdated:**    DateTime of the last price update
106 -
107 -**note:**                  string. Free formed text
108 -
109 -**imageurl:**           string. Optional. Points the URL for the image of the hotel if any.
110 -
111 -
112 -
113 -|**Parameter**|**Description**
114 -|**DepartingDate**|Date of depart  format example [10.01.2024 ~| DD.MM.YY]
115 -|**ReturningDate**|Date of Return format example [17.01.2024 ~| DD.MM.YY]
116 -|**CheckInDate**|Date of Hotel Checkin [10.01.2024 ~| DD.MM.YY]
117 -|**CheckOutDate**|Date of Hotel Checkout [17.01.2024 ~| DD.MM.YY]
118 -|**Adults**|Number of adults
119 -|**Children**|Number of Children
120 -|**ChildrenAges**|age of children, if there is more then one, ages must be defined by comma example [4,5] if there is no children, this parameter is not needed
121 -|**DepartureCityCode**|CityCode of departure city- in this example, "5efe9cfb-a9a0-4f99-93f5-42716e4ccbb7", in this case this is Astana
122 -|**ArrivalCountryCode**|Country code of the arrival country - in this example is for Georgia - "GE"
123 -|**HotelCodes**|Hotel code of one, or several hotels- in this example - "4da03ca4-70c7-429d-944a-484b51e32eb1,5c27c701-cc81-4cc5-8042-2a2e908e70bc" - in case of several hotel codes they are separated with comma ","
124 -
125 125