Route - Get Route Directions

Service:

Maps

API Version:

1.0

Verwenden Sie, um eine Route zwischen einem angegebenen Ursprung und Ziel zu berechnen und dabei alle angegebenen Wegpunkte zu durchlaufen.

Bei der Get Route Directions API handelt es sich um eine HTTP-Anforderung GET , die eine Route zwischen einem Ursprung und einem Ziel zurückgibt und bei Angabe durch Wegpunkte führt. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und zur Tageszeit.

Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung.

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Weitere Informationen finden Sie unter Verbrauchsmodell.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	string	Die Koordinaten, durch die die Route berechnet wird, durch einen Doppelpunkt getrennt. Es sind mindestens zwei Koordinaten erforderlich. Der erste ist der Ursprung und der letzte das Ziel der Route. Optionale Koordinaten dazwischen fungieren als WayPoints in der Route. Sie können bis zu 150 WayPoints übergeben.
accelerationEfficiency	query		number double	Gibt die Effizienz der Umwandlung chemischer Energie, die im Kraftstoff gespeichert ist, in kinetische Energie, wenn das Fahrzeug beschleunigt (d. h. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wird durch Umwandlung von verbrauchtem Kraftstoff in chemische Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit "decelerationEfficiency" gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/decelerationEfficiency. Sensible Werte : für Verbrennungsmodell : 0,33, für elektrisches Modell : 0,66
alternativeType	query		AlternativeRouteType	Steuert die Optimaleität der berechneten Alternativen im Hinblick auf die angegebenen Planungskriterien im Vergleich zur Referenzstrecke.
arriveAt	query		string date-time	Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als dateTime Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6 definiert, mit einem optionalen Zeitzonenoffset. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Des Zielpunkts handelt. Beispiele: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 Der arriveAt Parameter kann nicht in Verbindung mit departAt, minDeviationDistance oder minDeviationTimeverwendet werden.
auxiliaryPowerInkW	query		number double	Gibt den Stromverbrauch für unterstützende Hilfssysteme in Kilowatt (kW) an. Es kann verwendet werden, um den Verbrauch durch Geräte und Systeme wie Ac-Systeme, Radio, Heizung usw. anzugeben. Sensible Werte: 1.7
auxiliaryPowerInLitersPerHour	query		number double	Gibt die Menge an Kraftstoff an, die für die Unterhaltshilfssysteme des Fahrzeugs verbraucht wird, in Liter pro Stunde. Es kann verwendet werden, um den Verbrauch durch Geräte und Systeme wie Ac-Systeme, Radio, Heizung usw. anzugeben. Sensible Werte: 0.2
avoid	query		RouteAvoidType[]	Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.
computeBestOrder	query		boolean	Ordnen Sie die Routenwegpunkte mit einem schnellen heuristischen Algorithmus neu an, um die Routenlänge zu reduzieren. Erzielt beste Ergebnisse, wenn es in Verbindung mit routeType shortest verwendet wird. Beachten Sie, dass Ursprung und Ziel von den optimierten Wegpunktindizes ausgeschlossen sind. Wenn Sie Ursprung und Ziel in die Antwort einbeziehen möchten, erhöhen Sie alle Indizes um 1, um den Ursprung zu berücksichtigen, und fügen Sie dann das Ziel als endgültigen Index hinzu. Mögliche Werte sind true und false. True berechnet nach Möglichkeit eine bessere Reihenfolge, darf jedoch nicht in Verbindung mit dem maxAlternatives-Wert größer als 0 oder in Verbindung mit Kreis-Wegpunkten verwendet werden. False verwendet die Speicherorte in der angegebenen Reihenfolge und darf nicht in Verbindung mit routeRepresentation none verwendet werden.
computeTravelTimeFor	query		ComputeTravelTime	Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Gibt die geschwindigkeitsabhängige Verbrauchskomponente an. Wird als ungeordnete Liste von Geschwindigkeits-/Verbrauchsratenpaaren bereitgestellt. Die Liste definiert Punkte in einer Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, werden wie folgt ermittelt: durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt andernfalls durch lineare Extrapolation, unter der Annahme einer Konstanten (ΔConsumption/ΔSpeed), die von den nächsten zwei Punkten in der Liste bestimmt wird Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf keine doppelten Punkte für die gleiche Geschwindigkeit enthalten. Wenn er nur einen einzelnen Punkt enthält, wird die Verbrauchsrate dieses Punkts ohne weitere Verarbeitung verwendet. Der für die größte Geschwindigkeit angegebene Verbrauch muss größer oder gleich dem der vorletzten größten Geschwindigkeit sein. Dadurch wird sichergestellt, dass die Extrapolation nicht zu negativen Verbrauchsraten führt. Ebenso können Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine kleinere Geschwindigkeit führen. Der gültige Bereich für die Verbrauchswerte (ausgedrückt in kWh/100km) liegt zwischen 0,01 und 100000,0. Sensible Werte: 50,8.2:130,21.3 Dieser Parameter ist für das Stromverbrauchsmodell erforderlich.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Gibt die geschwindigkeitsabhängige Verbrauchskomponente an. Wird als ungeordnete Liste von durch Doppelpunkt getrennten Geschwindigkeits- & Verbrauchsratenpaaren bereitgestellt. Die Liste definiert Punkte in einer Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, werden wie folgt ermittelt: durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt andernfalls durch lineare Extrapolation, unter der Annahme einer Konstanten (ΔConsumption/ΔSpeed), die von den nächsten zwei Punkten in der Liste bestimmt wird Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf keine doppelten Punkte für die gleiche Geschwindigkeit enthalten. Wenn er nur einen einzelnen Punkt enthält, wird die Verbrauchsrate dieses Punkts ohne weitere Verarbeitung verwendet. Der für die größte Geschwindigkeit angegebene Verbrauch muss größer oder gleich dem der vorletzten größten Geschwindigkeit sein. Dadurch wird sichergestellt, dass die Extrapolation nicht zu negativen Verbrauchsraten führt. Ebenso können Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine kleinere Geschwindigkeit führen. Der gültige Bereich für die Verbrauchswerte (ausgedrückt in l/100km) liegt zwischen 0,01 und 100000,0. Sensible Werte: 50,6.3:130,11,5 Hinweis : Dieser Parameter ist für das Verbrennungsverbrauchsmodell erforderlich.
currentChargeInkWh	query		number double	Gibt die aktuelle elektrische Energieversorgung in Kilowattstunden (kWh) an. Dieser Parameter ist zusammen mit dem MaxChargeInkWh-Parameter vorhanden. Der zulässige Wertebereich beträgt 0,0 bis maxChargeInkWh. Sensible Werte: 43
currentFuelInLiters	query		number double	Gibt die aktuelle Kraftstoffversorgung in Litern an. Sensible Werte: 55
decelerationEfficiency	query		number double	Gibt den Wirkungsgrad der Umwandlung von kinetischer Energie in eingesparten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug abbremst (d. h. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved wird durch Umwandlung von gespeichertem (nicht verbrauchtem) Kraftstoff in Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit accelerationEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/accelerationEfficiency. Sensible Werte : für Verbrennungsmodell : 0,83, für elektrisches Modell : 0,91
departAt	query		string date-time	Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt, der als dateTime Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6 definiert, mit einem optionalen Zeitzonenoffset. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Ursprungspunkts handelt. Standardwert: jetzt Anderer Wert: dateTime Beispiele: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 Der departAt Parameter kann nicht in Verbindung mit arriveAtverwendet werden.
downhillEfficiency	query		number double	Gibt die Effizienz der Umwandlung potenzieller Energie in eingesparten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug an Höhe verliert (d. h. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved wird durch Umwandlung von gespeichertem (nicht verbrauchtem) Kraftstoff in Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit uphillEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/uphillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,51, für elektrisches Modell : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Gibt die Menge der chemischen Energie an, die in einem Liter Kraftstoff in Megajoules (MJ) gespeichert wird. Es wird in Verbindung mit den *Effizienzparametern für Umrechnungen zwischen eingesparter oder verbrauchter Energie und Kraftstoff verwendet. Beispielsweise beträgt die Energiedichte 34,2 MJ/l für Benzin und 35,8 MJ/l für Dieselkraftstoff. Dieser Parameter ist erforderlich, wenn ein *Efficiency-Parameter festgelegt ist. Sensible Werte: 34.2
hilliness	query		InclineLevel	Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.
instructionsType	query		RouteInstructionsType	Falls angegeben, werden Anleitungen zurückgegeben. Beachten Sie, dass der instructionsType-Parameter nicht in Verbindung mit routeRepresentation=none verwendet werden kann.
language	query		string	Der Language-Parameter bestimmt die Sprache der Leitmeldungen. Richtige Nomen (die Namen von Straßen, Plätzen usw.) werden in der angegebenen Sprache zurückgegeben, oder wenn dies nicht verfügbar ist, werden sie in einer verfügbaren Sprache zurückgegeben, die sich in ihrer Nähe befindet. Zulässige Werte sind (eine Teilmenge von) die IETF-Sprachtags. Die derzeit unterstützten Sprachen sind im Abschnitt Unterstützte Sprachen aufgeführt. Standardwert: en-GB
maxAlternatives	query		integer	Anzahl der gewünschten alternativen Routen, die berechnet werden sollen. Standard: 0, Minimum: 0 und Maximum: 5
maxChargeInkWh	query		number double	Gibt die maximale elektrische Energieversorgung in Kilowattstunden (kWh) an, die in der Batterie des Fahrzeugs gespeichert werden kann. Dieser Parameter ist zusammen mit dem Parameter currentChargeInkWh vorhanden. Der Mindestwert muss größer oder gleich currentChargeInkWh sein. Sensible Werte: 85
minDeviationDistance	query		integer	Alle zurückgegebenen alternativen Routen folgen der Referenzroute (siehe Abschnitt POST-Anforderungen) vom Ursprungspunkt der calculateRoute-Anforderung für mindestens diese Anzahl von Metern. Kann nur beim Rekonstruieren einer Route verwendet werden. Der minDeviationDistance-Parameter kann nicht in Verbindung mit "arriveAt" verwendet werden.
minDeviationTime	query		integer	Alle alternativen Routen, die zurückgegeben werden, folgen mindestens dieser Anzahl von Sekunden der Referenzroute (siehe Abschnitt POST-Anforderungen) vom Ursprungspunkt der calculateRoute-Anforderung. Kann nur beim Rekonstruieren einer Route verwendet werden. Der minDeviationTime-Parameter kann nicht in Verbindung mit arriveAt verwendet werden. Der Standardwert ist 0. Das Festlegen von )minDeviationTime_ auf einen Wert größer als 0 (null) hat die folgenden Folgen: Der Ursprungspunkt der calculateRoute-Anforderung muss sich auf (oder sehr nahe) der Eingabereferenzroute befinden. Wenn dies nicht der Fall ist, wird ein Fehler zurückgegeben. Der Ursprungspunkt muss sich jedoch nicht am Anfang der Eingabereferenzroute befinden (er kann als die aktuelle Fahrzeugposition auf der Referenzroute betrachtet werden). Die Referenzroute, die als erste Route in der calculateRoute-Antwort zurückgegeben wird, beginnt an dem in der calculateRoute-Anforderung angegebenen Ursprungspunkt. Der anfängliche Teil der Eingabeverweisroute, bis der Ursprungspunkt von der Antwort ausgeschlossen wird. Die Werte von minDeviationDistance und minDeviationTime bestimmen, wie weit alternative Routen ab dem Ursprungspunkt garantiert der Referenzroute folgen. Die Route muss "departAt" verwenden. Das vehicleHeading wird ignoriert.
report	query		Report	Gibt an, welche Daten zu Diagnosezwecken gemeldet werden sollen. Der einzige mögliche Wert ist effectiveSettings. Meldet die effektiven Parameter oder Daten, die beim Aufrufen der API verwendet werden. Bei Standardparametern wird die Standardeinstellung angezeigt, wenn der Parameter nicht vom Aufrufer angegeben wurde.
routeRepresentation	query		RouteRepresentationForBestOrder	Gibt die Darstellung der Als Antwort bereitgestellten Routen an. Dieser Parameterwert kann nur in Verbindung mit computeBestOrder=true verwendet werden.
routeType	query		RouteType	Der Typ der angeforderten Route.
sectionType	query		SectionType	Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.
traffic	query		boolean	Mögliche Werte: true: Berücksichtigen Sie während des Routings alle verfügbaren Datenverkehrsinformationen. false: Aktuelle Datenverkehrsdaten während des Routings ignorieren. Beachten Sie, dass die aktuellen Verkehrsdaten zwar beim Routing ignoriert werden, die Auswirkungen des historischen Verkehrs auf die effektiven Straßengeschwindigkeiten jedoch weiterhin berücksichtigt werden.
travelMode	query		TravelMode	Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.
uphillEfficiency	query		number double	Gibt die Effizienz der Umwandlung chemischer Energie, die im Kraftstoff gespeichert ist, in potenzielle Energie, wenn das Fahrzeug an Höhe gewinnt (d. h. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wird durch Umwandlung von verbrauchtem Kraftstoff in chemische Energie unter Verwendung von KraftstoffEnergyDensityInMJoulesPerLiter gewonnen. Muss mit downhillEfficiency gekoppelt werden. Der zulässige Wertebereich ist 0,0 bis 1/downhillEfficiency. Sensible Werte : für Verbrennungsmodell : 0,27, für elektrisches Modell : 0,74
vehicleAxleWeight	query		integer	Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtsbeschränkungen pro Achse nicht berücksichtigt werden.
vehicleCommercial	query		boolean	Gibt an, ob das Fahrzeug zu kommerziellen Zwecken verwendet wird. Nutzfahrzeuge dürfen möglicherweise nicht auf einigen Straßen fahren.
vehicleEngineType	query		VehicleEngineType	Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein.
vehicleHeading	query		integer	Die Richtungsrichtung des Fahrzeugs in Grad, beginnend bei true Nord und weiter im Uhrzeigersinn. Norden ist 0 Grad, Osten 90 Grad, Süden 180 Grad, West ist 270 Grad. Mögliche Werte 0-359
vehicleHeight	query		number double	Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.
vehicleLength	query		number double	Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden.
vehicleLoadType	query		VehicleLoadType	Arten von Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für US-Routing, während otherHazmat für alle anderen Länder/Regionen verwendet werden sollte. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.
vehicleMaxSpeed	query		integer	Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Die Höchstgeschwindigkeit im Fahrzeugprofil wird verwendet, um zu überprüfen, ob ein Fahrzeug auf Autobahnen zugelassen ist. Der Wert 0 bedeutet, dass bei der Routenplanung ein geeigneter Wert für das Fahrzeug ermittelt und angewendet wird. Ein Wert ungleich 0 kann während der Routenplanung überschrieben werden. Beispielsweise beträgt der aktuelle Verkehrsfluss 60 km/h. Wenn die Höchstgeschwindigkeit des Fahrzeugs auf 50 km/h festgelegt ist, berücksichtigt der Routingmotor 60 km/h, da dies die aktuelle Situation ist. Wenn die Höchstgeschwindigkeit des Fahrzeugs mit 80 km/h angegeben wird, der aktuelle Verkehrsfluss jedoch 60 km/h beträgt, verwendet der Routingmotor wieder 60 km/h.
vehicleWeight	query		integer	Gewicht des Fahrzeugs in Kilogramm. Dies ist obligatorisch, wenn einer der *Efficiency-Parameter festgelegt ist. Es muss streng positiv sein, wenn es im Kontext des Verbrauchsmodells verwendet wird. Gewichtungseinschränkungen werden berücksichtigt. Wenn kein detailliertes Verbrauchsmodell angegeben wird und der Wert von vehicleWeight ungleich Null ist, werden Gewichtsbeschränkungen berücksichtigt. In allen anderen Fällen wird dieser Parameter ignoriert. Sensible Werte : für Verbrennungsmodell : 1600, für elektrisches Modell : 1900
vehicleWidth	query		number double	Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.
windingness	query		WindingnessLevel	Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	RouteDirections	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

• Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

• Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, der CLI, Azure SDKs oder der REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Successfully retrieve a route between an origin and a destination

Sample Request

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Sample Response

Status code:

200

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
AlternativeRouteType	Steuert die Optimalität der berechneten Alternativen im Hinblick auf die angegebenen Planungskriterien im Vergleich zur Referenzroute.
ComputeTravelTime	Gibt an, ob zusätzliche Reisezeiten zurückgegeben werden sollen, indem verschiedene Arten von Verkehrsinformationen (keine, historische, live) sowie die am besten geschätzte Standardreisezeit verwendet werden.
DelayMagnitude	Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API.
DrivingSide	Gibt an, dass links und rechts am Punkt des Manövers gefahren wird.
EffectiveSetting	Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GuidanceInstructionType	Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform.
GuidanceManeuver	Ein Code, der das Manöver identifiziert.
InclineLevel	Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.
JunctionType	Der Typ der Kreuzung, an der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert.
LatLongPair	Ein Standort, der als Breiten- und Längengrad dargestellt wird.
Report	Gibt an, welche Daten für Diagnosezwecke gemeldet werden sollen. Der einzige mögliche Wert ist effectiveSettings. Meldet die effektiven Parameter oder Daten, die beim Aufrufen der API verwendet werden. Im Fall von Standardparametern wird der Standardwert dort widergespiegelt, wo der Parameter nicht vom Aufrufer angegeben wurde.
ResponseFormat	Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.
ResponseSectionType	Abschnittstypen der gemeldeten Routenantwort
ResponseTravelMode	Reisemodus für die berechnete Route. Der Wert wird auf other festgelegt, wenn der angeforderte Transportmodus in diesem Abschnitt nicht möglich ist.
Route
RouteAvoidType	Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.
RouteDirections	Dieses Objekt wird von einem erfolgreichen Routenbeschreibungsaufruf zurückgegeben.
RouteGuidance	Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist.
RouteInstruction	Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Rechts abbiegen", "Links bleiben", "Fähre nehmen", "Autobahn nehmen", "Ankommen".
RouteInstructionGroup	Gruppen eine Sequenz von Befehlselementen, die miteinander in Beziehung stehen. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten als Leitfaden angefordert werden (instructionType=text oder getaggt), wird für die instructionGroup eine Zusammenfassungsmeldung zurückgegeben, sofern verfügbar.
RouteInstructionsType	Falls angegeben, werden Anleitungen zurückgegeben. Beachten Sie, dass der parameter instructionsType nicht in Verbindung mit routeRepresentation=none verwendet werden kann.
RouteLeg	Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung angegeben wird, führt zu einer zusätzlichen Etappe auf der zurückgegebenen Route.
RouteLegSummary	Summary-Objekt für den Routenabschnitt.
RouteOptimizedWaypoint	Optimiertes Wegepunktobjekt.
RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden.
RouteRepresentationForBestOrder	Gibt die Darstellung der Gruppe von Routen an, die als Antwort bereitgestellt werden. Dieser Parameterwert kann nur in Verbindung mit computeBestOrder=true verwendet werden.
RouteSection	Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente startPointIndex, endPointIndexund sectionType.
RouteSectionTec	Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente.
RouteSectionTecCause	Die Ursache des Verkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Ikonografie und Beschreibungen zu definieren.
RouteSummary	Summary-Objekt
RouteType	Der Typ der angeforderten Route.
SectionType	Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.
SimpleCategory	Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec".
TravelMode	Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "Other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.
VehicleEngineType	Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein.
VehicleLoadType	Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus eingeschränkt werden können. Verfügbare VehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für das US-Routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.
WindingnessLevel	Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

AlternativeRouteType

Steuert die Optimalität der berechneten Alternativen im Hinblick auf die angegebenen Planungskriterien im Vergleich zur Referenzroute.

Name	Typ	Beschreibung
anyRoute	string	Lassen Sie jede alternative Route zurück, unabhängig davon, wie sie im Hinblick auf die Optimalität mit der Referenzroute verglichen wird.
betterRoute	string	Geben Sie eine alternative Route nur zurück, wenn sie gemäß den angegebenen Planungskriterien besser als die Referenzroute ist.

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten zurückgegeben werden sollen, indem verschiedene Arten von Verkehrsinformationen (keine, historische, live) sowie die am besten geschätzte Standardreisezeit verwendet werden.

Name	Typ	Beschreibung
all	string	Berechnet Die Reisezeiten für alle Arten von Verkehrsinformationen und gibt alle Ergebnisse in den Feldern noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds und liveTrafficIncidentsTravelTimeInSeconds an, die in den Zusammenfassungen in der Routenantwort enthalten sind.
none	string	Berechnet keine zusätzlichen Reisezeiten.

DelayMagnitude

Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API.

Name	Typ	Beschreibung
0	string	Unbekannt
1	string	Gering.
2	string	Mäßig.
3	string	Schwerwiegend.
4	string	Undefiniert, für Straßensperrungen und andere unbestimmte Verspätungen verwendet.

DrivingSide

Gibt an, dass links und rechts am Punkt des Manövers gefahren wird.

Name	Typ	Beschreibung
LEFT	string	Links.
RIGHT	string	Rechte Seite.

EffectiveSetting

Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden.

Name	Typ	Beschreibung
key	string	Der Name des verwendeten Parameters.
value	string	Wert des verwendeten Parameters.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GuidanceInstructionType

Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform.

Name	Typ	Beschreibung
DIRECTION_INFO	string	Richtungsinformationen.
LOCATION_ARRIVAL	string	Ankunftsort.
LOCATION_DEPARTURE	string	Abfahrtsort.
LOCATION_WAYPOINT	string	Wegpunktposition.
ROAD_CHANGE	string	Straßenänderung.
TURN	string	Drehen.

GuidanceManeuver

Ein Code, der das Manöver identifiziert.

Name	Typ	Beschreibung
ARRIVE	string	Sie sind angekommen.
ARRIVE_LEFT	string	Sie sind angekommen. Ihr Ziel befindet sich auf der linken Seite.
ARRIVE_RIGHT	string	Sie sind angekommen. Ihr Ziel befindet sich auf der rechten Seite.
BEAR_LEFT	string	Bär links.
BEAR_RIGHT	string	Bärt recht.
DEPART	string	Verlassen.
ENTER_FREEWAY	string	Nehmen Sie die Autobahn.
ENTER_HIGHWAY	string	Nehmen Sie die Autobahn.
ENTER_MOTORWAY	string	Nehmen Sie die Autobahn.
ENTRANCE_RAMP	string	Nehmen Sie die Rampe.
FOLLOW	string	Folgen.
KEEP_LEFT	string	Bleiben Sie links.
KEEP_RIGHT	string	Halten Sie sich rechts.
MAKE_UTURN	string	Machen Sie eine Kehrtwende.
MOTORWAY_EXIT_LEFT	string	Nehmen Sie den linken Ausgang.
MOTORWAY_EXIT_RIGHT	string	Nehmen Sie den rechten Ausgang.
ROUNDABOUT_BACK	string	Fahren Sie um den Kreisverkehr herum.
ROUNDABOUT_CROSS	string	Überqueren Sie den Kreisverkehr.
ROUNDABOUT_LEFT	string	Am Kreisverkehr nehmen Sie die Ausfahrt links.
ROUNDABOUT_RIGHT	string	Am Kreisverkehr nehmen Sie die Ausfahrt rechts.
SHARP_LEFT	string	Biegen Sie scharf links ab.
SHARP_RIGHT	string	Drehen Sie sich scharf nach rechts.
STRAIGHT	string	Bleiben Sie geradeaus.
SWITCH_MAIN_ROAD	string	Wechseln Sie zur Standard Straße.
SWITCH_PARALLEL_ROAD	string	Wechseln Sie zur Parallelstraße.
TAKE_EXIT	string	Nehmen Sie den Ausgang.
TAKE_FERRY	string	Nehmen Sie die Fähre.
TRY_MAKE_UTURN	string	Versuchen Sie, eine Kehrtwende vorzunehmen.
TURN_LEFT	string	Biege links ab.
TURN_RIGHT	string	Rechts abbiegen.
WAYPOINT_LEFT	string	Sie haben den Wegpunkt erreicht. Es befindet sich auf der linken Seite.
WAYPOINT_REACHED	string	Sie haben den Wegpunkt erreicht.
WAYPOINT_RIGHT	string	Sie haben den Wegpunkt erreicht. Sie befindet sich auf der rechten Seite.

InclineLevel

Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Name	Typ	Beschreibung
high	string	high
low	string	niedrig
normal	string	normal

JunctionType

Der Typ der Kreuzung, an der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert.

Name	Typ	Beschreibung
BIFURCATION	string	Gabelung
REGULAR	string	regular
ROUNDABOUT	string	Kreisverkehr

LatLongPair

Ein Standort, der als Breiten- und Längengrad dargestellt wird.

Name	Typ	Beschreibung
latitude	number	Latitude-Eigenschaft
longitude	number	Längengradeigenschaft

Report

Gibt an, welche Daten für Diagnosezwecke gemeldet werden sollen. Der einzige mögliche Wert ist effectiveSettings. Meldet die effektiven Parameter oder Daten, die beim Aufrufen der API verwendet werden. Im Fall von Standardparametern wird der Standardwert dort widergespiegelt, wo der Parameter nicht vom Aufrufer angegeben wurde.

Name	Typ	Beschreibung
effectiveSettings	string	Meldet die effektiven Parameter oder Daten, die beim Aufrufen der API verwendet werden.

ResponseFormat

Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation
xml	string	The Extensible Markup Language

ResponseSectionType

Abschnittstypen der gemeldeten Routenantwort

Name	Typ	Beschreibung
CARPOOL	string	Streckenabschnitte, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern.
CAR_TRAIN	string	Streckenabschnitte, bei denen es sich um Autos oder Züge handelt.
COUNTRY	string	Abschnitte, in denen angegeben wird, in welchen Ländern/Regionen sich die Route befindet.
FERRY	string	Streckenabschnitte, bei denen es sich um Fähren handelt.
MOTORWAY	string	Streckenabschnitte, die Autobahnen sind.
PEDESTRIAN	string	Streckenabschnitte, die nur für Fußgänger geeignet sind.
TOLL_ROAD	string	Streckenabschnitte, für die mautpflichtig ist.
TOLL_VIGNETTE	string	Streckenabschnitte, für die eine Mautvignette erforderlich ist.
TRAFFIC	string	Abschnitte der Route, die Verkehrsinformationen enthalten.
TRAVEL_MODE	string	Abschnitte in Bezug auf den Anforderungsparameter travelMode.
TUNNEL	string	Abschnitte der Route, die Tunnel sind.
URBAN	string	Streckenabschnitte, die sich innerhalb städtischer Gebiete befinden.

ResponseTravelMode

Reisemodus für die berechnete Route. Der Wert wird auf other festgelegt, wenn der angeforderte Transportmodus in diesem Abschnitt nicht möglich ist.

Name	Typ	Beschreibung
bicycle	string	Die Rückgabewege sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.
bus	string	Die zurückgegebenen Routen sind für Busse optimiert, einschließlich der Verwendung von Busspuren. BETA-Funktionalität.
car	string	Die zurückgegebenen Routen sind für Autos optimiert.
motorcycle	string	Die zurückgegebenen Routen sind für Motorräder optimiert. BETA-Funktionalität.
other	string	Die angegebene Transportart ist in diesem Abschnitt nicht möglich.
pedestrian	string	Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich der Nutzung von Gehwegen.
taxi	string	Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.
truck	string	Die Rückgaberouten sind für Nutzfahrzeuge optimiert, z. B. für Lkw.
van	string	Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität.

Route

Name	Typ	Beschreibung
guidance	RouteGuidance	Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist.
legs	RouteLeg[]	Legs-Array
sections	RouteSection[]	Abschnittsarray
summary	RouteSummary	Summary-Objekt

RouteAvoidType

Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In Routenbereichsanforderungen darf der Wert alreadyUsedRoads nicht verwendet werden.

Name	Typ	Beschreibung
alreadyUsedRoads	string	Vermeidet die mehrfache Verwendung derselben Straße. Am nützlichsten in Verbindung mit routeType=spannend.
borderCrossings	string	Vermeidet Grenzübergänge bei der Routenberechnung.
carpools	string	Vermeidet Routen, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern.
ferries	string	Vermeidet Fähren
motorways	string	Vermeidet Autobahnen
tollRoads	string	Vermeidet mautpflichtige Straßen.
unpavedRoads	string	Vermeidet unbefestigte Straßen

RouteDirections

Dieses Objekt wird von einem erfolgreichen Routenbeschreibungsaufruf zurückgegeben.

Name	Typ	Beschreibung
formatVersion	string	Format Version-Eigenschaft
optimizedWaypoints	RouteOptimizedWaypoint[]	Optimierte Sequenz von Wegpunkten. Es zeigt den Index aus der vom Benutzer bereitgestellten Wegpunktsequenz für die ursprüngliche und optimierte Liste an. Für instance eine Antwort: <optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints> bedeutet, dass die ursprüngliche Sequenz [0, 1, 2] und die optimierte Sequenz [1, 2, 0] ist. Da der Index mit 0 beginnt, lautet das Original "first, second, third", and the optimized is "second, third, first".
report	RouteReport	Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden.
routes	Route[]	Routenarray

RouteGuidance

Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist.

Name	Typ	Beschreibung
instructionGroups	RouteInstructionGroup[]	Gruppen eine Sequenz von Anweisungselementen, die miteinander verbunden sind.
instructions	RouteInstruction[]	Eine Liste mit Anweisungen, die Manöver beschreiben.

RouteInstruction

Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Rechts abbiegen", "Links bleiben", "Fähre nehmen", "Autobahn nehmen", "Ankommen".

Name	Typ	Beschreibung
combinedMessage	string	Eine lesbare Nachricht für das Manöver in Kombination mit der Nachricht aus der nächsten Anweisung. Manchmal ist es möglich, zwei aufeinander folgende Anweisungen in einer einzigen Anweisung zu kombinieren, um die Folgen zu erleichtern. Wenn dies der Fall ist, ist das flag possibleCombineWithNext true. Beispiel: 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam Das möglicheCombineWithNext-Flag in Anweisung 10 ist true. Dies gibt den Clients der codierten Anleitung an, dass sie mit Anweisung 11 kombiniert werden kann. Die Anweisungen werden automatisch für Clients kombiniert, die eine lesbare Anleitung anfordern. Das Feld combinedMessage enthält die kombinierte Nachricht: Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode	string	3-Zeichen ISO 3166-1 Alpha-3-Ländercode. Z.B. USA.
drivingSide	DrivingSide	Gibt an, dass links und rechts am Punkt des Manövers gefahren wird.
exitNumber	string	Die Nummer(n) einer Autobahnausfahrt, die vom aktuellen Manöver genommen wurde. Wenn ein Exit über mehrere Exitnummern verfügt, werden sie durch "," getrennt und möglicherweise durch "-" aggregiert, z. B. "10, 13-15".
instructionType	GuidanceInstructionType	Art der Anweisung, z. B. Abbiegen oder Ändern der Straßenform.
junctionType	JunctionType	Der Typ der Kreuzung, an der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Ein- und Verlassen des Kreisverkehrs generiert.
maneuver	GuidanceManeuver	Ein Code, der das Manöver identifiziert.
message	string	Eine für Menschen lesbare Nachricht für das Manöver.
point	LatLongPair	Ein Standort, der als Breiten- und Längengrad dargestellt wird.
pointIndex	integer	Der Index des Punkts in der Liste der polylinenen "Punkte", die dem Punkt der Anweisung entsprechen.
possibleCombineWithNext	boolean	Es ist möglich, die Anweisung optional mit der nächsten zu kombinieren. Dies kann verwendet werden, um Nachrichten wie "Links abbiegen und dann rechts abbiegen".
roadNumbers	string[]	Die Straßennummern der nächsten wichtigen Straßenabschnitte nach dem Manöver oder der zu befolgenden Straße(en). Beispiel: ["E34", "N205"]
roundaboutExitNumber	string	Dies gibt an, welche Ausfahrt an einem Kreisverkehr zu nehmen ist.
routeOffsetInMeters	integer	Abstand vom Anfang der Route bis zum Punkt der Anweisung.
signpostText	string	Der Text auf einem Wegweiser, der für das Manöver oder für die Richtung, die befolgt werden soll, am wichtigsten ist.
stateCode	string	Eine Unterteilung (z. B. Bundesstaat) des Landes, dargestellt durch den zweiten Teil eines ISO 3166-2-Codes . Dies ist nur für einige Länder/Regionen wie die USA, Kanada und Mexiko verfügbar.
street	string	Straßenname des nächsten wichtigen Straßenabschnitts nach dem Manöver oder der Straße, die befolgt werden sollte.
travelTimeInSeconds	integer	Geschätzte Reisezeit bis zu dem Punkt, der routeOffsetInMeters entspricht.
turnAngleInDecimalDegrees	integer	Gibt die Richtung einer Anweisung an. Wenn junctionType eine Abbiegeanweisung angibt: 180 = U-Turn [-179, -1] = Linkskurve 0 = Gerade ein (0 Grad) [1, 179] = Rechtskurve Wenn junctionType eine Bifurcation-Anweisung angibt: <0 – Links halten >0 – Rechts bleiben

RouteInstructionGroup

Gruppen eine Sequenz von Befehlselementen, die miteinander in Beziehung stehen. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten als Leitfaden angefordert werden (instructionType=text oder getaggt), wird für die instructionGroup eine Zusammenfassungsmeldung zurückgegeben, sofern verfügbar.

Name	Typ	Beschreibung
firstInstructionIndex	integer	Index der ersten Anweisung in den Anweisungen und gehört zu dieser Gruppe.
groupLengthInMeters	integer	Länge der Gruppe.
groupMessage	string	Zusammenfassungsnachricht, wenn lesbare Textnachrichten als Anleitung angefordert werden (instructionType=text oder getaggt).
lastInstructionIndex	integer	Index der letzten Anweisung in den Anweisungen und gehört zu dieser Gruppe.

RouteInstructionsType

Falls angegeben, werden Anleitungen zurückgegeben. Beachten Sie, dass der parameter instructionsType nicht in Verbindung mit routeRepresentation=none verwendet werden kann.

Name	Typ	Beschreibung
coded	string	Gibt unformatierte Befehlsdaten ohne lesbare Nachrichten zurück.
tagged	string	Gibt unformatierte Befehlsdaten mit markierten, für Menschen lesbaren Nachrichten zurück, um formatierungsfähige Nachrichten zu ermöglichen. Eine für Menschen lesbare Nachricht wird aus wiederholbaren identifizierten Elementen aufgebaut. Diese werden markiert, damit Clientanwendungen sie ordnungsgemäß formatieren können. Die folgenden Nachrichtenkomponenten werden getaggt, wenn instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Beispiel für die markierte Meldung "Links abbiegen": Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>
text	string	Gibt unformatierte Anweisungen mit für Menschen lesbaren Nachrichten in Nur-Text zurück.

RouteLeg

Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung angegeben wird, führt zu einer zusätzlichen Etappe auf der zurückgegebenen Route.

Name	Typ	Beschreibung
points	LatLongPair[]	Punktarray
summary	RouteLegSummary	Summary-Objekt für den Routenabschnitt.

RouteLegSummary

Summary-Objekt für den Routenabschnitt.

Name	Typ	Beschreibung
arrivalTime	string	Die geschätzte Ankunftszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben.
batteryConsumptionInkWh	number	Geschätzter Stromverbrauch in Kilowattstunden (kWh) nach dem Stromverbrauchsmodell. Enthalten, wenn vehicleEngineType auf electric und constantSpeedConsumptionInkWhPerHundredkm festgelegt ist. Der Wert von batteryConsumptionInkWh umfasst die rekuperierte elektrische Energie und kann daher negativ sein (was auf die Gewinnung von Energie hinweist). Wenn sowohl maxChargeInkWh als auch currentChargeInkWh angegeben sind, wird die Rekuperation begrenzt, um sicherzustellen, dass der Akkuladestand niemals maxChargeInkWh überschreitet. Wenn weder maxChargeInkWh noch currentChargeInkWh angegeben werden, wird bei der Verbrauchsberechnung von einer nicht eingeschränkten Rekuperation ausgegangen.
departureTime	string	Die geschätzte Abfahrtszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben.
fuelConsumptionInLiters	number	Geschätzter Kraftstoffverbrauch in Litern unter Verwendung des Verbrennungsverbrauchsmodells. Enthalten, wenn vehicleEngineType auf verbrennung und constantSpeedConsumptionInLitersPerHundredkm festgelegt ist. Der Wert ist nicht negativ.
historicTrafficTravelTimeInSeconds	integer	Geschätzte Reisezeit, die anhand zeitabhängiger Verlaufsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird.
lengthInMeters	integer	Length In Meters-Eigenschaft
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschätzte Reisezeit, die mithilfe von Echtzeitgeschwindigkeitsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird.
noTrafficTravelTimeInSeconds	integer	Geschätzte Reisezeit, berechnet, als ob es aufgrund von Verkehrsbedingungen (z. B. Staus) zu keinen Verzögerungen auf der Strecke kommt. Nur enthalten, wenn computeTravelTimeFor = all in der Abfrage verwendet wird.
trafficDelayInSeconds	integer	Geschätzte Verzögerung in Sekunden, die durch die Echtzeitvorfälle gemäß Den Verkehrsinformationen verursacht wird. Bei routen, die in Zukunft mit Abfahrtszeit geplant sind, beträgt die Verspätung immer 0. Um zusätzliche Reisezeiten mithilfe verschiedener Arten von Datenverkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.
travelTimeInSeconds	integer	Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echtzeitdatenverkehr enthält. Beachten Sie, dass auch wenn traffic=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs enthält. Wenn DepartAt in der Zukunft liegt, wird die Reisezeit anhand zeitabhängiger historischer Verkehrsdaten berechnet.

RouteOptimizedWaypoint

Optimiertes Wegepunktobjekt.

Name	Typ	Beschreibung
optimizedIndex	integer	Optimierter Wegpunktindex aus dem System.
providedIndex	integer	Vom Benutzer bereitgestellter Wegpunktindex.

RouteReport

Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden.

Name	Typ	Beschreibung
effectiveSettings	EffectiveSetting[]	Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden.

RouteRepresentationForBestOrder

Gibt die Darstellung der Gruppe von Routen an, die als Antwort bereitgestellt werden. Dieser Parameterwert kann nur in Verbindung mit computeBestOrder=true verwendet werden.

Name	Typ	Beschreibung
none	string	Enthält nur die optimierten Wegpunktindizes, aber nicht die Routengeometrie in die Antwort.
polyline	string	Enthält Routengeometrie in die Antwort.
summaryOnly	string	Zusammenfassung nach Polylinie, jedoch ohne die Elemente der Punktgeometrie für die Routen in der Antwort.

RouteSection

Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente startPointIndex, endPointIndexund sectionType.

Name	Typ	Beschreibung
delayInSeconds	integer	Verzögerung in Sekunden, die durch den Vorfall verursacht wird.
effectiveSpeedInKmh	integer	Effektive Geschwindigkeit des Vorfalls in km/h, gemittelt über seine gesamte Länge.
endPointIndex	integer	Index des letzten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt.
magnitudeOfDelay	DelayMagnitude	Das Ausmaß der Verzögerung, die durch den Vorfall verursacht wird. Diese Werte entsprechen den Werten des Antwortfelds der Get Traffic Incident Detail-API.
sectionType	ResponseSectionType	Abschnittstypen der gemeldeten Routenantwort
simpleCategory	SimpleCategory	Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec".
startPointIndex	integer	Index des ersten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt.
tec	RouteSectionTec	Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente.
travelMode	ResponseTravelMode	Reisemodus für die berechnete Route. Der Wert wird auf other festgelegt, wenn die angeforderte Transportart in diesem Abschnitt nicht möglich ist.

RouteSectionTec

Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente.

Name	Typ	Beschreibung
causes	RouteSectionTecCause[]	Verursacht Array
effectCode	integer	Die Auswirkung auf den Verkehrsfluss. Enthält einen Wert in der Tabelle tec001:EffectCode, wie im TPEG2-TEC-Standard definiert. Kann verwendet werden, um Datenverkehrsereignisse entsprechend dem Schweregrad farblich zu codieren.

RouteSectionTecCause

Die Ursache des Verkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Ikonografie und Beschreibungen zu definieren.

Name	Typ	Beschreibung
mainCauseCode	integer	Die Standard Ursache des Verkehrsereignisses. Enthält einen Wert in der Tabelle tec002:CauseCode, wie im TPEG2-TEC-Standard definiert.
subCauseCode	integer	Die Unterause des Verkehrsereignisses. Enthält einen Wert in der Unterursachentabelle, die durch mainCauseCode definiert wird, wie im TPEG2-TEC-Standard definiert.

RouteSummary

Summary-Objekt

Name	Typ	Beschreibung
arrivalTime	string	Die geschätzte Ankunftszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben.
departureTime	string	Die geschätzte Abfahrtszeit für die Route oder Etappe. Die Zeit wird in UTC angegeben.
lengthInMeters	integer	Length In Meters-Eigenschaft
trafficDelayInSeconds	integer	Geschätzte Verzögerung in Sekunden, die durch die Echtzeitvorfälle gemäß Den Verkehrsinformationen verursacht wird. Bei routen, die in Zukunft mit Abfahrtszeit geplant sind, beträgt die Verspätung immer 0. Um zusätzliche Reisezeiten mithilfe verschiedener Arten von Datenverkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.
travelTimeInSeconds	integer	Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echtzeitdatenverkehr enthält. Beachten Sie, dass auch wenn traffic=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs enthält. Wenn DepartAt in der Zukunft liegt, wird die Reisezeit anhand zeitabhängiger historischer Verkehrsdaten berechnet.

RouteType

Der Typ der angeforderten Route.

Name	Typ	Beschreibung
eco	string	Eine Strecke, die durch Wirtschaftlichkeit und Geschwindigkeit ausgeglichen ist.
fastest	string	Die schnellste Route.
shortest	string	Die kürzeste Strecke.
thrilling	string	Beinhaltet interessante oder anspruchsvolle Straßen und nutzt so wenige Autobahnen wie möglich. Sie können das Niveau der enthaltenen Kurven und auch den Grad der Hügeligkeit auswählen. Wie Sie dies festlegen, sehen Sie sich die Parameter für Hügeligkeit und Windigkeit an. Es gibt eine Grenze von 900 km auf geplanten Routen mit routeType=spannend

SectionType

Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird.

Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt.

Name	Typ	Beschreibung
carTrain	string	Streckenabschnitte, bei denen es sich um Autos oder Züge handelt.
carpool	string	Streckenabschnitte, die die Verwendung von Fahrgemeinschaftsspuren (HOV/Fahrzeuge mit hoher Auslastung) erfordern.
country	string	Abschnitte, in denen angegeben wird, in welchen Ländern/Regionen sich die Route befindet.
ferry	string	Streckenabschnitte, bei denen es sich um Fähren handelt.
motorway	string	Streckenabschnitte, die Autobahnen sind.
pedestrian	string	Streckenabschnitte, die nur für Fußgänger geeignet sind.
tollRoad	string	Streckenabschnitte, für die mautpflichtig ist.
tollVignette	string	Streckenabschnitte, für die eine Mautvignette erforderlich ist.
traffic	string	Abschnitte der Route, die Verkehrsinformationen enthalten.
travelMode	string	Abschnitte in Bezug auf den Anforderungsparameter travelMode.
tunnel	string	Abschnitte der Route, die Tunnel sind.
urban	string	Streckenabschnitte, die sich innerhalb städtischer Gebiete befinden.

SimpleCategory

Typ des Vorfalls. Kann derzeit JAM, ROAD_WORK, ROAD_CLOSURE oder OTHER sein. Ausführliche Informationen finden Sie unter "tec".

Name	Typ	Beschreibung
JAM	string	Stau.
OTHER	string	Sonstiges
ROAD_CLOSURE	string	Straßensperrung.
ROAD_WORK	string	Straßenarbeiten.

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "car". Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, lautet das travelMode-Element der Antwort für diesen Abschnitt "Other". Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar.

Name	Typ	Beschreibung
bicycle	string	Die Rückgabewege sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.
bus	string	Die zurückgegebenen Routen sind für Busse optimiert, einschließlich der Verwendung von Busspuren. BETA-Funktionalität.
car	string	Die zurückgegebenen Routen sind für Autos optimiert.
motorcycle	string	Die zurückgegebenen Routen sind für Motorräder optimiert. BETA-Funktionalität.
pedestrian	string	Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich der Nutzung von Gehwegen.
taxi	string	Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.
truck	string	Die Rückgaberouten sind für Nutzfahrzeuge optimiert, z. B. für Lkw.
van	string	Die zurückgegebenen Routen sind für Vans optimiert. BETA-Funktionalität.

VehicleEngineType

Motortyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleEngineType konsistent sein.

Name	Typ	Beschreibung
combustion	string	Verbrennungsmotor.
electric	string	E-Motor.

VehicleLoadType

Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus eingeschränkt werden können. Verfügbare VehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern/Regionen. Werte, die mit USHazmat beginnen, gelten für das US-Routing, während andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt.

Name	Typ	Beschreibung
USHazmatClass1	string	explosive Stoffe
USHazmatClass2	string	Komprimiertes Gas
USHazmatClass3	string	Brennbare Flüssigkeiten
USHazmatClass4	string	Brennbare Feststoffe
USHazmatClass5	string	Oxidatoren
USHazmatClass6	string	Gifte
USHazmatClass7	string	radioaktive Stoffe
USHazmatClass8	string	Ätzende Stoffe
USHazmatClass9	string	Verschiedenes
otherHazmatExplosive	string	explosive Stoffe
otherHazmatGeneral	string	Verschiedenes
otherHazmatHarmfulToWater	string	Wasserschädlich

WindingnessLevel

Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden.

Name	Typ	Beschreibung
high	string	high
low	string	niedrig
normal	string	normal