Property Search

Request Url: /apis/propertysearch?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&BrandID=1

• checkin Set the start date of the booking, this can be the earliest date they can travel

• checkout Set the end date of the booking, this can be the latest date they can travel to

• nights If 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

• flexiblenights You 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.

• Location As 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.

• PriceFilterType can 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

• Attributes First 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

• Sort Possible values: Sleeps, Bedrooms, Bathrooms, Price

• SortDirection Possible values: asc, desc. The default value is desc.

• IsBrokenRule Possible values: false, true, any.

• BrandID: Search for properties with this brand id.

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": 2,
  "Items": [
    {
      "Id": 9257,
      "Name": "Casa Vinatigo",
      "Title": "Casa Vinatigo",
      "Reference": "7",
      "Description": "Casa Vinatigo is the principal property on Amarilla Golf’s Championship course.Built in 1986 by one of the founding partners for himself and his family the house has an unrivalled and spectacular  position with commanding views over the course’s signature 110M Par 3... 5th hole.\r\n",
      "Location": "Amarilla Golf",
      "Image": "www.iprodemo.co.uk/media/356148/photo 1-10.JPG?id=9259\u0026scale=both\u0026mode=crop\u0026quality=70\u0026width=350\u0026height=250",
      "InActive": false,
      "Bathrooms": "2",
      "Bedrooms": "3",
      "Sleeps": "6",
      "Price": 1320,
      "PriceRange": "€1320",
      "PropertyType": "Villa",
      "Wifi": false,
      "PropertyWebsite": "",
      "Url": "/tenerife/amarilla-golf/casa-vinatigo/",
      "Commission": "10.00",
      "Owner": {
        "CompanyId": 1910,
        "CompanyName": "Sarah Duthoit",
        "ContactId": 1910,
        "Email": "andy.jones@ipro-software.com",
        "Phone": "",
        "Rep": 2075
      },
      "IsAvailable": true,
      "IsBrokenRule": false,
      "AvailabilityMessage": null,
      "RatesIncludeVat": false,
      "AverageRating": 10
    },
    {
      "Id": 8867,
      "Name": "Villa Tinali",
      "Title": "5 Bedroom Villa with Heated Pool and Jacuzzi Hot Tub",
      "Reference": "14",
      "Description": "Villa Tinali is conveniently situated, in a semi-rural location, in the town of Guaragacho. Local amenities, shops, restaurants, bars and supermarkets are all close to hand. Sleeping 11 adults, there are 5 Spacious Bedrooms, 3 bath/shower rooms and Private Heated Swimming Pool - (9mtrs x 5mtrs)",
      "Location": "Garagacho",
      "Image": "www.iprodemo.co.uk/media/349527/js57_IMG_1580.jpg?id=9094\u0026scale=both\u0026mode=crop\u0026quality=70\u0026width=350\u0026height=250",
      "InActive": true,
      "Bathrooms": "3",
      "Bedrooms": "5",
      "Sleeps": "13",
      "Price": 1400,
      "PriceRange": "£1400 - £800",
      "PropertyType": "Villa",
      "Wifi": false,
      "PropertyWebsite": "",
      "Url": "/tenerife/garagacho/villa-tinali/",
      "Commission": "10.00",
      "Owner": {
        "CompanyId": 1909,
        "CompanyName": "Safdar \u0026 Tina Ali",
        "ContactId": 1909,
        "Email": "andy.jones@ipro-software.com",
        "Phone": "",
        "Rep": 2075
      },
      "IsAvailable": true,
      "IsBrokenRule": false,
      "AvailabilityMessage": null,
      "RatesIncludeVat": false,
      "AverageRating": 10
    }
  ]
}