Sicherheits-Parameter

Name Typ Beschreibung
systemPartner String Partnername (wird direkt von YellowMap bereitgestellt).
securityId String Zugangsschlüssel (wird direkt von YellowMap bereitgestellt).

Allgemeine Parameter

Name Typ Beschreibung
bBox String Rahmen des Kartenausschnitts ("bounding box"), mit dem kleinsten Wert der x- und y-Achse gefolgt vom größten Wert. Die Werte sind durch Komma getrennt.
Beispiel: -10.0,-10.0,10.0,10.0.
center String Die Koordinaten des Kartenmittelpunkts, mit dem kleinsten Wert gefolgt vom größten Wert. Die Werte sind durch Komma getrennt.
Beispiel: 10.0,10.0.
channel String Beliebige Zeichenfolge, die protokolliert wird und dazu dient, den Aufruf später zu identifizieren. Sie kann frei gewählt werden.
contentType String Wenn auf application/json oder application/vnd.geo+json gesetzt, kommt ein JSON-Objekt zurück; in allen anderen Fällen eine Base-64-Zeichenfolge des Bildes.
crsName String Der Name des Koordinaten-Refernzesystems ("coordinate reference system by name") für die Koordinaten, die an den Service übergeben werden.
See geojson.org
imageType String Einer der beiden folgenden Werte: JPG oder PNG
isoLocale String Die ISO-Angabe zum Local; für Deutschland zum Beispiel "de-DE" (Voreinstellung).
mapAddresses String Format: LAND|PLZ|STADT|TEILORT|STRASSE|HOUSENUMMER|BILDNAME^
LAND|PLZ|STADT|TEILORT|STRASSE|HOUSENUMMER|BILDNAME^[...]
mapAsBase64 String true or false (Standard). Nur relevant für die JSON-Rückgabe. Aus Performance-Gründen ist die Rückgabe der Karte als Base64-Zeichenfolge deaktiviert. Dem Kunden steht immer der Link auf die Karte zur Verfügung.
mapLines String In der Karte einzuzeichnende Linien. Mehrere Linine sind durch das Zeichen ^ getrennt.
Format: X1 Y1 X2 Y2 X3 Y3^X4 Y4^[...]
mapLinesColor String Die Farben der in die Karte einzuzeichnenden Linien. Vier hexadezimale Werte für den Alpha-Kanal, Rot, Grün und Blau. Sind weniger Werte als Anzahl Linien vorhanden, wird für fehlende Angaben der erste Wert für die restlichen Linien übernommen.
Format: FFAABBCC^FFAABBCC^[...]
mapLinesWidth String Die Linienbreiten der in die Karte einzuzeichnenden Linien. Sind weniger Werte als Anzahl Linien vorhanden, wird für fehlende Angaben der erste Wert für die restlichen Linien übernommen.
Format: X1 Y1 X2 Y2 X3 Y3^X4 Y4^[...]
mapPoints String Format: X|Y|BILDNAME^X|Y|BILDNAME[...]
mapScale String Maßstab: 01 (Meter/Kilometer, Standardwert) oder 2 (Yard/Miles).
radius Unsigned Integer Radius in Meter.
size String Angabe der Breite gefolgt von der Höhe, getrennt durch Komma: WIDTHxHEIGHT
Die Größe ist beschränkt auf 2048 x 2048 Pixel. Die minimale Größe ist 100 x 100 Pixel.
Beispiel: 100x200

Parameters by Interface

Name der Schnittstelle Parameter
mapByLocation Notwendige Parameter:
center, crsName, radius
systemPartner, securityId

Optional u. a.:
size, isoLocale, imageType, mapProvider, 
mapPoints (als Markierung in der Karte), mapScale
mapByRect Notwendige Parameter:
bBox, crsName
systemPartner, securityId

Optional u. a.:
size, isoLocale, imageType, mapProvider, 
mapPoints (als Markierung in der Karte), mapScale
mapByAddress Notwendige Parameter:
mapAddresses, radius
systemPartner, securityId

Optional u. a.:
size, isoLocale, imageType, mapProvider, 
mapPoints (als Markierung in der Karte), mapScale
mapByPoints Notwendige Parameter:
mapPoints
systemPartner, securityId

Optional u. a.:
radius (falls nur ein einziger Punkt), size, isoLocale, imageType, mapProvider, mapScale