API za podatke VerbaAlpine je pod URL https://www.verba-alpina.gwi.uni-muenchen.de/?api=1 na razpolago (za popolne primere glej spodaj).
Naslednje instrukcije se lahko navaja preko action-parametra:
| INSTRUKCIJA | OPIS | VRAČILEN Format | OBVEZNI Parametri | NEOBVEZNI Parametri |
|---|---|---|---|---|
| getIds | Vrača seznam z Ids vseh zapisov VerbaAlpina-verzije. | CSV | - | version |
| getNames | Vrača seznam z Ids in imena vseh zapisov VerbaAlpina-verzije. | CSV | - | version |
| getName | Vrača ime za določen zapis. | CSV | id | version |
| getRecord | Vrača en posamezen zapis. | CSV ali določeno s pomočjo format | id | version, format, empty |
dodatni parametri:
| Parameter | OPIS | VREDNOSTI |
|---|---|---|
| version | Navedba VerbaAlpina-verzije. Če ni navedene verzije, se uporablja najnovejšo citatno različico. Aktualno obstajajo sledeče verzije: 232, 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161 | [0-9][0-9][1-2] |
| id | Navedba od Id zapisa. | [A-Z][1-9][0-9]* |
| format | Izdajalni format pri instrukciji getRecord (Default: csv) | csv, xml, json |
| changed | Če je ta vrednost 1, se pri getIds in getNames vračajo samo zapisi, kateri so se spremenili od zadnje verzije. | csv, xml, json |
| empty | Če je parameter empty enako 0, pri instrukcijah getRecord in pri izdajalnem formatu XML niso navedene prazne XML-oznake. | 1 ali 0 |
PRIMERI
- seznam vseh imen v verziji 18/2 (traja nekaj sekund):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getNames&version=182 - ime zapisa S134468 v verziji 18/2:
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getName&id=S134468&version=182 - zapis k konceptu C1 v verziji 18/2 (XML format brez praznih oznak):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getRecord&id=C1&version=182&format=xml&empty=0