Skip to Content

Changes for page 4. Hotel Extras

Last modified by Giorgi Mdivnishvili on 2024/02/27 22:06
From version 3.1
edited by Giorgi Mdivnishvili
on 2024/02/26 16:25
Change comment: There is no comment for this version
To version 14.1
edited by Giorgi Mdivnishvili
on 2024/02/27 09:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -{{toc/}}
1 +== Endpoint ==
2 2  
3 3  **https:~/~/restapi.rustaronline.com/v1.01/api/hotelextras**
4 4  
... ... @@ -11,9 +11,10 @@
11 11  **https:~/~/restapi.rustaronline.com/v1.01/api/hotelextras?agentid=test.test&agentpassword=TestP@ssw0rd**
12 12  
13 13  
14 +== Request/Reponse ==
15 +
14 14  The method returns the list of gala dinners and other additional services mandatory or complimentary for stay at specific dates
15 15  
16 -
17 17  Return value example:
18 18  
19 19  {{code language="json"}}
... ... @@ -214,56 +214,32 @@
214 214  {{/code}}
215 215  
216 216  
218 +== Definitions ==
217 217  
218 -**hotelid:**                          GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
220 +(% class="info" %)|**Value**|**Description**
221 +|**hotelid**|GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
222 +|**hotelname**|string. Name of the hotel
223 +|**servicetype**|Object type of service/gala dinner
224 +|**roomcategorytype**|GUID of the Room category type. Unique by description of the room
225 +|**roomcategoryname**|string. The name of the room category
226 +|**extraservicetypeid**|GUID of the service type. Unique for GALA DINNER, CHRISTMAS DINNER etc
227 +|**extraservicetype**|Sstring. The name of the extra service type. E.g. GALA DINNER
228 +|**extraserviceid**|GUID of the extra service provided/requested by the hotel
229 +|**extraservice**|String. The name of the service/extra for the specific hotel. E.g. NEW YEAR GALA DINNER IN ATLANTIS
230 +|**servicedescriptionnote**|String. Optional description to be displayed to client. The description explains the conditions of the gala dinner in human readable format
231 +|**serviceconditionsnote**|String. Optional description of conditions of the service to be displayed to client. The conditions displayed are in human readable format
232 +|**ismandatory**|Boolean. 1 if this dinner/service is mandatory for the stay. 0 if using of this service/dinner is optional
233 +|**serviceprices**|Array of different options for gala dinners/extra services
234 +|** description**|Description of one of the option
235 +|** adult**|Price for the adult
236 +|** teen**|Price for the teenager (Age is specified in maxage property)
237 +|** child**|Price for the child (Age is specified in maxage property)
238 +|** infant**|Price for the infant (Age is specified in maxage property). If priceid is null, then infant is not allowed
239 +|**serviceconditions**|conditions to be met in order to request this dinner/service
240 +|** bookingstartdate**|If not null, then the booking should be done starting from this date
241 +|** bookingenddate**|If not null, then the booking should be done ending this date
242 +|** minimumstay**|If not null, then the booking duration should be at least the specified days
243 +|** stayperiodstart**|If not null, then the reservation (stay date) should be starting from specified date
244 +|** stayperiodend**|If not null, then the reservation (stay date) should end before specified date
219 219  
220 -**hotelname:**                    string. Name of the hotel
221 -
222 -**servicetype:                   **Object type of service/gala dinner
223 -
224 -**roomcategorytype:         **GUID of the Room category type. Unique by description of the room
225 -
226 -**roomcategoryname:       **string. The name of the room category
227 -
228 -**extraservicetypeid:        **GUID of the service type. Unique for GALA DINNER, CHRISTMAS DINNER etc
229 -
230 -**extraservicetype:           **string. The name of the extra service type. E.g. GALA DINNER
231 -
232 -**extraserviceid:**               GUID of the extra service provided/requested by the hotel
233 -
234 -**extraservice:                  **string. The name of the service/extra for the specific hotel. E.g. NEW YEAR GALA DINNER IN ATLANTIS
235 -
236 -**servicedescriptionnote: **string. Optional description to be displayed to client. The description explains the conditions of the gala dinner in human readable format
237 -
238 -**serviceconditionsnote:   **string. Optional description of conditions of the service to be displayed to client. The conditions displayed are in human readable format
239 -
240 -**ismandatory:**                 Boolean. 1 if this dinner/service is mandatory for the stay. 0 if using of this service/dinner is optional
241 -
242 -**serviceprices:**                Array of different options for gala dinners/extra services
243 -
244 -**~ description:**                 Description of one of the option
245 -
246 - **adult:**                           Price for the adult
247 -
248 - **teen:**                            Price for the teenager (Age is specified in maxage property)
249 -
250 - **child:**                           Price for the child (Age is specified in maxage property)
251 -
252 - **infant:**                          Price for the infant (Age is specified in maxage property). If priceid is null, then infant is not allowed
253 -
254 -**serviceconditions:**          conditions to be met in order to request this dinner/service
255 -
256 - **bookingstartdate:        **If not null, then the booking should be done starting from this date
257 -
258 - **bookingenddate:**          If not null, then the booking should be done ending this date
259 -
260 - **minimumstay:**              If not null, then the booking duration should be at least the specified days
261 -
262 - **stayperiodstart:**           If not null, then the reservation (stay date) should be starting from specified date
263 -
264 - **stayperiodend:**             If not null, then the reservation (stay date) should end before specified date
265 -
266 -
267 -
268 -
269 269