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