Skip to content

Tags Migration Guide

RudiThoeni edited this page Nov 19, 2024 · 2 revisions

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

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

Clone this wiki locally