Skip to Content

Changes for page 2. Hotel Prices

Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 8.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:55
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,18 @@
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 -
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 -
14 14  Parameters to pass: agentid, agentpassword, hotelid
15 15  
16 16  Sample URL:
17 17  
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 -== Request Parameters ==
20 20  
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 -)))
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.
30 30  
31 31  Return value example:
32 32  
... ... @@ -246,46 +246,83 @@
246 246  {{/code}}
247 247  
248 248  
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.
290 290  
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 +
291 291  Please be noted, that the prices are already calculated with all possible discounts.