Diese Seite beschreibt beispielhaft und für Laien verständlich, welche Aufgaben die ZHistLex Webservices wie umsetzen. Generell sind Webservices eine Form technischen Zugriffs auf Wörterbuchdaten bei der ein Server unabhängig von einer graphischen Oberfläche Anfragen anderer Computer selbsständig beantwortet. Somit können Webservices sowohl von Menschen als auch Programmen genutzt werden. Die sog. Spezifikation gibt an, wie eine Anfrage formuliert sein muss, damit ein Webservice (oder eine Familie gleich spezifizierter Webservices auf verschiedenen Ressourcen, wie es die ZHistLex Services sind) diese verstehen kann.
Schritt 1 – Formulieren einer Anfrage
Eine Anfrage besteht bei ZHistLex aus der URI des Webservices, sowie der Anfrage. Diese wiederum muss zuerst angeben, ob Wörterbücher, Quellen oder Textstellen gesucht werden. Danach wird angegeben, welche Art Informationen zurückgegeben werden sollen: Lemmalisten, Wörterbuchartikel, Autorenlisten, bibliographische Angaben, … Schließlich kann noch zwischen reiner Stringsuche und regulären Ausdrücken gewählt werden.
Eine solche Beispielanfrage ist
http://urts55.uni-trier.de:8111/api/Lexer/dictionaries/entries;fulltext=sollen
Hier gibt alles bis und inklusive “Lexer” die Basis-URI des Webservice an. “dictionaries/entries;” spezifiziert, dass es sich um eine Suche nach Einträgen (entries) im Wörterbuch (dictionary) handelt. Die eigentliche Suchanfrage lautet “sollen” und sie wird im Artikelvolltext (fulltext) als String (Default) gesucht. Auch eine Darstellung des hier zurückgegebenen JSON Formats im Browser ist möglich.
Schritt 2 – Absenden der Anfrage
Die Anfrage kann nun z.B. per Adresszeile des Browsers abgesendet werden oder aber über den Quellcode eines ausgeführten Programmes.
Schritt 3 – Ergebnis
Nach einer Verarbeitungszeit sendet der Webservice das zur Anfrage passende Ergebnis an den Fragenden (Mensch oder Maschine), der die Ergebnisse entsprechend weiterverarbeiten kann, ob für die manuelle Durchsuchung, die Darstellung in einer eigenen GUI oder die weitergehende informationstechnische Analyse. Enthalten die Anfragen Fehler, werden vom Webservice statt einer Antwort Fehlermeldungen generiert.