Wiki source code of 1. Hotels
Version 13.1 by Giorgi Mdivnishvili on 2024/02/26 17:59
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | |||
| 3 | |||
| 4 | {{toc/}} | ||
| 5 | {{/box}} | ||
| 6 | |||
| 7 | = Method Description = | ||
| 8 | |||
| 9 | The method returns the list of hotels with the statuses and timestamps of the prices | ||
| 10 | |||
| 11 | |||
| 12 | == Endpoint URL - [Method - GET] == | ||
| 13 | |||
| 14 | {{info}} | ||
| 15 | [[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels>>https://restapi.rustaronline.com/v1.01/api/hotels]] | ||
| 16 | {{/info}} | ||
| 17 | |||
| 18 | |||
| 19 | Parameters to pass: agentid and agentpassword | ||
| 20 | |||
| 21 | == Request Parameters == | ||
| 22 | |||
| 23 | (% class="box infomessage" %) | ||
| 24 | ((( | ||
| 25 | |**Key**|**Value**|**Request URL** | ||
| 26 | |agentid|test.test|[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd>>https://restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd]] | ||
| 27 | |agentpassword|[[TestP@ssw0rd>>mailto:TestP@ssw0rd]]|[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd>>https://restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd]] | ||
| 28 | ))) | ||
| 29 | |||
| 30 | |||
| 31 | Return value example: | ||
| 32 | |||
| 33 | == Response Body == | ||
| 34 | |||
| 35 | {{code language="json"}} | ||
| 36 | { | ||
| 37 | "Code": "00", | ||
| 38 | "Message": "", | ||
| 39 | "Timestamp": "2016-06-27T19:20:00.7512185+04:00", | ||
| 40 | "Version": “1.01”, | ||
| 41 | "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d", | ||
| 42 | "Data": [ | ||
| 43 | { | ||
| 44 | "hotelid": "d6f9299f-5d94-4955-85e7-003e0383023c", | ||
| 45 | "hotelname": "Summer Land Motel - Sharjah", | ||
| 46 | "pricestatus": "ready", | ||
| 47 | "cityid": "f78ac3bc-f040-46d0-8319-2c52083080a6", | ||
| 48 | "cityname": "Sharjah", | ||
| 49 | "districtid": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b", | ||
| 50 | "districtname": "Sharjah", | ||
| 51 | "hasalcohol": false, | ||
| 52 | "hasfreewifi": true, | ||
| 53 | "hasmall": false, | ||
| 54 | "hasmetro": false, | ||
| 55 | "haspool": true, | ||
| 56 | "hotelclass": "***", | ||
| 57 | "hoteltype": "City", | ||
| 58 | "popular": false, | ||
| 59 | "recommended": false, | ||
| 60 | "priceupdated": "2016-04-24T11:12:09.66", | ||
| 61 | "note": "Check-in time is 14:00 hrs, Check-out time is 12:00 hrs\r\n\r\n\r\nHotel guests can access the pool and beach of Beach Hotel Sharjah hotel - AED 20.00 ($5.50) for 1 person a day. \r\nHotel guests can access the pool and beach of Sharjah Carlton Hotel hotel - AED 20.00 ($5.50) for 1 person a day. \r\nHotel guests can access the pool and beach of Golden Beach Motel hotel - AED 15.00 ($4.10) for 1 person a day. \r\nThe hotel provides a group transfer to Dubai (Naser Square).\r\n\r\n\r\n", | ||
| 62 | "imageurl": "https://www.rustaronline.com/images/pages/hotels/thumbnail/F2EB7838-B479-4A81-BE9A-8113E06C70B5.jpg" | ||
| 63 | }, | ||
| 64 | { | ||
| 65 | "hotelid": "60d6bb96-a8ba-4c14-908e-7a9227c34bf3", | ||
| 66 | "hotelname": "Burj Al Arab", | ||
| 67 | "pricestatus": "ready", | ||
| 68 | "cityid": "f5185fa3-3f56-44ed-bf6b-80386a33caa2", | ||
| 69 | "cityname": "Dubai", | ||
| 70 | "districtid": "e6f59e6e-4747-4c14-9b6b-a709cce36c33", | ||
| 71 | "districtname": "Jumeirah", | ||
| 72 | "hasalcohol": true, | ||
| 73 | "hasfreewifi": true, | ||
| 74 | "hasmall": false, | ||
| 75 | "hasmetro": false, | ||
| 76 | "haspool": true, | ||
| 77 | "hotelclass": "*****", | ||
| 78 | "hoteltype": "Beach", | ||
| 79 | "popular": false, | ||
| 80 | "recommended": false, | ||
| 81 | "priceupdated": "2016-06-19T14:17:39.65", | ||
| 82 | "note": null, | ||
| 83 | "imageurl": "" | ||
| 84 | } | ||
| 85 | ] | ||
| 86 | } | ||
| 87 | |||
| 88 | |||
| 89 | {{/code}} | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | == Definitions == | ||
| 94 | |||
| 95 | |**hotelid**| GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel | ||
| 96 | |**hotelname**|String. Name of the hotel | ||
| 97 | |**pricestatus**|String. "ready" or "pending". “ready” means that prices are ready to be downloaded. “pending” means that price registration is under processing and not all prices are available for the hotel. In case of “pending” the prices should be downloaded later when the status is changed to “ready”. | ||
| 98 | |**cityid**|GUID of the City where the hotel is located. | ||
| 99 | |**cityname**|String. Name of the city | ||
| 100 | |**districtid**|GUID of the district, where the hotel is located | ||
| 101 | |**districtname**|String. Name of the district | ||
| 102 | |**hasalcohol**|Boolean parameter. Describes whether hotel serves alcohol or not | ||
| 103 | |**hasfreewifi**|Boolean parameter. Describes whether free wifi is available in the rooms | ||
| 104 | |**hasmall**|Boolean parameter. Describes whether there is a shopping mall near the hotel | ||
| 105 | |**hasmetro**| Boolean parameter. Describes whether there is a metro station near the hotel | ||
| 106 | |**haspool**| Boolean parameter. Describes whether there is swimming pool in the hotel | ||
| 107 | |**hotelclass**|string. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel | ||
| 108 | |**hoteltype**|string. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach | ||
| 109 | |**popular**|Boolean. Describes if the hotel was popular last 7 days | ||
| 110 | |**recommended**|Boolean. True if the hotel is recommended by Rustar | ||
| 111 | |**priceupdated**|DateTime of the last price update | ||
| 112 | |**note**|String. Free formed text | ||
| 113 | |**imageurl**|String. Optional. Points the URL for the image of the hotel if any. | ||
| 114 | |||
| 115 |