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
Change comment: There is no comment for this version
To version 7.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:55
Change comment: There is no comment for this version

Summary

Details

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