Skip to Content

Changes for page 4. Hotel Extras

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

Summary

Details

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