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 9.1
edited by Giorgi Mdivnishvili
on 2024/02/26 17:36
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,168 @@
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  
5 -Parameters to pass: agentid and agentpassword
7 += Method Description =
6 6  
7 -Sample URL: **https:~/~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd**
9 +**GetDestinationCountries **method is used to get all destination countries list, which is provided by Nugios.
8 8  
9 9  
10 -The method returns the list of hotels with the statuses and timestamps of the prices
12 +== Endpoint URL - [GET] ==
11 11  
12 -Return value example:
14 +{{info}}
15 +[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries]]
16 +{{/info}}
13 13  
14 -{
15 15  
16 - "Code": "00",
19 +== Request Parameters ==
17 17  
18 - "Message": "",
21 +(% class="box infomessage" %)
22 +(((
23 +
19 19  
20 - "Timestamp": "2016-06-27T19:20:00.7512185+04:00",
25 +|**Key**|**Value**|**Request URL**
26 +|onlyHotels|True|[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=true>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=true]]
27 +|onlyHotels|False|[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=false>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=false]]
21 21  
22 - "Version": “1.01”,
29 +
30 +)))
23 23  
24 - "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d",
25 25  
26 - "Data": [
33 +{{{In the system, Destination countries are two types:
34 +1) Destinations where packages are available with flights,
35 +2) Destination Countries with only hotels.
36 +So using parameter false, or true there is option given, to determine type of destination country.}}}
27 27  
28 - {
29 29  
30 - "hotelid": "d6f9299f-5d94-4955-85e7-003e0383023c",
39 +== Request Body ==
31 31  
32 - "hotelname": "Summer Land Motel - Sharjah",
41 +{{code language="Json"}}
42 +none
43 +{{/code}}
33 33  
34 - "pricestatus": "ready",
35 35  
36 - "cityid": "f78ac3bc-f040-46d0-8319-2c52083080a6",
46 +== Response Body ==
37 37  
38 - "cityname": "Sharjah",
39 -
40 - "districtid": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b",
41 -
42 - "districtname": "Sharjah",
43 -
44 - "hasalcohol": false,
45 -
46 - "hasfreewifi": true,
47 -
48 - "hasmall": false,
49 -
50 - "hasmetro": false,
51 -
52 - "haspool": true,
53 -
54 - "hotelclass": "~*~**",
55 -
56 - "hoteltype": "City",
57 -
58 - "popular": false,
59 -
60 - "recommended": false,
61 -
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 -
68 - },
69 -
48 +{{code language="json"}}
49 +{
50 + "error": true,
51 + "errorCode": "string",
52 + "errorDescription": "string",
53 + "userErrorDescription": "string",
54 + "countries": [
70 70   {
71 -
72 - "hotelid": "60d6bb96-a8ba-4c14-908e-7a9227c34bf3",
73 -
74 - "hotelname": "Burj Al Arab",
75 -
76 - "pricestatus": "ready",
77 -
78 - "cityid": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
79 -
80 - "cityname": "Dubai",
81 -
82 - "districtid": "e6f59e6e-4747-4c14-9b6b-a709cce36c33",
83 -
84 - "districtname": "Jumeirah",
85 -
86 - "hasalcohol": true,
87 -
88 - "hasfreewifi": true,
89 -
90 - "hasmall": false,
91 -
92 - "hasmetro": false,
93 -
94 - "haspool": true,
95 -
96 - "hotelclass": "~*~*~*~**",
97 -
98 - "hoteltype": "Beach",
99 -
100 - "popular": false,
101 -
102 - "recommended": false,
103 -
104 - "priceupdated": "2016-06-19T14:17:39.65",
105 -
106 - "note": null,
107 -
108 -"imageurl": ""
109 -
56 + "countryCode": "string",
57 + "countryName": "string",
58 + "note": "string",
59 + "phoneCode": "string",
60 + "isO2": "string",
61 + "isO3": "string",
62 + "status": 0,
63 + "sortingOrder": 0,
64 + "sellCurrency": "string"
110 110   }
111 -
112 112   ]
113 -
114 114  }
68 +{{/code}}
115 115  
116 116  
71 +=== example ===
117 117  
73 +{{code language="Json"}}
74 + {
75 + "countryCode": "MV",
76 + "countryName": "Maldives",
77 + "phoneCode": "960",
78 + "isO2": "MV",
79 + "isO3": "MDV",
80 + "status": 1,
81 + "sortingOrder": 800,
82 + "sellCurrency": "USD"
83 + },
84 + {
85 + "countryCode": "GE",
86 + "countryName": "Georgia",
87 + "phoneCode": "995",
88 + "isO2": "GE",
89 + "isO3": "GEO",
90 + "status": 1,
91 + "sortingOrder": 900,
92 + "sellCurrency": "USD"
93 + }
94 +{{/code}}
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
120 120  
121 -**hotelname:**        string. Name of the hotel
97 +=== Schema ===
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”.
99 +(% data-xwiki-non-generated-content="java.util.List" %)
100 +(((
101 +{{success}}
102 +GetCountriesResponse{
124 124  
125 -**cityid:**                GUID of the City where the hotel is located.
104 +|error|boolean
105 +|errorCode|string
106 +nullable: true
107 +|errorDescription|string
108 +nullable: true
109 +|userErrorDescription|string
110 +nullable: true
111 +|countries|[
112 +nullable: trueCountry{(((
113 +|countryCode|string
114 +nullable: true
115 +readOnly: true
116 +|countryName|string
117 +nullable: true
118 +|note|string
119 +nullable: true
120 +|phoneCode|string
121 +nullable: true
122 +|isO2|string
123 +nullable: true
124 +|isO3|string
125 +nullable: true
126 +|status|integer($int32)
127 +|sortingOrder|integer($int32)
128 +|sellCurrency|string
129 +nullable: true
126 126  
127 -**cityname:**          string. Name of the city
131 +}]
132 +)))
128 128  
129 -**districtid:**          GUID of the district, where the hotel is located
134 +}
135 +{{/success}}
130 130  
131 -**districtname: ** string. Name of the district
137 +
138 +)))
132 132  
133 -**hasalcohol:**        Boolean parameter. Describes whether hotel serves alcohol or not
140 +== Definitions ==
134 134  
135 -**hasfreewifi:**       Boolean parameter. Describes whether free wifi is available in the rooms
142 +{{code language="none"}}
143 +countrycode: string. ISO2 Country code
144 +countryName : Name of the country
145 +isO2 : country name in iso2 standard
146 +isO3 : country name in iso3 standard
147 +sellCurrency : Sell Currency in given country
148 +{{/code}}
136 136  
137 -**hasmall:**            Boolean parameter. Describes whether there is a shopping mall near the hotel
138 138  
139 -**hasmetro:**          Boolean parameter. Describes whether there is a metro station near the hotel
151 +== Important ==
140 140  
141 -**haspool:**            Boolean parameter. Describes whether there is swimming pool in the hotel
153 +{{error}}
154 +It's Important to in every other request header, put Auth token
142 142  
143 -**hotelclass:**         string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
156 +**Key **- Authorization
144 144  
145 -**hoteltype:**          string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
158 +**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token)
146 146  
147 -**popular:**            Boolean. Describes if the hotel was popular last 7 days
148 148  
149 -**recommended:**   Boolean. True if the hotel is recommended by Rustar
161 +**also note in headers that:**
150 150  
151 -**priceupdated:**    DateTime of the last price update
163 +Content-Type - application/json
152 152  
153 -**note:**                  string. Free formed text
165 +**Key - **X-nugios-timezone
154 154  
155 -**imageurl:**           string. Optional. Points the URL for the image of the hotel if any.
156 -
157 -
167 +**Value **- 240
168 +{{/error}}