Klöster und Stifte des Alten Reiches – Datenservice

Dokumentation der API-Schnittstelle

 

Endpunkte:

/v1/monasteries/list gibt eine gefilterte Liste der Klöster zurück.  

Parameter: 

q - Definiert eine Abfrage, um die Liste der Klöster zu filtern. Syntax eines Attributblocks [q[Index][field|operator|value]=Wert]. Ein Attributblock besteht aus drei Teilen. 

Field - definiert den internen Namen des Suchfeldes. Diese Feldnamen sind möglich: location, patrocinium, number, dateOrderFrom, dateOrderTo, state, personName, diocese, order, gender. 

Operator - definiert den Vergleichsoperator. Momentan steht nur der Operator "gleich" (eq) zur Verfügung. 

Value - definiert den Suchbegriff. Mehrere Attributblöcke können hintereinander verkettet werden, dabei muss der Index jeweils um eins erhöht werden.  Attributblöcke werden intern untereinander mit AND verknüpft. 

Beispiel: https://api.gs.sub.uni-goettingen.de/v1/monasteries/list?q[0][field]=location&q[0][operator]=eq&q[0][value]=aachen&q[1][field]=patrocinium&q[1][operator]=eq&q[1][value]=adalbert&q[2][field]=patrocinium&q[2][operator]=eq&q[2][value]=maria

limit - Schränkt das Resultat ein. Wird für die Paginierung verwendet. Standardwert ist 30.

offset - Verschiebt das Resultat um die gegebene Zahl. Wird für die Paginierung verwendet. Standardwert ist 0. 

Beispiel für Paginierung zur Seite 2: https://api.gs.sub.uni-goettingen.de/v1/monasteries/list?limit=30&offset=30

Beispiel für Paginierung zur Seite 3 https://api.gs.sub.uni-goettingen.de/v1/monasteries/list?limit=30&offset=60

 


/v1/monasteries/locations/{format}

Gibt ein parametrisiertes Ergebnis für Klosterstandorte zurück. Die Ausgabe kann hier in unterschiedlichen Formaten erfolgen. Zurzeit steht nur das Format "geojson" zur Verfügung. Wird der Endpunkt ohne Formatangabe aufgerufen (also bspw. nur https.//api.gs.sub.uni-goettingen.de/v1/monasteries/locations), so wird ein nach Koordinaten gruppiertes Resultat zurückgegeben, welches als Key/Value-Paare zu verstehen ist. Dabei ist jeweils einem Schlüssel aus Lat/Lng Koordinaten ein Array aus Klöstern an diesem Ort zugeordnet (unterscheidbar durch GSN).

Parameter:

q - Siehe oben

Beispiel: https://api.gs.sub.uni-goettingen.de/v1/monasteries/locations/geojson?q[0][field]=location&q[0][operator]=eq&q[0][value]=aachen

 

/v1/monasteries/facet/{field}     

Gibt eine Facettierung für das gegebene Attribut zurück. Jedes Element beinhält den genauen Wert und Anzahl der Vorkommen für dieses Attribut. Mögliche Attribute: diocese, order, gender.

Beispiel: https://api.gs.sub.uni-goettingen.de/v1/monasteries/facet/diocese      

 


/v1/monastery/{gsn}/{format}

Gibt den Datensatz für ein einzelnes Kloster zurück. Es ist außerdem möglich, diesen Datensatz in verschiedenen Linked-Data-Formaten auszugeben. Mögliche Formate: jsonld, turtle, rdfxml. Wird kein explizites Format angegeben, so wird JSON ausgegeben.

Beispiele:

https://api.gs.sub.uni-goettingen.de/v1/monastery/2077      

https://api.gs.sub.uni-goettingen.de/v1/monastery/2077/jsonld         


/v1/orders                         

Gibt eine Liste der Orden zurück.


/v1/monasteries/suggest

Gibt eine Liste von Vorschlägen zu einem Suchbegriff zurück. 

Parameter:

attribute - Das Attribut, zu dem Vorschläge zurückgegeben werden sollen. Mögliche Attribute: location, patrocinium, number, dateOrderFrom, dateOrderTo, state, personName.     

value - Suchbegriff.

Beispiel: https://api.gs.sub.uni-goettingen.de/v1/monasteries/suggest?field=location&value=aa


/v1/monasteries/diocese-borders

Gibt die Bistumsgrenzen im GeoJSON Format zurück.

Vokabulare:

kloster => http://klosterdatenbank.germania-sacra.de/gsn/
foaf => http://xmlns.com/foaf/0.1/
rdf => http://www.w3.org/1999/02/22-rdf-syntax-ns#
prov => http://www.w3.org/ns/prov#
gnd => http://d-nb.info/gnd/
license => https://creativecommons.org/licenses/by-sa/3.0/
dcterms => http://purl.org/dc/terms/
skos => http://www.w3.org/2004/02/skos/core#
rdfs => http://www.w3.org/2000/01/rdf-schema#
dbpedia-ontology => http://dbpedia.org/ontology/
geo => http://www.w3.org/2003/01/geo/wgs84_pos#
role => http://purl.org/vocab/participation/schema#
xsd => http://www.w3.org/2001/XMLSchema#