API Dokumentation

Die API für die Daten von VerbaAlpina steht unter der Basis-URL https://www.verba-alpina.gwi.uni-muenchen.de/?api=1 (für vollständige Beispiele siehe unten) zur Verfügung.

Folgende Befehle können über den action-Parameter angegeben werden:

Befehl Beschreibung Rückgabeformat Notwendige Parameter Optionale Parameter
getIds Gibt eine Liste mit den Ids aller Datensätze einer VerbaAlpina-Version zurück. CSV - version, changed, class, type_lang, download
getNames Gibt eine Liste mit den Ids und Namen aller Datensätze einer VerbaAlpina-Version zurück. CSV - version, changed, class, type_lang, download
getName Gibt den Namen für einen bestimmten Datensatz zurück. CSV id version
getRecord Gibt einen einzelnen Datensatz zurück. CSV oder durch format festgelegt id version, format, empty, download
getTextList Gibt eine Liste mit den Ids aller Texte einer VerbaAlpina-Version zurück. Diese enthält zusätzlich Informationen über die Titel der Texte und deren Autoren. CSV oder durch format festgelegt - version, format, download
getText Gibt einen einzelnen Text zurück. HTML id version, download

Weitere Parameter:

Parameter Beschreibung Werte
version Angabe der VerbaAlpina-Version. Wenn keine Version angegeben wird, wird die jüngste Zitierversion verwendet. Aktuell gibt es folgende Versionen: 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161. Für die jeweils aktuelle Version kann der Platzhalter "latest" verwendet werden. [0-9][0-9][1-2]
id Angabe der Id eines Datensatzes [A-Z][1-9][0-9]*
format Ausgabeformat beim Befehl getRecord oder getTextList (Default: csv) csv, xml, json (letzteres nur bei getRecord)
changed Wenn dieser Wert 1 ist, werden bei getIds und getNames nur Datensätze zurückgegeben, die sich seit der letzten Version geändert haben. 1 oder 0
empty Wenn der Parameter empty gleich 0 ist, werden beim Befehl getRecord und dem Ausgabeformat XML leere XML-Tags nicht mit angegeben. 1 oder 0
class Bei getIds und getNames werden nur Werte der entsprechenden Klasse zurückgegeben (C = Konzepte, L = morpho-lexikalische Typen, A = Gemeinden, S = Einzelbelege). C, L, A, S
type_lang Bei getIds und getNames werden nur die morpho-lexikalische Typen aus der entsprechenden Sprachfamilie zurückgegeben. gem, roa, sla
download Wenn dieser Wert auf 0 gesetzt wird, wird keine herunterladbare Datei erstellt, sondern das Ergebnis im Browser angezeigt. 1 oder 0

Beispiele