zur Staatsbibliothek
 
Deutsche ISIL-Agentur und Sigelstelle - Start page
Suche > JSON-API

 
 

JSON-API der Deutschen ISIL-Agentur und Sigelstelle

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.

Einfache Suchanfrage

Eine einfache Suche kann in der Form

https://sigel.staatsbibliothek-berlin.de/suche/api/?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.

Beispielanfrage (mit nam=Institut AND ort=München)

https://sigel.staatsbibliothek-berlin.de/suche/api/?q=nam%3Dinstitut%20AND%20ort%3Dm%C3%BCnchen

Parameter, die die Antwort beeinflussen

Das Ergebnis einer Anfrage kann über zwei URL-Parameter beeinflusst werden

  • size - Die Anzahl der Ergebnisse pro Seite. Der Default Wert ist 100
  • page - Die Nummer der Ergebnisseite, die angezeigt werden soll. Der Defaultwert ist 1

Beispielanfrage (mit size=5 und page=2)

https://sigel.staatsbibliothek-berlin.de/suche/api/?q=nam%3Dinstitut%20AND%20ort%3Dm%C3%BCnchen&size=5&page=2

Antwort in JSON

Die Antwort auf eine Suchnanfrage wird in Form eines JSON-Objekts gegeben, welches im Grunde aus drei Teilen besteht:

  • Metadaten der Suchanfrage
  • ISIL- und Adressedaten
  • Links zur Navigation in der Ergebnismenge

Metadaten der Suchanfrage

Die Metadaten zur Suchanfrage bestehen aus folgenden Schlüsseln:

  • id - URL der ursprünglich gestellten Suchanfrage
  • searchTerm - die Suchterme
  • totalItems - Absolute Anzahl der Ergebnisse
  • numberOfPages - Anzahl der Seiten, auf die das Ergebnis aufgeteilt ist
  • start - Rang es Datensatzes mit dem die aktuelle Seite beginnt
  • size - Anzahl der Datensätze pro Seite
  • page - Nummer der aktuellen Seite

ISIL- und Adressdaten

Die eigentlichen ISIL- und Adressdaten werden unter dem Schlüssel 'member' in einem JSON-Array zusammengefasst. Jeder ISIL- und Adressdatensatz ist ein PICA-Plus-Datensatz in Form eines JSON-Objekts.

Gibt es keine Ergebnisse für die Anfrage, dann wird ein leeres JSON-Array zurückgegeben.

Links zur Navigation in der Ergebnismenge

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:

  • id - Link zur aktuellen Seite
  • first - Link zur ersten Seite
  • last - Link zur letzten Seite

und möglicherweise

  • previous - Link zur vorherigen Seite, falls vorhanden
  • next - Link zur nächsten Seite, falls vorhanden

Hat die Anfrage keine Ergebnisse, dann hat der Schlüssel 'view' den Wert null.

Abfrage einzelner Datensätze

Jeder Datensatz kann einzeln mit Hilfe eines ISIL im Parameter 'isil' abgerufen werden:

https://sigel.staatsbibliothek-berlin.de/suche/api/?isil={ISIL}

Beispielanfrage (mit isil=DE-12)

https://sigel.staatsbibliothek-berlin.de/suche/api/?q=DE-12