5. SOAP Schnittstelle
Kapitel hinzufügen

Für die Interaktion mit MyBib eL Server stehen mehrere SOAP-basierte Webservice Schnittstellen zur Verfügung, deren WSDL-Adressen mit dem Servlet-Aufruf

${eroom-url}/system?method=getWebServiceConfiguration

abgerufen werden können, z.B. http://localhost:8080/mertest14/system?method=getWebServiceConfiguration

Dieser Aufruf liefert ein XML-Dokument zurück in der Art:

<?xml version="1.0" encoding="iso-8859-15" standalone="yes"?>
<webservice-configuration>
    <version>1.0.x</version>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/account?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/event?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/repository?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/session?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/task?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/transfer?wsdl</wsdl>
    </webservice>
    <webservice>
        <wsdl>http://localhost:8080/mertest14/ws/eroom/workstation?wsdl</wsdl>
    </webservice>
</webservice-configuration>

Die Beschreibung der Webservice-Schnittstelle, ihrer Funktionen und Datenstrukturen ist in Javadoc der Stub-Klassen aufgeführt.

5.1 Übersicht der SOAP Webservices
Abschnitt hinzufügen

Benutzer-/Clientbezogene Funktionen

SeiteDatum
Access Webservice2018/06/05 08:55
Account Webservice2018/06/05 08:55
Session Webservice2018/06/05 08:55
Workstation Webservice2018/06/05 08:55

Dokumentbezogene Funktionen

SeiteDatum
Repository Webservice2018/06/05 08:55
Transfer Webservice2018/06/05 08:55

Logging-/Statistikbezogene Funktionen

SeiteDatum
Event Webservice2018/06/05 08:55

Steuererungsbezogene Funktionen

SeiteDatum
Task Webservice2018/06/05 08:55

5.2 Access Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.6.x1.0.0Berechtigungen

Mit dem Access Webservice können Berechtigungen auf Objekten des elektronischen Lesesaals abgefragt werden.

5.2.1 Berechtigung eines Principals auf ein Objekt abfragen

Diese Methode ermöglicht das gezielte Abfragen der Berechtigungen eines Principals, welche exakt einem Objekt zugeordnet sind.
Ein Principal kann ein Benutzer, ein Gruppe oder eine Rolle sein, während ein Objekt ein Dokument, ein Kapitel, ein Artikel oder eine Seite sein kann.
Methodenname: getPermissions

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
principal idId des Principals, für das Berechtigungen abgefragt werden sollen
object idId des Objektes, dessen Berechtigungen abgefragt werden sollen

Rückgabe: Liste aller Berechtigungen des Principals auf dem Objekt

5.2.2 Alle Berechtigung auf ein Objekt abfragen

Diese Methode ermöglicht das Abfragen sämtlicher Berechtigungen, welche einem Objekt zugeordnet sind.
Wie bei getPermissions kann ein Objekt ein Dokument, ein Kapitel, ein Artikel oder eine Seite sein.
Methodenname: getPermissionSet

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
object idId des Objektes, dessen Berechtigungen abgefragt werden sollen

Rückgabe: Liste mit sämtlichen Berechtigungen, die Principals auf dem Objekt haben

5.3 Account Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???Benutzerverwaltung (neu)

Mit dem Account Webservice können verschiedene Aspekte der Benutzerverwaltung durchgeführt werden. Hierzu gehören das Anlegen, Bearbeiten und Löschen von Benutzern, Gruppen und Rollen.

5.3.1 Benutzer anlegen

Mithilfe dieser Methode kann ein neuer Benutzer innerhalb des MyBib eL Servers angelegt werden.

Methodenname: createUser

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
login nameName, mit dem er Benutzer sich einloggen kann
passwordPasswort, mit dem er Benutzer sich einloggen kann
full nameVollständiger Name des Benutzers
commentKommentar zum Benutzer

Rückgabe: Eindeutige Benutzer Id, welche für weitere Operationen verwendet werden kann.

5.3.2 Benutzer löschen

Mit dieser Methode kann ein vorhandenes Benutzerkonto aus dem MyBib eL Server gelöscht werden.

Methodenname: deleteUser

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user idId des zu löschenden Benutzers

Rückgabe:

5.3.3 Benutzer auflisten

Diese Methode wird verwendet, um eine Liste aller Benutzer Ids abzufragen, welche momentan auf dem MyBib eL Server registriert sind.

Methodenname: getUserIds

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients

Rückgabe: Ids aller vorhandenen Benutzer

5.3.4 Benutzerdaten abfragen

Diese Methode wird verwendet, um die genauen Benutzerdaten eines auf dem MyBib eL Server existierenden Benutzers abfragen zu können.

Methodenname: getUserData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user idId des Benutzers, dessen Daten abgefragt werden sollen

Rückgabe: Die zurückgegebenen Nutzerdaten enthalten folgende Werte:

  • Benutzer-Id: Id zur Identifizierung eines Benutzers in dem MyBib eL Server
  • Login: Login Name des Nutzers für den MyBib eL Server
  • Benutzername: Vollständiger Name des Benutzers
  • Status: Status des Benutzers
    Folgende sind möglich:
    • aktiviert: Benutzer ist aktiviert
    • wartend: Benutzer wartet auf Aktivierung
    • deaktiviert: Benutzer ist deaktiviert.
  • Beschreibung: Beschreibung zu dem jeweiligen Benutzer

5.3.5 Benutzerdaten speichern

Diese Methode wird verwendet, um die Benutzerdaten eines existierenden MyBib eL Benutzerkontos neu zu setzen.
Hierunter fallen sämtliche Benutzer-Daten, welche man mithilfe der Methode getUserData zum Auslesen der Benutzerdaten abfragen kann.
Wichtig: Die ID der Benutzergruppe darf nicht geändert werden.

Methodenname: setUserData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user dataNutzerdaten, welche gültige Werte für Id, Beschreibung, Login Name, vollständiger Name, Registrierungsstatus enthalten

Rückgabe:

5.3.6 Benutzergruppe anlegen

Mithilfe dieser Methode kann eine neue Benutzergruppe innerhalb des MyBib eL Servers angelegt werden.

Methodenname: createUserGroup

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
parent user group idId einer vorhandenen Benutzergruppe, deren Untergruppe die neu anzulegende Gruppe sein soll
user group nameName der Benutzergruppe
descriptionBeschreibung der Benutzergruppe

Rückgabe: Eindeutige Benutzergruppen Id, welche für weitere Operationen verwendet werden kann.

5.3.7 Benutzergruppe löschen

Mit dieser Methode kann eine vorhandene Benutzergruppe aus dem MyBib eL Server gelöscht werden.

Methodenname: deleteUserGroup

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user group idId der zu löschenden Benutzergruppe

Rückgabe:

5.3.8 Benutzergruppen auflisten

Diese Methode wird verwendet, um eine Liste aller Benutzergruppen Ids abzufragen, welche momentan auf dem MyBib eL Server registriert sind.

Methodenname: getUserGroupIds

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients

Rückgabe: Ids aller vorhandenen Benutzergruppen

5.3.9 Benutzergruppendaten abfragen

Diese Methode wird verwendet, um die genauen Benutzergruppendaten einer auf dem MyBib eL Server existierenden Benutzergruppe abfragen zu können.

Methodenname: getUserGroupData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user group idId der Benutzergruppe, deren Daten abgefragt werden sollen

Rückgabe: Die zurückgegebenen Nutzergruppendaten enthalten folgende Werte:

  • Benutzergruppen Id: Id zur Identifizierung einer Benutzergruppe in dem MyBib eL Server
  • Gruppenname: Name der Gruppe
  • Benutzer Ids: Ids der MyBib eL Benutzer, die dieser Gruppe angehören
  • Beschreibung: Beschreibung zu der jeweiligen Benutzergruppe

5.3.10 Benutzergruppendaten speichern

Diese Methode wird verwendet, um die Gruppendaten einer existierenden MyBib eL Benutzergruppe neu zu setzen.
Hierunter fallen sämtliche Benutzergruppen-Daten, welche man mithilfe der Methode getUserGroupData zum Auslesen der Benutzergruppendaten abfragen kann.
Wichtig: Die ID der Benutzergruppe darf nicht geändert werden.

Methodenname: setUserGroupData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user group dataNutzergruppendaten, welche gültige Werte für Id der Gruppe, Beschreibung, Gruppenname, Ids der Benutzer dieser Gruppe enthalten

Rückgabe:

5.3.11 Rolle anlegen

Mithilfe dieser Methode kann eine neue Rolle innerhalb des MyBib eL Servers angelegt werden.

Methodenname: createRole

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
role nameName der Rolle
descriptionBeschreibung der Rolle

Rückgabe: Eindeutige Rollen Id, welche für weitere Operationen verwendet werden kann.

5.3.12 Rolle löschen

Mit dieser Methode kann eine vorhandene Rolle aus dem MyBib eL Server gelöscht werden.

Methodenname: deleteRole

Parameter

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
role idId der zu löschenden Rolle

Rückgabe:

5.3.13 Rollen auflisten

Diese Methode wird verwendet, um eine Liste aller Rollen Ids abzufragen, welche momentan auf dem MyBib eL Server registriert sind.

Methodenname: getRoleIds

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients

Rückgabe: Ids aller vorhandenen Rollen

5.3.14 Rollendaten abfragen

Diese Methode wird verwendet, um die genauen Rollendaten einer auf dem MyBib eL Server existierenden Rolle abfragen zu können.

Methodenname: getRoleData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
role idId der Rolle, deren Daten abgefragt werden sollen

Rückgabe: Die zurückgegebenen Nutzergruppendaten enthalten folgende Werte:

  • Role Id: Id zur Identifizierung einer Rolle in dem MyBib eL Server
  • Rollenname: Name der Rolle
  • Benutzer Ids: Ids der MyBib eL Benutzer, die diese Rolle haben
  • Beschreibung: Beschreibung zu der jeweiligen Rolle

5.3.15 Rollendaten speichern

Diese Methode wird verwendet, um die Rollendaten einer existierenden MyBib eL Rolle neu zu setzen.
Hierunter fallen sämtliche Rollendaten, welche man mithilfe der Methode getRoleData zum Auslesen der Rollendaten abfragen kann.
Wichtig: Die Id der Rolle darf nicht geändert werden.

Methodenname: setRoleData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
role dataRollendaten, welche gültige Werte für Id der Rolle, Beschreibung, Rollenname, Ids der Benutzer dieser Rolle enthalten

Rückgabe:

5.4 Event Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???Ereignisverwaltung (neu)

Der Event Webservice ermöglicht die Abfrage im MyBib eL Server gespeicherter Events (Ereignisse). Zusätzlich biete er die Möglichkeit, Events anzulegen und vorhandene Events zu löschen.

5.4.1 Events abfragen

Diese Methode ermöglicht die Abfrage von Events, die im MyBib eL Server im gegebenen Zeitraum aufgetreten und gespeichert worden sind.

Methodenname: getEventData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
fromStartdatum des geforderten Zeitraumes
toEnddatum des geforderten Zeitraumes

Rückgabe: Liste aller Events, die im gegebenen Zeitraum aufgetreten und gespeichert worden sind. Ein Event beinhaltet folgende Daten:

  • Event Id: Id eines Events
  • Datum: Datum der Events
  • Name: Name des Events
  • Typ: Art des Events
  • Quelle: Quelle des Events
  • Aktion: Aktion, welche zu dem Event führte
  • Beschreibung: Beschreibung des Events
  • Fehlermeldung: Fehlermeldung des Events
  • Liste mit zum Event gehörenden Variablen
    • Name der Variable
    • Wert der Variable

5.4.2 Event anlegen

Diese Methode dient zum Anlegen von Events im MyBib eL Server. Hierdurch können Events gespeichert werden, welche relevant für z.B. Dokumente im eL sind, aber nicht durch den eL Server ermittelt werden können bzw. erfasst worden sind.

Methodenname: setEventData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
eventsListe mit Events, die gespeichert werden sollen
Pro Event werden folgende Daten erfasst (vgl. Datenstruktur bei getEventData): Id, Datum, Typ, Quelle, Aktion, Beschreibung, Eventvariablen

Rückgabe: Liste mit Events, die in dieser Methode gespeichert wurden

5.4.3 Event löschen

Diese Methode dient zum Löschen von im MyBib eL Server gespeicherten Events.

Methodenname: removeEventData

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
event idsListe mit Event Ids der zu löschenden Events

Rückgabe: –

5.5 Repository Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???Repositoryverwaltung (neu)

Der Repository Webservice ist für die Verwaltung der Dokumente innerhalb eines MyBib eL Servers gedacht.

5.5.1 Dokumente auflisten

Mit dieser Methode kann eine Liste aller im MyBib eL gespeicherten Dokumente abgefragt werden. Optional kann die Liste auf Dokumente eingeschränkt werden, die einem bestimmten Benutzer gehören.

Methodenname: getMediaNumbers

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user idId eines MyBib eL Nutzers, dessen Dokumente angezeigt werden sollen (optional)

Rückgabe: Liste mit Mediennummern der im MyBib eL vorhandenen Dokumente bzw deren Owner dem angegebenen Benutzer entspricht.

5.5.2 Druckbare Dokumente auflisten

Mit dieser Methode kann eine Liste aller Dokumente abgefragt werden, deren Druckzähler (Anzahl noch zur Verfügung stehender Druckvorgänge) größer null ist. Optional kann die Liste auf Dokumente mit Druckzähler größer null eingeschränkt werden, die einem bestimmten Benutzer gehören.

Methodenname: queryPrintableDocuments

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
user idId eines MyBib eL Nutzers, dessen Dokumente angezeigt werden sollen (optional)

Rückgabe: Liste mit Mediennummern der im MyBib eL vorhandenen Dokumente mit Druckzähler größer null, optional eingeschränkt auf Dokumente des angegebenen Nutzers. deren Owner dem angegebenen Benutzer entspricht.

5.5.3 Dokumentinformationen abfragen

Mit dieser Methode können nähere Informationen zu Dokumenten im MyBib eL Server abgefragt werden.

Methodenname: getDocumentInfos

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
media numbersListe mit Mediennummern der Dokumente, deren Informationen abgefragt werden sollen

Rückgabe: Liste mit den jeweiligen Daten der Dokumente:

  • Dokument Id: Id des Dokumentes im MyBib eL Server
  • Medienummer: Die Mediennummer des Dokuments im MyBib eL Server
  • Name: Der Titel des Dokuments
  • Identifier: Metadatenfeld für z.B. die Signatur eines Dokumentes, Inhalt abhängig von Dokumentformat/Spezifikation durch Kunden
  • Seiten: Eine Liste Ids der Seiten, die zu diesem Dokument gehören
  • Zähler: Die Zählerstände des Dokuments (Anzeigezähler, Exemplarzähler, Druckzähler)

5.5.4 Kapitelinformationen abfragen

Mit dieser Methode können nähere Informationen zu Kapiteln eines Dokumentes im MyBib eL Server abgefragt werden.

Methodenname: getChapterInfos

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idId des Dokumentes, dessen Kapitelinformationen abgefragt werden sollen

Rückgabe: Liste mit Informationen zu den Kapiteln des angegebenen Dokumentes.

  • Kapitel Id: Id des jeweiligen Kapitels im MyBib eL Server
  • Name: Titel des Kapitels
  • Seiten: Eine Liste mit Ids der Seiten, welche zum jeweiligen Kapitel gehören

5.5.5 Artikelinformationen abfragen

Mit dieser Methode können nähere Informationen zu Artikeln eines Dokumentes im MyBib eL Server abgefragt werden.

Methodenname: getArticleInfos

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idId des Dokumentes, dessen Artikelinformationen abgefragt werden sollen

Rückgabe: Liste mit Informationen zu den Artikeln des angegebenen Dokumentes

  • Artikel Id: Id des Artikels
  • Titel: Titel des Artikels

5.5.6 Seiteninformationen abfragen

Mit dieser Methode können nähere Informationen zu Seiten eines Dokumentes im MyBib eL Server abgefragt werden.

Methodenname: getPageInfos

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idId des Dokumentes, dessen Seiteninformationen abgefragt werden sollen

Rückgabe: Liste mit Informationen zu den Seiten des angegebenen Dokumentes

  • Seiten Id: Id der Seite des Dokuments im MyBib eL Server
  • Name: Name der Seite
  • Nummer: Nummer der Seite

5.5.7 Dokumentenzähler abfragen

Mit dieser Methode können Zählerstände von im MyBib eL befindlichen Dokumenten abgefragt werden.

Methodenname: getDocumentCounters

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
media numbersListe mit Mediennummern der Dokumente, deren Zählerstände abgefragt werden sollen.

Rückgabe: Liste mit den Zählerständen der angeforderten Dokumente:

  • Mediennummer: Die Mediennummer des jeweiligen Dokuments
  • Anzeigezähler: Die Menge der zur Anzeige verfügbaren Exemplare des Dokumentes
  • Exemplarzähler: Die Menge der verfügbaren Exemplare des Dokumentes
  • Druckzähler: Die Menge der noch möglichen Druckvorgänge für das Dokument

5.5.8 Dokumentenzähler setzen

Mit dieser Methode können die Zählerstände von Dokumenten im MyBib eL Server gesetzt werden.

Methodenname: setDocumentCounters

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document count listListe mit Zählerständen, die für die angegebenen Dokumente gesetzt werden sollen
– Mediennummer
– Anzeigezähler
– Exemplarzähler
– Druckzähler

Rückgabe:

5.5.9 Erweiterte Metadatenfelder eines Objektes abfragen

Mit dieser Methode können die erweiterten Metadatenfelder eines Dokumentes/Kapitels/Artikels/einer Seite im MyBib eL Server abgefragt werden.

Methodenname:

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
object idId des Objektes (Dokument/Kapitel/Artikel/Seite, dessen erweiterte Metadaten abgefragt werden sollen

Rückgabe: Liste (Name-Wert-Paare) mit den jeweiligen erweiterten Metadaten des Dokuments/Kapitels/Artikels/der Seite

5.5.10 Erweiterte Metadatenfelder eines Objektes setzen

Mit dieser Methode können die erweiterten Metadatenfelder eines Dokumentes/Kapitels/Artikels/einer Seite im MyBib eL Server gesetzt werden.
VORSICHT: Vorhandene erweiterte Metadaten des betreffenden Objektes werden hierbei gelöscht, so dass nach dem Aufruf dieser Methode nur noch die dadurch gesetzten Felder als erweiterte Metadaten des Objektes vorhanden sind!

Methodenname:

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
object idId des Objektes (Dokument/Kapitel/Artikel/Seite), dessen erweiterte Metadaten gesetzt werden sollen
extra data fieldsListe (Name-Wert-Paare) der erweiterten Metadaten, die gesetzt werden sollen

Rückgabe: –

5.6 Session Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???eigener Webservice

In dem Webservice für die Sessionverwaltung sind Funktionen zusammengefasst, welche sich auf das Sessionmanagement eines MyBib eL Servers beziehen.

5.6.1 Einloggen

Diese Methode dient dazu, einen Benutzer am MyBib eL Server einzuloggen und eine aktive Sitzung/Session zu erzeugen.

Methodenname: login

Parameter:

NameBeschreibung
node idId der Workstation, von der aus ein Nutzer sich anmeldet
user nameBenutzername
passwordPassword

Rückgabe: Id der Session, die für die folgende Interaktion zwischen Client und Server erzeugt worden ist.

5.6.2 Ausloggen

Diese Methode dient dazu, einen Benutzer vom MyBib eL Server auszuloggen und die aktive Sitzung zu beenden.

Methodenname: logout

Parameter:

NameBeschreibung
session idId der Session, die beendet werden soll

Rückgabe: –

5.7 Task Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???Aufgabenverwaltung (neu)

Der Task Webservice für die Verwaltung von Aufgaben/Tasks stellt Methoden zur Verfügung, mit denen Informationen über Tasks auf dem MyBib eL Server abgefragt und Tasks gelöscht werden können.

5.7.1 Aufgaben auflisten

Diese Methode gibt eine Liste aller auf dem MyBib eL Server vorhandenen Task Ids zurück.

Methodenname: getTaskIds

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers

Rückgabe: Liste aller Task Ids

5.7.2 Aufgabeinformationen abfragen

Mit dieser Methode können weitere Details zu Aufgaben abgefragt werden.

Methodenname: getTaskInfos

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
task idsListe mit Task Ids, zu denen weitere Informationen abgefragt werden sollen

Rückgabe: Liste mit Informationen zu vorhandenen Tasks, folgende Details werden pro Task zurückgegeben:

  • Task Id: Id zur Identifizierung eines Tasks auf dem MyBib eL Server
  • Typ: Art des Tasks
  • Status: Status des Tasks
  • Datum enqueued: Zeitpunkt, zu dem der Task hinzugefügt wurde
  • Datum scheduled: Zeitpunkt, zu dem die Bearbeitung des Tasks begonnen wurde
  • Datum processed: Zeitpunkt, zu dem die Bearbeitung des Tasks beendet wurde
  • Kommentar: Ein Kommentar zum Task

5.7.3 Aufgabe überprüfen/warten

Mit dieser Methode werden Informationen zu einer Aufgabe abgefragt, wobei im Falls noch nicht abgeschlossener Aufgaben gewartet wird, bis diese entweder beendet wurden (Status „finished“) oder eine Grenze der Wartezeit von 100 Sekunden erreicht wurde.

Methodenname: checkForTaskCompletion

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
task idId eines Tasks, auf dessen Abschluss gewartet werden soll

Rückgabe: Informationen zum Task, folgende Details werden zurückgegeben:

  • Task Id: Id zur Identifizierung eines Tasks auf dem MyBib eL Server
  • Typ: Art des Tasks
  • Status: Status des Tasks
  • Datum enqueued: Zeitpunkt, zu dem der Task hinzugefügt wurde
  • Datum scheduled: Zeitpunkt, zu dem die Bearbeitung des Tasks begonnen wurde
  • Datum processed: Zeitpunkt, zu dem die Bearbeitung des Tasks beendet wurde
  • Kommentar: Ein Kommentar zum Task

5.7.4 Aufgabe löschen

Mit dieser Methode können Tasks, deren Bearbeitung noch nicht begonnen wurde, gelöscht werden. So kann deren Abarbeitung verhindert werden.

Methodenname: removeTask

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Nutzers
task idId einer Aufgabe, die gelöscht werden soll

Rückgabe: –

5.8 Transfer Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???Import-/Exportverwaltung (neu)

Der Transfer Webservice wird verwendet, um Dokumente in den MyBib eL Server einzuchecken bzw. auszuchecken oder zu exportieren. Hierbei ist zu beachten, das grundsätzlich keine Dokumente über den Webservice selbst gesendet werden. Vielmehr wird mitgeteilt, wo ein Dokument auf dem MyBib eL Server zu finden ist, welches importiert werden soll, bzw. wo ein zu exportierendes Dokument gespeichert werden soll.
Wichtig: Die Aktionen zu Dokumentbewegungen werden durch die Methodenaufrufe dieses Webservices nicht unmittelbar gestartet, sondern in eine Warteschlange (Task Queue) eingereiht, die automatisch sequentiell in der Reihenfolge des Eintreffens der Tasks auf dem Server abgearbeitet wird.

5.8.1 Dokumente einchecken

Mit dieser Methode kann nach dem Upload von Dokumenten in einem der unterstützten Importformate dem MyBib eL Server mitgeteilt werden, dass er diese Dokumente einchecken soll. Hierbei wird eine Liste mit Dateinamen übergeben, um explizit nur diese Dokumente einzuchecken.

Methodenname: checkinDocument

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
file namesListe mit Dateinamen (absolute Pfade), die eingecheckt werden sollen

Rückgabe: Task Id des Checkin Tasks, der im MyBib eL erzeugt und in die Queue zur Abarbeitung eingereiht wurde.

5.8.2 Dokumente auschecken

Diese Methode wird verwendet, um Dokumente aus dem MyBib eL Server auszuchecken (es ist dann nicht mehr im Datenbestand des Lesesaals verfügbar). Hierbei wird das auszucheckende Dokument wieder in das XML-Format umgewandelt, welches es beim Import hatte und dann im Checkout-Verzeichnis abgelegt.
Wichtig: Es sind ggf. nicht mehr alle Metadaten vorhanden, die das ursprüngliche Dokument beim Checkin hatte. (Der Lesesaal speichert abhängig vom Dokumentformat nur eine Teilmenge der Dokumentmetadaten, die für die Verarbeitung im Lesesaal relevant sind.)

Methodenname: checkoutDocument

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idsListe mit Dokument Ids, die ausgecheckt werden sollen

Rückgabe: Task Id des Checkout Tasks, der im MyBib eL erzeugt und in die Queue zur Abarbeitung eingereiht wurde.

5.8.3 Dokumente löschen

Diese Methode wird verwendet, um Dokumente aus dem MyBib eL Server löschen. Im Gegensatz zur Checkout Methode, bei der Dokumente ausgespeichert werden, bevor sie aus dem Lesesaal entfernt werden, werden die Dokumente hier tatsächlich gelöscht, d.h. sie sind nach dem Löschvorgang weder im Datenbestand des Lesesaals noch im XML-Format im Checkout-Verzeichnis verfügbar.

Methodenname: deleteDocument

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idsListe mit Dokument Ids, die gelöscht werden sollen

Rückgabe: Task Id des Delete Document Tasks, der im MyBib eL erzeugt und in die Queue zur Abarbeitung eingereiht wurde.

5.8.4 Dokumente exportieren

Diese Methode kann zum Exportieren von Dokumenten genutzt werden. Analog zur Methode checkoutDocument werden die Dokumente in ihrem ursprünglichen XML-Format ausgespeichert. Der Unterschied zwischen diesen beiden Methoden ist, dass ein Export die Dokumente nicht aus dem Mybib eL Server löscht.

Methodenname: exportDocument

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
document idsListe mit Dokument Ids, die exportiert werden sollen

Rückgabe: Task Id des Export Document Tasks, der im MyBib eL erzeugt und in die Queue zur Abarbeitung eingereiht wurde.

5.8.5 Checkin Metadaten abfragen

Die Methode zum abfragen der Checkin-Metadaten wird verwendet, um in Erfahrung zu bringen, wie man einem MyBib eL Server neue Dokumente für den Checkin bereitstellt.

Methodenname: getCheckinConnectionMetadata

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients

Rückgabe: connection metadata, beinhaltet folgende Informationen:

  • URI: Protokoll und Pfad, wo Dokumente zum Checkin abgelegt sein müssen
  • Benutzer: Benutzername, um sich für den Upload über die URI mit dem Server zu verbinden
  • Passwort: Passwort, um sich für den Upload über die URI mit dem Server zu verbinden

5.8.6 Checkout Metadaten abfragen

Die Methode zum Abfragen der Checkout-Metadaten wird verwendet, um in Erfahrung zu bringen, wo der MyBib eL Server ausgecheckte bzw. exportierte Dokumente bereitstellt.

Methodenname: getCheckoutConnectionMetadata

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients

Rückgabe: connection metadata, beinhaltet folgende Informationen:

  • URI: Protokoll und Pfad wo sich die Dokumente zum abholen befinden
  • Benutzer: Benutzername um sich über die URI mit dem Server zu verbinden
  • Passwort: Passwort um sich über die URI mit dem Server zu verbinden

5.9 Workstation Webservice
Abschnitt hinzufügen

MyBib eL VersionWebservice VersionÄnderung
1.4.x1.x???eigener Webservice

Der Workstation Webservice ist für die Verwaltung von Workstations bzw. Clients vorgesehen.

5.9.1 Workstation Registrierung

Diese Methode wird verwendet, um eine neue Workstation auf dem MyBib eL Server zu registrieren oder die Registrierungsinformationen bereits registrierter Workstations anzupassen.
Der Registrierungsstatus einer Workstation kann entweder mittels eines Aktivierungscodes/Autorisierungscodes bereits während der Registrierung aktiviert werden oder aber die Workstation kann nur registriert und zu einem späteren Zeitpunkt aktiviert werden.

Methodenname: registerWorkstation

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
node idId der Workstation, die registriert/deren Registrierung modifiziert werden soll
computer nameName der Workstation
activation codeAktivierungscode
registrar nameRegistrierer
authorization codeAutorisierungscode
commentKommentar zur Workstation

Rückgabe: Registrierungsstatus der Workstation, folgende Werte sind möglich:

  • aktiviert: Die Workstation hat Zugriff auf den MyBib eL Server
  • wartend: Die Workstation ist noch nicht freigeschaltet
  • deaktiviert: Die Workstation wurde deaktiviert

5.9.2 Workstation Registrierung entfernen

Diese Methode wird verwendet, um die Registrierung einer Workstation vom MyBib eL Server zu entfernen. D.h. nach der Entfernung ist die Workstation dem Server nicht mehr bekannt. (Soll sie weiter/wieder genutzt werden, ist eine erneute Registrierung erforderlich.)

Methodenname: unregisterWorkstation

Parameter:

NameBeschreibung
session idId einer gültigen Session des angemeldeten Webservice Clients
node idId der Workstation, deren Registrierung entfernt werden soll

Rückgabe: –