API steht für "application programming interface", zu Deutsch ‚Anwendungsprogrammierschnittstelle'. Eine solche stellt VerbaAlpina unter der Adresse https://www.verba-alpina.gwi.uni-muenchen.de/?api=1 zur Verfügung. Die nachfolgende Dokumentation der dort zu verwendenden Syntax findet sich auch in folgendem Beitrag: API Dokumentation. Die API erlaubt es, gezielt bestimmte Inhalte aus der VA-Datenbank (VA_DB) in definierten Formaten über einen Browser abzurufen. Die Auswahl der Daten und das Ausgabeformat werden dabei durch URL-Parameter gesteuert.

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:

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
getNames Gibt eine Liste mit den Ids und Namen aller Datensätze einer VerbaAlpina-Version zurück. CSV - version, changed, class, type_lang
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
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: [version_list format="simple"]. 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 (Default: csv) csv, xml, json
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. csv, xml, json
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

Beispiele