Fields documentation for SearchCriteria

NameTypeSummeryRemarks
AttributesAttributeBaseWeb[]The attributes and their desired values to include in the search.This property is optional. Since returning all attributes for all rental object search results would be too time consuming a spoecific (small) list of attributes can be provided for the search to return values for. IncludeAttributes.
CategoryCategoryWebThe lower-most rental object category to include in the search.This property is optional.
CategorySpecificIdNullable<Int32>Specifies an exact category to use instead of Category.
CountInt32The number of results returned starting from the offset position.This property is optional. The default value is 10.
CurrencyIsoCodeStringThe ISO 4217 currency code to perform the search in.This property is optional. However, if no currency code is given the consumers default currency is used.
CustomerReviewsCustomerReviewGradeWeb[]The elements in this list are used by the rental object search to find rental objects with an average grade score equal to or greater than the values provided. If No CustomerReviewCategory is provided for the elements in the list then the requested grade score is compared with the total average grade score on the rental object.This property is optional.
GeographyCriteriaGeographyCriteriaThe geographic search criteria.This property is optional.
GeometricWellKnownTextStringCoordinate to a point of interest to find houses nearby or within 1 or more coordinates forming a polygon. Format is WKT: See Wiki: http://en.wikipedia.org/wiki/Well-known_text Important notes regarding usage: 1. When parsing POLYGON structures ensure that start and end points are ALWAYS the same! 2. For POLYGON structures the preferable orientation of points are anticlockwise. 3. For all coordinate pairs make sure that the order is: long/lat and NOT lat/long! 4. When parsing a single POINT the resultset can be sorted by inserting a sorting expression in the list: Sorting. Use the enummeration value: RentalObjectSortOptionEnum.PointDistance. 5. When parsing a single POINT filter the resultset using PoiKmRadius to disregard rental objects outside the maximum distance. 6. If the coordinate structure is invalid the search ignores the geodetic search criteria. .This property is optional.
IncludeAttributesSystemInt32[]This list contains the IDs of attributes that should be included in the search result.This property is optional.
IncludeCatalogueTextBooleanInclude Catalogue text in this search.
IncludePriceCalculationDetailsBooleanInclude Price Calculation Details or not. Please remember including the details will costs some performance.
MaxPriceDoubleThe maximum price of a vacancy returned by the search.This property is optional.
MinDiscountDoubleThe minimum amount of discount that should be given of a vacancy returned by the search.This property is optional. This can be used tom filter only those houses that offer some sort of discount
MinPriceDoubleThe minimum price of a vacancy returned by the search.This property is optional.
OffsetInt32The offset of which the result set should start at.This property is optional. The default value is 1.
PoiKmRadiusDoubleMaximum distance allowed from a coordinate supplied in GeometricWellKnownText to the rental object.This property is optional.
ResultTypeSearchResultTypeWebEnumThe type of search result when searching for rental objects.
SingleSearchPhraseStringA search phrase expressed as a list of rental object numbers divided by comma to narrow the search to specific rental objects. Example: 62-3433,54-3456, etc..This property is optional.
SortingRentalObjectSortExpressionWeb[]A list of sorting expressions to be used for sorting purposes.This property is optional. If no sorting is provided the default sorting is used: 1. Cancellations first. 2. Rental objects that specifically matched the requested arrival date. 3. Randomly sorted.
TypesSystemInt32[]A list of rental object type ID's to include in the search.This property is optional.
VacancyOptionsVacancyOptionsWebVacancy options for the search criteria.This property is optional. However if no vacancy options are provided the search will perform a search for a 1 week tennancy D.D.
VacationTypesSystemInt32[]When one or more vacation type Id(s) are added to this list, the search result will only contain rental objects that have at least one of the requested vacation types. The following rules apply for the 3 different search types: 1) Specific search: The vacation type is available for one or more days within the searched booking period 2) Wide search: The vacation type is available for one or more days wihtin the specified search window 3) Periodless search: The vacation type is available for one or more days after the current date.