Skip to Content

Changes for page 4. Hotel Extras

Last modified by Giorgi Mdivnishvili on 2024/02/27 22:06
From version 1.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:18
Change comment: There is no comment for this version
To version 5.1
edited by Giorgi Mdivnishvili
on 2024/02/26 16:28
Change comment: There is no comment for this version

Summary

Details

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