GetTravelBoundary - web_services - 23 - 23.1

Spectrum-Webdienste-Handbuch

Product type
Software
Portfolio
Integrate
Product family
Spectrum™ software
Product
Spectrum™ software > Web Services
Version
23.1
ft:locale
de-DE
Product name
Spectrum Technology Platform
ft:title
Spectrum-Webdienste-Handbuch
First publish date
2007
ft:lastEdition
2023-10-25
ft:lastPublication
2023-10-25T07:20:03.279000

Beschreibung

GetTravelBoundary bestimmt die Fahrt- oder Gehzeit bzw. die Fahrtgrenze von einer Position aus. Mit dieser Funktion werden Polygone abgerufen, die deiner Berechnung von Isochronen oder Isodistanzen entsprechen. Ein Isochron ist ein Polygon oder Satz von Punkten und stellt ein Gebiet dar, das in einem Netz von einem Startpunkt in einer gegebenen Zeitdauer traversiert werden kann. Eine Isodistanz ist ein Polygon oder Satz von Punkten und stellt das Gebiet dar, das eine bestimmte Entfernung vom Startpunkt hat. Bei dem GetTravelBoundary-Vorgang (auch als Iso-Definition bekannt) werden ein Ausgangspunkt, eine Einheit (linear Einheit oder Zeiteinheit) sowie mindestens eine Kostenangabe als Eingabe gewählt, und die resultierende Fahrtgrenze wird zurückgegeben. Kosten beziehen sich auf den Betrag der Zeit oder Entfernung, der zum Berechnen einer Iso verwendet werden soll. Es können auch mehrere Kosten als Eingabe angegeben werden. Bei mehreren Kosten können diese auch als eine durch Kommas getrennte Zeichenfolge angegeben werden.

Anmerkung: Die Antwort vom REST-Dienst erscheint im JSON-Format. Wenn eine Anforderung ungültige Abfrageparameter in der GET URL oder eine ungültige Nutzlast für POST enthält, wird eine gesammelte Fehlerantwort in einem JSON-Array zurückgegeben. Der Knoten value in der Antwort-JSON ist veraltet. Bei der Fehlerüberprüfung sollte nur der Knoten errors verwendet werden.

URL-Format von HTTP-GET-Anforderungen

Für HTTP-GET-Anforderungen wird das folgende Format verwendet. HTTP GET wird für alle Fahrtgrenzen verwendet, bei denen keine zusätzliche JSON-Nutzlast erforderlich ist (Änderungen der Umgebungsgeschwindigkeit).

HTTP GET /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&query_parameters

Dabei steht dbsource für den Namen der Datenbank, die die für die Route zu verwendenden Daten enthält. Verwenden Sie den Datenbanknamen, der im Routing-Datenbankressourcentool des Enterprise Routing-Moduls angegeben ist.

URL-Format von HTTP-POST-Anforderungen

Für HTTP-POST-Anforderungen wird das folgende Format verwendet:

HTTP POST:  /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&query_parameters POST BODY: Content-Type:application/json {Route Data}			

Route Data stellt den POST-JSON-Text (Content-Type: application/json) für die zusätzlichen Routeninformationen dar, die bei der Berechnung mit Umgebungsgeschwindigkeiten für Straßentypen verwendet werden sollen. Weitere Informationen und Beispiele für diese Optionen finden Sie unter HTTP-POST-Optionen für GetTravelBoundary.

Abfrageparameter

Bei diesem Vorgang werden die folgenden Abfrageparameter abgerufen.

Parameter Typ Erforderlich Beschreibung
point Zeichenfolge Ja Gibt die Startposition ab, von der aus die Fahrtgrenze in folgendem Format berechnet werden soll: x,y,coordSys. Beispiel: -74.2,40.8,epsg:4326
costs Double Ja Gibt die Kosten für Entfernung oder Zeit in den angegebenen Kosteneinheiten an (kann ein Dezimalwert sein). Beispiel: Wenn als Einheit Meilen angegeben sind und Sie in diesem Parameter „10“ angeben, wird bei der Fahrtgrenze berechnet, wie weit Sie fahren können, wenn Sie eine Strecke von 10 Meilen zurücklegen. Sie können auch mehrere Kosten angeben, indem Sie die Werte als eine durch Kommas getrennte Zeichenfolge angeben. Für alle angegebenen Kosten wird dann eine separate Fahrtgrenze zurückgegeben. Wenn Sie mehrere Kosten angeben, enthält jede Antwort ihr zugeordnete Kosten und Kosteneinheiten.
costUnit Zeichenfolge Ja Gibt den Typ der für die Berechnung der Fahrtgrenze verwendeten Metrik an. Verfügbare Entfernungswerte sind:
  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Fuß)
  • mi (Meile)
Verfügbare Zeitwerte sind:
  • min (Minute)
  • ms (Millisekunde)
  • s (Sekunde)
  • h (Stunde)
maxOffroadDistance Double Nein Die maximale Entfernung, die mit dem Parameter maxOffroadDistanceUnit außerhalb des Straßennetzwerks zulässig ist. Zu Beispielen für Off-Road-Netzwerke zählen Einfahrten und Zugangsstraßen. Wenn Sie beispielsweise eine maximale Off-Road-Entfernung von 1 Meile angeben, wird die Fahrtgrenze nur bis zu eine Meile von der Straße des Netzwerks erweitert. Wenn Sie den Wert 0 angeben, wird die Fahrtgrenze nicht über die Straße hinweg erweitert. Verwenden Sie die Optionen für die Umgebungsgeschwindigkeit, um die Fahrtgeschwindigkeit für Straßen außerhalb des Straßennetzwerks anzugeben.
maxOffroadDistanceUnit Zeichenfolge Nein Gibt die Entfernungseinheit, mit der maxOffroadDistance definiert wird. Sie müssen auch „maxOffroadDistance“ definieren, wenn Sie diesen Parameter definieren. Verfügbare Entfernungswerte sind:
  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Fuß)
  • mi (Meile)
destinationSrs Zeichenfolge Nein Gibt das Koordinatensystem für die Rückgabe der Geometriedaten für die Fahrtgrenze an. Standardmäßig wird das Koordinatensystem der Daten verwendet (z. B. epsg 4326).
majorRoads Boolean Nein Gibt an, ob alle Straßen oder nur Hauptverkehrsstraßen in die Berechnung eingeschlossen werden sollen. Wenn Sie entscheiden, dass nur Hauptverkehrsstraßen eingeschlossen werden sollen, wird die Leistung verbessert, aber die Genauigkeit verringert. Der Standardwert ist „true“.
returnHoles Boolean Nein Gibt an, ob Sie Lücken zurückgeben möchten. Dies sind Bereiche innerhalb der größeren Grenzfläche, die basierend auf dem Straßennetzwerk in der gewünschten Zeit oder Entfernung nicht erreicht werden können. Der Standardwert ist „false“.
returnIslands Boolean Nein Gibt an, ob Sie Inseln zurückgeben möchten. Dies sind kleine Bereiche außerhalb der Hauptgrenze, die in der gewünschten Zeit oder Entfernung erreicht werden können. Der Standardwert ist „false“.
simplificationFactor Ganze Zahl Nein Gibt an, wie hoch der zurückgegebene Prozentsatz der ursprünglichen Punkte sein soll oder worauf die resultierende Komplexität der Geometriedaten basieren sollte. Zulässig ist eine Zahl zwischen 0,0 und 1,0 (ausschließlich 0,0, aber einschließlich 1,0). Die Komplexität nimmt mit steigendem Wert zu. Folglich steht 1,0 für die höchste Komplexität. Der Standardwert ist 0,5.
bandingStyle Zeichenfolge Nein

Gibt den Bereichsstil an, der im Ergebnis verwendet werden soll. Bereichsstile sind die Typen mehrerer Entfernungsbereiche, die basierend auf mehreren Kosten angezeigt werden können. Bereichsstile können in den folgenden Formaten zurückgegeben werden:

Donut
Jede Grenze wird durch Subtrahieren der nächstkleineren Grenze bestimmt. Dies ist die Standardmethode.
Encompassing
Jede Grenze wird unabhängig von allen anderen bestimmt.
historicTrafficTimeBucket Zeichenfolge Nein

Gibt an, ob bei der Berechnung der Fahrtstrecke die Fahrtgeschwindigkeit der letzten Fahrten verwendet wurde. Diese Fahrtgeschwindigkeitswerte basieren auf unterschiedlichen Tageszeitintervallen. Die Daten müssen über den Verlauf der Fahrtgeschwindigkeitswerte verfügen, um diese Funktion nutzen zu können. Die Daten für jedes Land/jede Region haben dieselben Intervalldefinitionen, bei denen die Geschwindigkeitswerte für diese Schichtwerte variieren können. Die Optionen sind:

None
Der Standardwert. Es werden keine Fahrtdaten im Verlauf bei der Berechnung verwendet. Stattdessen wird ein durchschnittlicher Geschwindigkeitswert verwendet.
AMPeak
Berechnung der Routen mit den vormittäglichen Geschwindigkeitsspitzenwerten. AMPeak-Zeitintervall: 07:00 bis 10:00 Uhr.
PMPeak
Berechnung der Routen mit den nachmittäglichen Geschwindigkeitsspitzenwerten. PMPeak-Zeitintervall: 16:00 bis 19:00 Uhr.
OffPeak
Berechnung der Routen mit den Geschwindigkeitswerten außerhalb der Stoßzeiten (tagsüber). OffPeak-Zeitintervall: 10:00 bis 16:00 Uhr.
Night
Berechnung der Routen mit den nächtlichen Geschwindigkeitswerten. Nachts-Zeitintervall: 22:00 bis 04:00 Uhr.
defaultAmbientSpeed Zeichenfolge Nein
Gibt die Fahrtgeschwindigkeit bei Verlassen eines Straßennetzes an, um die Fahrtgrenze zu suchen (bei allen Straßentypen). Um zu steuern, wie Fahrten außerhalb des Netzwerks bei der Berechnung der Fahrtgrenze verwendet werden, müssen Sie die Fahrtgeschwindigkeit außerhalb des Straßennetzwerks angeben (die Umgebungsgeschwindigkeit). Die Umgebungsgeschwindigkeit kann Auswirkungen auf die Größe und den Shape des Polygons der Fahrtgrenze haben. Im Allgemeinen gilt: Je schneller die Umgebungsgeschwindigkeit, desto größer das Polygon. Wenn Sie sich beispielsweise an einem Punkt befinden, an dem Ihnen noch 5 Minuten zur Verfügung stehen und die Umgebungsgeschwindigkeit 15 Meilen pro Stunde beträgt, werden die Grenzpunkte bei einer Entfernung von 1,25 Meilen gesetzt. Wenn die Umgebungsgeschwindigkeit auf 10 Meilen pro Stunde verringert würde, würden Grenzpunkte auf eine Entfernung von 0,83 Meilen festgelegt.
Anmerkung: Der Standardwert für „defaultAmbientSpeed“ ist 15.
ambientSpeedUnit Zeichenfolge Nein
Gibt die Maßeinheit für die Berechnung der Umgebungsgeschwindigkeit an. Verfügbare Geschwindigkeitseinheiten sind:
  • MPH (Meilen pro Stunde)
  • KPH (Kilometer pro Stunde)
  • MTPS (Meter pro Sekunde)
  • MTPM (Meter pro Minute)
Anmerkung: Der Standardwert für „ambientSpeedUnit“ ist MPH.
propagationFactor Zeichenfolge Nein

Gibt den Prozentsatz der Kosten an, der zur Berechnung der Entfernung zwischen dem Startpunkt und der Isodistanz verwendet wird (für alle Straßentypen). Der Versatzfaktor dient Isochronen wie Isodistanzen der Umgebungsgeschwindigkeit, d. h. er steuert, wie die Fahrt außerhalb des Netzes bei der Berechnung der Fahrtgrenzen verwendet wird. Der Versatzfaktor kann Auswirkungen auf die Größe und die Form des Polygons der Fahrtgrenze haben. Im Allgemeinen ist das Versatzfaktorwert umso größer, je größer das Polygon ist.

Er gilt für Isodistanzen. Wenn diese Eigenschaft nicht angegeben wird, verwendet die Berechnung die Servereinstellung. Gültige Werte liegen zwischen einschließlich 0,0 und 1,0.
Anmerkung:
  • Standard propagationFactor ist 0,16.
  • Dieser Parameter kann auch im POST-Hauptteil angegeben werden. Wenn derselbe Parameter sowohl in GET als auch in POST gesetzt ist, wird der Wert in POST berücksichtigt.
version Zeichenfolge Nein Gibt die Version des GetTravelBoundary-REST-Dienstes an. Gültige Werte sind 1 und 2. Der Standardwert für version ist 1.

Beispiele

Fahrtgrenze mit einzelnen Kosten.

http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json? q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=5&costUnit=m

Antwort

{ 	"travelBoundary": { 		"costs": [ 			{ 				"cost": 5, 				"costUnit": "m", 				"geometry": {"type":"MultiPolygon","coordinates":[[[...]]]} 			} 		] 	} }

Fahrtgrenze mit mehreren Kosten.

http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?​q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=2,5&costUnit=m

Antwort

{ 	"travelBoundary": { 		"costs": [ 			{ 				"cost": 2, 				"costUnit": "m", 				"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}" 			}, 			{ 				"cost": 5, 				"costUnit": "m", 				"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}" 			} 		] 	} }

Versionsspezifische Fehlerreaktion

Wenn Sie in einer Anforderung einen ungültigen Parameterwert (z. B. Punkte außerhalb der Grenzen) eingeben, hängt die Fehlerreaktion von der von Ihnen eingegebenen Version ab. Wenn die Version 1 ist, erhalten Sie Wert und Fehler. Wenn dahingegen die Version 2 ist, enthält die Antwort nur den Fehler.

  • Abfrage, wenn version 1 ist:
    http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary&costs=5&costUnit=min&point=-14.321600,60.662859,epsg:4326&version=1
  • Antwort:
    {   "value": "Point outside boundaries: (-14.3216,60.662859,0)",   "errors": [     {       "errorCode": 5008,       "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"     }   ] }
  • Abfrage, wenn version 2 ist:
     http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary &costs=5&costUnit=min&point=-14.321600,60.662859,epsg:4326&version=2 
  • Antwort:
    {   "errors": [     {       "errorCode": 5008,       "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"     }   ] }