Returns list of PropertyDetails that match the search criteria.

Use this function to get a list of properties that are available to you. This will include properties listed under your own Ciirus account as well as any properties assigned to you by a supplier.

You can pass various filter options to the function. If you pass a date range, then only properties that are available for your specified dates will be returned. If you pass the start or end date as a NULL or Empty string, then all properties that match your other filter criteria will be returned regardless of availability.

All filter options are required for every request and each parameter value should be handeled individually. Though many use that same convention, please read the meaning of each value for each parameter carfully to ensure you can return intended properties correctly with each request.
Note: This function caches responses for 20 minute.

• APIUsername (String) *Required
• APIPassword (String) *Required
• ArriveDate (Date - dd MMM yyyy) *Required
• DepartDate (Date - dd MMM yyyy) *Required
• FilterOptions Class Object Parameters
  • ManagementCompanyID (Integer) *Required
    -Pass 0 for properties from all management companies. To retrieve only properties from a specific management company, enter their ID. Use the ‘GetManagementCompanyList’ function to get the list of available management companies and their ID.
  • CommunityID (Integer) *Required
    - This is currently for Central Florida Only. Pass 0 for all communities; otherwise, pass the ID of the community to filter. Use the ‘GetCommunities’ function to get the list of communities in which you have properties available.
  • PropertyID (Integer) *Required
    -Pass 0 for all properties or a specific ID to only receive details for 1 property.
  • PropertyType (Integer) *Required
    -Pass 0 for all types or a type ID for a specific type only. Use the ‘GetPropertyTypes’ function to get the list of available types.
  • HasPool (Integer) *Required
    -Pass 0 for properties without a pool, 1 for properties with a pool or any other integer for all properties.
  • HasSpa (Integer) *Required
    -Pass 0 for properties without a spa, 1 for properties with a spa or any other integer for all properties.
  • PrivacyFence (Integer) *Required
    -Pass 0 for properties without a privacy fence, 1 for properties with a privacy fence or any other integer for all properties.
  • CommunalGym (Integer) *Required
    -Pass 0 for properties without a communal gym, 1 for properties with a communal gym or any other integer for all properties.
  • HasGamesRoom (Integer) *Required
    -Pass 0 for properties without a games room, 1 for properties with a games room or any other integer for all properties.
  • IsGasFree (Boolean) *Required
    -Pass True to return only properties with no gas. Pass False for all properties.
  • Sleeps (Integer) *Required
    -Pass 0 for all properties, or >0 for properties that sleep at least the specified amount of guests.
  • Bedrooms (Integer) *Required
    -Pass 0 for all properties, or >0 for properties with the specified number of bedrooms.
  • PropertyClass (Integer) *Required
    -Pass 0 for all classes or a class ID for a specific class only. Use the ‘GetPropertyClasses’ function to get the list of available classes.
  • ConservationView (Integer) *Required
    -Pass 0 for properties without a conservation view, 1 for properties with a conservation view or any other integer for all properties.
  • WaterView (Integer) *Required
    -Pass 0 for properties without a water view, 1 for properties with a water view or any other integer for all properties.
  • LakeView (Integer) *Required
    -Pass 0 for properties without a lake view, 1 for properties with a lake view or any other integer for all properties.
  • WiFi (Integer) *Required
    -Pass 0 for properties without Wi-Fi, 1 for properties with Wi-Fi or any other integer for all properties.
  • PetsAllowed (Integer) *Required
    -Pass 0 for properties that do not allow pets, 1 for properties that do allow pets or any other integer for all properties.
  • OnGolfCourse (Integer) *Required
    -Pass 0 for properties not on a golf course, 1 for properties on a golf course or any other integer for all properties.
  • SouthFacingPool (Integer) *Required
    -Pass 0 for properties without a south facing pool, 1 for properties with a south facing pool or any other integer for all properties.
• SearchOptions Class Object Parameters
  • ReturnTopX (Integer) *Required
    -Pass 0 to return all results, or > 0 to return only that amount of results.
  • ReturnFullDetails (Boolean) *Required
    -Pass False to return fewer details in the search results. This will make the results download to you faster. Pass True to return all property details.
  • ReturnQuote (Boolean) *Required
    -Pass False if you do not need a quote returned for each property. Pass True to return a quote for the specified dates. ArriveDate and DepartDate must be entered if you wish to return a quote.
  • ReturnQuote (Boolean) *Required
    -Pass False if you do not need a quote returned for each property. Pass True to return a quote for the specified dates. ArriveDate and DepartDate must be entered if you wish to return a quote.
    Note: The time it takes for a query to run is significantly increased when you elect to return a quote. Do not select this option unless you specifically need to see the quoted price against each property.
  • IncludePoolHeatInQuote (Boolean) *Required
    -This option only applies if you also set ‘ReturnQuote’ to True. Setting this option to True includes the cost of pool heating in the calculated quote.
• xmlMsg (String) *Required
  -Pass blank string unless otherwise discussed with your CiiRUS technical point of contact. Below are optional "specialRequest" search options.

  <specialRequest>
  <UserID>11006</UserID>{If using this message, Required. Replace 11006 with your API user UserID - (refference GetManagementCompanyList fn(x))} 
  <BedroomsGreaterThanOrEqualTo>true</BedroomsGreaterThanOrEqualTo> (Optional) Filters results by Bedrooms >= the bedrooms input parameter. False by defualt (= only).
  <SleepsEqualTo>true</SleepsEqualTo> (Optional) Filters results by Sleeps = the sleeps input parameter. False by default (>=).
  </specialRequest>

  Note: Please pass your xmlMsg as a string (plaintext/no URL encoded values accepted)

• jSonMsg (String) *Required
  -Pass blank string unless otherwise discussed with your CiiRUS technical point of contact.

• GetProperties: Validation Error 1
• GetProperties: Error - DataSet not Populated
• GetProperties: No Properties were found for this set of parameters.
• GetProperties: Error - DataSet not Populated (AOA - BookingsInCat)
• GetProperties: Error - DataSet not Populated (AOA - NumRoomsInCat)
• GetProperties: Error - Invalid days in range (AOA)
• GetProperties: Error - running through days in range (AOA)
• GetProperties: Error - Unkown Error

If you are passing parameters correctly to this function, and are still not able to return properties, please check the function "GetPropertyPermissions", and/or contact the user and request they populate this data.