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