Search request
Search request¶
Parameter | Type | Description |
---|---|---|
searchText | string | Optional. Search for contained string by the searchable fields |
searchFields | string | Optional. When name of fields are specified as a comma separated string (e.g. "name, description, address/name") then only the selected fields will be used for searching. |
select | string | Optional. When name of fields are specified as a comma separated string (e.g. "name, description, @id, address") then only the selected fields will be returned. |
filters | string[] | Optional. Odata strings for filters |
currentPage | int | Optional. By default equal 1. Determines how many results are in response |
resultsPerPage | int | Optional. By default equal 10. Determines how many results are in response |
orderBy | string | Optional. Determines name of field by which result will be ordered |
facets | FacetRequest[] | List of facets which will be iin the response |
Custom filter properies¶
Parameter | Type | Description |
---|---|---|
datasource | string[] | Optional. Determines one or many datasource by which data will be filtered |
project | string[] | Optional. Determines one or many datasource by which data will be filtered |
campaignTag | string[] | Optional. Determines one or many campaign tag by which data will be filtered |
Facets filter properies¶
For filtering by facets is necessary to use porerty filterPropertyName
from Search facet response as a request property name. These properties are optional and have string[] type.
List of available facets filters¶
facet name | filter property name | description |
---|---|---|
address/addressLocality | addressLocality | |
address/postalCode | addressPostalCode | |
tag/id | tag | |
categoryTree | category | represent category tree list. For getting full list of categories don't forget to set big enough value for count property in facet request |
containedInPlace/id | containedInPlace | |
time | time | |
state | state | |
rating/condition | ratingСondition | |
rating/difficulty | ratingDifficulty | |
elevation/ascent | elevationAscent | |
elevation/descent | elevationDescent | |
elevation/minAltitude | elevationMinAltitude | |
elevation/maxAltitude | elevationMaxAltitude | |
seasons | season | |
type | type | |
combinedType | combinedType | represent array containing data from parentType and additionalType propeties |
leafType | leafType | contains additionalType or type |
Localization¶
default: de-CH
Language: Based on the Accept-Language header localized properties are translated. Search language is based on this header as well (e.g. for de-CH it will search only in german translations if the translation is available for this porperty.
Last update: October 23, 2020 15:06:58