Die Suchfunktion wird mit Erscheinen der Vollversion zur Verfügung stehen.

API Dokumentation

1.0.0

Die UJWA bietet eine Schnittstelle gemäß der openAPI 3.0.1–Spezifikation an, um es zu ermöglichen, Daten der Edition automatisiert abrufen zu können. Die aktuelle erste Version erlaubt Zugriff auf die Liste der Entitäten, die in den Texten der UJWA vorkommen. Diese kann in Gänze abgerufen, aber auch gefiltert und gezielt durchsucht werden.

Die Ausgabe erfolgt im JSON-Format. Details zum Datenmodell der Entitäten sind in der Schnittstellen-Definition zu finden.

Achtung: Im Moment liefert die Schnittstelle lediglich Musterdaten zur Demonstration der Funktionalität aus. In Zukunft wird die Schnittstelle Zugriff auf die Daten einer Personendatenbank der UJWA erlauben.

Verwendung

Endpunkte
Beschreibung
/api/v1/entities
Liefert eine Liste von Entitäten. Kann mittels der Parameter name und type gefiltert werden. Die Parameter sind kombinierbar. Mögliche Werte für type sind: person, place, organisation. Die Suche nach Namen berücksichtigt sowohl die Hauptbezeichnungen der Entitäten sowie Synonyme.
Beispiel:
http://ujwa.uni-rostock.de/api/v1/entities?type=place&name=Berlin
/api/v1/entities/{id}
Liefert eine Entität anhand des ID-Parameters. Die ID kann eine GND- oder Wikidata-ID sein.
Beispiel:
http://ujwa.uni-rostock.de/api/v1/entities/Q64
zur Schnittstellen-Definition