Skip to content

ODHActivityPoi

RudiThoeni edited this page May 16, 2022 · 21 revisions

How to use the ODHActivityPoi Endpoint

ODHActivityPoi contains data from different data Providers (LTS, Siag, IDM, Suedtirol Wine, etc...).

The source is identified by the field

_Meta: {
    Id: "xxxxxxx",
    Source: "idm",
    ....
}

ODHActivityPoi - important infos about fields

Deprecated fields:
Type, SubType, PoiType deprecated, should not be used.
AdditionalPoiInfos.language.MainType, AdditionalPoiInfos.language.SubType AdditionalPoiInfos.language.PoiType deprecated should not be used
GpsInfo is deprecated use GpsPoints
Source is deprecated use _Meta.Source
AreaId is deprecated use AreaIds
SmgTags is deprecated use ODHTags
SmgActive is deprecated use PublishedOn

Instead of using the deprecated "Types" we strongly recommend to rely on the multiple categorization defined by Tagging:

ODHTags Categorization of the ODHActivityPoi
AdditionalPoiInfos.[language].Categories Categorization to show (some Tags are marked as Categories to display and this Tags will be present here in all languages)

Filtering

Bitmask Type Filters:
type
subtype
level3type

All type/subtype/level3type/(activitytype/poitype) Filter "under the hood" are filtering on the assigned Tags. This works because The ODHActivityPoiTypes/ActivityType/PoiType id/key and the ODHTag id are identical.
Every ODHActivityPoi can have multiple Tags association. The Bitmask is only helpful to shorten the Parameter and allows filtering by certain type combinations. The type/activitytype/poitype/subtype/level3type filter is here for compatibility reasons. All can be done also with the filters for odhtags. We strongly recommend to use the odhtagfilters.

Tagging Filters:
odhtagfilter Multiple Tag ids allowed, separated by "," OR conjunction
odhtagfilter_and Multiple Tag ids allowed, separated by "," AND conjunction

Can be used together.

ODHActivityPoi Bitmask Type Filters

type --> Filters by ODHActivityPoi main types. Find all available types on this list ODHActivityPoi Main Types and pass the bitmask

subtype --> Additional Filtering by subtype. Only available if filtering by ONE type is active. Find all available keys on this list by passing the maintype key.
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoiTypes?rawfilter=and(eq(Type,"SubType"),eq(Parent,"TYPEKEY"))

Example:
All SubTypes from Type: Wellness Entspannung ODHActivityPoi Subtype - Wellness Entspannung

level3type --> Additional Filtering by level 3 type. Only available if filtering by ONE type and ONE subtype is active. Find all available keys on this list by passing by passing the subtypekey.
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoiTypes?rawfilter=and(eq(Type,"PoiType"),eq(Parent,"SUBTYPEKEY"))

Example:
All Level 3 Types from Subtype Wandern ODHActivityPoi Level 3 Type - Wandern

Filtering Examples:

Using type / subtype / level3type filters

I want to filter on all ODHActivityPois of Type "Winter"
Using the ODHActivityPoiTypes Main Types Bitmask:
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?type=2

I want to filter on all ODHActivityPois of Type "Winter" or "Sommer"
Using the ODHActivityPoiTypes Main Types Bitmask (adding values 2 + 4 = 6):
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?type=6

I want to filter on all ODHActivityPois of Type "Winter" and Subtype "Snowparks"
Using the ODHActivityPoiTypes Main Types Bitmask 2 and Subtype Bitmask 128:
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?type=2&subtype=128

I want to filter on all ODHActivityPois of Type "Winter" and Subtype "Snowparks" or "Eislaufen"
Using the ODHActivityPoiTypes Main Types Bitmask 2 and Subtype Bitmasks 4 + 128 = 132:
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?type=2&subtype=132

I want to filter on all ODHActivityPois of Type "Sommer" and Subtype "Wandern" and Level3type "Waalwege"
Using the ODHActivityPoiTypes Main Types Bitmask 4 and Subtype Bitmask 1 and level3type = 8:
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?type=4&subtype=1&level3type=8

Using odhtag / odhtagand filters

Still look on the Type Lists and simply pass the id/key of the type to the odhtagfilters.

I want to filter on all ODHActivityPois of Type "Winter"
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?odhtagfilter=winter

I want to filter on all ODHActivityPois of Type "Winter" or "Sommer"
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?odhtagfilter=winter,sommer

I want to filter on all ODHActivityPois of Type "Winter" and Subtype "Snowparks"
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?odhtagfilter_and=winter,snowparks

I want to filter on all ODHActivityPois of Type "Winter" and Subtype "Snowparks" or "Eislaufen"
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?odhtagfilter_and=winter&odhtagfilter=snowparks,eislaufen

I want to filter on all ODHActivityPois of Type "Sommer" and Subtype "Wandern" and Level3type "Waalwege"
https://tourism.api.opendatahub.bz.it/v1/ODHActivityPoi?odhtagfilter_and=sommer,wandern,waalwege

ODHActivityPoi - Additional Filters (Legacy, here for Compatibility reasons see Endpoint Migration Guide)

LTS Activities activitytype --> Filters by the LTS Activity categorization.
Find all available categorizations on this list LTS Activity Types
(Filters works like the ODHActivityPoi Bitmask Type Filters explained above)

LTS Pois poitype --> Filters by the LTS categorization.
Find all available categorizations on this list LTS Poi Main Types
(Filters works like the ODHActivityPoi Bitmask Type Filters explained above)

LTS Gastronomies categorycodefilter --> Filters by the LTS Categories
dishcodefilter--> Filters by the LTS Dish Codes
ceremonycodefilter--> Filters by the LTS Ceremony Codes
facilitycodefilter--> Filters by the LTS Facility Codes
cuisinecodefilter--> Filters by the LTS Cuisine Codes

Find all available categorizations for LTS Gastronomies on this list GastronomyTypes

Clone this wiki locally