Common parameters, fields, language, searchfilter, removenullvalues, updatefrom - noi-techpark/odh-docs GitHub Wiki
Common parameters
Common parameters are available on the most endpoints of ODH Tourism
fields
Select the fields to be included in the output. More fields can be selected, simply comma separate it.
the Id field is always included.
It is possible to navigate trough Objects
Also to display n-th items of Arrays
Selecting items of Arrays is also possible.
examples for (https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?fields=):
Shortname
: Includes the field ShortnameDetail
: Includes the object DetailDetail,ImageGallery,Shortname
: Includes Object Detail, Array ImageGallery and Property ShortnameDetail.en.Title
: Include Title in English of Detail ObjectODHTags
: Include ODHTags ArrayODHTags.[0]
: Include ODHTags Array first ElementODHTags.[0].Id
: Include ODHTags Array first Elements IdODHTags.[*].Id
: Includes ODHTags Array Element Id, returning an array
language
Language Selector.
The language selector crops the json to show only the selected language in the json Response.
Passing only one language is supported.
langfilter
Language Filter.
Only Content available in the filtered Language is returned.
The langfilter filters the data by its HasLanguage
field.
searchfilter
Search trough title fields of the Dataset.
If no language is passed, search is done trough all available languages.
removenullvalues
Remove all Null
values from json output. Useful for reducing json size.
By default set to false, the whole object is shown.
updatefrom
Get Data which was updated after the passed date. Format yyyy-MM-dd