Skip to Content

Changes for page 2. Hotel Prices

Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 3.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:11
Change comment: There is no comment for this version
To version 12.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:59
Change comment: There is no comment for this version

Summary

Details

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