Verwendung der API

Die Transkriptionen und Register, die im Rahmen von Lessing Digital entstehen, lassen sich für die Weiterarbeit in den Computational Literary Studies (CLS) per API abfragen. Generiert werden die Schnittstellen anhand der API-Funktion von ediarum.WEB, die hier dokumentiert ist. Die genaue URL der Schnittstellen setzt sich aus der Base-URL

https://lessing-digital.hab.de/exist/apps/ediarum.lessing-digital.web

und den Parametern, die in dieser Anleitung beschrieben werden, zusammen.

Transkriptionen werden entweder im XML/TEI- oder TXT-Format zur Verfügung gestellt. Andere Wissensbestände werden in der Regel im JSON-Format ausgegeben.

Die Schnittstellen lassen sich nach Dokumenttypen abfragen. Im Fall der Impulsedition von Ernst und Falk stehen derzeit Dramen zur Verfügung:

/api/dramen

Um Metadaten zur technischen Anlage einzelner Dokumente anzuzeigen, kann die URL um den Identifier (xml:id) eines Dokuments erweitert werden:

/api/dramen/<Identifier>

Beispiel: /api/dramen/EF_DR_BSB_RES138_1778b

Transkriptionen können als TXT-Datei oder als XML/TEI-Dokument aufgerufen werden. Hierfür müssen die folgenden Parameter am Ende der URL ergänzt werden:

output=text

output=xml

Beispiel: /api/dramen/EF_DR_BSB_RES138_1778b?output=xml

Eine besonders schlanke Version der Lesefassung, die u.a. um den Stellenkommentar, Layoutinformationen und den TEI-Header bereinigt wurde, kann abgerufen werden, indem zusätzlich der Parameter "view=plain" ergänzt wird:

Beispiel: /api/lesefassungen/EF-Lesefassung?output=xml&view=plain

Um nur bestimmte Seiten einer Transkription aufzurufen, kann der folgenden Parameter verwendet werden (der Output ist immer im XML/TEI-Format):

/p-<Seitenzahl>

Beispiel: /api/dramen/EF_DR_BSB_RES138_1778b/p-30

Für die Impulsedition wurden die folgenden Register angelegt: Personen, Orte und Sachbegriffe (Freimaurerjargon). Über die Editionsseite ist zusätzlich ein Register der Zensurspuren aufrufbar. Im Laufe des Langfristvorhabens soll dieses Register ebenfalls über die API bereitgestellt werden. Die Entitäten wurden in den a-Varianten ausgezeichnet, die auch der Lesefassung von Ernst und Falk zugrunde liegen. (Auch der Stellenkommentar wurde in den a-Varianten angelegt.) Einträge der einzelnen Register lassen sich darüber abrufen, dass der folgende Endpunkt aufgerufen wird:

/api/<Register>

Beispiel: /api/personen

Einträge zu einzelnen Entitäten können angezeigt werden, indem der Identifier der Entität angehängt wird. Es handelt sich dabei um eine ID, die bei der Anlage eines Eintrags automatisch erstellt wird. Die Identifier lassen sich der Liste der Registereinträge (voriger Schritt) entnehmen.

/api/<Register>/<Identifier>

Beispiel: /api/personen/ed_zps_fg2_gbc

Fundstellen der Registereinträge lassen sich durch die folgenden Parameter ausgeben:

/api/fundstellen_personen

/api/fundstellen_orte

/api/fundstellen_sachbegriffe