Beschreibung

Die Geo-API besitzt ein eigenes User-Interface (UI), welches grundsätzliche Funktionen zum Darstellen von Adressen und Geokoordinaten auf einer Karte.

Jede VIA-Instanz bringt diese Funktionen mit, welche allerdings nur über URL-Parameter aufgerufen werden können.

Verwendung

Das Geo-API UI dient dazu, grundsätzliche Funktionen von VIA in Drittprogramme zu integrieren. Dabei müssen durch die Drittprogramme URLs mit speziellen Parametern erzeugt werden.

Darstellen eines einzelnen Geo-Punktes mit einzelnen Parametern:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt einfache URL-Parameter.

Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?lat=[längengrad]&lng=[breitengrad]&caption=[Beschreibung zum Punkt]&embed=true

Beispiel:

https://via.testing.via-cloud.de/?lat=51.7199&lng=12.1999&caption=Ihr%20%C3%BCbergebener%20Punkt&embed=true

Parameter-Name

Beschreibung

Pflicht

Beispiel

lat

Die Längengrad-Komponente

✅

51.7199

lng

Die Breitengrad-Komponente

✅

12.1999

caption

Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.

Eine Punkt-Bezeichnung

embed

Gibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.

true

marker

Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker

blue, red, green

Darstellen eines einzelnen Geo-Punktes mit einem JSON-Objekt:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt ein eindimensionales JSON-Objekt.

Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?geopoint=[JSON-Objekt]&embed=true

Beispiel:

https://app.testing.via-cloud.de/?geopoint={"lat":"51.1","lng":"12.8","caption":"Ihr Punkt"}&embed=true

Parameter-Name

Beschreibung

Pflicht

Beispiel

geopoint

Das JSON-Objekt

✅

{
"lat":"51.1",
"lng":"12.8",
"caption":"Ihr Punkt",
"marker":"green"
}

embed

Gibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.

true

Die JSON-Felder:

JSON-Feld

Beschreibung

Pflicht

Beispiel

"lat"

Die Längengrad-Komponente

✅

51.7199

"lng"

Die Breitengrad-Komponente

✅

12.1999

"caption"

Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.

Ein Freitext

"marker"

Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker

blue, red, green

Darstellen mehrerer Geo-Punkte mit einem JSON-Objekt:

Stellt den übergebenen Geo-Punkt auf einer Karte dar. Benutzt ein eindimensionales JSON-Objekt.

Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?geopoints=[JSON-Objekt]&embed=true

Beispiel:

https://app.testing.via-cloud.de/?geopoints=[{"lat": "52.1", "lng": "11.8","caption": "Punkt 1"},{"lat": "51.5","lng": "12.2"},{"lat": "50.43","lng": "13.89"}]&embed=true

Parameter-Name

Beschreibung

Pflicht

Beispiel

geopoints

Das JSON-Objekt als Array

✅

[
    {
        "lat": "52.1",
        "lng": "11.8",
        "caption": "Punkt 1"
    },
    {
        "lat": "51.5",
        "lng": "12.2"
    },
    {
        "lat": "50.43",
        "lng": "13.89"
    }
]

embed

Gibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.

true

Die JSON-Felder:

JSON-Feld

Beschreibung

Pflicht

Beispiel

"lat"

Die Längengrad-Komponente

ja

51.7199

"lng"

Die Breitengrad-Komponente

ja

12.1999

"caption"

Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.

optional

Ihr Punkt

"marker"

Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker

optional

blue, red, green

Darstellen eines einzelnen Geo-Punktes anhand einer Adresse:

Stellt die übergebene Adresse auf einer Karte dar. Benutzt einfache URL-Parameter.

Erstellen Sie eine URL nach folgendem Schema:

https://[via_instanz_url]?address=[Straße Hnr, PLZ, Ort]&caption=[Beschreibung zum Punkt]&embed=true

Beispiel:

https://app.testing.via-cloud.de/?address=Bayrische Straße 8, 01069 Dresden&caption=Ein Punkt&embed=true

Parameter-Name

Beschreibung

Pflicht

Beispiel

address

Die in Textform übergebene Adresse.

ja

Bayrische Straße 8, 01069 Dresden

caption

Die Beschriftung des Punktes. Dies wird in die Karte und die Liste übernommen und einfach angezeigt.

optional

Eine Punkt-Bezeichnung

embed

Gibt an, ob die Karte mit den UI-Elementen und Listen dargestellt werden, oder ob nur die Karte angezeigt werden soll.

optional

true

marker

Gibt dem auf der Karte gezeichneten Punkt einen farbigen Marker

optional

blue, red, green