Zusatzinformationen anfragen

[Start]  [Zurück]  [Vorwärts]  

Die Web API erlaubt das Senden von Zusatzinformationen zu einem E-Skript. Diese können dem Benutzer gezeigt werden. Um den Zugriff auf sensible Daten der HAN Datenbank zu verhindern, sind die Datenfelder mit Informationen definiert und können nicht konfiguriert werden. Folgende Informationen können zu einem E-Skript übermittelt werden:

HAN ID

Beschreibung

Status (aktiviert, deaktiviert, befristet - inkl. Datum)

Berechtigung und wenn zugeordnet, die Beschreibung

E-ISSN

ISSN

Perioden

Fachgebiet

Verlag

Bezugsquelle

Lizenziert (Summe verfügbarer Lizenzen, belegte Lizenzen)

HAN URL

 

Wird eine HAN ID ohne Unterstrich übergeben, können unterschiedliche Lizenzzeiträume für das E-Skript vorliegen. In diesem Fall werden alle unterschiedlich lizenzierten Skripte zurückgegeben. Z.B.: Die Suche nach der HAN ID ‚100039‘ findet drei E-Skripte (100039, 100039_0, 100039_1‘).

 

warning IDs mit einem Unterstrich werden nur bei einem EZB-Import erzeugt. Wenn Sie über keine Verbindung zur EZB verfügen, enthalten Ihre HAN IDs keinen Unterstrich.

 

API-Funktionsweise

Die API wird über ein virtuelles Verzeichnis angesprochen: http://<HAN Server>/hanapi/action.

Der Parameter method entscheidet über die angefragt Methode. Die Schnittstelle zur Bestimmung einer HAN ID wird über den Wert getHANInfo angesprochen. Zusätzliche Parameter können mittels der HTTP-Methode GET als URL-Parameter angehängt werden, oder als JSON-Objekt über die HTTP-Methode POST gesendet werden.

Folgende zusätzliche Parameter stehen zur Verfügung:

hanid. HAN ID, zu der weitere Informationen gesucht werden

 

tip Für den Fall, dass das anfragende System die HAN ID nicht bestimmen kann, kann per Einstellung in den HAN Einstellungen auch die HAN URL mitgesendet werden.

 

Beispiele

Ein Beispiel für eine URL-Abfrage mit Parametern:

http://handemo.hh-software.com/hanapi/action?method=findCreateHANID&id=create&hanid=test

 

Der Aufbau eines JSON-Objekts ist ähnlich dem Aufbau der URL-Parameter, es werden die gleichen Parameternamen verwendet:

 

{

method : getHANInfo,

hanid : <HAN ID>,

hanurl : <HAN URL>,

return : <Rückgabemethode>,

id: <ID der konfigurierten API>

}

 

Bei der Verwendung eines JSON-Objekts gilt, dass die Standardrückgabe ein JSON-Objekt ist und immer verwendet wird, wenn die Rückgabemethode nicht spezifiziert wurde.

Rückgabe des Ergebnisses

Zusatzinformationen zu einer HAN ID/einem E-Skript können auf zwei Arten zurückgegeben werden. Die Art der Rückgabe wird über den Parameter return bestimmt. Mögliche Werte für diesen Parameter sind:

0 (JSON-Objekt)

1 (HTML-Template)

 

Die Standard-Rückgabeoption ist folgendes JSON-Objekt:

 

{

count : <Anzahl der gefundenen E-Skripte>,

scripts : <Array, pro E-Skript ein Objekt>

}

 

Wurde kein Ergebnis gefunden, hat der Parameter count den Wert „0". Wurde ein E-Skript gefunden, wird es in folgender Form als JSON-Objekt zurückgegeben:

 

{

hanid: <HAN ID>,

description: <Beschreibung>,

status: <0|1|2>,

expiredate: <Millisekunden seit 1.1.1970, wird nur ausgegeben wenn status:2>

permission: {

active: <false|true>,

description: <Beschreibung der Berechtigung>

},

eissn: <E-ISSN>,

issn: <ISSN>,

periods: <Perioden>,

subjects: [ <Fachgebiet Beschreibung>],

publisher: <Verlag>,

provider: <Bezugsquelle>,

license: {

active: <false|true>,

number: <Anzahl der Lizenzen>,

used: <Anzahl der belegten Lizenzen>

},

fulltext: <HAN URL>,

payment: {

type: <Bepreisungsart>,

fee: <Kosten>

}

}

 

Bei mehreren gefundenen E-Skripten werden entsprechend mehrere JSON-Objekte zurückgeliefert. Kann das anfragende System kein JSON-Objekt verarbeiten, kann auch ein HTML-Template zurückgegeben werden, das mittels Platzhaltern dynamisch mit Daten befüllt wird. Dies ist vor allem bei AJAX-Aufrufen sinnvoller als die Verwendung eines JSON-Objekts. Wurde kein E-Skript gefunden, wird ein Fehlercode zurückgegeben.