Skip to Content

Wiki source code of 4. Hotel Extras

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