Skip to Content

Wiki source code of 4. Hotel Extras

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