Aufbau der Anfragen
URLs werden mit der Basis
https://karte.fau.de/api/v1/[format]/
und im Anschluss daran die optionalen Elemente in beliebiger Reihenfolge folgendermaßen
[name1]/[wert1]/[name2]/[wert2]/...
aufgebaut.
Die möglichen Ausgabeformate:
Name | Beschreibung | Mögliche Werte | Standardwert | optional |
---|---|---|---|---|
format | Ausgabeformat | iframe , geojson oder csv |
nein |
Parameter
Angezeigte Geodaten
Das Suchergebnis lässt sich mit folgenden Parametern beeinflussen:
Name | Beschreibung | Mögliche Werte | Standardwert | optional |
---|---|---|---|---|
term | Suchbegriff | URL-encodierter String | ja | |
address | Adresse | URL-encodierter String, bestehend aus kommagetrennten Adressbestandteilen | ja | |
org | Organisationsnummer | bis zu zehnstellige Ganzzahl | ja | |
famos | Gebäudenummer | bis zu fünfstellige Ganzzahl | ja | |
bbox | Grenzkoordinaten | Länge 1,Breite 1,Länge 2,Breite 2 |
ja |
Formatierung der generierten Karte
Beim Format iframe
wird eine dynamische Karte mit der Leaflet-Bibliothek erzeugt. Die Darstellung dieser Karte lässt sich mit folgenden Attributen steuern:
Name | Beschreibung | Mögliche Werte | Standardwert | optional |
---|---|---|---|---|
desc | Beschreibung | normal oder verbose . Bei verbose werden zusätzlich Organisations- und Gebäudenummer ausgegeben |
normal |
ja |
center | Kartenmittelpunkt | Breite,Länge |
ja | |
zoom | Zoomstufe | 1-19 |
ja | |
zoomcontrol | Auswahl zwischen Standard-Zoomregler oder Zoomslider | on , slider oder off |
on |
ja |
layercontrol | Ebenenauswahl | on oder off |
off |
ja |
layer | Eingebundene Ebenen | Liste von durch Komma getrennten Namen oder Ganzzahlen. Eine Übersicht aller möglichen Ebenen findet sich beim Kartengenerator. | RRZE ,RRZE.DE ,Esri.WorldImagery ,Bayern ,Erlangen ,Stamen.Toner ,OpenTopoMap ,Wikimedia |
ja |
cluster | Aufteilung der Ergebnisse auf der Karte in Gruppen durch das MarkerCluster-Plugin für Leaflet | on oder off |
on |
ja |
geolocation | Gibt dem Betrachter die Möglichkeit, die eigene Position auf der Karte anzeigen zu lassen. Dazu wird das Leaflet-Plugin Leaflet.Locate verwendet. | on oder off |
off |
ja |
searchcontrol | Fügt der Karte ein Suchfeld hinzu. | on (äquivalent zu term ), address , org , famos oder off |
off |
ja |
Ausgabeformat
Die Antwort beim Format geojson
erfolgt im GeoJSON-Format.
Bei iframe
wird der generierte IFrame direkt zurückgegeben.
Generator
Mit dem Generator können Sie Ausgaben in verschiedenen Formaten erzeugen.
Beispiele
-
Alle Standorte der Bibliotheken im GeoJSON-Format:
https://karte.fau.de/api/v1/geojson/org/101111
-
Alle Standorte der Bibliotheken als einbettbare Karte:
https://karte.fau.de/api/v1/iframe/org/101111
-
Alle Standorte der Bibliotheken in Erlangen als einbettbare Karte mit "Stamen.Toner"-Ebene:
https://karte.fau.de/api/v1/iframe/org/101111/address/erlangen/layer/Stamen.Toner
-
Alle zentralen Einrichtungen als einbettbare Karte mit Zoomschieber:
https://karte.fau.de/api/v1/iframe/org/1011/zoomcontrol/slider
-
Karte mit Suche anhand der Organisationsnummer und ausführlicher Beschreibung:
https://karte.fau.de/api/v1/iframe/searchcontrol/org/desc/verbose
-
Karte mit Suche anhand der Adresse:
https://karte.fau.de/api/v1/iframe/searchcontrol/address