{"id":1780,"date":"2020-09-10T12:30:52","date_gmt":"2020-09-10T10:30:52","guid":{"rendered":"https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/en\/?page_id=1780&db=xxx"},"modified":"2023-06-16T14:15:58","modified_gmt":"2023-06-16T12:15:58","slug":"api-documentation","status":"publish","type":"page","link":"https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/en\/?page_id=1780&db=232","title":{"rendered":"API documentation"},"content":{"rendered":"

The API for the data of VerbaAlpina is available under the URL<\/span> https:\/\/www.verba-alpina.gwi.uni-muenchen.de\/?api=1 (for complete examples see below).<\/p>\n

The following commands can be issued using the action<\/strong> parameter:<\/p>\n\n\n\n\n\n\n\n
COMMAND<\/th>\nDESCRIPTION<\/th>\nRETURN FORMAT<\/th>\nNECESSARY ParameterS<\/th>\nOptional ParameterS<\/th>\n<\/tr>\n
getIds<\/td>\nReturns a list with the Ids of all datasets of a VerbaAlpina version.<\/td>\nCSV<\/td>\n-<\/td>\nversion<\/td>\n<\/tr>\n
getNames<\/td>\nReturns a list with the IDs and names of all datasets of a VerbaAlpina version.<\/td>\nCSV<\/td>\n-<\/td>\nversion<\/td>\n<\/tr>\n
getName<\/td>\nReturns the name of a specific dataset.<\/td>\nCSV<\/td>\nid<\/td>\nversion<\/td>\n<\/tr>\n
getRecord<\/td>\nReturns a single dataset.<\/td>\nCSV or defined by format<\/i><\/td>\nid<\/td>\nversion, format, empty<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Further parameters:<\/p>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDESCRIPTION<\/th>\nVALUES<\/th>\n<\/tr>\n
version<\/td>\nIndication of the VerbaAlpina version. If no version is indicated, the most recent citation version is used. The following versions are currently available:\u00a0232, 231, 222, 221, 212, 211, 202, 201, 192, 191, 182, 181, 172, 171, 162, 161<\/td>\n[0-9][0-9][1-2]<\/td>\n<\/tr>\n
id<\/td>\nIndication of the ID<\/span> of a dataset<\/td>\n[A-Z][1-9][0-9]*<\/td>\n<\/tr>\n
format<\/td>\nOutput format for the getRecord\u00a0<\/b>command (Default: csv)<\/td>\ncsv, xml, json<\/td>\n<\/tr>\n
changed<\/td>\nIf this value is 1, getIds<\/strong> and getNames<\/strong> will only return datasets that have changed since the last version.<\/td>\ncsv, xml, json<\/td>\n<\/tr>\n
empty<\/td>\nIf the parameter empty<\/strong> is 0, empty XML tags are not indicated in the getRecord<\/strong> command and the output format XML.<\/td>\n1 or 0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Examples<\/h3>\n