The API for the data of VerbaAlpina is available under the URL https://www.verba-alpina.gwi.uni-muenchen.de/?api=1 (for complete examples see below).
The following commands can be issued using the action parameter:
COMMAND | DESCRIPTION | RETURN FORMAT | NECESSARY ParameterS | Optional ParameterS |
---|---|---|---|---|
getIds | Returns a list with the Ids of all datasets of a VerbaAlpina version. | CSV | - | version |
getNames | Returns a list with the IDs and names of all datasets of a VerbaAlpina version. | CSV | - | version |
getName | Returns the name of a specific dataset. | CSV | id | version |
getRecord | Returns a single dataset. | CSV or defined by format | id | version, format, empty |
Further parameters:
Parameter | DESCRIPTION | VALUES |
---|---|---|
version | Indication of the VerbaAlpina version. If no version is indicated, the most recent citation version is used. The following versions are currently available: 232, 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161 | [0-9][0-9][1-2] |
id | Indication of the ID of a dataset | [A-Z][1-9][0-9]* |
format | Output format for the getRecord command (Default: csv) | csv, xml, json |
changed | If this value is 1, getIds and getNames will only return datasets that have changed since the last version. | csv, xml, json |
empty | If the parameter empty is 0, empty XML tags are not indicated in the getRecord command and the output format XML. | 1 or 0 |
Examples
- List of all names in version 18/2 (takes a few seconds):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getNames&version=182 - Name of data set S134468 in version 18/2:
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getName&id=S134468&version=182 - Data set for the concept C1 in version 18/2 (XML format without empty tags):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getRecord&id=C1&version=182&format=xml&empty=0