La API (eng. Application Programming Interface / ita. interfaccia di programmazione di un'applicazione) per i dati di VerbaAlpina è disponibile al seguente URL di base: https://www.verba-alpina.gwi.uni-muenchen.de/?api=1 (per esempi completi vedi sotto).
Attraverso il parametro action possono essere indicati i seguenti comandi:
COMANDO | DESCRIZIONE | formato di restituzione | parametri necessari | parametri opzionali |
---|---|---|---|---|
getIds | Restituisce una lista con gli Ids di tutti i record in una versione di VerbaAlpina. | CSV | - | version |
getNames | Restituisce una lista con gli Ids e i nomi di tutti i record di una versione di VerbaAlpina. | CSV | - | version |
getName | Restituisce il nome di uno specifico record. | CSV | id | version |
getRecord | Restituisce un unico record. | CSV oppure definito attraverso format | id | version, format, empty |
Ulteriori parametri:
parametro | descrizione | valori |
---|---|---|
version | Indicazione della versione di VerbaAlpina. Qualora non venga inserita alcuna versione, verrà applicata la più recente versione di citazione. Al momento sono disponibili le seguenti versioni: 232, 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161 | [0-9][0-9][1-2] |
id | Indicazione dell'Id di un singolo record | [A-Z][1-9][0-9]* |
format | Formato di restituzione con il comando getRecord (Default: csv) | csv, xml, json |
changed | Qualora questo valore sia 1, getIds e getNames restituiranno solo record che sono cambiati rispetto all'ultima versione | csv, xml, json |
empty | Qualora il parametro empty sia pari a 0, nel comando getRecord e nel formato di output XML i tag XML vuoti non verranno indicati | 1 oppure 0 |
Esempi
- Lista di tutti i nomi nella versione 18/2 (necessita di alcuni secondi):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getNames&version=182 - Nome del record S134468 nella versione 18/2:
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getName&id=S134468&version=182 - Record del concetto C1 nella versione 18/2 (Formato XML senza tag vuoti):
https://www.verba-alpina.gwi.uni-muenchen.de/?api=1&action=getRecord&id=C1&version=182&format=xml&empty=0