Skip to Content

Wiki source code of 4. Hotel Extras

Version 3.1 by Giorgi Mdivnishvili on 2024/02/26 16:25
Show last authors
1 {{toc/}}
2
3 **https:~/~/restapi.rustaronline.com/v1.01/api/hotelextras**
4
5 Method: GET
6
7 Parameters to pass: agented and agentpassword
8
9 Sample URL:
10
11 **https:~/~/restapi.rustaronline.com/v1.01/api/hotelextras?agentid=test.test&agentpassword=TestP@ssw0rd**
12
13
14 The method returns the list of gala dinners and other additional services mandatory or complimentary for stay at specific dates
15
16
17 Return value example:
18
19 {{code language="json"}}
20 {
21 "Code": "00",
22 "Message": "",
23 "Timestamp": "2016-10-25T17:02:41.7264196+04:00",
24 "Version": “1.01”,
25 "ResponseID": "385fcbce-843e-47ec-b962-3ced37831c9d",
26 "Data": [
27 {
28 "hotelid": "d5f11cf4-acc1-4c0e-9736-e45697a22031",
29 "hotelname": "Acacia By Bin Majid Hotels & Resorts",
30 "servicetype": {
31 "extraservicetypeid": "88ec1f35-4077-451b-a71f-0630fcc7fdff",
32 "extraservicetype": "GALA DINNER"
33 },
34 "service": {
35 "extraserviceid": "f6ebfdad-8964-4e3a-bf70-dfd7d7195ea3",
36 "extraservice": "NEW YEAR 2016 - 2017 GALA DINNER",
37 "servicedescriptionnote": "Inclusive of all kinds of Alcoholic and non-alcoholic drinks with Live Music and Entertainment Program.",
38 "serviceconditionsnote": "Minimum stay of Five (5) nights.",
39 "ismandatory": 1,
40 "serviceprices": [
41 {
42 "description": "GALA DINNER (on AI Basis)",
43 "adult": {
44 "priceid": "04c173f6-5b05-423b-b85e-115850e95fc9",
45 "currency": "USD",
46 "price": 88.0000000000000000000
47 },
48 "teen": {
49 "priceid": "04c173f6-5b05-423b-b85e-115850e95fc9",
50 "maxage": 20.99,
51 "currency": "USD",
52 "price": 88.0000000000000000000
53 },
54 "child": {
55 "priceid": "fb933a2b-7c31-4809-9f4d-565abcf1c27f",
56 "maxage": 11.99,
57 "currency": "USD",
58 "price": 44.0000000000000000000
59 },
60 "infant": {
61 "priceid": "e5d695b2-e5f4-4c3e-a947-e98cbf52ba06",
62 "maxage": 3.99,
63 "currency": "USD",
64 "price": 0.0
65 }
66 },
67 {
68 "description": "GALA DINNER (on BB Basis)",
69 "adult": {
70 "priceid": "46daffc1-3838-451d-af08-25c42e03ad8d",
71 "currency": "USD",
72 "price": 144.0000000000000000000
73 },
74 "teen": {
75 "priceid": "46daffc1-3838-451d-af08-25c42e03ad8d",
76 "maxage": 20.99,
77 "currency": "USD",
78 "price": 144.0000000000000000000
79 },
80 "child": {
81 "priceid": "b5123684-4cf7-4216-bf29-a4574487be7d",
82 "maxage": 11.99,
83 "currency": "USD",
84 "price": 72.0000000000000000000
85 },
86 "infant": {
87 "priceid": "e5d695b2-e5f4-4c3e-a947-e98cbf52ba06",
88 "maxage": 3.99,
89 "currency": "USD",
90 "price": 0.0
91 }
92 },
93 {
94 "description": "GALA DINNER (on FB Basis)",
95 "adult": {
96 "priceid": "9f7ce6fe-71a2-4c59-b80b-7eead8ad665b",
97 "currency": "USD",
98 "price": 100.0000000000000000000
99 },
100 "teen": {
101 "priceid": "9f7ce6fe-71a2-4c59-b80b-7eead8ad665b",
102 "maxage": 20.99,
103 "currency": "USD",
104 "price": 100.0000000000000000000
105 },
106 "child": {
107 "priceid": "bba98523-40f2-47e0-b924-0a649606200a",
108 "maxage": 11.99,
109 "currency": "USD",
110 "price": 50.0000000000000000000
111 },
112 "infant": {
113 "priceid": "e5d695b2-e5f4-4c3e-a947-e98cbf52ba06",
114 "maxage": 3.99,
115 "currency": "USD",
116 "price": 0.0
117 }
118 },
119 {
120 "description": "GALA DINNER (on HB Basis)",
121 "adult": {
122 "priceid": "958430e8-f0de-41af-a5a4-fa33e76ae00b",
123 "currency": "USD",
124 "price": 116.0000000000000000000
125 },
126 "teen": {
127 "priceid": "958430e8-f0de-41af-a5a4-fa33e76ae00b",
128 "maxage": 20.99,
129 "currency": "USD",
130 "price": 116.0000000000000000000
131 },
132 "child": {
133 "priceid": "083165a3-28d6-410a-afbf-ddb1ce816a62",
134 "maxage": 11.99,
135 "currency": "USD",
136 "price": 58.0000000000000000000
137 },
138 "infant": {
139 "priceid": "e5d695b2-e5f4-4c3e-a947-e98cbf52ba06",
140 "maxage": 3.99,
141 "currency": "USD",
142 "price": 0.0
143 }
144 }
145 ],
146 "serviceconditions": [
147 {
148 "bookingstartdate": null,
149 "bookingenddate": null,
150 "bookbefore": null,
151 "minimumstay": 5,
152 "stayperiodstart": "2016-12-31T00:00:00",
153 "stayperiodend": "2017-01-01T00:00:00"
154 }
155 ]
156 }
157 },
158 {
159 "hotelid": "78b20d33-83a6-4913-9777-dafbf9520ff1",
160 "hotelname": "Ajman Beach Hotel",
161 "servicetype": {
162 "extraservicetypeid": "88ec1f35-4077-451b-a71f-0630fcc7fdff",
163 "extraservicetype": "GALA DINNER"
164 },
165 "service": {
166 "extraserviceid": "6f1633df-f800-408b-a215-5c79772bf025",
167 "extraservice": "NEW YEAR 2016 - 2017 GALA DINNER",
168 "servicedescriptionnote": null,
169 "serviceconditionsnote": null,
170 "ismandatory": 1,
171 "serviceprices": [
172 {
173 "description": "GALA DINNER",
174 "adult": {
175 "priceid": "bcbcc8a8-0254-4750-bb70-6feb973b3f45",
176 "currency": "USD",
177 "price": 116.0000000000000000000
178 },
179 "teen": {
180 "priceid": "bcbcc8a8-0254-4750-bb70-6feb973b3f45",
181 "maxage": 20.99,
182 "currency": "USD",
183 "price": 116.0000000000000000000
184 },
185 "child": {
186 "priceid": "f1f6f0d6-884c-4d39-8e19-3e621b9e5f35",
187 "maxage": 11.99,
188 "currency": "USD",
189 "price": 58.0000000000000000000
190 },
191 "infant": {
192 "priceid": "ff32ba32-1289-4189-89d0-569519627d34",
193 "maxage": 5.99,
194 "currency": "USD",
195 "price": 0.0
196 }
197 }
198 ],
199 "serviceconditions": [
200 {
201 "bookingstartdate": null,
202 "bookingenddate": null,
203 "bookbefore": null,
204 "minimumstay": null,
205 "stayperiodstart": "2016-12-31T00:00:00",
206 "stayperiodend": "2017-01-01T00:00:00"
207 }
208 ]
209 }
210 }
211 ]
212 }
213
214 {{/code}}
215
216
217
218 **hotelid:**                          GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
219
220 **hotelname:**                    string. Name of the hotel
221
222 **servicetype:                   **Object type of service/gala dinner
223
224 **roomcategorytype:         **GUID of the Room category type. Unique by description of the room
225
226 **roomcategoryname:       **string. The name of the room category
227
228 **extraservicetypeid:        **GUID of the service type. Unique for GALA DINNER, CHRISTMAS DINNER etc
229
230 **extraservicetype:           **string. The name of the extra service type. E.g. GALA DINNER
231
232 **extraserviceid:**               GUID of the extra service provided/requested by the hotel
233
234 **extraservice:                  **string. The name of the service/extra for the specific hotel. E.g. NEW YEAR GALA DINNER IN ATLANTIS
235
236 **servicedescriptionnote: **string. Optional description to be displayed to client. The description explains the conditions of the gala dinner in human readable format
237
238 **serviceconditionsnote:   **string. Optional description of conditions of the service to be displayed to client. The conditions displayed are in human readable format
239
240 **ismandatory:**                 Boolean. 1 if this dinner/service is mandatory for the stay. 0 if using of this service/dinner is optional
241
242 **serviceprices:**                Array of different options for gala dinners/extra services
243
244 **~ description:**                 Description of one of the option
245
246 **adult:**                           Price for the adult
247
248 **teen:**                            Price for the teenager (Age is specified in maxage property)
249
250 **child:**                           Price for the child (Age is specified in maxage property)
251
252 **infant:**                          Price for the infant (Age is specified in maxage property). If priceid is null, then infant is not allowed
253
254 **serviceconditions:**          conditions to be met in order to request this dinner/service
255
256 **bookingstartdate:        **If not null, then the booking should be done starting from this date
257
258 **bookingenddate:**          If not null, then the booking should be done ending this date
259
260 **minimumstay:**              If not null, then the booking duration should be at least the specified days
261
262 **stayperiodstart:**           If not null, then the reservation (stay date) should be starting from specified date
263
264 **stayperiodend:**             If not null, then the reservation (stay date) should end before specified date
265
266
267
268
269