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