Changes for page 2. Hotel Prices
Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 3.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:11
on 2024/02/26 15:11
Change comment:
There is no comment for this version
To version 11.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:58
on 2024/02/27 11:58
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,18 +1,39 @@ 1 -**https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices** 1 +{{box cssClass="floatinginfobox" title="**Contents**"}} 2 + 2 2 3 -Method: GET 4 +{{toc/}} 5 +{{/box}} 4 4 7 += Method Description = 8 + 9 +>The method returns the object with three list of prices for specified hotel. ContractPrices, Promotions, PromotionsWithConditionsNote: Parameter removedublicates is optional, used for removing duplicate seasons from the list and split prices by seasons. False is default value of this parameter. 10 + 11 + 12 + 13 +== Endpoint URL - [Method - GET] == 14 + 15 +(% class="box infomessage" %) 16 +((( 17 +[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices>>https://restapi.rustaronline.com/v1.01/api/hotelprices]] 18 +))) 19 + 5 5 Parameters to pass: agentid, agentpassword, hotelid 6 6 7 7 Sample URL: 8 8 9 - **https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false**24 +== Request Parameters == 10 10 26 +(% class="box infomessage" %) 27 +((( 28 +(% class="table-bordered" %) 29 +|**Key**|**Value**|**Request URL** 30 +|agentid|test.test|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]** 31 +|agentpassword|[[TestP@ssw0rd>>mailto:TestP@ssw0rd]]|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]** 32 +|hotelid|d6f9299f-5d94-4955-85e7-003e0383023c|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]** 33 +|removedublicates|false| 34 +))) 11 11 12 -The method returns the object with three list of prices for specified hotel. ContractPrices, Promotions, PromotionsWithConditions 13 13 14 -Note: Parameter removedublicates is optional, used for removing duplicate seasons from the list and split prices by seasons. False is default value of this parameter. 15 - 16 16 Return value example: 17 17 18 18 ... ... @@ -231,83 +231,46 @@ 231 231 {{/code}} 232 232 233 233 255 +(% class="info" %)|**Value**|((( 256 +**Description** 257 +))) 258 +|**priceid**|GUID of the unique price id in the database of Rustar. This field together with placement creates unique combination of price for room/promotion/mealplan 259 +|**hotelid**|GUID of the hotel in the database of Rustar. 260 +|**roomcategory**|GUID of the Room category 261 +|**roomcategorytype**|GUID of the Room category type. Unique by description of the room 262 +|**roomcategoryname**|string. The name of the room category 263 +|**startdate**|Date. Start date of the price period 264 +|**enddate**|Date. End date of the price period 265 +|**mealplan**|CHAR(2). “RO”,"BB",”HB”,”FB”,”AL” 266 +|**adults**|Integer. Number of Aduts with beds 267 +|**teens**|Integer. Number of children (Teenagers) without extra bed 268 +|**children**|Integer. Number of children between infant and teen ages without extra bed 269 +|**infants**|Integer. Number of infants 270 +|**teenswithextrabeds**|Integer. Number of children (Teenagers) with extra bed 271 +|**childrenwithextrabeds**|Integer. Number of children between infant and teen ages with extra bed 272 +|**childpolicy**| { 273 +|**infantmaxage**|Decimal. Max age of the infant by the policy of the hotel 274 +|**childmaxage**|Decimal. Max age of the child by the policy of the hotel 275 +|**teenmaxage**|Decimal. Max age of the teenager by the policy of the hotel 276 +|**}**| 277 +|**placement**|string. Accomodation of all guests in following format e.g. 278 +|**SGL+1CHDEB(3-13,99)+1CHD(0-2,99)**| 279 +|**price**|Decimal. Price for the accommodation/placement 280 +|**currency**|CHAR(3). Currency of the price above 281 +|**promotioncode**|string. Optional. Promotion code if any of the specified price 282 +|**promotion**| { Promotion terms if any 283 +|**staydays**| Integer. Number of days to stay for stay/pay promotion (n nights free) 284 +|**paydays**| Integer. Number of days that will be charged in case of “staydays” stay 285 +|**discount**| Decimal. Discount % that was applied for this promotion 286 +|**cashback**| Decimal. Cashback in specified currency that was applied for this promotion 287 +|**}**| 288 +|**conditions"**| { Optional conditions for using this price 289 +|**bookingstartdate**| Date. When it is allowed to start the reservation for this promotion/accomodation 290 +|**bookingenddate**| Date. Date, after when the sale of this promotion should be stopped. 291 +|**bookbefore**| Integer. Number of days before checkin to use this promotion (Early Bird) 292 +|**minimumstay**| Integer. Minimal stay of nights to use this promotion 293 +|**maximumstay**| Integer. Maximal stay of nights to use this promotion 294 +|**}**| 295 +|**isactive**| Boolean. True if the price is active and can be used. False if the price is deactivated/inactive. 234 234 235 -**priceid:** GUID of the unique price id in the database of Rustar. This field together with placement creates unique combination of price for room/promotion/mealplan 236 - 237 -**hotelid:** GUID of the hotel in the database of Rustar. 238 - 239 -**roomcategory: **GUID of the Room category 240 - 241 -**roomcategorytype: **GUID of the Room category type. Unique by description of the room 242 - 243 -**roomcategoryname: **string. The name of the room category 244 - 245 -**startdate: **Date. Start date of the price period 246 - 247 -**enddate: **Date. End date of the price period 248 - 249 -**mealplan: **CHAR(2). “RO”,"BB",”HB”,”FB”,”AL” 250 - 251 -**adults: **Integer. Number of Aduts with beds 252 - 253 -**teens: **Integer. Number of children (Teenagers) **without** extra bed 254 - 255 -**children: **Integer. Number of children between infant and teen ages **without** extra bed 256 - 257 -**infants: **Integer. Number of infants 258 - 259 -**teenswithextrabeds: **Integer. Number of children (Teenagers) **with** extra bed 260 - 261 -**childrenwithextrabeds: **Integer. Number of children between infant and teen ages **with** extra bed 262 - 263 -**childpolicy: {** 264 - 265 -**infantmaxage: **Decimal. Max age of the infant by the policy of the hotel 266 - 267 -**childmaxage: **Decimal. Max age of the child by the policy of the hotel 268 - 269 -**teenmaxage: **Decimal. Max age of the teenager by the policy of the hotel 270 - 271 -**}** 272 - 273 -**placement: **string. Accomodation of all guests in following format e.g. 274 - 275 -**"SGL+1CHDEB(3-13,99)+1CHD(0-2,99)"** 276 - 277 -**price: **Decimal. Price for the accommodation/placement 278 - 279 -**currency: **CHAR(3). Currency of the price above 280 - 281 -**promotioncode: **string. Optional. Promotion code if any of the specified price 282 - 283 -**promotion: { **Promotion terms if any 284 - 285 -**staydays: **Integer. Number of days to stay for stay/pay promotion (n nights free) 286 - 287 -**paydays: **Integer. Number of days that will be charged in case of “staydays” stay 288 - 289 -**discount: **Decimal. Discount % that was applied for this promotion 290 - 291 -**cashback: **Decimal. Cashback in specified currency that was applied for this promotion 292 - 293 -**}** 294 - 295 - 296 -**conditions": { **Optional conditions for using this price 297 - 298 -**bookingstartdate: **Date. When it is allowed to start the reservation for this promotion/accomodation 299 - 300 -**bookingenddate: **Date. Date, after when the sale of this promotion should be stopped. 301 - 302 -**bookbefore: **Integer. Number of days before checkin to use this promotion (Early Bird) 303 - 304 -**minimumstay: **Integer. Minimal stay of nights to use this promotion 305 - 306 -**maximumstay: **Integer. Maximal stay of nights to use this promotion 307 - 308 -**}** 309 - 310 -**isactive: **Boolean. True if the price is active and can be used. False if the price is deactivated/inactive. 311 - 312 - 313 313 Please be noted, that the prices are already calculated with all possible discounts.