Beta-Version: Der API-Datenexport ist zu Testzwecken online geschaltet. Beim Prozess der Stabilisierung können sich geringfügige Änderungen an den exportierten Datensätzen ergeben, sodass ggf. automatische Auswertungsskripte angepasst werden müssen. Für Feedback sprechen Sie uns gerne an.

Die Module der API werden über Domänensegmente angesprochen. Im Moment steht folgendes Modul zur Verfügung:

search

Mit dem search-Modul können Volltextsuchen oder komplexe Suchen mit Hilfe der Elasticsearch Query DSL und als Simple Query String Query durchgeführt werden. Das Suchergebnis ist eine Liste von Verlagsartikeln und steht im Moment ausschließlich im json-Format zur Verfügung.

Leere Suche

Der search-Endpunkt kann ohne Parameter angesprochen werden und liefert alle verfügbaren Datensätze zurück.

https://musikverlage.slub-dresden.de/api/search

Beispiele Volltextsuche als Simple Query String

Dem q-Parameter kann eine Abfrage-Zeichenkette übergeben werden.

https://musikverlage.slub-dresden.de/api/search?q=Dotzauer

Sollen Begriffe in verschiedenen Feldern gesucht werden, müssen sie über AND oder OR verbunden werden.

https://musikverlage.slub-dresden.de/api/search?q=Requiem AND Brahms

Beispiel Feldsuche als Simple Query String

Die zu durchsuchenden Felder können mit dem fields-Parameter spezifiziert werden.

https://musikverlage.slub-dresden.de/api/search?q=Lied&fields=title

Der fields-Parameter kann auch eine kommaseparierte Liste erhalten.

https://musikverlage.slub-dresden.de/api/search?q=Leipzig
&fields=works.composers.place_of_birth,works.composers.place_of_death

Suchfenstergröße

Alle Suchanfragen liefern die ersten 10 Ergebnisse. Die Suchfenstergröße kann über den size-Parameter auf maximal 10 000 Ergebnisse angepasst werden. Das Suchfenster kann über den from-Parameter verschoben werden.

https://musikverlage.slub-dresden.de/api/search?q=Piano&fields=title&size=5&from=15

Fuzziness

Den Suchwörtern kann mit dem ~-Parameter eine Anzahl von ersetzbaren Zeichen angefügt werden, sodass auch ähnlich geschriebene Wörter gefunden werden. Bspw. liefert folgende Suche auch Suchergebnisse für die französische Schreibweise "Mélodie".

https://musikverlage.slub-dresden.de/api/search?q=Melodie~1