{"id":8844,"date":"2019-01-10T16:08:47","date_gmt":"2019-01-10T15:08:47","guid":{"rendered":"https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/?page_id=8844&db=xxx"},"modified":"2023-06-16T14:15:57","modified_gmt":"2023-06-16T12:15:57","slug":"apidoku","status":"publish","type":"page","link":"https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/?page_id=8844&db=232","title":{"rendered":"API Dokumentation"},"content":{"rendered":"

Die API f\u00fcr die Daten von VerbaAlpina steht unter der Basis-URL<\/span> https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/?api=1 (f\u00fcr vollst\u00e4ndige Beispiele siehe unten) zur Verf\u00fcgung.<\/p>\n

Folgende Befehle k\u00f6nnen \u00fcber den\u00a0action<\/b>-Parameter angegeben werden:<\/p>\n\n\n\n\n\n\n\n\n\n
Befehl<\/th>\nBeschreibung<\/th>\nR\u00fcckgabeformat<\/th>\nNotwendige Parameter<\/th>\nOptionale Parameter<\/th>\n<\/tr>\n
getIds<\/td>\nGibt eine Liste mit den Ids aller Datens\u00e4tze einer VerbaAlpina-Version zur\u00fcck.<\/td>\nCSV<\/td>\n-<\/td>\nversion, changed, class, type_lang, download<\/td>\n<\/tr>\n
getNames<\/td>\nGibt eine Liste mit den Ids und Namen aller Datens\u00e4tze einer VerbaAlpina-Version zur\u00fcck.<\/td>\nCSV<\/td>\n-<\/td>\nversion, changed, class, type_lang, download<\/td>\n<\/tr>\n
getName<\/td>\nGibt den Namen f\u00fcr einen bestimmten Datensatz zur\u00fcck.<\/td>\nCSV<\/td>\nid<\/td>\nversion<\/td>\n<\/tr>\n
getRecord<\/td>\nGibt einen einzelnen Datensatz zur\u00fcck.<\/td>\nCSV oder durch format<\/i> festgelegt<\/td>\nid<\/td>\nversion, format, empty, download<\/td>\n<\/tr>\n
getTextList<\/td>\nGibt eine Liste mit den Ids aller Texte einer VerbaAlpina-Version zur\u00fcck. Diese enth\u00e4lt zus\u00e4tzlich Informationen \u00fcber die Titel der Texte und deren Autoren.<\/td>\nCSV oder durch format<\/i> festgelegt<\/td>\n-<\/td>\nversion, format, download<\/td>\n<\/tr>\n
getText<\/td>\nGibt einen einzelnen Text zur\u00fcck.<\/td>\nHTML<\/td>\nid<\/td>\nversion, download<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Weitere Parameter:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nBeschreibung<\/th>\nWerte<\/th>\n<\/tr>\n
version<\/td>\nAngabe der VerbaAlpina-Version. Wenn keine Version angegeben wird, wird die j\u00fcngste Zitierversion verwendet. Aktuell gibt es folgende Versionen: 232, 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161. F\u00fcr die jeweils aktuelle Version kann der Platzhalter \"latest\" verwendet werden.<\/td>\n[0-9][0-9][1-2]<\/td>\n<\/tr>\n
id<\/td>\nAngabe der Id eines Datensatzes<\/td>\n[A-Z][1-9][0-9]*<\/td>\n<\/tr>\n
format<\/td>\nAusgabeformat beim Befehl getRecord<\/b> oder getTextList<\/b> (Default: csv)<\/td>\ncsv, xml, json (letzteres nur bei getRecord<\/b>)<\/td>\n<\/tr>\n
changed<\/td>\nWenn dieser Wert 1 ist, werden bei getIds<\/b> und getNames<\/b> nur Datens\u00e4tze zur\u00fcckgegeben, die sich seit der letzten Version ge\u00e4ndert haben.<\/td>\n1 oder 0<\/td>\n<\/tr>\n
empty<\/td>\nWenn der Parameter empty<\/b> gleich 0 ist, werden beim Befehl\u00a0getRecord<\/b> und dem Ausgabeformat XML leere XML-Tags nicht mit angegeben.<\/td>\n1 oder 0<\/td>\n<\/tr>\n
class<\/td>\nBei getIds<\/b> und getNames<\/b> werden nur Werte der entsprechenden Klasse zur\u00fcckgegeben (C = Konzepte, L = morpho-lexikalische Typen, A = Gemeinden, S = Einzelbelege).<\/td>\nC, L, A, S<\/td>\n<\/tr>\n
type_lang<\/td>\nBei getIds<\/b> und getNames<\/b> werden nur die morpho-lexikalische Typen aus der entsprechenden Sprachfamilie zur\u00fcckgegeben.<\/td>\ngem, roa, sla<\/td>\n<\/tr>\n
download<\/td>\nWenn dieser Wert auf 0 gesetzt wird, wird keine herunterladbare Datei erstellt, sondern das Ergebnis im Browser angezeigt.<\/td>\n1 oder 0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Beispiele<\/h3>\n