Route - Get Route Directions

Gilt für: S0-und S1-Tarife.

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück und übergibt ggf. angegebene Wegpunkte. Bei der Route werden Faktoren wie aktueller Datenverkehr und die üblichen Straßen Geschwindigkeiten am angeforderten Wochentag und der Tageszeit berücksichtigt.

Zu den zurückgegebenen Informationen zählen der Abstand, die geschätzte Reisezeit und eine Darstellung der Routen Geometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routing Informationen, wie z. b. eine optimierte Reihenfolge oder eine Reihe von Anweisungen, zur Verfügung.

Der Routing Dienst stellt eine Reihe von Parametern für eine ausführliche Beschreibung des fahrzeugspezifischen Verbrauchs Modells bereit. Überprüfen Sie das Verbrauchsmodell , um ausführliche Erläuterungen zu den beteiligten Konzepten und Parametern zu erhalten.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?subscription-key={subscription-key}&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={report}&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 Required Type Description
format
path True

Das gewünschte Format der Antwort. Der Wert kann entweder " JSON " oder " XML" lauten.

api-version
query True
  • string

Versionsnummer der Azure Maps-API. Aktuelle Version ist 1,0

query
query True
  • string

Die Koordinaten, durch die die Route berechnet wird, getrennt durch einen Doppelpunkt. Mindestens zwei Koordinaten sind erforderlich. Der erste ist der Ursprung, und das letzte ist das Ziel der Route. Optionale Koordinaten in-between fungieren als Punkte in der Route. Sie können bis zu 150-Wegpunkte übergeben.

accelerationEfficiency
query
  • number
float

Gibt die Effizienz an, mit der die in Treibstoff gespeicherte chemische Energie in eine kinetische Energie umwandelt wird, wenn das Fahrzeug beschleunigt wird (d. h. kineticenergygewonnene/chemicalenergykonsumiert). Die Verwendung von chemicalenergywird durch das Umwandeln von verbrauchter Treibstoff in chemische Energie mithilfe von fuelenergydensityinmjoulesperlitererzielt.

Muss mit " verlangsamungsefficiency" gekoppelt werden.

Der zulässige Wertebereich ist 0,0 bis 1/Verlangsamung der Effizienz.

Sinnvolle Werte: für das Verbrennungs Modell : 0,33, für das elektrische Modell : 0,66

alternativeType
query

Steuert die Optimalität der in Bezug auf die angegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Verweis Route.

arriveAt
query
  • string
date-time

Das Datum und die Uhrzeit der Ankunft am Zielpunkt. Er muss als DateTime-Wert angegeben werden. Wenn kein Zeit Zonen Offset angegeben wird, wird davon ausgegangen, dass es sich um den des Ziel Punkts handelt. Der Wert für "arriveat" muss in der Zukunft liegen. Der Parameter "arriveat" kann nicht in Verbindung mit "departat", "mindeviationdistance" oder "mindeviationtime" verwendet werden.

auxiliaryPowerInkW
query
  • string

Gibt die Stromversorgung an, die für die Aufrechterhaltung von Hilfssystemen in Kilowatt (kW) beansprucht wird.

Sie kann verwendet werden, um die Nutzung durch Geräte und Systeme wie z. b. AC-Systeme, Radio, Heizung usw. anzugeben.

Sinnvolle Werte: 1,7

auxiliaryPowerInLitersPerHour
query
  • number
float

Gibt den Umfang des für die Erhaltung der zusätzlichen Systeme des Fahrzeugs genutzten Treibstoffs in Litern pro Stunde an.

Sie kann verwendet werden, um die Nutzung durch Geräte und Systeme wie z. b. AC-Systeme, Radio, Heizung usw. anzugeben.

Sinnvolle Werte: 0,2

avoid
query

Gibt einen Wert an, den die Routenberechnung vermeiden soll, wenn die Route bestimmt wird. Kann in einer Anforderung mehrmals angegeben werden, z. b. "&vermeide-Autobahnen&vermeiden = tollstraßen&vermeiden = Fähren". In calculatereachablerange-Anforderungen darf der Wert alleseryusedroads nicht verwendet werden.

computeBestOrder
query
  • boolean

Ordnen Sie die Routen-waypunkte mithilfe eines schnellen heuristischen Algorithmus neu an, um die Routen Länge zu verringern. Liefert optimale Ergebnisse, wenn Sie in Verbindung mit routetype _kürzeste_verwendet werden. Beachten Sie, dass der Ursprung und das Ziel aus den optimierten Wegpunkt-Indizes ausgeschlossen werden. Um den Ursprung und das Ziel in die Antwort einzubeziehen, 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, kann aber nicht in Verbindung mit dem maxalternativen-Wert größer als 0 oder in Verbindung mit Kreis-waypunkten verwendet werden. False verwendet die Speicherorte in der angegebenen Reihenfolge und darf nicht in Verbindung mit routerepresentation _None_verwendet werden.

computeTravelTimeFor
query

Gibt an, ob zusätzliche Fahrtzeiten mit unterschiedlichen Arten von Datenverkehrs Informationen (None, Historic, Live) sowie der standardmäßig am besten geschätzten Reisezeit zurückgegeben werden.

constantSpeedConsumptionInkWhPerHundredkm
query
  • string

Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an.

Wird als ungeordnete Liste der Geschwindigkeit/Verbrauchsraten-Paare bereitgestellt. Die Liste definiert Punkte in einer Verbrauchs Kurve. Die Verbrauchsraten für die nicht in der Liste enthaltenen Geschwindigkeiten werden wie folgt ermittelt:

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

  • bei der linearen extrapolierungs Prüfung andernfalls, wenn eine Konstante (der Wert von "-Verbrauch/-Geschwindigkeit") bestimmt wird, die durch die nächstgelegenen beiden Punkte

Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf nicht für dieselbe Geschwindigkeit doppelte Punkte 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 Wert der vorletzten Höchstgeschwindigkeit sein. Dadurch wird sichergestellt, dass die extrapolierungs Rate nicht zu negativen Verbrauchsraten führt.

Entsprechend können die Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine geringere Geschwindigkeit führen.

Der gültige Bereich für die Verbrauchswerte (ausgedrückt in kWh/100km) liegt zwischen 0,01 und 100000,0.

Sinnvolle Werte: 50, 8.2:130, 21,3

Dieser Parameter ist für das Modell für den Stromverbraucherforderlich.

constantSpeedConsumptionInLitersPerHundredkm
query
  • number
float

Gibt die geschwindigkeitsabhängige Komponente des Verbrauchs an.

Wird als ungeordnete Liste von durch Doppelpunkten getrennten Geschwindigkeiten & Verbrauchsraten Paaren bereitgestellt. Die Liste definiert Punkte in einer Verbrauchs Kurve. Die Verbrauchsraten für die nicht in der Liste enthaltenen Geschwindigkeiten werden wie folgt ermittelt:

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

  • bei der linearen extrapolierungs Prüfung andernfalls, wenn eine Konstante (der Wert von "-Verbrauch/-Geschwindigkeit") bestimmt wird, die durch die nächstgelegenen beiden Punkte

Die Liste muss zwischen 1 und 25 Punkten (einschließlich) enthalten und darf nicht für dieselbe Geschwindigkeit doppelte Punkte 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 Wert der vorletzten Höchstgeschwindigkeit sein. Dadurch wird sichergestellt, dass die extrapolierungs Rate nicht zu negativen Verbrauchsraten führt.

Entsprechend können die Verbrauchswerte, die für die beiden kleinsten Geschwindigkeiten in der Liste angegeben werden, nicht zu einer negativen Verbrauchsrate für eine geringere Geschwindigkeit führen.

Der gültige Bereich für die Verbrauchswerte (ausgedrückt in l/100km) liegt zwischen 0,01 und 100000,0.

Sinnvolle Werte: 50, 6.3:130, 11,5

Hinweis : dieser Parameter ist für das Modell für den Verbrennungs Verbraucherforderlich.

currentChargeInkWh
query
  • string

Gibt die aktuelle Stromversorgung in kilostunden (kWh) an.

Dieser Parameter ist zusammen mit dem maxchargeinkwh -Parameter vorhanden.

Der zulässige Wertebereich ist 0,0 bis maxcharginkwh.

Sinnvolle Werte: 43

currentFuelInLiters
query
  • number
float

Gibt die aktuelle Stromversorgung in Litern an.

Sinnvolle Werte: 55

decelerationEfficiency
query
  • number
float

Gibt die Effizienz der Umstellung von kinetischen Energie in gespeicherten (nicht verbrauchten) Brennstoff an, wenn das Fahrzeug verlangsamt wird (d. h. chemicalenergygespeicherter/kineticenergylost). "Chemicalenergygespeicherter " wird durch das Umwandeln von gespeicherter (nicht verbrauchter) Brennstoff in Energie mithilfe von fuelenergydensityinmjoulesperliterabgerufen.

Muss mit accelerationefficiencygekoppelt werden.

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

Sinnvolle Werte: für das Verbrennungs Modell : 0,83, für das elektrische Modell : 0,91

departAt
query
  • string
date-time

Das Datum und die Uhrzeit des Abbruchs vom Ursprungs Punkt. Die Abflugzeiten außer jetzt müssen als DateTime-Wert angegeben werden. Wenn kein Zeit Zonen Offset angegeben wird, wird davon ausgegangen, dass es sich um den des Ursprungs Punkts handelt. Der departat-Wert muss in der Zukunft im Datums-/Uhrzeitformat (1996-12-19t16:39:57-08:00) liegen.

downhillEfficiency
query
  • number
float

Gibt die Effizienz der Umstellung potenzieller Energie in gespeicherten (nicht genutzten) Brennstoff an, wenn das Fahrzeug eine Erhöhung der Rechte verliert (d. h. chemicalenergygespeicherter/potenzialenergylost). "Chemicalenergygespeicherter " wird durch das Umwandeln von gespeicherter (nicht verbrauchter) Brennstoff in Energie mithilfe von fuelenergydensityinmjoulesperliterabgerufen.

Muss mit uphillefficiencygekoppelt werden.

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

Sinnvolle Werte: für das Verbrennungs Modell : 0,51, für das elektrische Modell : 0,73

fuelEnergyDensityInMJoulesPerLiter
query
  • number
float

Gibt die Menge an chemischer Energie an, die in einem Liter von Kraftstoff in Megajoules (MJ) gespeichert ist. Sie wird in Verbindung mit den *Effizienz Parametern für Konvertierungen zwischen gespeicherter oder verbrauchter Energie und Kraftstoff verwendet. Die Energiedichte beträgt z. b. 34,2 MJ/l für Benzin und 35,8 MJ/l für den Diesel Kraftstoff.

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

Sinnvolle Werte: 34,2

hilliness
query

Grad der Hilfe für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

instructionsType
query

Wenn 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 Leit Faden Nachrichten. Dies hat keine Auswirkung auf die richtigen Nomen (die Namen von Straßen, Plazas usw.). Dies hat keine Auswirkungen, wenn instructionstype = codiert ist. Zulässige Werte sind (eine Teilmenge) der beschriebenen IETF-Sprachen Tags.

maxAlternatives
query
  • integer

Anzahl der gewünschten alternativen Routen, die berechnet werden sollen. Standardwert: 0, Minimalwert: 0 und Maximum: 5

maxChargeInkWh
query
  • string

Gibt die maximale Stromversorgung in kilostunden (kWh) an, die im Akku des Fahrzeugs gespeichert werden kann.

Dieser Parameter ist zusammen mit dem currentchargeinkwh -Parameter vorhanden.

Der minimale Wert muss größer oder gleich currentchargeingekwhsein.

Sinnvolle Werte: 85

minDeviationDistance
query
  • integer

Alle alternativen Routen, die zurückgegeben werden, folgen der Verweis Route (siehe Abschnitt Post-Anforderungen) vom Ursprungs Punkt der calculateroute-Anforderung für mindestens diese Anzahl von Metern. Kann nur beim erneuten Erstellen 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 der Verweis Route (siehe Abschnitt Post-Anforderungen) vom Ursprungs Punkt der calculateroute-Anforderung für mindestens diese Anzahl von Sekunden. Kann nur beim erneuten Erstellen einer Route verwendet werden. Der mindeviationtime-Parameter kann nicht in Verbindung mit arriveat verwendet werden. Der Standardwert ist 0 (null). Das Festlegen von) minDeviationTime_ auf einen Wert größer als 0 (null) hat die folgenden Konsequenzen:

  • Der Ursprungs Punkt der calculateroute -Anforderung muss sich auf der Eingabe Verweis Route (oder in der Nähe) befinden.
    • Wenn dies nicht der Fall ist, wird ein Fehler zurückgegeben.
    • Der Ursprungs Punkt muss sich jedoch nicht am Anfang der Eingabe Verweis Route befinden (er kann als die aktuelle Fahrzeugposition auf der Verweis Route betrachtet werden).
  • Die Verweis Route, die als erste Route in der calculateroute -Antwort zurückgegeben wird, beginnt am Ursprungs Punkt, der in der calculateroute -Anforderung angegeben ist. Der erste Teil des Eingabe Verweises wird nach oben verschoben, bis der Ursprungs Punkt von der Antwort ausgeschlossen wird.
  • Mit den Werten von mindeviationdistance und mindeviationtime wird festgelegt, wie weit die Routen der Verweis Route von dem Ursprungs Punkt bis zu einem bestimmten Zeitpunkt sicher befolgt werden.
  • Die Route muss _departat_verwenden.
  • Vehicleüber Schrift wird ignoriert.
report
query
  • string

Gibt an, welche Daten zu Diagnose Zwecken 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 der Standardwert wiedergegeben, wenn der Parameter nicht vom Aufrufer angegeben wurde.

routeRepresentation
query

Gibt die Darstellung des Satzes von Routen an, der als Antwort bereitgestellt wird. Dieser Parameterwert kann nur in Verbindung mit computebestorder = true verwendet werden.

routeType
query

Der Typ der angeforderten Route.

sectionType
query

Gibt an, welcher der Abschnitts Typen in der Routen Antwort gemeldet wird.

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

subscription-key
query
  • string

Einer der Azure Maps Schlüssel, der von einem Azure Map-Konto bereitgestellt wird. Ausführliche Informationen zum Verwalten der Authentifizierung finden Sie in diesem Artikel .

traffic
query
  • boolean

Mögliche Werte:

  • true: Beachten Sie alle verfügbaren Datenverkehrs Informationen während des Routings.
  • false: die aktuellen Datenverkehrs Daten werden während des Routings ignoriert. Beachten Sie Folgendes: Obwohl die aktuellen Datenverkehrs Daten während des Routings ignoriert werden, sind die Auswirkungen des Verlaufs von Verlaufs Daten auf effektive Fahrgeschwindigkeiten weiterhin integriert.
travelMode
query

Der fortbewegungs Modus für die angeforderte Route. Wenn Sie nicht definiert ist, lautet 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, ist das travelmode-Element der Antwort für diesen Abschnitt "Other". Beachten Sie, dass die Reise Modi Bus, Motorrad, Taxi und van eine Beta Funktion sind. Vollständige Einschränkungs Daten sind nicht in allen Bereichen verfügbar. In calculatereachablerange -Anforderungen dürfen die Werte Bicycle und Fußgängern nicht verwendet werden.

uphillEfficiency
query
  • number
float

Gibt die Effizienz der Umstellung von in Kraftstoff gespeicherter chemischer Energie in eine potenzielle Energie an, wenn das Fahrzeug eine Erhöhung der Rechte erzielt (d. h. "potenzialenergygewonnene/chemicalenergy"). Die Verwendung von chemicalenergywird durch das Umwandeln von verbrauchter Treibstoff in chemische Energie mithilfe von fuelenergydensityinmjoulesperlitererzielt.

Muss mit downhillefficiencygekoppelt werden.

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

Sinnvolle Werte: für das Verbrennungs Modell : 0,27, für das elektrische Modell : 0,74

vehicleAxleWeight
query
  • integer

Gewichtung pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass keine Gewichtungs Beschränkungen pro Achse berücksichtigt werden.

vehicleCommercial
query
  • boolean

Das Fahrzeug wird zu kommerziellen Zwecken verwendet und ist daher möglicherweise auf einigen Straßen nicht zulässig.

vehicleEngineType
query

Der Modultyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleenginetypekonsistent sein.

vehicleHeading
query
  • integer

Die direktionale Überschrift des Fahrzeugs in Grad, beginnend bei true North und wird im Uhrzeigersinn fortgesetzt. North ist 0 Grad, Osten ist 90 Grad, Süd ist 180 Grad, West ist 270 Grad. Mögliche Werte 0-359

vehicleHeight
query
  • number
float

Höhe des Fahrzeugs in Meter. Der Wert 0 bedeutet, dass Höhen Einschränkungen nicht berücksichtigt werden.

vehicleLength
query
  • number
float

Die Länge des Fahrzeugs in Meter. Der Wert 0 bedeutet, dass Längen Einschränkungen nicht berücksichtigt werden.

vehicleLoadType
query

Ladungstypen, die als gefährliche Materialien klassifiziert und von einigen Straßen eingeschränkt werden können. Die verfügbaren vehicleloadtype-Werte sind US-Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit "ushazmat" beginnen, sind für das Routing von uns vorgesehen, während otherhazmat für alle anderen Länder verwendet werden sollte vehicleloadtype kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für "travelmode = Truck" berücksichtigt.

vehicleMaxSpeed
query
  • integer

Maximale Geschwindigkeit des Fahrzeugs in Kilometern pro Stunde. Die maximale Geschwindigkeit im Fahrzeug Profil wird verwendet, um zu überprüfen, ob ein Fahrzeug auf den Autobahnen zugelassen ist.

  • Der Wert 0 bedeutet, dass ein entsprechender Wert für das Fahrzeug während der Routenplanung bestimmt und angewendet wird.

  • Ein Wert ungleich 0 (null) kann während der Routenplanung überschrieben werden. Der aktuelle Daten Verkehrsfluss beträgt z. b. 60 km/Stunde. Wenn die maximale Geschwindigkeit des Fahrzeugs auf 50 km/Stunde festgelegt ist, wird die Routing-Engine 60 km/Stunde in Erwägung gezogen, da dies die aktuelle Situation ist. Wenn die maximale Geschwindigkeit des Fahrzeugs 80 km/Stunde beträgt, aber der aktuelle Daten Verkehrsfluss 60 km/Stunde beträgt, wird von der Routing-Engine erneut 60 km/Stunde verwendet.

vehicleWeight
query
  • integer

Gewichtung des Fahrzeugs in Kilogramm.

  • Es ist obligatorisch, wenn einer der * Effizienz Parameter festgelegt ist.

  • Sie muss streng positiv sein, wenn Sie im Kontext des Verbrauchs Modells verwendet wird. Gewichtungs Einschränkungen werden berücksichtigt.

  • Wenn kein detailliertes Verbrauchsmodell angegeben wird und der Wert von vehicleweight ungleich 0 (null) ist, werden Gewichtungs Beschränkungen berücksichtigt.

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

Sinnvolle Werte: für das Verbrennungs Modell : 1600, für das elektrische Modell : 1900

vehicleWidth
query
  • number
float

Breite des Fahrzeugs in Meter. Der Wert 0 bedeutet, dass keine breiten Einschränkungen berücksichtigt werden.

windingness
query

Die Ebene der Turn-Kurven für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

Anforderungsheader

Name Required Type Description
x-ms-client-id
  • string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps Konto dar und kann über Azure Maps Konto-API der Verwaltungsebene abgerufen werden. Informationen zur Verwendung Azure AD Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name Type Description
200 OK

OK

Media Types: "application/json", "application/xml"

400 Bad Request

Ungültige Anforderung: mindestens ein Parameter wurde falsch angegeben oder schließen sich gegenseitig aus.

Media Types: "application/json", "application/xml"

401 Unauthorized

Der Zugriff wurde aufgrund eines ungültigen Abonnement Schlüssels oder eines ungültigen Azure Active Directory bearertokens verweigert. Stellen Sie sicher, dass Sie einen gültigen Schlüssel für ein aktives Azure-Abonnement und eine Maps-Ressource angeben. Überprüfen Sie andernfalls den www-Authenticate- Header auf den Fehlercode und die Beschreibung des bereitgestellten Aad-bearertokens.

Media Types: "application/json", "application/xml"

Headers

  • WWW-Authenticate: string
403 Forbidden

Berechtigungs-, Kapazitäts-oder Authentifizierungs Probleme.

Media Types: "application/json", "application/xml"

404 Not Found

Nicht gefunden: die angeforderte Ressource wurde nicht gefunden, kann aber in Zukunft wieder verfügbar sein.

Media Types: "application/json", "application/xml"

500 Internal Server Error

Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten. Versuchen Sie es später noch mal.

Media Types: "application/json", "application/xml"

Sicherheit

azure_auth

Dies sind die Azure Active Directory OAuth2 Flows. In Kombination mit der rollenbasierten Zugriffs Steuerung in Azure kann Sie verwendet werden, um den Zugriff auf Azure Maps Rest-APIs zu steuern. Rollenbasierte Zugriffs Steuerung in Azure dient zum Festlegen des Zugriffs auf ein oder mehrere Azure Maps Ressourcen Konto oder unter Ressourcen. Allen Benutzern, Gruppen oder Dienst Prinzipalen kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle erteilt werden, die aus einer oder mehreren Berechtigungen für Azure Maps Rest-APIs besteht.

Zum Implementieren von Szenarien empfiehlt sich die Anzeige von Authentifizierungs Konzepten. Zusammenfassend bietet diese Sicherheits Definition eine Lösung für die Modellierung von Anwendungen mithilfe von Objekten, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweis

  • Diese Sicherheits Definition erfordert , dass der- x-ms-client-id Header verwendet wird, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Maps- Verwaltungs-APIabgerufen werden.
  • Der Authorization URL ist für die Azure Public Cloud-Instanz spezifisch. Unabhängige Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
  • Die rollenbasierte Zugriffs Steuerung in Azure wird über Azure-Portal, PowerShell, CLI, Azure sdche oder Rest-APIs über die Azure-Verwaltungsebene konfiguriert.
  • Die Verwendung des Azure Maps Web-SDK ermöglicht eine konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
  • Derzeit werden Azure Active Directory v 1.0 -Token unterstützt.

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

subscription-key

Dabei handelt es sich um einen gemeinsam genutzten Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure sdgt oder Rest-APIs bereitgestellt wird. Mit diesem Schlüssel wird jede Anwendung autorisiert, auf alle Rest-APIs zuzugreifen. Dies bedeutet, dass diese derzeit als Hauptschlüssel für das Konto behandelt werden können, für das Sie ausgestellt werden. Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps Rest-APIs zu verwenden, wo dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

Beispiele

GetRouteDirections

Sample Request

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

Sample Response

{
  "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"
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitionen

AlternativeRouteType

Steuert die Optimalität der in Bezug auf die angegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Verweis Route.

Avoid

Gibt einen Wert an, den die Routenberechnung vermeiden soll, wenn die Route bestimmt wird. Kann in einer Anforderung mehrmals angegeben werden, z. b. "&vermeide-Autobahnen&vermeiden = tollstraßen&vermeiden = Fähren". In calculatereachablerange-Anforderungen darf der Wert alleseryusedroads nicht verwendet werden.

ComputeTravelTimeFor

Gibt an, ob zusätzliche Fahrtzeiten mit unterschiedlichen Arten von Datenverkehrs Informationen (None, Historic, Live) sowie der standardmäßig am besten geschätzten Reisezeit zurückgegeben werden.

Coordinate

Ein als Längen-und Längengrad dargestellter Speicherort.

DrivingSide

Gibt an, dass die linke und die Rechte Seite an der Stelle des Manövers unterwegs ist.

GuidanceInstructionType

Der Typ der Anweisung, z. b. das ändern oder Ändern von Straßen Form.

GuidanceManeuver

Ein Code, der das Manöver identifiziert.

Hilliness

Grad der Hilfe für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

JunctionType

Der Typ der Verknüpfung, in der das Manöver stattfindet. Bei größeren Roundabouts werden zwei separate Anweisungen für die Eingabe und den Abschluss des Durchlaufs generiert.

MagnitudeOfDelay

Das Ausmaß der Verzögerung, die durch den Incident verursacht wurde. Diese Werte entsprechen den Werten der Antwort Feldwerte der API zum Abrufen von Datenverkehrs Vorfällen.

ODataError

Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

ODataErrorResponse

Dieses Response-Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

RouteDirectionsResponse

Dieses Objekt wird von einem erfolgreichen Routen Weiterleitungs-Befehl zurückgegeben.

RouteDirectionsResult
RouteDirectionsSummary

Zusammenfassungs Objekt

RouteInstructionsType

Wenn angegeben, werden Anleitungen zurückgegeben. Beachten Sie, dass der instructionstype-Parameter nicht in Verbindung mit routerepresentation = None verwendet werden kann.

RouteOptimizedWaypoint

Optimiertes Way-Point-Objekt.

RouteRepresentation

Gibt die Darstellung des Satzes von Routen an, der als Antwort bereitgestellt wird. Dieser Parameterwert kann nur in Verbindung mit computebestorder = true verwendet werden.

RouteResponseReport

Gibt die im aktuellen-Befehl verwendeten effektiven Einstellungen an.

RouteResponseReportEffectiveSetting

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

RouteResultGuidance

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

RouteResultInstruction

Eine Reihe von Attributen, die ein Manöver beschreiben, z. b. "Turn right", "keep left", "Take The Ferry", "Take the A9", "arrive".

RouteResultInstructionGroup

Gruppiert eine Sequenz von Anweisungs Elementen, die miteinander verknüpft sind. Der Sequenz Bereich ist auf firstinstructionindex und lastinstructionindex beschränkt. Wenn menschenlesbare Textnachrichten angefordert werden, um Anleitungen zu erhalten (instructiontype = Text oder markiert), wird für die instructiongroup eine Zusammenfassungs Meldung zurückgegeben, wenn Sie verfügbar ist.

RouteResultLeg
RouteResultLegSummary

Zusammenfassungs Objekt für den Abschnitt "Route".

RouteResultSection
RouteResultSectionTec

Details zum Datenverkehrs Ereignis unter Verwendung von Definitionen im TPEG2-Tec- Standard. Kann effectcode enthalten und bewirkt, dass Elemente ausgelöst werden.

RouteResultSectionTecCause

Die Ursache des Verkehrs Ereignisses. Kann maincausecode-und subcausecode-Elemente enthalten. Kann zum Definieren von Ikonographie und Beschreibungen verwendet werden.

RouteType

Der Typ der angeforderten Route.

SectionType

Gibt an, welcher der Abschnitts Typen in der Routen Antwort gemeldet wird.

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

TextFormat

Das gewünschte Format der Antwort. Der Wert kann entweder " JSON " oder " XML" lauten.

TravelMode

Der fortbewegungs Modus für die angeforderte Route. Wenn Sie nicht definiert ist, lautet 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, ist das travelmode-Element der Antwort für diesen Abschnitt "Other". Beachten Sie, dass die Reise Modi Bus, Motorrad, Taxi und van eine Beta Funktion sind. Vollständige Einschränkungs Daten sind nicht in allen Bereichen verfügbar. In calculatereachablerange -Anforderungen dürfen die Werte Bicycle und Fußgängern nicht verwendet werden.

VehicleEngineType

Der Modultyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleenginetypekonsistent sein.

VehicleLoadType

Ladungstypen, die als gefährliche Materialien klassifiziert und von einigen Straßen eingeschränkt werden können. Die verfügbaren vehicleloadtype-Werte sind US-Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit "ushazmat" beginnen, sind für das Routing von uns vorgesehen, während otherhazmat für alle anderen Länder verwendet werden sollte vehicleloadtype kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für "travelmode = Truck" berücksichtigt.

Windingness

Die Ebene der Turn-Kurven für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

AlternativeRouteType

Steuert die Optimalität der in Bezug auf die angegebenen Planungskriterien der berechneten Alternativen im Vergleich zur Verweis Route.

Name Type Description
anyRoute
  • string

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

betterRoute
  • string

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

Avoid

Gibt einen Wert an, den die Routenberechnung vermeiden soll, wenn die Route bestimmt wird. Kann in einer Anforderung mehrmals angegeben werden, z. b. "&vermeide-Autobahnen&vermeiden = tollstraßen&vermeiden = Fähren". In calculatereachablerange-Anforderungen darf der Wert alleseryusedroads nicht verwendet werden.

Name Type Description
alreadyUsedRoads
  • string

Vermeidet die Verwendung derselben Straße mehrmals. Besonders nützlich in Verbindung mit routeType = spannend.

borderCrossings
  • string

Vermeidet Grenzübergänge in der Routenberechnung.

carpools
  • string

Vermeidet Routen, für die die Verwendung von Einlagerungs Bereichen (Hov/High Belegung Vehicle) erforderlich ist.

ferries
  • string

Vermeidet Fähren

motorways
  • string

Vermeidet Autobahnen

tollRoads
  • string

Vermeidet Mautstraßen.

unpavedRoads
  • string

Vermeidet nicht gepflasterte Straßen

ComputeTravelTimeFor

Gibt an, ob zusätzliche Fahrtzeiten mit unterschiedlichen Arten von Datenverkehrs Informationen (None, Historic, Live) sowie der standardmäßig am besten geschätzten Reisezeit zurückgegeben werden.

Name Type Description
all
  • string

Berechnet die Reisezeiten für alle Arten von Datenverkehrs Informationen und gibt alle Ergebnisse in den Feldern "notraffictraveltimeinseconds", "historictraffictraveltimeinseconds" und "livetrafficincidentstraveltimeinseconds" an, die in den Zusammenfassungen in der Routen Antwort enthalten sind.

none
  • string

Berechnet keine zusätzlichen Reisezeiten.

Coordinate

Ein als Längen-und Längengrad dargestellter Speicherort.

Name Type Description
latitude
  • number

Breitengrad-Eigenschaft

longitude
  • number

Längengrad (Eigenschaft)

DrivingSide

Gibt an, dass die linke und die Rechte Seite an der Stelle des Manövers unterwegs ist.

Name Type Description
LEFT
  • string

Links.

RIGHT
  • string

Rechte Seite.

GuidanceInstructionType

Der Typ der Anweisung, z. b. das ändern oder Ändern von Straßen Form.

Name Type Description
DIRECTION_INFO
  • string

Informationen zur Richtung.

LOCATION_ARRIVAL
  • string

Der Ankunfts Standort.

LOCATION_DEPARTURE
  • string

Ablageort.

LOCATION_WAYPOINT
  • string

Die Position des Punkts.

ROAD_CHANGE
  • string

Straße ändern.

TURN
  • string

Sich.

GuidanceManeuver

Ein Code, der das Manöver identifiziert.

Name Type Description
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

Nach links.

BEAR_RIGHT
  • string

Recht.

DEPART
  • string

Lassen Sie.

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 Sie: .

KEEP_LEFT
  • string

Bleiben Sie weiter.

KEEP_RIGHT
  • string

Behalten Sie die Rechte.

MAKE_UTURN
  • string

Nehmen Sie eine U-Turn-Option.

MOTORWAY_EXIT_LEFT
  • string

Beenden Sie die linke Seite.

MOTORWAY_EXIT_RIGHT
  • string

Nehmen Sie den rechten Ausgang.

ROUNDABOUT_BACK
  • string

Wechseln Sie in den Kreis.

ROUNDABOUT_CROSS
  • string

Überqueren Sie den Kreis.

ROUNDABOUT_LEFT
  • string

Nehmen Sie am linken Rand am linken Rand an.

ROUNDABOUT_RIGHT
  • string

Nehmen Sie an der über-und der-Seite an der rechten Seite.

SHARP_LEFT
  • string

Aktivieren Sie Sharp left.

SHARP_RIGHT
  • string

Aktivieren Sie Sharp right.

STRAIGHT
  • string

Bleiben Sie auf dem laufenden.

SWITCH_MAIN_ROAD
  • string

Wechseln Sie zur Hauptstraße.

SWITCH_PARALLEL_ROAD
  • string

Wechseln Sie zur parallelen Straße.

TAKE_EXIT
  • string

Beenden Sie den Vorgang.

TAKE_FERRY
  • string

Nehmen Sie die Fähre.

TRY_MAKE_UTURN
  • string

Versuchen Sie, eine U-Turn zu erstellen.

TURN_LEFT
  • string

Nach links.

TURN_RIGHT
  • string

Rechts ändern.

WAYPOINT_LEFT
  • string

Sie haben den-Waypoint erreicht. Sie befindet sich auf der linken Seite.

WAYPOINT_REACHED
  • string

Sie haben den-Waypoint erreicht.

WAYPOINT_RIGHT
  • string

Sie haben den-Waypoint erreicht. Er befindet sich auf der rechten Seite.

Hilliness

Grad der Hilfe für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

Name Type Description
high
  • string

high

low
  • string

niedrig

normal
  • string

normal

JunctionType

Der Typ der Verknüpfung, in der das Manöver stattfindet. Bei größeren Roundabouts werden zwei separate Anweisungen für die Eingabe und den Abschluss des Durchlaufs generiert.

Name Type Description
BIFURCATION
  • string

Gabelung

REGULAR
  • string

regular

ROUNDABOUT
  • string

Umlage

MagnitudeOfDelay

Das Ausmaß der Verzögerung, die durch den Incident verursacht wurde. Diese Werte entsprechen den Werten der Antwort Feldwerte der API zum Abrufen von Datenverkehrs Vorfällen.

Name Type Description
0
  • string

Unbekannt

1
  • string

Gering.

2
  • string

Mäßig.

3
  • string

Schwerwiegend.

4
  • string

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

ODataError

Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

Name Type Description
code
  • string

Der odataerror-Code.

details

Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

message
  • string

Sofern verfügbar eine lesbare Beschreibung des Fehlers.

target
  • string

Falls verfügbar, wird das Ziel den Fehler verursacht.

ODataErrorResponse

Dieses Response-Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

Name Type Description
error

Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Maps-API auftritt.

RouteDirectionsResponse

Dieses Objekt wird von einem erfolgreichen Routen Weiterleitungs-Befehl zurückgegeben.

Name Type Description
formatVersion
  • string

Format Version (Eigenschaft)

optimizedWaypoints

Optimierte Sequenz von-Standpunkten. Der Index zeigt den Index der vom Benutzer bereitgestellten "Wegpunkt"-Sequenz 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>

Dies bedeutet, dass die ursprüngliche Sequenz [0, 1, 2] und die optimierte Sequenz [1, 2, 0] ist. Da der Index mit 0 beginnt, ist der ursprüngliche Wert "First, Second, dritte", während der optimierte "Second, Third, First" ist.

report

Gibt die im aktuellen-Befehl verwendeten effektiven Einstellungen an.

routes

Routen Array

RouteDirectionsResult

Name Type Description
guidance

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

legs

Legs-Array

sections

Abschnitts Array

summary

Zusammenfassungs Objekt

RouteDirectionsSummary

Zusammenfassungs Objekt

Name Type Description
arrivalTime
  • string

Eigenschaft "Ankunftszeit"

departureTime
  • string

Eigenschaft "Abflugzeit"

lengthInMeters
  • integer

Länge in Meter (Eigenschaft)

trafficDelayInSeconds
  • integer

Geschätzte Verzögerung (in Sekunden), die durch die Echt Zeit Vorfälle gemäß den Datenverkehrs Informationen verursacht wird. Bei Routen, die in der Zukunft mit der Abbruchzeit geplant sind, ist die Verzögerung immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Datenverkehrs Informationen zurückzugeben, muss der Parameter computetraveltimefor = all hinzugefügt werden.

travelTimeInSeconds
  • integer

Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echt Zeit Datenverkehr einschließt. Beachten Sie, dass auch dann, wenn "Traffic = false traveltimeinseconds" die Verzögerung aufgrund von Datenverkehr einschließt. Wenn departat in der Zukunft liegt, wird die Reisezeit mithilfe zeitabhängiger historischer Datenverkehrs Daten berechnet.

RouteInstructionsType

Wenn angegeben, werden Anleitungen zurückgegeben. Beachten Sie, dass der instructionstype-Parameter nicht in Verbindung mit routerepresentation = None verwendet werden kann.

Name Type Description
coded
  • string

Gibt unformatierte Anweisungs Daten ohne lesbare Nachrichten zurück.

tagged
  • string

Gibt rohanweisungs Daten mit markierten, lesbaren Nachrichten zurück, um die Formatierung zuzulassen. Eine lesbare Nachricht wird aus wiederholbaren identifizierten Elementen erstellt. Diese werden gekennzeichnet, damit Client Anwendungen Sie ordnungsgemäß formatieren können. Die folgenden Nachrichten Komponenten werden markiert, wenn instructionstype = gekennzeichnet ist: Straße, roadnumber, signposttext, exitnumber, roundaboutexitnumber.

Beispiel für eine markierte "Turn Left"-Meldung:

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

Gibt rohdatenanweisungs-Daten mit lesbaren Nachrichten im Klartext zurück.

RouteOptimizedWaypoint

Optimiertes Way-Point-Objekt.

Name Type Description
optimizedIndex
  • integer

Optimierter Weg Punkt Index vom System.

providedIndex
  • integer

Der vom Benutzer bereitgestellte Wege Index.

RouteRepresentation

Gibt die Darstellung des Satzes von Routen an, der als Antwort bereitgestellt wird. Dieser Parameterwert kann nur in Verbindung mit computebestorder = true verwendet werden.

Name Type Description
none
  • string

Schließt nur die optimierten "Wegpunkt"-Indizes ein, aber nicht die Routen Geometrie in der Antwort.

polyline
  • string

Schließt die Routen Geometrie in die Antwort ein.

summaryOnly
  • string

Zusammenfassung gemäß Polylinie, aber ohne die Punkt Geometrie Elemente für die Routen in der Antwort.

RouteResponseReport

Gibt die im aktuellen-Befehl verwendeten effektiven Einstellungen an.

Name Type Description
effectiveSettings

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

RouteResponseReportEffectiveSetting

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

Name Type Description
key
  • string

Der Name des verwendeten Parameters.

value
  • string

Der Wert des verwendeten Parameters.

RouteResultGuidance

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

Name Type Description
instructionGroups

Gruppiert eine Sequenz von Anweisungs Elementen, die miteinander verknüpft sind.

instructions

Eine Liste der Anweisungen, die Manöver beschreiben.

RouteResultInstruction

Eine Reihe von Attributen, die ein Manöver beschreiben, z. b. "Turn right", "keep left", "Take The Ferry", "Take the A9", "arrive".

Name Type Description
combinedMessage
  • string

Eine lesbare Nachricht für das Manöver, kombiniert mit der Meldung aus der nächsten Anweisung. Manchmal ist es möglich, zwei aufeinander folgende Anweisungen in einer einzigen Anweisung zu kombinieren, sodass Sie leichter befolgt werden kann. 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 "possiblecombinewithnext"-Flag für Anweisung 10 ist "true". Dadurch wird den Clients der codierten Anleitung angezeigt, dass Sie mit Anweisung 11 kombiniert werden kann. Die Anweisungen werden automatisch für Clients kombiniert, die lesbare Anleitungen 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. Beispiel: US.

drivingSide

Gibt an, dass die linke und die Rechte Seite an der Stelle des Manövers unterwegs ist.

exitNumber
  • string

Die Anzahl (n) einer Autobahn Beendigung, die vom aktuellen Manöver erstellt wurde. Wenn eine Beendigung über mehrere Beendigungs Nummern verfügt, werden Sie durch "," und möglicherweise durch "-", z. b. "10, 13-15", getrennt.

instructionType

Der Typ der Anweisung, z. b. das ändern oder Ändern von Straßen Form.

junctionType

Der Typ der Verknüpfung, in der das Manöver stattfindet. Bei größeren Roundabouts werden zwei separate Anweisungen für die Eingabe und den Abschluss des Durchlaufs generiert.

maneuver

Ein Code, der das Manöver identifiziert.

message
  • string

Eine lesbare Nachricht für das Manöver.

point

Ein als Längen-und Längengrad dargestellter Speicherort.

pointIndex
  • integer

Der Index des Punkts in der Liste der polyzeiligen "Punkte", der dem Punkt der Anweisung entspricht.

possibleCombineWithNext
  • boolean

Optional kann die Anweisung mit der nächsten kombiniert werden. Dies kann verwendet werden, um Nachrichten wie "Turn Left und then turn right" zu erstellen.

roadNumbers
  • string[]

Die Straßennummer (n) der nächsten bedeutenden straßensegmente nach dem Manöver oder der Straße (en), die befolgt werden sollen. Beispiel: ["E34", "N205"]

roundaboutExitNumber
  • string

Dies gibt an, welcher Exit-Vorgang an einem Kreis ausgeführt werden soll.

routeOffsetInMeters
  • integer

Abstand zwischen dem Anfang der Route und dem Punkt der Anweisung.

signpostText
  • string

Der Text in einem Signpost, der für das Manöver am relevantesten ist, oder die Richtung, die befolgt werden soll.

stateCode
  • string

Eine Unterteilung (z. b. State) des Landes, dargestellt durch den zweiten Teil eines ISO 3166-2 -Codes. Dies ist nur für einige Länder wie USA, Kanada und Mexiko verfügbar.

street
  • string

Der Name der Straße des nächsten bedeutenden Straßen Segments nach dem Manöver oder der Straße, die befolgt werden soll.

travelTimeInSeconds
  • integer

Geschätzte Reisezeit bis zu dem Punkt, der routeoffantinmeter entspricht.

turnAngleInDecimalDegrees
  • integer

Gibt die Richtung einer Anweisung an. Wenn junctiontype eine Turn-Anweisung angibt:

  • 180 = U-Turn
  • [-179,-1] = Left Turn
  • 0 = gerade an (ein ' 0 Grad '-Turn)
  • [1, 179] = right turn

Wenn junctiontype eine bifurationsanweisung angibt:

  • <0-keep-left
  • >0-rechts halten

RouteResultInstructionGroup

Gruppiert eine Sequenz von Anweisungs Elementen, die miteinander verknüpft sind. Der Sequenz Bereich ist auf firstinstructionindex und lastinstructionindex beschränkt. Wenn menschenlesbare Textnachrichten angefordert werden, um Anleitungen zu erhalten (instructiontype = Text oder markiert), wird für die instructiongroup eine Zusammenfassungs Meldung zurückgegeben, wenn Sie verfügbar ist.

Name Type Description
firstInstructionIndex
  • integer

Index der ersten Anweisung.

groupLengthInMeters
  • integer

Die Länge der Gruppe.

groupMessage
  • string

Eine Zusammenfassungs Meldung, wenn menschenlesbare Textnachrichten angefordert werden, um Anleitungen zu erhalten (instructiontype = Text oder markiert).

lastInstructionIndex
  • integer

Der Index der letzten Anweisung.

RouteResultLeg

Name Type Description
points

Points-Array

summary

Zusammenfassungs Objekt für den Abschnitt "Route".

RouteResultLegSummary

Zusammenfassungs Objekt für den Abschnitt "Route".

Name Type Description
arrivalTime
  • string

Eigenschaft "Ankunftszeit"

batteryConsumptionInkWh
  • number

Geschätzter Stromverbrauch in kilostunden (kWh) unter Verwendung des Modells für den Stromverbrauch. Enthalten, wenn vehicleenginetype auf "Electric" und "constantspeedconsumptioninkwhperhundertstel km" festgelegt ist. Der Wert von "batteryconsumptioninkwh" umfasst die wiederhergestellte Strom Energie und kann daher negativ sein (was auf die Gewinnung von Energie hinweist). Wenn sowohl maxcharginkwh als auch currentchargeingekwh angegeben werden, wird die Wiederherstellung begrenzt, um sicherzustellen, dass die Akku ladestufe nie maxchargeingekwh überschreitet. Wenn weder maxchargeingekwh noch currentchargan kWh angegeben ist, wird in der Verbrauchs Berechnung eine nicht eingeschränkte Neuerfassung angenommen.

departureTime
  • string

Eigenschaft "Abflugzeit"

fuelConsumptionInLiters
  • number

Geschätzter Kraftstoffverbrauch in Litern mit dem Modell für den Verbrennungs Verbrauch. Enthalten, wenn vehicleenginetype auf " Verbrennung " und constantspeedconsumptioninlitersperhundertstel km festgelegt ist. Der Wert ist nicht negativ.

historicTrafficTravelTimeInSeconds
  • integer

Geschätzte Reisezeit, die mithilfe zeitabhängiger historischer Datenverkehrs Daten berechnet wurde. Nur enthalten, wenn computetraveltimefor = all in der Abfrage verwendet wird.

lengthInMeters
  • integer

Länge in Meter (Eigenschaft)

liveTrafficIncidentsTravelTimeInSeconds
  • integer

Geschätzte Reisezeit, berechnet mithilfe von Echt Zeit Geschwindigkeitsdaten. Nur enthalten, wenn computetraveltimefor = all in der Abfrage verwendet wird.

noTrafficTravelTimeInSeconds
  • integer

Geschätzte Reisezeit, die berechnet wird, als ob die Route aufgrund von Datenverkehrs Zuständen (z. b. Überlastung) nicht verzögert werden soll. Nur enthalten, wenn computetraveltimefor = all in der Abfrage verwendet wird.

trafficDelayInSeconds
  • integer

Geschätzte Verzögerung (in Sekunden), die durch die Echt Zeit Vorfälle gemäß den Datenverkehrs Informationen verursacht wird. Bei Routen, die in der Zukunft mit der Abbruchzeit geplant sind, ist die Verzögerung immer 0. Um zusätzliche Reisezeiten mit unterschiedlichen Arten von Datenverkehrs Informationen zurückzugeben, muss der Parameter computetraveltimefor = all hinzugefügt werden.

travelTimeInSeconds
  • integer

Geschätzte Reisezeit in Sekunden, die die Verzögerung aufgrund von Echt Zeit Datenverkehr einschließt. Beachten Sie, dass auch dann, wenn "Traffic = false traveltimeinseconds" die Verzögerung aufgrund von Datenverkehr einschließt. Wenn departat in der Zukunft liegt, wird die Reisezeit mithilfe zeitabhängiger historischer Datenverkehrs Daten berechnet.

RouteResultSection

Name Type Description
delayInSeconds
  • integer

Verzögerung (in Sekunden) aufgrund des Vorfalls.

effectiveSpeedInKmh
  • integer

Die effektive Geschwindigkeit des Vorfalls in km/h, der Durchschnitt über die gesamte Länge erreicht wurde.

endPointIndex
  • integer

Endpunkt Index Eigenschaft

magnitudeOfDelay

Das Ausmaß der Verzögerung, die durch den Incident verursacht wurde. Diese Werte entsprechen den Werten der Antwort Feldwerte der API zum Abrufen von Datenverkehrs Vorfällen.

sectionType
  • string

Section-Typeigenschaft

simpleCategory
  • string

Der Typ des Vorfalls. Kann derzeit "Jam", "ROAD_WORK", "ROAD_CLOSURE" oder ein anderes sein. Ausführliche Informationen finden Sie unter "Tec".

startPointIndex
  • integer

Start Punkt Index (Eigenschaft)

tec

Details zum Datenverkehrs Ereignis unter Verwendung von Definitionen im TPEG2-Tec- Standard. Kann effectcode enthalten und bewirkt, dass Elemente ausgelöst werden.

travelMode
  • string

Eigenschaft "Reisemodus"

RouteResultSectionTec

Details zum Datenverkehrs Ereignis unter Verwendung von Definitionen im TPEG2-Tec- Standard. Kann effectcode enthalten und bewirkt, dass Elemente ausgelöst werden.

Name Type Description
causes

Verursacht Array

effectCode
  • integer

Die Auswirkung auf den Daten Verkehrsfluss. Enthält einen Wert in der tec001: effectcode-Tabelle, wie im TPEG2-Tec- Standard definiert. Kann verwendet werden, um Datenverkehrs Ereignisse nach Schweregrad zu färben.

RouteResultSectionTecCause

Die Ursache des Verkehrs Ereignisses. Kann maincausecode-und subcausecode-Elemente enthalten. Kann zum Definieren von Ikonographie und Beschreibungen verwendet werden.

Name Type Description
mainCauseCode
  • integer

Die Hauptursache des Verkehrs Ereignisses. Enthält einen Wert in der tec002: causecode-Tabelle, wie im TPEG2-Tec- Standard definiert.

subCauseCode
  • integer

Die unter Ursache des Verkehrs Ereignisses. Enthält einen Wert in der von maincausecode definierten unter Ursachen Tabelle, wie im TPEG2-Tec- Standard definiert.

RouteType

Der Typ der angeforderten Route.

Name Type Description
eco
  • string

Eine Route, die nach Wirtschaft und Geschwindigkeit ausgeglichen ist.

fastest
  • string

Die schnellste Route.

shortest
  • string

Die kürzeste Route nach Entfernung.

thrilling
  • string

Enthält interessante oder anspruchsvolle Straßen und verwendet so wenige Autobahnen wie möglich. Sie können die Ebene der einzuschließenden Turn-und auch den Grad der Unterordnung auswählen. Informationen zum Festlegen dieses Parameters finden Sie unter "hilness" und "windingness". Es gibt eine Beschränkung von 900 km auf Routen, die mit = spannend geplant sind. routeType

SectionType

Gibt an, welcher der Abschnitts Typen in der Routen Antwort gemeldet wird.

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

Name Type Description
carTrain
  • string

Hier erhalten Sie Abschnitte, wenn die Route Auto trainiert enthält.

country
  • string

Länder, in denen die Route Teile hat.

ferry
  • string

Hier erhalten Sie Abschnitte, wenn die Route Fähren enthält.

motorway
  • string

Hier erhalten Sie Abschnitte, wenn die Route die-Auto-

pedestrian
  • string

Erhalten Sie Abschnitte, die für Fußgänger geeignet sind.

tollRoad
  • string

Hier erhalten Sie Abschnitte, für die eine Mautgebühr erforderlich ist.

tollVignette
  • string

Hier erhalten Sie Abschnitte, in denen eine Maut Vignette vorhanden sein muss.

traffic
  • string

Hier erhalten Sie Abschnitte, die Informationen zum Datenverkehr enthalten.

travelMode
  • string

Erhalten Sie Abschnitte in Bezug auf den Anforderungs Parameter travelMode .

tunnel
  • string

Erhalten Sie Abschnitte, wenn die Route Tunnel enthält.

TextFormat

Das gewünschte Format der Antwort. Der Wert kann entweder " JSON " oder " XML" lauten.

Name Type Description
json
  • string

Das JavaScript Object Notation-Datenaustausch Format.

xml
  • string

Der Extensible Markup Language

TravelMode

Der fortbewegungs Modus für die angeforderte Route. Wenn Sie nicht definiert ist, lautet 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, ist das travelmode-Element der Antwort für diesen Abschnitt "Other". Beachten Sie, dass die Reise Modi Bus, Motorrad, Taxi und van eine Beta Funktion sind. Vollständige Einschränkungs Daten sind nicht in allen Bereichen verfügbar. In calculatereachablerange -Anforderungen dürfen die Werte Bicycle und Fußgängern nicht verwendet werden.

Name Type Description
bicycle
  • string

Die zurückgegebenen Routen sind für Fahrräder optimiert, einschließlich der Verwendung von Fahrrad Bereichen.

bus
  • string

Die zurückgegebenen Routen sind für Busse optimiert, einschließlich der Verwendung von reinen busbereichen. 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 Verwendung von gehgehenden.

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 Lieferwagen optimiert. Beta-Funktionalität.

VehicleEngineType

Der Modultyp des Fahrzeugs. Wenn ein detailliertes Verbrauchsmodell angegeben wird, muss es mit dem Wert von vehicleenginetypekonsistent sein.

Name Type Description
combustion
  • string

Internes Verbrennungs Modul.

electric
  • string

Die Strom-Engine.

VehicleLoadType

Ladungstypen, die als gefährliche Materialien klassifiziert und von einigen Straßen eingeschränkt werden können. Die verfügbaren vehicleloadtype-Werte sind US-Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit "ushazmat" beginnen, sind für das Routing von uns vorgesehen, während otherhazmat für alle anderen Länder verwendet werden sollte vehicleloadtype kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für "travelmode = Truck" berücksichtigt.

Name Type Description
USHazmatClass1
  • string

SIV

USHazmatClass2
  • string

Komprimiertes Gas

USHazmatClass3
  • string

Brennbare Flüssigkeiten

USHazmatClass4
  • string

Brennbare Festplatten

USHazmatClass5
  • string

Oxidizer

USHazmatClass6
  • string

Berechtigungen

USHazmatClass7
  • string

Aktive

USHazmatClass8
  • string

Bestädungen

USHazmatClass9
  • string

Verschiedenes

otherHazmatExplosive
  • string

SIV

otherHazmatGeneral
  • string

Verschiedenes

otherHazmatHarmfulToWater
  • string

Schädlich für Wasser

Windingness

Die Ebene der Turn-Kurven für eine spannende Route. Dieser Parameter kann nur in Verbindung mit routeType = aufregende verwendet werden.

Name Type Description
high
  • string

high

low
  • string

niedrig

normal
  • string

normal