Skip to content

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 in the response
scoringTags string[] List of tags which will be used for scoring (Beta) of results in the response

Custom filter properties

Parameter Type Description
datasource string[] Optional. Determines one or many datasources used to filter data
project string[] Optional. Determines one or many projects used to filter data
category string[] Optional. Determines one or many categories used to filter data
campaignTag string[] Optional. Determines one or many campaign tag by which data will be filtered
profileTag string[] Optional. Determines one or many profile tag by which data will be filtered

Facets filter properies

For filtering by facets it is necessary to use porerty filterPropertyName from Search facet response as a request property name. These filter properties are optional.

List of available facets filters

facet name filter property name filter value type description
address/addressLocality addressLocality string[]
address/postalCode addressPostalCode string[]
tag tag string[]
categoryTree categoryTree string[] 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 string[]
time time int[]
state state string[]
rating/condition ratingСondition int[]
rating/difficulty ratingDifficulty int[]
elevation/ascent elevationAscent int[]
elevation/descent elevationDescent int[]
elevation/minAltitude elevationMinAltitude int[]
elevation/maxAltitude elevationMaxAltitude int[]
season season string[]
type type string[]
combinedType combinedType string[] represent array containing data from parentType and parentAdditionalType properties
combinedTypeTree combinedTypeTree string[] represent array containing tree data from parentType and parentAdditionalType properties
leafType leafType string[] contains additionalType or type

Localization

Default value

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: February 10, 2021 11:25:01