Freigeben über


Route - Get Route Directions

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

Die Get Route Directions-API ist eine HTTP-GET-Anforderung, die eine Route zwischen einem Ursprung und einem Ziel zurückgibt, wobei bei Angabe Wegpunkte übergeben werden. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am gewünschten Tag der Woche und tageszeit.

Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Fahrzeit und eine Darstellung der Routengeometrie. Je nach ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Waypoint-Reihenfolge 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}
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

Gewünschtes 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, wird durch einen Doppelpunkt getrennt. Mindestens zwei Koordinaten sind erforderlich. Der erste ist der Ursprung und das letzte ist das Ziel der Route. Optionale Koordinaten zwischeneinander fungieren als WayPoints in der Route. Sie können bis zu 150 WayPoints bestehen.

accelerationEfficiency
query

number

double

Gibt die Effizienz der Umwandlung chemischer Energie im Kraftstoff in kinetische Energie an, wenn das Fahrzeug beschleunigt (d. h.Kine EnergyGained/Chemical EnergyConsumed). ChemicalEnergieConsumed wird durch umwandlung verbrauchten Kraftstoff in chemische Energie mit fuel EnergyDensityInMJoulesPerLiter.

Muss mit DeelerationEfficiencygekoppelt werden.

Der zulässige Wertebereich ist 0,0 bis 1/VerzögerungEffizienz.

Vernünftige Werte : für Verbrennungsmodell : 0,33, für Elektromodell : 0,66

alternativeType
query

AlternativeRouteType

Steuert die Optimaleität in Bezug auf die vorgegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Referenzroute.

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.6definiert, mit einem optionalen Offset der Zeitzone. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Zielpunkt handelt.

Beispiele:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Der parameter arriveAt kann nicht in Verbindung mit departAt, minDeviationDistance oder minDeviationTimeverwendet werden.

auxiliaryPowerInkW
query

number

double

Gibt die Menge der verbrauchten Energie für die Aufrechterhaltung von Hilfssystemen in Watten (kW) an.

Es kann verwendet werden, um den Verbrauch aufgrund von Geräten und Systemen wie Ac-Systemen, Funk, Heizung usw. anzugeben.

Sensible Werte : 1,7

auxiliaryPowerInLitersPerHour
query

number

double

Gibt die Menge des verbrauchten Kraftstoffs für die Erhaltung von Hilfssystemen des Fahrzeugs in Litern pro Stunde an.

Es kann verwendet werden, um den Verbrauch aufgrund von Geräten und Systemen wie Ac-Systemen, Funk, 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 in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen darf der Wert "AlreadyUsedRoads" nicht verwendet werden.

computeBestOrder
query

boolean

Ordnen Sie die Routenwegpunkte mithilfe eines schnellen Heuristikalgorithmus neu an, um die Routenlänge zu reduzieren. Erzielt beste Ergebnisse, wenn sie in Verbindung mit routeType kürzestenverwendet werden. Beachten Sie, dass Ursprung und Ziel von den optimierten Wegpunktindizes ausgeschlossen werden. Um Den Ursprung und das Ziel in die Antwort einzuschließen, erhöhen Sie alle Indizes um 1, um den Ursprung zu berücksichtigen, und fügen Sie das Ziel dann als endgültigen Index hinzu. Mögliche Werte sind wahr oder falsch. True berechnet nach Möglichkeit eine bessere Reihenfolge, darf aber nicht in Verbindung mit 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 keineverwendet werden.

computeTravelTimeFor
query

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.

constantSpeedConsumptionInkWhPerHundredkm
query

string

Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an.

Wird als ungeordnete Liste der Geschwindigkeits-/Verbrauchsratenpaare bereitgestellt. Die Liste definiert Punkte für eine Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, sind wie folgt zu finden:

  • durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt

  • durch lineare Extrapolation andernfalls, vorausgesetzt, eine Konstante (ΔConsumption/ΔSpeed), die durch die nächsten zwei Punkte in der Liste bestimmt wird

Die Liste muss zwischen 1 und 25 Punkt (einschließlich) enthalten und darf keine doppelten Punkte für dieselbe Geschwindigkeit enthalten. Wenn sie nur einen einzigen 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.

Entsprechend können verbrauchsspezifische Werte für die beiden kleinsten Geschwindigkeiten in der Liste 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 Elektrische Verbrauchsmodellerforderlich.

constantSpeedConsumptionInLitersPerHundredkm
query

string

Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an.

Bereitgestellt als eine nicht geordnete Liste der durch Doppelpunkt getrennten Geschwindigkeiten & Verbrauchsratenpaare. Die Liste definiert Punkte für eine Verbrauchskurve. Verbrauchsraten für Geschwindigkeiten, die nicht in der Liste enthalten sind, sind wie folgt zu finden:

  • durch lineare Interpolation, wenn die angegebene Geschwindigkeit zwischen zwei Geschwindigkeiten in der Liste liegt

  • durch lineare Extrapolation andernfalls, vorausgesetzt, eine Konstante (ΔConsumption/ΔSpeed), die durch die nächsten zwei Punkte in der Liste bestimmt wird

Die Liste muss zwischen 1 und 25 Punkt (einschließlich) enthalten und darf keine doppelten Punkte für dieselbe Geschwindigkeit enthalten. Wenn sie nur einen einzigen 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.

Entsprechend können verbrauchsspezifische Werte für die beiden kleinsten Geschwindigkeiten in der Liste 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 Verbrennungsverbrauchsmodellerforderlich.

currentChargeInkWh
query

number

double

Gibt die aktuelle elektrische Energieversorgung in Wattstunden (kWh) an.

Dieser Parameter ist mit maxChargeInkWh Parameter koexistiert.

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 die Effizienz der Umwandlung kinetischer Energie in gespeicherten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug verzögert (d. h. Chemical EnergySaved/Kine EnergyLost). ChemicalEnergieSaved wird durch Umwandlung von gespeicherten (nicht verbrauchten) Brennstoffen in Energie mit fuelEnergieDensityInMJoulesPerLitergewonnen.

Muss mit accelerationEfficiencygekoppelt werden.

Der zulässige Wertebereich ist 0,0 bis 1/accelerationEfficiency.

Vernünftige Werte : für Verbrennungsmodell : 0,83, für Elektromodell : 0,91

departAt
query

string

date-time

Das Datum und die Uhrzeit des Abflugpunkts, der als dateTime Wert formatiert ist, wie in RFC 3339, Abschnitt 5.6definiert, mit einem optionalen Offset der Zeitzone. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Ursprungspunkt handelt.

  • Standardwert: jetzt
  • Anderer Wert: dateTime

Beispiele:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Der parameter departAt kann nicht in Verbindung mit arriveAtverwendet werden.

downhillEfficiency
query

number

double

Gibt die Effizienz der Umwandlung potenzieller Energie in gespeicherten (nicht verbrauchten) Kraftstoff an, wenn das Fahrzeug die Höhe verliert (d. h. Chemical EnergySaved/Potential EnergyLost). ChemicalEnergieSaved wird durch Umwandlung von gespeicherten (nicht verbrauchten) Brennstoffen in Energie mit fuelEnergieDensityInMJoulesPerLitergewonnen.

Muss mit uphillEfficiencygekoppelt werden.

Der zulässige Wertebereich ist 0,0 bis 1/uphillEfficiency.

Sensible Werte : für Verbrennungsmodell : 0,51, für Elektromodell : 0,73

fuelEnergyDensityInMJoulesPerLiter
query

number

double

Gibt die Menge an chemischer Energie an, die in einem Liter Kraftstoff in Megajoules (MJ) gespeichert ist. Es wird in Verbindung mit dem *Efficiency Parametern für Umwandlungen zwischen gespeicherter oder verbrauchter Energie und Kraftstoff verwendet. Die Energiedichte beträgt beispielsweise 34,2 MJ/l für Benzin und 35,8 MJ/l für Dieselkraftstoff.

Dieser Parameter ist erforderlich, wenn *Efficiency Parameter festgelegt ist.

Sensible Werte : 34,2

hilliness
query

InclineLevel

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

instructionsType
query

RouteInstructionsType

Wenn angegeben, werden Anleitungsanweisungen zurückgegeben. Beachten Sie, dass der instructionsType-Parameter nicht in Verbindung mit routeRepresentation=none verwendet werden kann.

language
query

string

Der Sprachparameter bestimmt die Sprache der Anleitungsmeldungen. Richtige Nomen (die Namen der Straßen, Plätze 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 der Nähe befindet. Zulässige Werte sind (eine Teilmenge) der IETF-Sprachtags. Die derzeit unterstützten Sprachen werden im Abschnitt Unterstützten Sprachenaufgeführt.

Standardwert: en-GB

maxAlternatives
query

integer

Die Anzahl der gewünschten alternativen Routen, die berechnet werden sollen. Standard: 0, Minimum: 0 und maximal: 5

maxChargeInkWh
query

number

double

Gibt die maximale elektrische Energieversorgung in Wattstunden (kWh) an, die in der Batterie des Fahrzeugs gespeichert werden kann.

Dieser Parameter ist mit currentChargeInkWh Parameter koexistiert.

Der Mindestwert muss größer oder gleich currentChargeInkWhsein.

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 Parameter "minDeviationDistance" kann nicht in Verbindung mit "arriveAt" verwendet werden.

minDeviationTime
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 Sekunden. Kann nur beim Rekonstruieren einer Route verwendet werden. Der parameter minDeviationTime kann nicht in Verbindung mit "arriveAt" verwendet werden. Der Standardwert ist 0. Das Festlegen von )minDeviationTime_ auf einen Wert größer als 0 hat die folgenden Folgen:

  • Der Ursprungspunkt des calculateRoute Anforderung muss sich auf der Eingabereferenzroute befinden (oder sehr nahe).
    • Wenn dies nicht der Fall ist, wird ein Fehler zurückgegeben.
    • Der Ausgangspunkt muss sich jedoch nicht am Anfang der Eingabebezugsroute befinden (er kann als aktuelle Fahrzeugposition auf der Referenzroute betrachtet werden).
  • Die Referenzroute, die als erste Route in der calculateRoute Response zurückgegeben wird, beginnt am Ursprungspunkt, der in der calculateRoute Anforderung angegeben ist. Der erste Teil der Eingabereferenzroute bis zum Ursprungspunkt wird von der Antwort ausgeschlossen.
  • Die Werte von minDeviationDistance und minDeviationTime bestimmen, wie weit alternative Routen garantiert werden, ab dem Ausgangspunkt die Referenzroute zu verfolgen.
  • Die Route muss departAtverwenden.
  • Die vehicleHeading wird ignoriert.
report
query

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. Bei standardmäßigen Parametern wird die Standardeinstellung angezeigt, bei der der Parameter vom Aufrufer nicht angegeben wurde.

routeRepresentation
query

RouteRepresentationForBestOrder

Gibt die Darstellung des Satzes von Routen an, die als Antwort bereitgestellt werden.

routeType
query

RouteType

Der Typ der angeforderten Route.

sectionType
query

SectionType[]

Gibt an, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig auf "Auto" festgelegt.

traffic
query

boolean

Mögliche Werte:

  • true – Berücksichtigen Sie alle verfügbaren Datenverkehrsinformationen während des Routings.
  • false – Aktuelle Datenverkehrsdaten während des Routings ignorieren. Beachten Sie, dass auch wenn die aktuellen Verkehrsdaten während der Weiterleitung ignoriert werden, die Auswirkungen des historischen Verkehrs auf effektive Straßengeschwindigkeiten immer noch integriert werden.
travelMode
query

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.

uphillEfficiency
query

number

double

Gibt die Effizienz der Umwandlung chemischer Energie im Kraftstoff in potenzielle Energie an, wenn das Fahrzeug eine Erhöhung erhält (d. h. PotentialEnergieGained/ChemicalEnergieConsumed). ChemicalEnergieConsumed wird durch umwandlung verbrauchten Kraftstoff in chemische Energie mit fuel EnergyDensityInMJoulesPerLiter.

Muss mit downhillEfficiencygekoppelt werden.

Der zulässige Wertebereich ist 0,0 bis 1/downhillEfficiency.

Sensible Werte : für Verbrennungsmodell : 0,27, für Elektromodell : 0,74

vehicleAxleWeight
query

integer

Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden.

vehicleCommercial
query

boolean

Ob das Fahrzeug für gewerbliche Zwecke verwendet wird. Nutzfahrzeuge dürfen auf einigen Straßen möglicherweise nicht fahren.

vehicleEngineType
query

VehicleEngineType

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

vehicleHeading
query

integer

Die Richtungsrichtung des Fahrzeugs in Grad, die mit true Nord beginnt und im Uhrzeigersinn fortsetzt. Nord ist 0 Grad, Osten ist 90 Grad, Süd ist 180 Grad, West ist 270 Grad. Mögliche Werte 0-359

vehicleHeight
query

number

double

Höhe des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.

vehicleLength
query

number

double

Länge des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Längenbeschränkungen nicht berücksichtigt werden.

vehicleLoadType
query

VehicleLoadType

Ladungstypen, die als gefährliche Stoffe eingestuft 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 andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.

vehicleMaxSpeed
query

integer

Maximale Geschwindigkeit des Fahrzeugs in km/Stunde. Die Höchstgeschwindigkeit im Fahrzeugprofil wird verwendet, um zu überprüfen, ob ein Fahrzeug auf Autobahnen erlaubt ist.

  • Ein Wert von 0 bedeutet, dass bei der Routenplanung ein entsprechender Wert für das Fahrzeug bestimmt und angewendet wird.

  • Ein Wert ungleich Null kann während der Routenplanung außer Kraft gesetzt werden. Beispielsweise beträgt der aktuelle Verkehrsfluss 60 km/Stunde. Wenn die Maximale Geschwindigkeit des Fahrzeugs auf 50 km/Stunde festgelegt ist, berücksichtigt der Routingmotor 60 km/Stunde, da dies die aktuelle Situation ist. Wenn die maximale Geschwindigkeit des Fahrzeugs als 80 km/Stunde angegeben wird, aber der aktuelle Verkehrsfluss 60 km/Stunde beträgt, wird der Routingmotor erneut 60 km/Stunde verwenden.

vehicleWeight
query

integer

Gewicht des Fahrzeugs in Kilogramm.

  • Es ist obligatorisch, wenn eine der *Efficiency-Parameter festgelegt ist.

  • Es muss streng positiv sein, wenn es im Rahmen des Verbrauchsmodells verwendet wird. Gewichtsbeschränkungen werden berücksichtigt.

  • Wenn kein detailliertes Verbrauchsmodell angegeben wird und der Wert fahrzeuggewichtige ungleich Null ist, werden Gewichtseinschränkungen berücksichtigt.

  • In allen anderen Fällen wird dieser Parameter ignoriert.

Vernünftige Werte : für Verbrennungsmodell : 1600, für Elektromodell : 1900

vehicleWidth
query

number

double

Breite des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.

windingness
query

WindingnessLevel

Grad der Kurven für spannende 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 in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Antworten

Name Typ Beschreibung
200 OK

RouteDirections

OKAY

Other Status Codes

ErrorResponse

Unerwarteter Fehler.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Notizen

  • 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 Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das 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.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

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

Typ: apiKey
In: header

Beispiele

Successfully retrieve a route between an origin and a destination

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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 Optimaleität in Bezug auf die vorgegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Referenzroute.

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.

DelayMagnitude

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

DrivingSide

Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.

EffectiveSetting

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

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

GuidanceInstructionType

Art der Anweisung, z. B. Abbiege- oder Straßenwechsel.

GuidanceManeuver

Ein Code, der das Manöver identifiziert.

InclineLevel

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

JunctionType

Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.

LatLongPair

Ein Ort, 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. Bei standardmäßigen Parametern wird die Standardeinstellung angezeigt, bei der der Parameter vom Aufrufer nicht 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 bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen darf der Wert "AlreadyUsedRoads" nicht verwendet werden.

RouteDirections

Dieses Objekt wird von einem erfolgreichen Route Directions-Aufruf zurückgegeben.

RouteGuidance

Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind.

RouteInstruction

Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Turn right", "Keep left", "Take the ferry", "Take the autobahn", "Arrive".

RouteInstructionGroup

Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist mit firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn für Anleitungen lesbare Textnachrichten angefordert werden (instructionType=text oder tagged), wird von der instructionGroup eine Zusammenfassungsmeldung zurückgegeben, wenn sie verfügbar ist.

RouteInstructionsType

Wenn angegeben, werden Anleitungsanweisungen zurückgegeben. Beachten Sie, dass der instructionsType-Parameter 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 bereitgestellt wird, führt zu einem zusätzlichen Abschnitt in der zurückgegebenen Route.

RouteLegSummary

Summary-Objekt für den Routenabschnitt.

RouteOptimizedWaypoint

Optimierte Art des Punktobjekts.

RouteReport

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

RouteRepresentationForBestOrder

Gibt die Darstellung des Satzes von Routen an, die als Antwort bereitgestellt werden.

RouteSection

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

RouteSectionTec

Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.

RouteSectionTecCause

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

RouteSummary

Summary-Objekt

RouteType

Der Typ der angeforderten Route.

SectionType

Gibt an, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig 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, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.

VehicleEngineType

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

VehicleLoadType

Ladungstypen, die als gefährliche Stoffe eingestuft 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 andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.

WindingnessLevel

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

AlternativeRouteType

Steuert die Optimaleität in Bezug auf die vorgegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Referenzroute.

Name Typ Beschreibung
anyRoute

string

Lassen Sie jede alternative Route unabhängig davon zurück, wie sie mit der Referenzroute im Hinblick auf die Optimaleität verglichen wird.

betterRoute

string

Geben Sie eine alternative Route nur zurück, wenn sie besser als die Referenzroute gemäß den angegebenen Planungskriterien ist.

ComputeTravelTime

Gibt an, ob zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen (keine, historischen, live) sowie die standardmäßige am besten geschätzte Reisezeit zurückgegeben werden sollen.

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 die Zusammenfassungen in der Routenantwort einbezogen werden.

none

string

Berechnet keine zusätzlichen Reisezeiten.

DelayMagnitude

Die Größe 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

Kleiner.

2

string

Mäßig.

3

string

Haupt.

4

string

Nicht definiert, für Straßenschließungen und andere unbestimmte Verzögerungen verwendet.

DrivingSide

Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.

Name Typ Beschreibung
LEFT

string

Linke Seite.

RIGHT

string

Rechte Seite.

EffectiveSetting

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

Name Typ Beschreibung
key

string

Name des verwendeten Parameters.

value

string

Wert des verwendeten Parameters.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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. Abbiege- oder Straßenwechsel.

Name Typ Beschreibung
DIRECTION_INFO

string

Richtungsinformationen.

LOCATION_ARRIVAL

string

Ankunftsort.

LOCATION_DEPARTURE

string

Abfahrtsort.

LOCATION_WAYPOINT

string

Position des Wegpunkts.

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 links.

ARRIVE_RIGHT

string

Sie sind angekommen. Ihr Ziel befindet sich auf der rechten Seite.

BEAR_LEFT

string

Bär links.

BEAR_RIGHT

string

Bär rechts.

DEPART

string

Verlassen.

ENTER_FREEWAY

string

Nehmen Sie den Freiweg.

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

Behalten Sie das Recht bei.

MAKE_UTURN

string

Machen Sie eine U-Turn.

MOTORWAY_EXIT_LEFT

string

Nehmen Sie den linken Ausgang.

MOTORWAY_EXIT_RIGHT

string

Nehmen Sie den rechten Ausgang.

ROUNDABOUT_BACK

string

Fahren Sie mit dem Kreisverkehr um.

ROUNDABOUT_CROSS

string

Kreuzen Sie den Kreisverkehr.

ROUNDABOUT_LEFT

string

Im Kreisverkehr nehmen Sie die Ausfahrt auf der linken Seite.

ROUNDABOUT_RIGHT

string

Im Kreisverkehr nehmen Sie die Ausfahrt auf der rechten Seite.

SHARP_LEFT

string

Drehen Sie scharf nach links.

SHARP_RIGHT

string

Drehen Sie scharf nach rechts.

STRAIGHT

string

Halten Sie es gerade.

SWITCH_MAIN_ROAD

string

Wechseln Sie zur Hauptstraße.

SWITCH_PARALLEL_ROAD

string

Wechseln Sie zur parallelen Straße.

TAKE_EXIT

string

Nehmen Sie den Ausgang.

TAKE_FERRY

string

Nehmen Sie die Fähre.

TRY_MAKE_UTURN

string

Versuchen Sie, eine U-Turn zu erstellen.

TURN_LEFT

string

Biege links ab.

TURN_RIGHT

string

Rechts abbiegen.

WAYPOINT_LEFT

string

Sie haben den Wegpunkt erreicht. Sie befindet sich auf der linken Seite.

WAYPOINT_REACHED

string

Sie haben den Wegpunkt erreicht.

WAYPOINT_RIGHT

string

Sie haben den Wegpunkt erreicht. Es befindet sich auf der rechten Seite.

InclineLevel

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

Name Typ Beschreibung
high

string

Hoch

low

string

Niedrig

normal

string

normal

JunctionType

Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.

Name Typ Beschreibung
BIFURCATION

string

Gabelung

REGULAR

string

regelmäßig

ROUNDABOUT

string

Kreisel

LatLongPair

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

Name Typ Beschreibung
latitude

number

Latitude-Eigenschaft

longitude

number

Longitude-Eigenschaft

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. Bei standardmäßigen Parametern wird die Standardeinstellung angezeigt, bei der der Parameter vom Aufrufer nicht 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 JavaScript Object Notation Data Interchange Format

xml

string

Extensible Markup Language

ResponseSectionType

Abschnittstypen der gemeldeten Routenantwort

Name Typ Beschreibung
CARPOOL

string

Abschnitte der Strecke, die die Nutzung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug) erfordern.

CAR_TRAIN

string

Abschnitte der Strecke, die Autos oder Züge sind.

COUNTRY

string

Abschnitte, die angeben, in welchen Ländern/Regionen sich die Route befindet.

FERRY

string

Abschnitte der Route, die Fähren sind.

MOTORWAY

string

Abschnitte der Autobahnen.

PEDESTRIAN

string

Abschnitte der Route, die nur für Fußgänger geeignet sind.

TOLL_ROAD

string

Abschnitte der Route, für die eine Gebührenzahlung erforderlich ist.

TOLL_VIGNETTE

string

Abschnitte der Route, für die eine mautpflichtige Vignette vorhanden sein muss.

TRAFFIC

string

Abschnitte der Route, die Verkehrsinformationen enthalten.

TRAVEL_MODE

string

Abschnitte im Verhältnis zum Anforderungsparameter travelMode.

TUNNEL

string

Abschnitte der Route, die Tunnel sind.

URBAN

string

Abschnitte der Strecke, die sich in städtischen Gebieten 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 zurückgegebenen Routen sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.

bus

string

Die zurückgegebenen Strecken sind für Busse optimiert, einschließlich der Nutzung von Nur-Busspuren. BETA-Funktionalität.

car

string

Die zurückgegebenen Routen sind für Autos optimiert.

motorcycle

string

Die zurückgegebenen Strecken sind für Motorräder optimiert. BETA-Funktionalität.

other

string

Der angegebene Verkehrsträger ist in diesem Abschnitt nicht möglich.

pedestrian

string

Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich des Einsatzes von Gehwegen.

taxi

string

Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.

truck

string

Die zurückgegebenen Routen sind für Nutzfahrzeuge wie für Lkw optimiert.

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 Anleitungen angefordert und verfügbar sind.

legs

RouteLeg[]

Beinenarray

sections

RouteSection[]

Abschnittsarray

summary

RouteSummary

Summary-Objekt

RouteAvoidType

Gibt etwas an, das bei der Routenberechnung beim Bestimmen der Route vermieden werden soll. Kann in einer Anforderung mehrmals angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=fähren". In Route Range-Anforderungen darf der Wert "AlreadyUsedRoads" nicht verwendet werden.

Name Typ Beschreibung
alreadyUsedRoads

string

Vermeiden Sie die Verwendung derselben Straße mehrmals. Am nützlichsten in Verbindung mit routeType=nervenkitzeln.

borderCrossings

string

Vermeidet Grenzübergänge bei der Routenberechnung.

carpools

string

Vermeidet Routen, die die Verwendung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug)-Fahrspuren erfordern.

ferries

string

Vermeiden von Fähren

motorways

string

Vermeiden von Autobahnen

tollRoads

string

Vermeidet mautpflichtige Straßen.

unpavedRoads

string

Vermeidet nicht gepavte Straßen

RouteDirections

Dieses Objekt wird von einem erfolgreichen Route Directions-Aufruf zurückgegeben.

Name Typ Beschreibung
formatVersion

string

Format Version-Eigenschaft

optimizedWaypoints

RouteOptimizedWaypoint[]

Optimierte Sequenz von Wegpunkten. Er zeigt den Index aus der vom Benutzer bereitgestellten Wegpunktsequenz für die ursprüngliche und optimierte Liste an. Beispielsweise 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] lautet und die optimierte Sequenz [1, 2, 0] ist. Da der Index mit 0 beginnt, lautet das Original "first, second, third", while the optimized is "second, third, first".

report

RouteReport

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

routes

Route[]

Routingarray

RouteGuidance

Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind.

Name Typ Beschreibung
instructionGroups

RouteInstructionGroup[]

Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind.

instructions

RouteInstruction[]

Eine Liste der Anweisungen, die Manöver beschreiben.

RouteInstruction

Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Turn right", "Keep left", "Take the ferry", "Take the autobahn", "Arrive".

Name Typ Beschreibung
combinedMessage

string

Eine menschlich 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, die es einfacher macht, zu folgen. Wenn dies der Fall ist, ist das möglicheCombineWithNext-Flag wahr. Zum Beispiel:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Das möglicheCombineWithNext-Flag für Anweisung 10 ist wahr. Dies weist auf die Clients von codierten Anleitungen hin, dass sie mit Anweisung 11 kombiniert werden kann. Die Anweisungen werden automatisch für Kunden kombiniert, die menschenlesbare Anleitungen anfordern. Das combinedMessage-Feld 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-stellige ISO 3166-1 Alpha-3-Ländercode. Z.B. USA.

drivingSide

DrivingSide

Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.

exitNumber

string

Die Anzahl(n) einer Autobahnausfahrt, die vom aktuellen Manöver genommen wird. Wenn ein Exit mehrere Ausgangsnummern aufweist, werden sie durch "" getrennt und möglicherweise durch "-" aggregiert, z. B. "10, 13-15".

instructionType

GuidanceInstructionType

Art der Anweisung, z. B. Abbiege- oder Straßenwechsel.

junctionType

JunctionType

Die Art der Kreuzung, in der das Manöver stattfindet. Bei größeren Kreisverkehren werden zwei separate Anweisungen zum Betreten und Verlassen des Kreisverkehrs generiert.

maneuver

GuidanceManeuver

Ein Code, der das Manöver identifiziert.

message

string

Eine lesbare Nachricht für das Manöver.

point

LatLongPair

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

pointIndex

integer

Der Index des Punkts in der Liste der Polylinien "Punkte", die dem Punkt der Anweisung entsprechen.

possibleCombineWithNext

boolean

Optional ist es möglich, die Anweisung mit dem nächsten zu kombinieren. Dies kann verwendet werden, um Nachrichten wie "Nach links drehen und dann nach rechts zu drehen" zu erstellen.

roadNumbers

string[]

Die Straßennummer(n) des nächsten signifikanten Straßensegments(n) nach dem Manöver oder der zu verfolgenden Straße(n). Beispiel: ["E34"; "N205"]

roundaboutExitNumber

integer

Dies zeigt an, welche Ausfahrt bei einem Kreisverkehr zu nehmen ist.

routeOffsetInMeters

integer

Entfernung vom Anfang der Route zum Punkt der Anweisung.

signpostText

string

Der Text auf einem Wegweiser, der für das Manöver am relevantesten ist, oder für die Richtung, die verfolgt werden sollte.

stateCode

string

Eine Unterteilung (z. B. Bundesland) 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 bedeutenden Straßensegments nach dem Manöver oder der Straße, die verfolgt werden sollte.

travelTimeInSeconds

integer

Geschätzte Fahrzeit bis zum Punkt, der der RouteOffsetInMeters entspricht.

turnAngleInDecimalDegrees

integer

Gibt die Richtung einer Anweisung an. If junctionType indicates a turn instruction:

  • 180 = U-Turn
  • [-179, -1] = Linksdrehung
  • 0 = Gerade ein (ein "0 Grad"-Drehung)
  • [1, 179] = Rechtsdrehung

Wenn junctionType eine Bifurcationsanweisung angibt:

  • <0 - links halten
  • >0 - rechts halten

RouteInstructionGroup

Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist mit firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn für Anleitungen lesbare Textnachrichten angefordert werden (instructionType=text oder tagged), wird von der instructionGroup eine Zusammenfassungsmeldung zurückgegeben, wenn sie verfügbar ist.

Name Typ Beschreibung
firstInstructionIndex

integer

Index der ersten Anweisung in den Anweisungen und Zugehörigkeit zu dieser Gruppe.

groupLengthInMeters

integer

Länge der Gruppe.

groupMessage

string

Zusammenfassungsmeldung, wenn textlesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged).

lastInstructionIndex

integer

Index der letzten Anweisung in den Anweisungen und Zugehörigkeit zu dieser Gruppe.

RouteInstructionsType

Wenn angegeben, werden Anleitungsanweisungen zurückgegeben. Beachten Sie, dass der instructionsType-Parameter nicht in Verbindung mit routeRepresentation=none verwendet werden kann.

Name Typ Beschreibung
coded

string

Gibt unformatierte Anweisungsdaten ohne lesbare Nachrichten zurück.

tagged

string

Gibt unformatierte Anweisungsdaten mit markierten, menschenlesbaren Nachrichten zurück, um die Formatierung zu ermöglichen. Eine lesbare Nachricht wird aus wiederholbaren identifizierten Elementen aufgebaut. Diese werden markiert, damit Clientanwendungen sie richtig formatieren können. Die folgenden Nachrichtenkomponenten werden markiert, wenn instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Beispiel für markierte Nachricht "Links drehen":

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text

string

Gibt Unformatierte Anweisungen mit 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 bereitgestellt wird, führt zu einem zusätzlichen Abschnitt in der zurückgegebenen Route.

Name Typ Beschreibung
points

LatLongPair[]

Punktearray

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 den Abschnitt. Die Uhrzeit ist in UTC.

batteryConsumptionInkWh

number

Geschätzter elektrischer Energieverbrauch in Wattstunden (kWh) mit dem Elektroverbrauchsmodell. Enthalten, wenn vehicleEngineType auf elektro- und constantSpeedConsumptionInkWhPerHundredkm festgelegt ist. Der Wert von batteryConsumptionInkWh umfasst die recuperierte elektrische Energie und kann daher negativ sein (was auf energiegewinnende Energie hinweist). Wenn sowohl maxChargeInkWh als auch currentChargeInkWh angegeben werden, wird die Recuperation begrenzt, um sicherzustellen, dass der Akkuladestand niemals maxChargeInkWh überschreitet. Wenn weder maxChargeInkWh noch currentChargeInkWh angegeben werden, wird bei der Verbrauchsberechnung eine nicht eingeschränkte Rekuperation angenommen.

departureTime

string

Die geschätzte Abfahrtszeit für die Route oder den Bein. Die Uhrzeit ist in UTC.

fuelConsumptionInLiters

number

Geschätzter Kraftstoffverbrauch in Litern mit dem Verbrennungsverbrauchsmodell. Enthalten, wenn vehicleEngineType auf Verbrennung und constantSpeedConsumptionInLitersPerHundredkm festgelegt ist. Der Wert ist nicht negativ.

historicTrafficTravelTimeInSeconds

integer

Geschätzte Fahrzeit, die mit zeitabhängigen historischen Verkehrsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.

lengthInMeters

integer

Length In Meter-Eigenschaft

liveTrafficIncidentsTravelTimeInSeconds

integer

Geschätzte Fahrzeit, die mithilfe von Echtzeitgeschwindigkeitsdaten berechnet wird. Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.

noTrafficTravelTimeInSeconds

integer

Geschätzte Fahrzeit, die so berechnet wird, als ob es aufgrund von Verkehrsbedingungen keine Verzögerungen auf der Strecke gibt (z. B. Stau). Nur enthalten, wenn computeTravelTimeFor = alle in der Abfrage verwendet werden.

trafficDelayInSeconds

integer

Geschätzte Verzögerung in Sekunden, die durch den(n) Echtzeitvorfall(n) nach Datenverkehrsinformationen verursacht wird. Bei künftig geplanten Routen mit Abfahrtszeit sind Verzögerungen immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.

travelTimeInSeconds

integer

Geschätzte Fahrzeit in Sekunden, die die Verzögerung aufgrund des Echtzeitdatenverkehrs enthält. Beachten Sie, dass auch wenn datenverkehr=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs noch enthält. Wenn "DepartAt" in Zukunft erfolgt, wird die Fahrzeit mit zeitabhängigen historischen Verkehrsdaten berechnet.

RouteOptimizedWaypoint

Optimierte Art des Punktobjekts.

Name Typ Beschreibung
optimizedIndex

integer

Optimierter Wegpunktindex aus dem System.

providedIndex

integer

Wegpunktindex, der vom Benutzer bereitgestellt wird.

RouteReport

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

Name Typ Beschreibung
effectiveSettings

EffectiveSetting[]

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

RouteRepresentationForBestOrder

Gibt die Darstellung des Satzes von Routen an, die als Antwort bereitgestellt werden.

Name Typ Beschreibung
none

string

Enthält nur die optimierten Wegpunktindizes, enthält aber nicht die Routengeometrie in der Antwort. Dieser Parameterwert kann nur in Verbindung mit computeBestOrder=true verwendet werden.

polyline

string

Enthält die Routengeometrie in der Antwort.

summaryOnly

string

Zusammenfassung gemäß Polylinie, jedoch ohne die Punktgeometrieelemente 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 werden.

effectiveSpeedInKmh

integer

Effektive Geschwindigkeit des Vorfalls in km/h, durchschnittlich über die gesamte Länge.

endPointIndex

integer

Index des letzten Punkts (Offset 0) in der Route, für die dieser Abschnitt gilt.

magnitudeOfDelay

DelayMagnitude

Die Größe 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 Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.

travelMode

ResponseTravelMode

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

RouteSectionTec

Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente.

Name Typ Beschreibung
causes

RouteSectionTecCause[]

Verursacht Array

effectCode

integer

Der Effekt auf den Datenverkehrsfluss. Enthält einen Wert in der Tabelle tec001:EffectCode, wie im TPEG2-TEC- Standard definiert. Kann verwendet werden, um Datenverkehrsereignisse entsprechend dem Schweregrad farbcodieren zu können.

RouteSectionTecCause

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

Name Typ Beschreibung
mainCauseCode

integer

Die Hauptursache des Datenverkehrsereignisses. Enthält einen Wert in der Tabelle tec002:CauseCode, wie im TPEG2-TEC- Standard definiert.

subCauseCode

integer

Die Unterkause des Datenverkehrsereignisses. Enthält einen Wert in der durch den mainCauseCode definierten Unterursachentabelle, wie im TPEG2-TEC- Standard definiert.

RouteSummary

Summary-Objekt

Name Typ Beschreibung
arrivalTime

string

Die geschätzte Ankunftszeit für die Route oder den Abschnitt. Die Uhrzeit ist in UTC.

departureTime

string

Die geschätzte Abfahrtszeit für die Route oder den Bein. Die Uhrzeit ist in UTC.

lengthInMeters

integer

Length In Meter-Eigenschaft

trafficDelayInSeconds

integer

Geschätzte Verzögerung in Sekunden, die durch den(n) Echtzeitvorfall(n) nach Datenverkehrsinformationen verursacht wird. Bei künftig geplanten Routen mit Abfahrtszeit sind Verzögerungen immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Verkehrsinformationen zurückzugeben, muss der Parameter computeTravelTimeFor=all hinzugefügt werden.

travelTimeInSeconds

integer

Geschätzte Fahrzeit in Sekunden, die die Verzögerung aufgrund des Echtzeitdatenverkehrs enthält. Beachten Sie, dass auch wenn datenverkehr=false travelTimeInSeconds die Verzögerung aufgrund des Datenverkehrs noch enthält. Wenn "DepartAt" in Zukunft erfolgt, wird die Fahrzeit mit zeitabhängigen historischen Verkehrsdaten berechnet.

RouteType

Der Typ der angeforderten Route.

Name Typ Beschreibung
eco

string

Eine Route, die durch Wirtschaft und Geschwindigkeit ausgeglichen ist.

fastest

string

Die schnellste Route.

shortest

string

Die kürzeste Strecke nach Entfernung.

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. Sehen Sie sich die Hügel- und Windigkeitsparameter an, um dies festzulegen. Es gibt eine Grenze von 900 km auf Routen, die mit routeType=nervenkitzeln geplant sind.

SectionType

Gibt an, welche Der Abschnittstypen in der Routenantwort gemeldet werden.

Beispiel: SectionType = Fußgänger die Abschnitte, die nur für Fußgänger geeignet sind, werden zurückgegeben. Kann in einer Anforderung mehrmals angegeben werden, z. B. "§ionType=carTrain§ionType=pedestrian§ionType=autobahn". Der Standard sectionType bezieht sich auf die travelMode-Eingabe. "travelMode" ist standardmäßig auf "Auto" festgelegt.

Name Typ Beschreibung
carTrain

string

Abschnitte der Strecke, die Autos oder Züge sind.

carpool

string

Abschnitte der Strecke, die die Nutzung von Fahrgemeinschaften (HOV/High-Belegung Fahrzeug) erfordern.

country

string

Abschnitte, die angeben, in welchen Ländern/Regionen sich die Route befindet.

ferry

string

Abschnitte der Route, die Fähren sind.

motorway

string

Abschnitte der Autobahnen.

pedestrian

string

Abschnitte der Route, die nur für Fußgänger geeignet sind.

tollRoad

string

Abschnitte der Route, für die eine Gebührenzahlung erforderlich ist.

tollVignette

string

Abschnitte der Route, für die eine mautpflichtige Vignette vorhanden sein muss.

traffic

string

Abschnitte der Route, die Verkehrsinformationen enthalten.

travelMode

string

Abschnitte im Verhältnis zum Anforderungsparameter travelMode.

tunnel

string

Abschnitte der Route, die Tunnel sind.

urban

string

Abschnitte der Strecke, die sich in städtischen Gebieten 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

Verkehrsstau.

OTHER

string

Andere.

ROAD_CLOSURE

string

Straßenschließung.

ROAD_WORK

string

Straßenarbeiten.

TravelMode

Der Reisemodus für die angeforderte Route. Wenn nicht definiert, lautet der Standardwert "Auto". 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 Reisemodi Bus, Motorrad, Taxi und Van beta Funktionalität sind. Vollständige Einschränkungsdaten sind in allen Bereichen nicht verfügbar.

Name Typ Beschreibung
bicycle

string

Die zurückgegebenen Routen sind für Fahrräder optimiert, einschließlich der Nutzung von Fahrradspuren.

bus

string

Die zurückgegebenen Strecken sind für Busse optimiert, einschließlich der Nutzung von Nur-Busspuren. BETA-Funktionalität.

car

string

Die zurückgegebenen Routen sind für Autos optimiert.

motorcycle

string

Die zurückgegebenen Strecken sind für Motorräder optimiert. BETA-Funktionalität.

pedestrian

string

Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich des Einsatzes von Gehwegen.

taxi

string

Die zurückgegebenen Routen sind für Taxis optimiert. BETA-Funktionalität.

truck

string

Die zurückgegebenen Routen sind für Nutzfahrzeuge wie für Lkw optimiert.

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übereinstimmen.

Name Typ Beschreibung
combustion

string

Verbrennungsmotor.

electric

string

Elektrischer Motor.

VehicleLoadType

Ladungstypen, die als gefährliche Stoffe eingestuft 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 andereHazmat für alle anderen Länder/Regionen verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter gilt derzeit nur für travelMode=truck.

Name Typ Beschreibung
USHazmatClass1

string

Sprengstoff

USHazmatClass2

string

Komprimiertes Gas

USHazmatClass3

string

Brennbare Flüssigkeiten

USHazmatClass4

string

Brennbare Feststoffe

USHazmatClass5

string

Oxidizer

USHazmatClass6

string

Gifte

USHazmatClass7

string

Radioaktiv

USHazmatClass8

string

Beizmittel

USHazmatClass9

string

Verschiedenes

otherHazmatExplosive

string

Sprengstoff

otherHazmatGeneral

string

Verschiedenes

otherHazmatHarmfulToWater

string

Schädlich für Wasser

WindingnessLevel

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

Name Typ Beschreibung
high

string

Hoch

low

string

Niedrig

normal

string

normal