Changes for page 2. Hotel Prices
Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 15.1
edited by Giorgi Mdivnishvili
on 2024/02/27 12:01
on 2024/02/27 12:01
Change comment:
There is no comment for this version
To version 2.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:10
on 2024/02/26 15:10
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -2. 1 +2.Hotel Prices - Content
-
... ... @@ -1,41 +1,21 @@ 1 -{{box cssClass="floatinginfobox" title="**Contents**"}} 2 - 1 +**https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices** 3 3 4 -{{toc/}} 5 -{{/box}} 3 +Method: GET 6 6 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 - 20 20 Parameters to pass: agentid, agentpassword, hotelid 21 21 22 22 Sample URL: 23 23 24 - == RequestParameters9 +**https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false** 25 25 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|[[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|[[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]] 34 -))) 35 35 12 +The method returns the object with three list of prices for specified hotel. ContractPrices, Promotions, PromotionsWithConditions 36 36 37 - ==Returnvalue example:==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. 38 38 16 +Return value example: 17 + 18 + 39 39 {{code language="json"}} 40 40 { 41 41 "Code": "00", ... ... @@ -251,52 +251,83 @@ 251 251 {{/code}} 252 252 253 253 254 -== Definitions == 255 255 256 -(% class="table-bordered" %) 257 -(% class="info" %)|**Value**|((( 258 -**Description** 259 -))) 260 -|**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 261 -|**hotelid**|GUID of the hotel in the database of Rustar. 262 -|**roomcategory**|GUID of the Room category 263 -|**roomcategorytype**|GUID of the Room category type. Unique by description of the room 264 -|**roomcategoryname**|string. The name of the room category 265 -|**startdate**|Date. Start date of the price period 266 -|**enddate**|Date. End date of the price period 267 -|**mealplan**|CHAR(2). “RO”,"BB",”HB”,”FB”,”AL” 268 -|**adults**|Integer. Number of Aduts with beds 269 -|**teens**|Integer. Number of children (Teenagers) without extra bed 270 -|**children**|Integer. Number of children between infant and teen ages without extra bed 271 -|**infants**|Integer. Number of infants 272 -|**teenswithextrabeds**|Integer. Number of children (Teenagers) with extra bed 273 -|**childrenwithextrabeds**|Integer. Number of children between infant and teen ages with extra bed 274 -|**childpolicy**| { 275 -|**infantmaxage**|Decimal. Max age of the infant by the policy of the hotel 276 -|**childmaxage**|Decimal. Max age of the child by the policy of the hotel 277 -|**teenmaxage**|Decimal. Max age of the teenager by the policy of the hotel 278 -|**}**| 279 -|**placement**|string. Accomodation of all guests in following format e.g. 280 -|**SGL+1CHDEB(3-13,99)+1CHD(0-2,99)**| 281 -|**price**|Decimal. Price for the accommodation/placement 282 -|**currency**|CHAR(3). Currency of the price above 283 -|**promotioncode**|string. Optional. Promotion code if any of the specified price 284 -|**promotion**| { Promotion terms if any 285 -|**staydays**| Integer. Number of days to stay for stay/pay promotion (n nights free) 286 -|**paydays**| Integer. Number of days that will be charged in case of “staydays” stay 287 -|**discount**| Decimal. Discount % that was applied for this promotion 288 -|**cashback**| Decimal. Cashback in specified currency that was applied for this promotion 289 -|**}**| 290 -|**conditions"**| { Optional conditions for using this price 291 -|**bookingstartdate**| Date. When it is allowed to start the reservation for this promotion/accomodation 292 -|**bookingenddate**| Date. Date, after when the sale of this promotion should be stopped. 293 -|**bookbefore**| Integer. Number of days before checkin to use this promotion (Early Bird) 294 -|**minimumstay**| Integer. Minimal stay of nights to use this promotion 295 -|**maximumstay**| Integer. Maximal stay of nights to use this promotion 296 -|**}**| 297 -|**isactive**| Boolean. True if the price is active and can be used. False if the price is deactivated/inactive. 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 298 298 299 -(% class="box errormessage" %) 300 -((( 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 + 301 301 Please be noted, that the prices are already calculated with all possible discounts. 302 -)))