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 |
| getNames | Gibt eine Liste mit den Ids und Namen aller Datensätze einer VerbaAlpina-Version zurück. | CSV | – | version |
| 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: 202, 201, 192, 191, 182, 181, 172, 171, 162, 161 | [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 |
Beispiele
- Liste aller Namen in Version 18/2 (dauert einige Sekunden):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getNames&version=182 - Name des Datensatzes S134468 in Version 18/2:
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getName&id=S134468&version=182 - Datensatz zum Konzept C1 in Version 18/2 (XML Format ohne leere Tags):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getRecord&id=C1&version=182&format=xml&empty=0