Changes for page 4. Hotel Extras

Last modified by Giorgi Mdivnishvili on 2024/02/27 22:06

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