Vokabular-Methoden

Über DANTE-Vokabulare


Schlagwortlisten, Namensdateien, Klassifikationen, Kategorienschemata, Wörterbücher, Thesauri, Terminologien, Taxonomien, Ontologien, Listen, Glossare und Ortslexika werden in DANTE als Vokabulare bezeichnet.

Zu jedem Vokabular gibt es einen Metadatensatz mit Informationen zu Namen, verwendete Sprachen, Herausgeber, Lizenz usw..

Subsets
Für Anwendungen kann es wichtig sein nur einen Ausschnitt (z.B. einen hierarchischen Ast) aus einem Vokabular anzusprechen. Diese Ausschnitte können in DANTE definiert werden und erben alle Eigenschaften des Vokabulars. Sie können aber eigene Definitionen oder Verwendungshinweise haben. Diese Teilmengen-Vokabulare werden Subsets genannt und ihre Notation beginnt immer mit "subset_".

Wird ein Subset per API genutzt, sollte der URL-Parameter "&voc=subset_XYZ" bei jedem Endpoint gesetzt werden um nicht ungewollt den eingeschränkten Kontext des Subsets zu verlassen.



Liste aller Vokabulare


GET /voc

Query-Parameter: limit (optional), subset (optional)

Liefert ein JSON-Array mit Informationen zu den einzelnen Vokabularen (siehe "Informationen zu einem Vokabular").


            
          



Informationen zu einem Vokabular


Für einzelne Vokabulare. Jedes Vokabular kann durch eine ID referenziert werden ({vocid}), wobei ggf. mehrere IDs pro Vokabular möglich sind. Die ID bestehen nur aus Ziffern, a-z und ggf. Minus-Zeichen. Die Vokabular-IDs werden im Feld "notation" des Vokabulars zurückgeliefert.
Die Parameter "notation", "uri" und "id" können hier auch als '|'-separierte Liste übergeben werden, um Informationen über mehrere Vokabulare gleichzeitig zu erhalten.

GET /voc/{vocid}

GET /voc?notation={notation}

GET /voc?uri={uri}

GET /voc?id={bartoc-uri}


            
          



Liste aller Oberbegriffe


GET /voc/{vocid}/top

Query-Parameter: type (optional), limit (optional)


GET /voc/top

Query-Parameter: uri (Pflicht), type (optional), limit (optional)

Liefert ein JSON-Array mit allen Konzepten, die als topConcept gekennzeichnet sind. In der Regel sind dies alle Konzepte ohne Elternelement.