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