Changes for page 1. Hotels

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,94 +1,168 @@
1		-**https:~/~/restapi.rustaronline.com/v1.01/api/hotels**
	1	+{{box cssClass="floatinginfobox" title="**Contents**"}}
	2	+
2	2
3		-Method: GET
	4	+{{toc/}}
	5	+{{/box}}
4	4
5		-Parameters to pass: agentid and agentpassword
	7	+= Method Description =
6	6
7		-Sample URL: **https:~/~/restapi.rustaronline.com/v1.01/api/hotels?agentid=test.test&agentpassword=TestP@ssw0rd**
	9	+**GetDestinationCountries **method is used to get all destination countries list, which is provided by Nugios.
8	8
9	9
10		-The method returns the list of hotels with the statuses and timestamps of the prices
	12	+== Endpoint URL - [GET] ==
11	11
12		-Return value example:
	14	+{{info}}
	15	+[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries]]
	16	+{{/info}}
13	13
14	14
	19	+== Request Parameters ==
	20	+
	21	+(% class="box infomessage" %)
	22	+(((
	23	+
	24	+
	25	+|**Key**|**Value**|**Request URL**
	26	+|onlyHotels|True|[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=true>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=true]]
	27	+|onlyHotels|False|[[https:~~/~~/integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=false>>http://integration.kazunion.com/api/Catalogue/GetDestinationCountries?onlyHotels=false]]
	28	+
	29	+
	30	+)))
	31	+
	32	+
	33	+{{{In the system, Destination countries are two types:
	34	+1) Destinations where packages are available with flights,
	35	+2) Destination Countries with only hotels.
	36	+So using parameter false, or true there is option given, to determine type of destination country.}}}
	37	+
	38	+
	39	+== Request Body ==
	40	+
	41	+{{code language="Json"}}
	42	+none
	43	+{{/code}}
	44	+
	45	+
	46	+== Response Body ==
	47	+
15	15	{{code language="json"}}
16	16	{
17		- "Code": "00",
18		- "Message": "",
19		- "Timestamp": "2016-06-27T19:20:00.7512185+04:00",
20		- "Version": “1.01”,
21		- "ResponseID": "b512a117-6745-493d-9fa4-828d79c0df1d",
22		- "Data": [
	50	+ "error": true,
	51	+ "errorCode": "string",
	52	+ "errorDescription": "string",
	53	+ "userErrorDescription": "string",
	54	+ "countries": [
23	23	{
24		- "hotelid": "d6f9299f-5d94-4955-85e7-003e0383023c",
25		- "hotelname": "Summer Land Motel - Sharjah",
26		- "pricestatus": "ready",
27		- "cityid": "f78ac3bc-f040-46d0-8319-2c52083080a6",
28		- "cityname": "Sharjah",
29		- "districtid": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b",
30		- "districtname": "Sharjah",
31		- "hasalcohol": false,
32		- "hasfreewifi": true,
33		- "hasmall": false,
34		- "hasmetro": false,
35		- "haspool": true,
36		- "hotelclass": "***",
37		- "hoteltype": "City",
38		- "popular": false,
39		- "recommended": false,
40		- "priceupdated": "2016-04-24T11:12:09.66",
41		- "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",
42		- "imageurl": "https://www.rustaronline.com/images/pages/hotels/thumbnail/F2EB7838-B479-4A81-BE9A-8113E06C70B5.jpg"
43		- },
44		- {
45		- "hotelid": "60d6bb96-a8ba-4c14-908e-7a9227c34bf3",
46		- "hotelname": "Burj Al Arab",
47		- "pricestatus": "ready",
48		- "cityid": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
49		- "cityname": "Dubai",
50		- "districtid": "e6f59e6e-4747-4c14-9b6b-a709cce36c33",
51		- "districtname": "Jumeirah",
52		- "hasalcohol": true,
53		- "hasfreewifi": true,
54		- "hasmall": false,
55		- "hasmetro": false,
56		- "haspool": true,
57		- "hotelclass": "*****",
58		- "hoteltype": "Beach",
59		- "popular": false,
60		- "recommended": false,
61		- "priceupdated": "2016-06-19T14:17:39.65",
62		- "note": null,
63		-"imageurl": ""
	56	+ "countryCode": "string",
	57	+ "countryName": "string",
	58	+ "note": "string",
	59	+ "phoneCode": "string",
	60	+ "isO2": "string",
	61	+ "isO3": "string",
	62	+ "status": 0,
	63	+ "sortingOrder": 0,
	64	+ "sellCurrency": "string"
64	64	}
65	65	]
66	66	}
	68	+{{/code}}
67	67
	70	+
	71	+=== example ===
	72	+
	73	+{{code language="Json"}}
	74	+ {
	75	+ "countryCode": "MV",
	76	+ "countryName": "Maldives",
	77	+ "phoneCode": "960",
	78	+ "isO2": "MV",
	79	+ "isO3": "MDV",
	80	+ "status": 1,
	81	+ "sortingOrder": 800,
	82	+ "sellCurrency": "USD"
	83	+ },
	84	+ {
	85	+ "countryCode": "GE",
	86	+ "countryName": "Georgia",
	87	+ "phoneCode": "995",
	88	+ "isO2": "GE",
	89	+ "isO3": "GEO",
	90	+ "status": 1,
	91	+ "sortingOrder": 900,
	92	+ "sellCurrency": "USD"
	93	+ }
68	68	{{/code}}
69	69
70	70
	97	+=== Schema ===
71	71
	99	+(% data-xwiki-non-generated-content="java.util.List" %)
	100	+(((
	101	+{{success}}
	102	+GetCountriesResponse{
72	72
73		-**~ GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel**
	104	+|error|boolean
	105	+|errorCode|string
	106	+nullable: true
	107	+|errorDescription|string
	108	+nullable: true
	109	+|userErrorDescription|string
	110	+nullable: true
	111	+|countries|[
	112	+nullable: trueCountry{(((
	113	+|countryCode|string
	114	+nullable: true
	115	+readOnly: true
	116	+|countryName|string
	117	+nullable: true
	118	+|note|string
	119	+nullable: true
	120	+|phoneCode|string
	121	+nullable: true
	122	+|isO2|string
	123	+nullable: true
	124	+|isO3|string
	125	+nullable: true
	126	+|status|integer($int32)
	127	+|sortingOrder|integer($int32)
	128	+|sellCurrency|string
	129	+nullable: true
74	74
	131	+}]
	132	+)))
75	75
76		-|**hotelid**|GUID of the hotel in the database of Rustar. This GUID will be used to retrieve additional information (like prices) about the hotel
77		-|**hotelname**| string. Name of the hotel
78		-|**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”.
79		-|**cityid**|GUID of the City where the hotel is located.
80		-|**cityname**|String. Name of the city
81		-|**districtid**|GUID of the district, where the hotel is located
82		-|**districtname**|String. Name of the district
83		-|**hasalcohol**|Boolean parameter. Describes whether hotel serves alcohol or not
84		-|**hasfreewifi**|Boolean parameter. Describes whether free wifi is available in the rooms
85		-|**hasmall**|Boolean parameter. Describes whether there is a shopping mall near the hotel
86		-|**hasmetro**|Boolean parameter. Describes whether there is a metro station near the hotel
87		-|**haspool**|Boolean parameter. Describes whether there is swimming pool in the hotel
88		-|**hotelclass**|String. “*”,”~*~*”,”~*~**”,”~*~*~*~*”,”~*~*~*~**” or ”Apartments”. Number of stars or Apartment hotel
89		-|**hoteltype**|String. "City" or “Beach”. Describes whether this hotel is located in the city or at the beach
90		-|**popular**|Boolean. Describes if the hotel was popular last 7 days
91		-|**recommended**|Boolean. True if the hotel is recommended by Rustar
92		-|**priceupdated**|DateTime of the last price update
93		-|**note**|String. Free formed text
94		-|**imageurl**|String. Optional. Points the URL for the image of the hotel if any.
	134	+}
	135	+{{/success}}
	136	+
	137	+
	138	+)))
	139	+
	140	+== Definitions ==
	141	+
	142	+{{code language="none"}}
	143	+countrycode: string. ISO2 Country code
	144	+countryName : Name of the country
	145	+isO2 : country name in iso2 standard
	146	+isO3 : country name in iso3 standard
	147	+sellCurrency : Sell Currency in given country
	148	+{{/code}}
	149	+
	150	+
	151	+== Important ==
	152	+
	153	+{{error}}
	154	+It's Important to in every other request header, put Auth token
	155	+
	156	+**Key **- Authorization
	157	+
	158	+**Value **- Bearer Token what is given in this response. (Authorization type Bearer Token)
	159	+
	160	+
	161	+**also note in headers that:**
	162	+
	163	+Content-Type - application/json
	164	+
	165	+**Key - **X-nugios-timezone
	166	+
	167	+**Value **- 240
	168	+{{/error}}