SearchCriteria Class |
Inheritance HierarchyNamespace: Tse.EasyBook.Server.DataContracts
Assembly: Tse.EasyBook.Server.DataContracts (in Tse.EasyBook.Server.DataContracts.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic class SearchCriteria : DataContractBase
The SearchCriteria type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchCriteria |
Properties| Name | Description | |
|---|---|---|
 | Attributes |
The attributes and their desired values to include in the search
|
| Category |
The lower-most rental object category to include in the search
|
| CategorySpecificId |
Specifies an exact category to use instead of Category.
|
| Count |
The number of results returned starting from the offset position.
|
| CurrencyIsoCode |
The ISO 4217 currency code to perform the search in.
|
| CustomerReviews |
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.
|
| GeographyCriteria |
The geographic search criteria
|
 | GeometricWellKnownText |
Coordinate 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. |
| IncludeAttributes |
This list contains the IDs of attributes that should be included in the search result.
|
| IncludeCatalogueText |
Include Catalogue text in this search
|
| IncludePriceCalculationDetails |
Include Price Calculation Details or not. Please remember including the details will costs some performance.
|
| MaxPrice |
The maximum price of a vacancy returned by the search
|
| MinDiscount |
The minimum amount of discount that should be given of a vacancy returned by the search
|
| MinPrice |
The minimum price of a vacancy returned by the search
|
| Offset |
The offset of which the result set should start at
|
| PoiKmRadius |
Maximum distance allowed from a coordinate supplied in to the rental object.
|
| ResultType |
The type of search result when searching for rental objects
|
| SingleSearchPhrase |
A 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..
|
| Sorting |
A list of sorting expressions to be used for sorting purposes
|
| Types |
A list of rental object type ID's to include in the search
|
| VacancyOptions |
Vacancy options for the search criteria
|
| VacationTypes |
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
|
See Also