Skip to Content

Changes for page 2. Hotel Prices

Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 10.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:57
Change comment: There is no comment for this version
To version 5.1
edited by Giorgi Mdivnishvili
on 2024/02/26 18:01
Change comment: There is no comment for this version

Summary

Details

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