-
Notifications
You must be signed in to change notification settings - Fork 0
Property Search Events
**Request Url: /apis/searcheventlistings?size=15&index=1&checkIn=2021-09-21&checkout=2021-10-21&LocationID=&Adults=1&Children=&Nights=&flexiblenights&PriceFilterType=Nightly&NightlyPriceRange=10,600&WeeklyPriceRange=&Attributes=123,456&Sort=Bedrooms&SortDirection=asc&IsBrokenRule=false
-
checkinSet the start date of the booking, this can be the earliest date they can travel -
checkoutSet the end date of the booking, this can be the latest date they can travel to -
nightsIf you use the night filter, you can display properties that have x nights available between two dates i.e. 7 nights between the 1st and 31st August -
flexiblenightsYou can set here the variance between the start date you entered and the checkout date you entered. i.e 7 nights between the 1st and 8th August with 3 night flexibility will search from 29th July for 7 nights up to 4th August for 7 nights. -
LocationAs with Attributes, you will need to call apis/locations to get all location IDs. You can then submit the ID to filter to the location. -
PriceFilterTypecan be "Nightly" or "Weekly".
If it is Nightly, then NightlyPriceRange should be set. You would enter 0,150 this will provide a nightly range of 0 - 150 per night
If it is Weekly, then WeeklyPriceRange should be set. You would enter 0,550 this will provide a nightly range of 0 - 550 per week
-
AttributesFirst call this api: apis/amenities to get all the attributes and cache them in your system. For example, you see the json data in that page: https://github.com/ipro-software/api-csharp-client/wiki/Attributes, if you want to get the result with attributes: 4 double beds, 4th Floor, then you can pass the attributes parameter in the api.
The request url will be like /apis/propertysearch?size=15&index=1&checkIn=2015-09-21&checkout=2015-10-21&Adults=1&Children=&attributes=7052,1350
-
SortPossible values: Sleeps, Bedrooms, Bathrooms, Price -
SortDirectionPossible values: asc, desc. The default value is desc. -
IsBrokenRulePossible values: false, true, any.
False: return only those properties where the booking rules haven't been broken
True: Return only the properties where the booking rules have been broken
any: return all matching properties regardless of if the booking rules have been broken. The default value is any
Response:
{
"TotalHits": 3,
"Items": [
{
"Id": 42995,
"Name": "14082 - Mas du Verger",
"Title": "Beautiful 6-bedroom farmhouse with pool surrounded by apple orchards near L'Isle-sur-la-Sorgue",
"Reference": "14082",
"Description": "Recently converted 18th-century farmhouse with pool, surrounded by orchards, located in the countryside close to L'Isle sur la Sorgue.",
"Location": "L'Isle-sur-la-Sorgue",
"Image": "cdvillascom.iprostage.com/media/4665070/V1.jpg?id=43014&scale=both&mode=crop&quality=70&width=350&height=250",
"Price": 9380.80,
"PricingFrom": 0.0,
"PriceRange": "€5,200 - €9,350",
"IsAvailable": true,
"IsBrokenRule": false,
"AverageRating": 0.0,
"Attributes": {
"Theme": [
"Rural"
],
"Rental Type": [
"Holiday Rentals",
"French Connections"
],
"Property Type": [
"Villa"
],
"Swimming Pool": [
"Rectangular"
],
"Pool Sizes": [
"8m x 6m"
],
"Bedrooms": [
"6"
],
"Bathrooms": [
"6"
],
"Sleeps": [
"14"
],
"Facilities": [
"Internet",
"Central Heating",
"Fireplace",
"Microwave",
"Music System",
"Security Alarm",
"Gas BBQ",
"AC"
],
"Parking": [
"Secure",
"Off-Street",
"4+"
],
"Suitability": [
"Villas for Kids"
],
"Activities": [
"Cycling",
"Golf",
"Hiking",
"Mountain Biking",
"Tennis"
],
"Kitchen Facilities": [
"Cooker & Hob",
"Microwave",
"Dishwasher",
"Fridge / Freezer",
"Toaster & Kettle",
"Coffee Machine",
"Cooking Utensils & Cutlery"
],
"Property Status: Sale or Rental": [
"Rental"
],
"Included within your stay": [
"Linen & Towels",
"End of stay cleaning"
],
"Indoor space": [
"350"
],
"Outdoor space": [
"9000"
]
}
},
{
"Id": 81376,
"Name": "20032 - Manoir de la Sorgue",
"Title": "Magnificent 18th-century bastide with 7 bedrooms and large pool set within 15 hectares of private grounds near L'Isle-sur-la-Sorgue",
"Reference": "20032",
"Description": "This imposing 18th-century bastide set in extensive grounds was the first provencal home of Albert Camus ! Located close to L’Isle sur la Sorgue with alarge swimming pool, this property is an ideal setting for a large family or group of friends or as a venue for a wedding or a business event.",
"Location": "L'Isle-sur-la-Sorgue",
"Image": "cdvillascom.iprostage.com/media/7486460/manoirsorgue02.jpg?id=81038&scale=both&mode=crop&quality=70&width=350&height=250",
"Price": 17680.80,
"PricingFrom": 0.0,
"PriceRange": "€9,950 - €20,350",
"IsAvailable": true,
"IsBrokenRule": false,
"AverageRating": 10.0,
"Attributes": {
"Theme": [
"Rural"
],
"Rental Type": [
"Holiday Rentals",
"French Connections"
],
"Property Type": [
"Chateau"
],
"Swimming Pool": [
"Rectangular",
"Heated Pool"
],
"Pool Sizes": [
"18m x 8m"
],
"Bedrooms": [
"7"
],
"Bathrooms": [
"6"
],
"Sleeps": [
"14"
],
"Services Included": [
"Staff"
],
"Facilities": [
"Internet",
"Central Heating",
"Fireplace",
"Microwave",
"International TV Channels",
"Washing Machine",
"Clothes Dryer",
"Gas BBQ",
"AC"
],
"Parking": [
"Secure",
"4+"
],
"Suitability": [
"Villas for Kids",
"Corporate Events",
"Photo Shoots",
"Weddings",
"Villas for Large Groups",
"Birthdays and Anniversaries"
],
"Activities": [
"Cycling",
"Hiking"
],
"Kitchen Facilities": [
"Cooker & Hob",
"Microwave",
"Dishwasher",
"Fridge / Freezer",
"Iron & Ironing Board",
"Cooking Utensils & Cutlery",
"Ice Maker"
],
"Property Status: Sale or Rental": [
"Rental"
],
"Included within your stay": [
"Linen & Towels",
"End of stay cleaning"
],
"Standing Cocktail": [
"150"
],
"Banquet Seating": [
"100"
],
"Boardroom Seating": [
"50"
],
"Outside": [
"Pool",
"Terrace",
"Lawn"
],
"WCs": [
"3"
],
"Indoor space": [
"500"
],
"Outdoor space": [
"150000"
]
}
},
{
"Id": 15300,
"Name": "13821 - La Douceur de Vivre",
"Title": "Spacious 18th-century farmhouse turned into a luxury holiday home with 9 bedrooms, heated pool, home cinema and games room in the Provencal countryside",
"Reference": "13821",
"Description": "This recently renovated 18th-century farmhouse set in 6 hectares of parkland in the countryside some 3 km from L'Isle-sur-la-Sorgue offers a heated pool, boules court, children's playground, games room, home cinema, etc.",
"Location": "L'Isle-sur-la-Sorgue",
"Image": "cdvillascom.iprostage.com/media/1236974/ALADOUCEURDEVIVREVILLA1.jpg?id=21449&scale=both&mode=crop&quality=70&width=350&height=250",
"Price": 22130.80,
"PricingFrom": 0.0,
"PriceRange": "€11,120 - €22,100",
"IsAvailable": true,
"IsBrokenRule": false,
"AverageRating": 0.0,
"Attributes": {
"Theme": [
"Rural"
],
"Rental Type": [
"Holiday Rentals",
"Fully Serviced Villas"
],
"Property Type": [
"Villa"
],
"Swimming Pool": [
"Rectangular"
],
"Bedrooms": [
"9"
],
"Bathrooms": [
"9"
],
"Sleeps": [
"20"
],
"Facilities": [
"AC"
],
"Suitability": [
"Villas for Kids",
"Photo Shoots",
"Villas for Large Groups"
],
"Activities": [
"Cycling",
"Hiking"
],
"Kitchen Facilities": [
"Cooker & Hob",
"Microwave",
"Dishwasher",
"Fridge / Freezer",
"Toaster & Kettle",
"Coffee Machine",
"Cooking Utensils & Cutlery"
],
"Property Status: Sale or Rental": [
"Rental"
],
"Included within your stay": [
"Linen & Towels",
"End of stay cleaning"
],
"Indoor space": [
"700"
],
"Outdoor space": [
"60000"
]
}
}
]
}
- Get Started
- Settings
- Contacts
- Properties
- Properties
- Property Detail
- Property Images
- Property Extras
- Property Reference Lookup
- Property Rates
- Push Property Rates
- Property Custom Rates
- Property Availabilities
- Property Day Availabilities
- Property Rooms
- Property Distances
- Property All
- Property Search
- Property Search Lite
- Property Search Lite v2
- Property Enquiries
- Property Welcome Pack
- Push Property
- Properties Last Updated
- Property Day Availability Check
- Property Reviews
- Property Blockouts
- Property Detail Events
- Property Search Events
- Property Management
- Enquries
- Bookings
- Reviews
- Payments
- Offers & Deals
- Reports
- Communications