Skip to Content

Wiki source code of 4. Hotel Extras

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