4. HTTP Schnittstelle
Kapitel hinzufügen

Für den maschinellen Zugriff auf den elektronischen Lesesaal existiert eine HTTP-Schnittstelle über die verschiedene Funktionen aufgerufen werden können.

4.1 Aufruf des Browser
Abschnitt hinzufügen

Beim Aufruf des Browsers können folgende (optionalen) Aufrufparameter übergeben werden:

${eroom-url}/browser[?option=value[&option=value]]
appmode={activation}

Bei Angabe von activation beendet sich der Browser direkt nach der Aktivierung.

open={medianumber}

Mit open kann die Medianumber des zu öffnenden Dokumentes angegeben werden.

pageNr={page-nr}

Mit pageNr kann die zu öffnende Seite eines Dokumentes angegeben werden. Nur sinnvoll, wenn auch open gleichzeitig gesetzt wird.

search={query}

Der Browser kann nach dem Start auch direkt eine Suche mit dem angegebenen Query starten und die Suchtrefferliste anzeigen.

activationcode={activation-code}

Bei Installation mit Rechnerauthentifizierung kann ein Rechner für die Benutzung des elektronischen Lesesaals über einen activationcode freigeschaltet werden. Wird der appmode auf activation gesetzt, so beendet sich der Browser nach erfolgreicher Aktivierung direkt.

4.2 Export von Originalseitenbildern
Abschnitt hinzufügen

Die originalen Seitenbilder eines eingecheckten Dokumentes können über die folgende URL in einer ZIP-Datei abgerufen werden.

${eroom-url}/repository/document.zip?method=exportDocument&mediaNumber=${medianumber}

4.3 Export von Protokolldaten
Abschnitt hinzufügen

Die vom System aufgezeichneten und über das Admin-Tool abrufbaren Events können über die folgende URL in Form einer CSV-Datei abgerufen werden.

${eroom-url}/repository/events.csv?method=exportEventLog&from=${from}&to=${to]

Die Parameter from und to sind optional (yyyyMMdd). Das CSV-Format ist das gleiche wie bei einem Export über das Admin-Tool (siehe 4. Event- und Journal-Einträge).

4.4 Abruf von skalierten Seitenbildern
Abschnitt hinzufügen

Die Seitenbilder eines Dokuments können über die folgende URL abgerufen werden:

${eroom-url}/repository?method=getImage&scale=${scale}&quality=${quality}&pageId=${page-id}

Die Parameter scale und quality entsprechen den Parametern des Imagemagick Tools convert, also dem Skalierungsfaktor (von 0 bis 1, mit 1 gleich 100%) und der Qualitätsstufe (von 0 bis 1, mit 1 gleich 100%). Das skalierte Seitenbild wird im JPEG-Format zurückgeliefert. Der Parameter page-id referenziert die Seite und kann z.B. über die Webservice Funktion getDocumentInfos abgerufen werden.