Tags Migration Guide - noi-techpark/opendatahub-docs GitHub Wiki

Why this Migration

Most of the old ODHTags contains german Tag Ids/Keys.
Also the use of some special characters (umlaut) as Tag Ids/Keys leads to problems.
The old Tag Endpoint & Tag Assignments in the data has some scalability issues, the Source and the Type of the Tag cannot be determined. The idea of the new Tag Endpoint is to add all Tags with the regarding Source and Type of the Tag. So all other fields with categorizations will be obsolete. It is up to the data consumer to decide which Tags he wants to use, Open Data Hub offers all available Tags.

EndPoint

ODHTag Endpoint is https://tourism.api.opendatahub.com/v1/ODHTag
The new Tag Endpoint ODHTag Endpoint is https://tourism.api.opendatahub.com/v1/Tag

Tag Assignment in the data

The Tags are stored with their Source & Type directly in the data, see here https://github.com/noi-techpark/opendatahub-docs/wiki/Tags

Datamodel Differences

Source --> CHANGED only one Source allowed, Source is taken from https://tourism.api.opendatahub.com/v1/Source. ODHTag had a Source Array with other sources.
Types --> NEW string List, which defines the Type this Tag is, all current assigned Types can be retrieved with this call https://tourism.api.opendatahub.com/v1/Distinct?type=tag&fields=Types.[*]&getasarray=true The Types replaces the old Source Array from ODHTags
Description --> NEW Tag Description in different languages
Active --> NEW Tag can be active/inactive
ODHTagIds --> NEW String List which contains the IDs if a Tag was derived from a ODHTag

Explanation of common fields

Mapping --> All additional information of a Tag is saved into this Dictionary
ValidForEntity --> All entities this tag is valid for (_Meta.Type)
DisplayAsCategory --> Use this Tag as Categorization Text (to explain better)
MappedTagIds --> If data has this Tag which Tags are also to Add to the record.

Obsolete fields here for compatibility reasons (Do not use this fields)

MainEntity --> Replaced by ValidForEntity
IDMCategoryMapping --> Obsolete IDM Mapping Information
LTSTaggingInfo --> LTS specific information, now field Mapping is used