Changes for page 4. Hotel Search

Summary

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

Details

Page properties

Content

...	...	@@ -15,7 +15,6 @@
15	15	Method POST
16	16
17	17
18		-
19	19	== **Request example:** ==
20	20
21	21	{{code language="Json"}}
...	...	@@ -41,22 +41,29 @@
41	41	{{/code}}
42	42
43	43
	43	+== Definition of Request Parameters ==
	44	+
44	44	(% class="table-bordered" %)
45		-(% class="info" %)|**Parameter**|**value**|**Description**
46		-|** "MaxResultCount"**|2,|
47		-|** "MaxHotelCount"**|2,|
48		-|** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|
49		-|** "countryMask"**| "TR",|
50		-|** "CheckInDate"**| "2024-05-06",|
51		-|** "CheckOutDate"**| "2024-05-07",|
52		-|** "Adults"**| 1,|
53		-|** "Children"**| 0,|
54		-|** "ChildrenAges"**| "",|
55		-|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|
	46	+(% class="info" %)|**Parameter**|**Value**|**Description**
	47	+|** "MaxResultCount"**|2,|Maximum number of results to display
	48	+|** "MaxHotelCount"**|2,|Maximum number of hotels to display results
	49	+|** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|A unique code assigned to each application user
	50	+|** "countryMask"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
	51	+|** "CheckInDate"**| "2024-05-06",|Check in date "YY-MM-DD"
	52	+|** "CheckOutDate"**| "2024-05-07",|Check out date "YY-MM-DD"
	53	+|** "Adults"**| 1,|number of Adults
	54	+|** "Children"**| 0,|Number of children
	55	+|** "ChildrenAges"**| "",|children ages, the must be separated with ","
	56	+|** "cityUID"**| "e1344ba0-5273-4fc1-b6c4-72446260f430"|Code of the city, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
56	56
57		-== Response Example ==
	58	+== ==
58	58
	60	+(% class="wikigeneratedid" %)
	61	+In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
59	59
	63	+
	64	+== Response Example ==
	65	+
60	60	{{code language="json"}}
61	61	{
62	62	"result": [
...	...	@@ -177,4 +177,64 @@
177	177	}
178	178	{{/code}}
179	179
180		-
	186	+
	187	+== Definition of Response Parameters ==
	188	+
	189	+(% class="table-bordered" %)
	190	+(% class="info" %)|**Parameter**|**value**|**Description**
	191	+|**{**| |
	192	+|** "resultID"**| 1656436810005000001,|Unique ID of the Result
	193	+|** "hotelID"**| 871186,|Unique ID of the hotel
	194	+|** "providerID"**| 5,|provider id - (system internal)
	195	+|** "roomCategoryCode"**| "ECO",|Special code for Room Category type
	196	+|** "roomCategoryName"**| "Economic Room",|Name of the Room Category Type - definition of the ** "roomCategoryCode"**
	197	+|** "mealPlanName"**| "BB",|Meal Plan code
	198	+|** "placementType"**| 1,|Placement type code - in this case  1 means  single
	199	+|** "placementTypeName"**| "1 Adult",|Placement type name - definition of the ** "placementType"**
	200	+|** "priceCode"**| "BASERATE BB ECO",|price code for the current option
	201	+|** "priceCurrency"**| "EUR",|
	202	+|** "priceCurrencySrc"**| "EUR",|
	203	+|** "availability"**| 3,|Availability
	204	+|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
	205	+|** "totalSellPriceSrc"**| 40.70,|
	206	+|** "totalSellPrice"**| 40.70,|
	207	+|** "totalPriceSurcharge"**| 0.00,|
	208	+|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
	209	+|** "cancellationPolicy"**| {|
	210	+|** "noShowChargeValue"**| 100.00,|
	211	+|** "noShowChargeValueType"**| "%",|
	212	+|** "earlyDepartureChargeValue"**| 100.00,|
	213	+|** "earlyDepartureChargeValueType"**| "%",|
	214	+|** "conditions"**| [|
	215	+|** {**| |
	216	+|** "timeunits"**| 365,|
	217	+|** "timeunitType"**| "Day",|
	218	+|** "timeOffsetTypeName"**| "Before Arrival",|
	219	+|** "chargeValue"**| 100.00,|
	220	+|** "chargeValueType"**| "%"|
	221	+|** }**| |
	222	+|** ]**| |
	223	+|** },**| |
	224	+|** "searchId"**| 1656436810,|search id of the hotel
	225	+|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
	226	+|** "id"**| 1656436810005000001,|
	227	+|** "hotel"**| {|
	228	+|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
	229	+|** "hotelName"**| "Istanbul Holiday Hotel",|Full name of the Hotel
	230	+|** "hotelClass"**| "~*~**",|Hotel Class in Stars
	231	+|** "cityId"**| "e1344ba0-5273-4fc1-b6c4-72446260f430",|Code of the city where  hotel is located, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
	232	+|** "cityName"**| "Istanbul",|Full Name of the City
	233	+|** "countryCode"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
	234	+|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|District unique code, where hotel is located.
	235	+|** "districtName"**| "Fatih",|Full name of the District
	236	+|** "note"**| ""|Hotel note - this is optional
	237	+|** },**| |
	238	+|** "adults"**| 1,|Number of the adults
	239	+|** "children"**| 0,|Number of the children
	240	+|** "childrenAges"**| "",|in case of children, here will be their ages
	241	+|** "childrenExeptInfants"**| 0,|
	242	+|** "checkInDate"**| "2024-05-06T00000",|date of the check in
	243	+|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
	244	+|** "includedExtrasAmount"**| 0,|
	245	+|** "extraServices"**| []|
	246	+|** },**| |