Zur automatisieten Abfrage der ISIL- und Adressdaten stellt die Deutsche ISIL-Agentur und Sigelstelle eine webbasierte Programmierschnittstelle (API) bereit, die die Daten in der JavaScript Notation JSON zurückgibt.
Eine einfache Suche kann in der Form
/api/org.jsonld?q={Suchterme}
formuliert werden.
Die Suchterme können in gleicher Weise, wie in Hilfe zur Suche beschrieben, gebildet bzw. kombiniert werden. Dabei müssen die Suchterme als Wert für den Parameter q URL-codiert sein.
https://sigel.staatsbibliothek-berlin.de/api/org.jsonld?q=nam%3Dinstitut%20AND%20ort%3Dm%C3%BCnchen
Das Ergebnis einer Anfrage kann über zwei URL-Parameter beeinflusst werden
Die Antwort auf eine Suchanfrage wird in Form eines JSON-Objekts gegeben, welches im Grunde aus drei Teilen besteht:
Die Metadaten zur Suchanfrage bestehen aus folgenden Schlüsseln:
Die eigentlichen ISIL- und Adressdaten werden unter dem Schlüssel member in einem JSON-Array zusammengefasst. Jeder ISIL- und Adressdatensatz hat folgende Schlüssel:
Gibt es keine Ergebnisse für die Anfrage, dann wird ein leeres JSON-Array zurückgegeben.
Wenn der Parameter compact genutzt wird, dann wird jeder Datensatz mit den Schlüsseln
ausgegeben.
Gibt es keine Ergebnisse für die Anfrage, dann wird ein leeres JSON-Array zurückgegeben.
Da die Ergebnisse möglicherweise auf mehrere Antwortseiten aufgeteilt sind, werden Links zur Navigation in diesen Seiten benötigt. Diese Navigation ist unter dem Schlüssel view als JSON-Objekt zusammengefasst und enthält die Schlüssel:
und möglicherweise
Optional können die Ergebnisse in einem Funktionsaufruf umschlossen werden (JSONP). So können die Daten direkt an eine Callback-Funktion des Clients übergeben werden. JSONP wird durch den Paramater callback erzeugt. Der Wert des Parameters ist der Name der Funktion des Clients (Callback-Funktion), mit dem die Daten weiterverarbeitet werden sollen.
Eine entsprechende Anfrage hätte dann die Form:
/api/org.jsonld?q={Suchterme}&callback={Name_der_Callback-Funktion}
Ein weiterer Parameter format beeinflusst den Umfang der Daten, die als JSONP ausgegeben werden. Hat der Parameter den Wert lookup, dann werden nur die häufigsten Daten ausgeben. Mit dem Wert data werden nur JSON-kodierte PICA+-Daten in die Callback-Funktion eingeschlossen. Entsprechend lautet die Syntax:
/api/org.jsonld?q={Suchterme}&callback={Name_der_Callback-Funktion}&format={lookup|data}
https://sigel.staatsbibliothek-berlin.de/api/org.jsonld?q=ort%3DBonn&callback=list&format=lookup
Jeder Datensatz kann einzeln mit Hilfe eines ISIL abgerufen werden:
/api/org/{ISIL}.jsonld
https://sigel.staatsbibliothek-berlin.de/api/org/DE-12.jsonld
Siehe hierzu https://www.zeitschriftendatenbank.de/services/schnittstellen/json-api/
Bei Fragen zur JSON-API und bei Anmerkungen zur Verbesserung wenden Sie sich bitte an:
Carsten Klee |
---|
Tel.: +49 30 266 434402 |