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