Route - Post Route Directions
Verwenden Sie diese Methode, um die beste Route zwischen Ursprung und Ziel für Autos, Nutzfahrzeuge und Wanderrouten zu erhalten.
Die Route Directions-API ist eine HTTP-POST-Anforderung, die die ideale Route zwischen Einem Ursprung und Ziel für Autos (Fahren), gewerbliche Lkw und Fußwege zurückgibt. Wenn angegeben, durchläuft die Route eine Reihe von Wegpunkten. Ein Wegpunkt ist ein geografischer Ort, der durch Längengrad und Breitengrad definiert ist, der für Navigationszwecke verwendet wird. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am gewünschten Tag der Woche und tageszeit.
Die API gibt die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie zurück. Je nach den verwendeten Parametern stehen auch weitere Routinginformationen wie eine optimierte Wegpunktreihenfolge oder turn by turn by turn instructions zur Verfügung.
Die Routenbeschreibung berücksichtigt lokale Gesetze, Fahrzeugdimensionen, Frachttyp, Max-Geschwindigkeit, Brücken- und Tunnelhöhen, um die spezifischen Routen des Lkw zu berechnen und komplexe Manöver und schwierige Straßen zu vermeiden. Nicht alle Lkw können aufgrund bestimmter Einschränkungen auf der Grundlage des Fahrzeugprofils oder des Frachttyps dieselben Routen wie andere Fahrzeuge fahren. Beispielsweise haben Autobahnen oft separate Geschwindigkeitsbeschränkungen für Lkw, einige Straßen erlauben keine Lkw mit brennbaren oder gefährlichen Materialien, und es kann Höhen- und Gewichtseinschränkungen auf Brücken geben.
Bis zu 150 Wegpunkte und 10 viaWaypoints zwischen zwei beliebigen Wegpunkten werden unterstützt. Jede Gruppe von Wegpunkten erstellt eine separate Route Leg. ViaWaypoints definieren den Routenpfad und können für die Routenerstellung an bestimmten Orten verwendet werden, aber sie erstellen keine Routenbeine.
Informationen zur Routingverfügbarkeit in Ländern/Regionen finden Sie unter Azure Maps-Routingabdeckung.
POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. |
Anforderungsheader
Media Types: "application/geo+json"
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-id |
string |
Gibt das Konto an, das für die Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
|
| Accept-Language |
string |
Sprache, in der Routingergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter Lokalisierungsunterstützung in Azure Maps. |
Anforderungstext
Media Types: "application/geo+json"
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| features | True |
Fahr-, Wander- und LKW-Routen werden durch eine Reihe von Wegpunkten (Stopps) und viaWaypoints (Zwischenorte, die die Route passieren muss) definiert. Sie können maximal 150 Wegpunkte und maximal 10 viaWaypoints zwischen jedem Satz von Wegpunkten haben. Eine Route muss mindestens 2 Wegpunkte aufweisen, und die Start- und Endpunkte der Route können nicht überWaypoints erfolgen. Sowohl Waypoint- als auch viaWaypoint-Standorte müssen zusammen mit PointIndex als gültiges GeoJSON Point-Featureobjekt angegeben werden, das die Reihenfolge der Standorte angibt. Weitere Informationen zum GeoJSON-Format finden Sie unter RFC 7946. |
|
| type | True |
Gibt den |
|
| arriveAt |
string (date-time) |
Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als Der parameter Beispiel: "arriveAt": "2023-06-01T09:30:00.000-07:00" |
|
| avoid |
Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt. Beispiel: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Das Datum und die Uhrzeit des Abflugpunkts, der als Wenn die Example: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| heading |
integer (int64) minimum: 0maximum: 359 |
Die erste Richtung 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. |
|
| maxRouteCount |
integer (int64) minimum: 1maximum: 6 |
Die maximale Anzahl der zurückzugebenden Routen. Verfügbar für die Fahr- und Lkw-Reisemodi. Standardwert: "maxRouteCount":1 |
|
| optimizeRoute |
Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "fastestWithoutTraffic", der die Route zurückgibt, um die Fahrzeit zu minimieren, ohne aktuelle Verkehrsinformationen zu verwenden. Beispiel: "optimizeRoute":"kürzeste" |
||
| optimizeWaypointOrder |
boolean |
Ordnen Sie die Routenwegpunkte mithilfe eines schnellen heuristischen Algorithmus neu an, um die mit dem Optimierungsparameter angegebenen Routenkosten zu reduzieren. Der Ursprung und das Ziel werden vom optimierten Wegpunkt ausgeschlossen, und ihre Position wird als fest betrachtet. Zulässige Werte sind wahr oder falsch. |
|
| routeOutputOptions |
Fügen Sie die gewünschten Routeninformationen aus der Antwort ein. Standardmäßig ist die Reiseroute in der Antwort enthalten. Unterstützt mehrere Werte, z. B. "routeOutputOptions": ["routePath", "itinerary"] |
||
| travelMode |
Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "Fahren", der die für Autos optimierte Route zurückgibt.
Beispiel: "travelMode":"fahren" |
||
| vehicleSpec |
Gibt die Fahrzeugattribute an, z. B. Größe, Gewicht, Max. Geschwindigkeit, Frachttyp usw. nur für lkw-Routing. Dies trägt dazu bei, geringe Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Lkw-Route basierend auf den Fahrzeugspezifikationen bereitzustellen.
|
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OK Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. Media Types: "application/geo+json", "application/json" Header x-ms-error-code: string |
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.
Note
- 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 URList 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 das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.
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 gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.
Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
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 with additional parameters in the body
Beispielanforderung
POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.201399,
47.608678
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.20687,
47.612002
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "viaWaypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.201669,
47.615076
],
"type": "Point"
},
"properties": {
"pointIndex": 2,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "fastestWithTraffic",
"routeOutputOptions": [
"routePath"
],
"maxRouteCount": 3,
"travelMode": "driving"
}
Beispiel für eine Antwort
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20147,
47.60868
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 0
},
"order": {
"inputIndex": 0
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.2016,
47.61508
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 64
},
"order": {
"inputIndex": 2
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": [
[
[
-122.20147,
47.60868
],
[
-122.20148,
47.60884
],
[
-122.20148,
47.60906
],
[
-122.20148,
47.60919
],
[
-122.20148,
47.60953
],
[
-122.20148,
47.60967
],
[
-122.20149,
47.60997
],
[
-122.2015,
47.61011
],
[
-122.2015,
47.61019
],
[
-122.20192,
47.61021
],
[
-122.20199,
47.61021
],
[
-122.20252,
47.61019
],
[
-122.20264,
47.61018
],
[
-122.20271,
47.61015
],
[
-122.20276,
47.61015
],
[
-122.20281,
47.61015
],
[
-122.20286,
47.61015
],
[
-122.20329,
47.61016
],
[
-122.20346,
47.61016
],
[
-122.20414,
47.61017
],
[
-122.20416,
47.61057
],
[
-122.20418,
47.61083
],
[
-122.20418,
47.61092
],
[
-122.20419,
47.61103
],
[
-122.20419,
47.61121
],
[
-122.2042,
47.61126
],
[
-122.20478,
47.61127
],
[
-122.20555,
47.61128
],
[
-122.20569,
47.61128
],
[
-122.20596,
47.61128
],
[
-122.20617,
47.61127
],
[
-122.20624,
47.61125
],
[
-122.2066,
47.61126
],
[
-122.20669,
47.61127
],
[
-122.20686,
47.61129
],
[
-122.20687,
47.61158
],
[
-122.20689,
47.61187
],
[
-122.20691,
47.61233
],
[
-122.20691,
47.61247
],
[
-122.20694,
47.61317
],
[
-122.20695,
47.61342
],
[
-122.20696,
47.61362
],
[
-122.20697,
47.61384
],
[
-122.20683,
47.61384
],
[
-122.20638,
47.61384
],
[
-122.20612,
47.61384
],
[
-122.20568,
47.61383
],
[
-122.20559,
47.6138
],
[
-122.20467,
47.61379
],
[
-122.20443,
47.61379
],
[
-122.20405,
47.61379
],
[
-122.20325,
47.6138
],
[
-122.203,
47.6138
],
[
-122.20274,
47.6138
],
[
-122.20241,
47.61381
],
[
-122.20222,
47.6138
],
[
-122.20202,
47.6138
],
[
-122.20193,
47.6138
],
[
-122.20181,
47.61386
],
[
-122.20167,
47.61386
],
[
-122.20155,
47.61386
],
[
-122.20158,
47.61464
],
[
-122.20159,
47.61475
],
[
-122.2016,
47.61503
],
[
-122.2016,
47.61508
]
]
]
},
"properties": {
"distanceInMeters": 1520,
"durationInSeconds": 307,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:13:10+00:00",
"durationTrafficInSeconds": 300,
"trafficCongestion": "Medium",
"type": "RoutePath",
"legs": [
{
"distanceInMeters": 1520,
"durationInSeconds": 307,
"durationTrafficInSeconds": 300,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:13:10+00:00",
"routePathRange": {
"legIndex": 0,
"range": [
0,
64
]
}
}
]
},
"bbox": [
-122.20697,
47.60868,
-122.20147,
47.61508
]
}
],
"alternativeRoutes": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20147,
47.60868
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 0
},
"order": {
"inputIndex": 0
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.2016,
47.61508
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 29
},
"order": {
"inputIndex": 1
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": [
[
[
-122.20147,
47.60868
],
[
-122.20148,
47.60884
],
[
-122.20148,
47.60906
],
[
-122.20148,
47.60919
],
[
-122.20148,
47.60953
],
[
-122.20148,
47.60967
],
[
-122.20149,
47.60997
],
[
-122.2015,
47.61011
],
[
-122.2015,
47.61019
],
[
-122.20151,
47.61072
],
[
-122.20152,
47.61092
],
[
-122.20152,
47.61097
],
[
-122.20149,
47.611
],
[
-122.20147,
47.61104
],
[
-122.20145,
47.61117
],
[
-122.20145,
47.61122
],
[
-122.20145,
47.61126
],
[
-122.20146,
47.61149
],
[
-122.20147,
47.61166
],
[
-122.20148,
47.61197
],
[
-122.20148,
47.61203
],
[
-122.2015,
47.61268
],
[
-122.20151,
47.61289
],
[
-122.20152,
47.61297
],
[
-122.20153,
47.61338
],
[
-122.20155,
47.61386
],
[
-122.20158,
47.61464
],
[
-122.20159,
47.61475
],
[
-122.2016,
47.61503
],
[
-122.2016,
47.61508
]
]
]
},
"properties": {
"distanceInMeters": 713,
"durationInSeconds": 92,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:09:40+00:00",
"durationTrafficInSeconds": 90,
"trafficCongestion": "Medium",
"type": "RoutePath",
"legs": [
{
"distanceInMeters": 713,
"durationInSeconds": 92,
"durationTrafficInSeconds": 90,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:09:40+00:00",
"routePathRange": {
"legIndex": 0,
"range": [
0,
29
]
}
}
]
},
"bbox": [
-122.2016,
47.60868,
-122.20145,
47.61508
]
}
]
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Address |
Der Regierungsbezirk und die Landesregion für die Wegpunkte und Manöverpunkte auf der Route. |
|
Admin |
Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region. |
|
Adr |
Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf. |
|
Avoid |
Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt. Beispiel: "avoid": ["limitedAccessHighways", "tollRoads"] |
|
Country |
Stellt ein Land oder eine Region dar, das verwandte Details enthält. |
|
Directions |
Dieses Objekt ist der Anforderungstext. |
|
Driving |
Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an. |
|
Feature |
|
|
Features |
GeoJSON-Featureobjekt, das Geometry-Objekt und zusätzliche Eigenschaften der Route enthält. |
|
Features |
Gibt den |
|
Feature |
Gibt den |
|
Geo |
Ein gültiger |
|
Input |
Gibt den Eingabewegpunkt und überWaypoint |
|
Input |
Gibt die Eigenschaften eines Wegpunkts an, der eine bestimmte Position oder einen bestimmten Punkt entlang einer Route oder Reise ist, die als Bezugs- oder Haltepunkt dient. |
|
Input |
Wegpunkttyp auf der Route. Es kann sich um eine Haltestelle oder eine Zwischenposition sein, die die Route passieren muss. |
| Instruction |
Eine Beschreibung eines Manövers in einer Reihe von Richtungen. |
| Leg |
Informationen zu einem Abschnitt einer Route zwischen zwei Wegpunkten. Weitere Informationen zu den Feldern, die in einem Routenabschnitt enthalten sind: |
|
Maneuver |
Gibt die Fahranweisungen und zusätzlichen Eigenschaften für jeden Manöverpunkt im Streckenabschnitt an. |
|
Maneuver |
Die Art des Manövers, das in dieser detaillierten Sammlung beschrieben wird. Der Manövertyp liefert Informationen für einen Teil des Manövers, der durch die entsprechende Anweisung angegeben wird. Beispielsweise kann der Manövertyp einer Anweisung TurnLeftThenTurnRight angeben, während die zugehörigen Detailelemente Einzelheiten über die TurnLeft- und TurnRight-Manöver bereitstellen können. |
|
Maps |
Das Fehlerdetails. |
|
Maps |
Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. |
|
Maps |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
Multi |
Gibt das |
|
Optimized |
Optimierte Art des Punktobjekts. |
| Order |
Reihenfolge für den Besuch von Wegpunkten. |
|
Point |
Der Als gültige
|
|
Route |
Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "fastestWithoutTraffic", der die Route zurückgibt, um die Fahrzeit zu minimieren, ohne aktuelle Verkehrsinformationen zu verwenden. Beispiel: "optimizeRoute":"kürzeste" |
|
Route |
Dieses Objekt wird von einem erfolgreichen Aufruf zurückgegeben. |
|
Route |
Gibt die Fahrzeugattribute an, z. B. Größe, Gewicht, Max. Geschwindigkeit, Frachttyp usw. nur für lkw-Routing. Dies trägt dazu bei, geringe Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Lkw-Route basierend auf den Fahrzeugspezifikationen bereitzustellen. IS |
|
Route |
Fügen Sie die gewünschten Routeninformationen aus der Antwort ein. Standardmäßig ist die Reiseroute in der Antwort enthalten. Unterstützt mehrere Werte, z. B. "routeOutputOptions": ["routePath", "itinerary"] |
|
Route |
Bezieht sich auf den Index eines Punkts innerhalb eines bestimmten Abschnitts einer Route. |
|
Route |
Gibt die Eigenschaften an, die den Pfad der Route in der Antwort beschreiben. |
|
Route |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
|
Route |
Der Reisemodus für den Routenpfad in der Antwort. |
|
Side |
Die Seite der Straße, an der das Ziel basierend auf der Ankunftsrichtung gefunden wird. Dieses Feld gilt nur für das letzte ManöverPoint. |
| Step |
Ein Streckenabschnitt enthält Turn-by-Turn-Anweisungen. Ein Schritt bezieht sich auf einen Bereich einer Route zwischen zwei aufeinander folgenden ManöverPoint. |
|
Traffic |
Die Verkehrsüberlastung entlang der Route.
|
|
Travel |
Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "Fahren", der die für Autos optimierte Route zurückgibt.
Beispiel: "travelMode":"fahren" |
|
Vehicle |
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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung. |
|
Waypoint |
Gibt die Eigenschaften eines Wegpunkts an, der eine bestimmte Position oder einen bestimmten Punkt entlang einer Route oder Reise ist, die als Bezugs- oder Haltepunkt dient. |
Address
Der Regierungsbezirk und die Landesregion für die Wegpunkte und Manöverpunkte auf der Route.
| Name | Typ | Beschreibung |
|---|---|---|
| adminDistricts |
Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region. |
|
| countryRegion |
Stellt ein Land oder eine Region dar, das verwandte Details enthält. |
AdminDistrict
Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region.
| Name | Typ | Beschreibung |
|---|---|---|
| shortName |
string |
Der Kurzname für das entsprechende Feld "adminDistrict" für "AdminDistrict[0]," könnte der kurze Name des Zustands sein, z. B. WA. Dies ist nur für die USA, Kanada und Mexiko verfügbar. |
AdrTunnelRestrictionCodeEnum
Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf.
| Wert | Beschreibung |
|---|---|
| B |
Fahrzeuge mit Code B sind von Straßen mit ADR-Tunnelkategorien B, C, D und E eingeschränkt. |
| C |
Fahrzeuge mit Code C sind von Straßen mit ADR-Tunnelkategorien C, D und E eingeschränkt |
| D |
Fahrzeuge mit Code D sind von Straßen mit ADR-Tunnelkategorien D und E eingeschränkt. |
| E |
Fahrzeuge mit Code E sind von Straßen mit ADR-Tunnelkategorie E eingeschränkt. |
AvoidEnum
Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt.
Beispiel: "avoid": ["limitedAccessHighways", "tollRoads"]
| Wert | Beschreibung |
|---|---|
| limitedAccessHighways |
Vermeidet die Verwendung begrenzter Zugangsstraßen in der Route. |
| tollRoads |
Vermeidet die Nutzung der mautpflichtigen Straßen auf der Route. |
| ferries |
Vermeidet die Verwendung von Fähren auf der Route. |
| tunnels |
Verhindert die Verwendung von Tunneln in der Route. |
| borderCrossings |
Verhindert die Grenzüberquerung der Länder in der Route. |
| lowEmissionZones |
Vermeidet emissionsarme Zonen in der Route. |
| unpavedRoads |
Vermeidet nicht gepavte Straßen in der Route. |
CountryRegion
Stellt ein Land oder eine Region dar, das verwandte Details enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| ISO |
string |
ISO des Landes/der Region stellt einen ISO 3166-1 Alpha-2-Region/Ländercode dar. |
| name |
string |
Name des Landes/der Region |
DirectionsRequest
Dieses Objekt ist der Anforderungstext.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| arriveAt |
string (date-time) |
Das Datum und die Uhrzeit der Ankunft am Zielpunkt, der als Der parameter Beispiel: "arriveAt": "2023-06-01T09:30:00.000-07:00" |
|
| avoid |
Gibt Einschränkungen an, die bei der Ermittlung der Route berücksichtigt werden sollen. Vermeiden Sie die Unterstützung mehrerer Werte in einer Anforderung und wird nur für den Fahr- und Lkw-Reisemodus unterstützt. Beispiel: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Das Datum und die Uhrzeit des Abflugpunkts, der als Wenn die Example: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| features |
Fahr-, Wander- und LKW-Routen werden durch eine Reihe von Wegpunkten (Stopps) und viaWaypoints (Zwischenorte, die die Route passieren muss) definiert. Sie können maximal 150 Wegpunkte und maximal 10 viaWaypoints zwischen jedem Satz von Wegpunkten haben. Eine Route muss mindestens 2 Wegpunkte aufweisen, und die Start- und Endpunkte der Route können nicht überWaypoints erfolgen. Sowohl Waypoint- als auch viaWaypoint-Standorte müssen zusammen mit PointIndex als gültiges GeoJSON Point-Featureobjekt angegeben werden, das die Reihenfolge der Standorte angibt. Weitere Informationen zum GeoJSON-Format finden Sie unter RFC 7946. |
||
| heading |
integer (int64) minimum: 0maximum: 359 |
Die erste Richtung 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. |
|
| maxRouteCount |
integer (int64) minimum: 1maximum: 6 |
Die maximale Anzahl der zurückzugebenden Routen. Verfügbar für die Fahr- und Lkw-Reisemodi. Standardwert: "maxRouteCount":1 |
|
| optimizeRoute | fastestWithoutTraffic |
Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "fastestWithoutTraffic", der die Route zurückgibt, um die Fahrzeit zu minimieren, ohne aktuelle Verkehrsinformationen zu verwenden. Beispiel: "optimizeRoute":"kürzeste" |
|
| optimizeWaypointOrder |
boolean |
False |
Ordnen Sie die Routenwegpunkte mithilfe eines schnellen heuristischen Algorithmus neu an, um die mit dem Optimierungsparameter angegebenen Routenkosten zu reduzieren. Der Ursprung und das Ziel werden vom optimierten Wegpunkt ausgeschlossen, und ihre Position wird als fest betrachtet. Zulässige Werte sind wahr oder falsch. |
| routeOutputOptions | [ "itinerary" ] |
Fügen Sie die gewünschten Routeninformationen aus der Antwort ein. Standardmäßig ist die Reiseroute in der Antwort enthalten. Unterstützt mehrere Werte, z. B. "routeOutputOptions": ["routePath", "itinerary"] |
|
| travelMode | driving |
Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "Fahren", der die für Autos optimierte Route zurückgibt.
Beispiel: "travelMode":"fahren" |
|
| type |
Gibt den |
||
| vehicleSpec |
Gibt die Fahrzeugattribute an, z. B. Größe, Gewicht, Max. Geschwindigkeit, Frachttyp usw. nur für lkw-Routing. Dies trägt dazu bei, geringe Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Lkw-Route basierend auf den Fahrzeugspezifikationen bereitzustellen.
|
DrivingSideEnum
Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an.
| Wert | Beschreibung |
|---|---|
| Left |
Linksseitiges Fahren. |
| Right |
Rechtsseitiges Fahren. |
FeatureCollection
GeoJSON
FeatureCollection Objekt, das eine Liste der Features enthält. Weitere Informationen finden Sie unter RFC 7946, Abschnitt 3.3.
| Name | Typ | Beschreibung |
|---|---|---|
| features |
|
|
| type |
Gibt den |
FeaturesItem
GeoJSON-Featureobjekt, das Geometry-Objekt und zusätzliche Eigenschaften der Route enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Ein rechteckiger Bereich auf der Erde, der als umgebendes Boxobjekt definiert ist. Die Seiten der Rechtecke werden durch Breiten- und Längengradwerte definiert. Weitere Informationen finden Sie unter RFC 7946, Abschnitt 5. Beispiel: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteDirectionsGeometry: |
Ein gültiges |
| properties | FeatureProperties: |
Gibt die Featureeigenschaften der Route wie Reiseroute, Streckenbeine und Geometrie, Reisezusammenfassung an. |
| type |
Gibt den |
FeaturesItemTypeEnum
Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist Feature. Weitere Informationen finden Sie unter RFC 7946.
| Wert | Beschreibung |
|---|---|
| Feature |
Gibt den |
FeatureTypeEnum
Gibt den GeoJSON Typ an. Der einzige unterstützte Objekttyp ist FeatureCollection. Weitere Informationen finden Sie unter RFC 7946.
| Wert | Beschreibung |
|---|---|
| FeatureCollection |
Gibt den |
GeoJsonPoint
Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Ein |
| type |
string:
Point |
Gibt den |
InputWaypointFeaturesItem
Gibt den Eingabewegpunkt und überWaypoint GeoJSON Featureobjekt und zusätzliche Eigenschaften an. Weitere Informationen finden Sie unter RFC 7946.
| Name | Typ | Beschreibung |
|---|---|---|
| geometry | GeoJsonPoint: |
Ein gültiger |
| properties |
Gibt die Eigenschaften eines Wegpunkts an, der eine bestimmte Position oder einen bestimmten Punkt entlang einer Route oder Reise ist, die als Bezugs- oder Haltepunkt dient. |
|
| type |
Gibt den |
InputWaypointProperties
Gibt die Eigenschaften eines Wegpunkts an, der eine bestimmte Position oder einen bestimmten Punkt entlang einer Route oder Reise ist, die als Bezugs- oder Haltepunkt dient.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| pointIndex |
integer (int64) |
Identifizieren und ordnen Sie die Abfolge von Wegpunkten in der Route an. Der Standardwert ist die |
|
| pointType | waypoint |
Wegpunkttyp auf der Route. Es kann sich um eine Haltestelle oder eine Zwischenposition sein, die die Route passieren muss. |
InputWaypointTypeEnum
Wegpunkttyp auf der Route. Es kann sich um eine Haltestelle oder eine Zwischenposition sein, die die Route passieren muss.
| Wert | Beschreibung |
|---|---|
| waypoint |
Ein Wegpunkt ist ein bestimmter Ort oder Punkt entlang einer Route oder Reise, die als Bezugs- oder Haltepunkt dient. |
| viaWaypoint |
Ein viaWaypoint ist ein bestimmter Wegpunkt, der entlang einer Route oder Reise durchquert oder besucht werden muss. |
Instruction
Eine Beschreibung eines Manövers in einer Reihe von Richtungen.
| Name | Typ | Beschreibung |
|---|---|---|
| drivingSide |
Gibt links- und rechtsseitiges Fahren an der Stelle des Manövers an. |
|
| formattedText |
string |
Die formatierte Textbeschreibung der Anweisung. |
| maneuverType |
Die Art des Manövers, das in dieser detaillierten Sammlung beschrieben wird. Der Manövertyp liefert Informationen für einen Teil des Manövers, der durch die entsprechende Anweisung angegeben wird. Beispielsweise kann der Manövertyp einer Anweisung TurnLeftThenTurnRight angeben, während die zugehörigen Detailelemente Einzelheiten über die TurnLeft- und TurnRight-Manöver bereitstellen können. |
|
| text |
string |
Die Nur-Text-Beschreibung der Anweisung. |
Leg
Informationen zu einem Abschnitt einer Route zwischen zwei Wegpunkten. Weitere Informationen zu den Feldern, die in einem Routenabschnitt enthalten sind:
| Name | Typ | Beschreibung |
|---|---|---|
| arrivalAt |
string (date-time) |
Die geschätzte Ankunftszeit für das Bein, die die Verkehrsbedingungen berücksichtigt, wird als dateTime-Wert formatiert, der durch RFC 3339, Abschnitt 5.6definiert ist. Es wird auf den Zeitzonenoffset entweder durch |
| departureAt |
string (date-time) |
Die geschätzte Abfahrtszeit für das Bein, die die Verkehrsbedingungen berücksichtigt, wird als dateTime-Wert formatiert, der durch RFC 3339, Abschnitt 5.6definiert ist. Es wird auf den Zeitzonenoffset entweder durch |
| distanceInMeters |
number |
Die physische Entfernung in Metern, die von einer Strecke Bein bedeckt ist. |
| durationInSeconds |
integer (int64) |
Geschätzte Fahrzeit in Sekunden, die aufgrund von Verkehrsbedingungen keine Verzögerungen auf der Route enthält. |
| durationTrafficInSeconds |
integer (int64) |
Die Zeit, die es in Sekunden dauert, um eine entsprechende |
| routePathRange |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
ManeuverPointProperties
Gibt die Fahranweisungen und zusätzlichen Eigenschaften für jeden Manöverpunkt im Streckenabschnitt an.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| address |
Der Regierungsbezirk und die Landesregion für die Wegpunkte und Manöverpunkte auf der Route. |
||
| distanceInMeters |
number |
Die physische Entfernung in Metern, die von diesem Routenschritt abgedeckt wird. |
|
| durationInSeconds |
integer (int64) |
Die Zeit, die es in Sekunden dauert, um eine entsprechende |
|
| exitIdentifier |
string |
Der Name oder die Nummer des Exits, der diesem Routenschritt zugeordnet ist. |
|
| instruction |
Eine Beschreibung eines Manövers in einer Reihe von Richtungen. |
||
| order |
Reihenfolge für den Besuch von Wegpunkten. |
||
| routePathPoint |
Bezieht sich auf den Index eines Punkts innerhalb eines bestimmten Abschnitts einer Route. |
||
| sideOfStreet |
Die Seite der Straße, an der das Ziel basierend auf der Ankunftsrichtung gefunden wird. Dieses Feld gilt nur für das letzte ManöverPoint. |
||
| signs |
string[] |
Beschilderungstext für die Route. Möglicherweise gibt es mehrere Zeichenwerte. |
|
| steps |
Step[] |
Schritte zwischen zwei aufeinander folgenden Manöverpunkten. |
|
| towardsRoadName |
string |
Der Name der Straße, die die Route in die erste |
|
| travelMode | driving |
Der Reisemodus für den Routenpfad in der Antwort. |
|
| type |
string:
Maneuver |
Art der Ausgabe. |
ManeuverTypeEnum
Die Art des Manövers, das in dieser detaillierten Sammlung beschrieben wird. Der Manövertyp liefert Informationen für einen Teil des Manövers, der durch die entsprechende Anweisung angegeben wird. Beispielsweise kann der Manövertyp einer Anweisung TurnLeftThenTurnRight angeben, während die zugehörigen Detailelemente Einzelheiten über die TurnLeft- und TurnRight-Manöver bereitstellen können.
| Wert | Beschreibung |
|---|---|
| ArriveFinish |
Kommen Sie am endgültigen Ziel an. |
| ArriveIntermediate |
Kommen Sie zu einem Zwischenwegpunkt. |
| BearLeft |
Halten Sie sich links. |
| BearLeftThenBearLeft |
Bär links und dann wieder bärt. |
| BearLeftThenBearRight |
Bärt links und dann rechts. |
| BearLeftThenTurnLeft |
Halten Sie sich links und biegen Sie dann links ab. |
| BearLeftThenTurnRight |
Bärt links und dann rechts. |
| BearRight |
Halten Sie sich rechts. |
| BearRightThenBearLeft |
Halten Sie rechts und dann links. |
| BearRightThenBearRight |
Tragen Sie rechts, und tragen Sie dann wieder recht. |
| BearRightThenTurnLeft |
Halten Sie sich rechts und biegen Sie dann links ab. |
| BearRightThenTurnRight |
Bärt rechts und dann rechts. |
| BearThenKeep |
Bärenanweisung und dann eine Behaltensanweisung |
| BearThenMerge |
Bear-Anweisung und dann eine Merge-Anweisung. |
| Continue |
Fahren Sie auf der aktuellen Straße fort. |
| DepartIntermediateStop |
Verlassen Sie einen Zwischenwegpunkt in eine andere Richtung und Straße als Sie angekommen sind. |
| DepartIntermediateStopReturning |
Verlassen Sie einen Zwischenwegpunkt in die gleiche Richtung und auf der gleichen Straße, auf der Sie angekommen sind. |
| DepartStart |
Verlassen Sie den Ausgangspunkt. |
| EnterRoundabout |
Geben Sie einen Kreisverkehr ein. |
| ExitRoundabout |
Verlassen Sie einen Kreisverkehr. |
| EnterThenExitRoundabout |
Geben Sie einen Kreisverkehr ein, und verlassen Sie ihn. |
| ExitRoundaboutRight |
Im Kreisverkehr nehmen Sie die Ausfahrt auf der rechten Seite. |
| ExitRoundaboutLeft |
Im Kreisverkehr nehmen Sie die Ausfahrt auf der linken Seite. |
| Follow |
Follow. |
| GoAroundRoundabout |
Fahren Sie mit dem Kreisverkehr um. |
| KeepLeft |
Bleiben Sie auf einer anderen Straße. |
| KeepOnRampLeft |
Bleiben Sie links, und fahren Sie mit der Rampe fort. |
| KeepOnRampRight |
Halten Sie nach rechts, und fahren Sie mit der Rampe fort. |
| KeepOnRampStraight |
Halten Sie gerade, und fahren Sie mit der Rampe fort. |
| KeepRight |
Halten Sie rechts auf eine andere Straße. |
| KeepStraight |
Halten Sie gerade auf eine andere Straße. |
| KeepToStayLeft |
Bleiben Sie links, um auf derselben Straße zu bleiben. |
| KeepToStayRight |
Halten Sie das Recht, auf derselben Straße zu bleiben. |
| KeepToStayStraight |
Halten Sie gerade, um auf derselben Straße zu bleiben. |
| MergeFreeway |
Verbinden Sie sich mit einem Freiweg. |
| MergeHighway |
Verbinden Sie sich mit einer Autobahn. |
| MergeMotorway |
Verbinden Sie sich auf einer Autobahn. |
| MotorwayExitLeft |
Nehmen Sie den linken Ausgang. |
| MotorwayExitRight |
Nehmen Sie den rechten Ausgang. |
| None |
Keine Anweisung. |
| RampThenHighwayLeft |
Nehmen Sie die linke Rampe auf die Autobahn. Dies ist Teil einer kombinierten Anweisung. |
| RampThenHighwayRight |
Fahren Sie mit der rechten Rampe auf die Autobahn. Dies ist Teil einer kombinierten Anweisung. |
| RampThenHighwayStraight |
Bleiben Sie gerade, um die Rampe auf die Autobahn zu nehmen. Dies ist Teil einer kombinierten Anweisung. |
| RoadNameChange |
Änderungen des Straßennamens. |
| SwitchToParallelRoad |
Wechseln Sie zur parallelen Straße. |
| SwitchToMainRoad |
Wechseln Sie zur Hauptstraße. |
| Take |
Nehmen Sie die Straße. Diese Anweisung wird verwendet, wenn Sie eine Fähre betreten oder verlassen. |
| TakeFerry |
Nehmen Sie die Fähre. |
| TakeExit |
Nehmen Sie den Ausgang. |
| TakeRamp |
Nehmen Sie die Rampe. |
| TakeRampLeft |
Fahren Sie mit der Rampe nach links. |
| TakeRampRight |
Fahren Sie mit der Rampe nach rechts. |
| TakeRampStraight |
Bleiben Sie direkt, um die Rampe zu nehmen. |
| TurnBack |
Kehren Sie scharf zurück. |
| TurnLeft |
Biege links ab. |
| TurnLeftSharp |
Nehmen Sie eine scharfe linke Drehung. |
| TurnLeftThenBearLeft |
Biegen Sie links ab, und tragen Sie dann links. |
| TurnLeftThenBearRight |
Biegen Sie nach links, und tragen Sie dann rechts. |
| TurnLeftThenTurnLeft |
Biegen Sie nach links ab, und kehren Sie dann wieder nach links. |
| TurnLeftThenTurnRight |
Biegen Sie nach links und dann nach rechts. |
| TurnRight |
Rechts abbiegen. |
| TurnRightSharp |
Nehmen Sie eine scharfe rechte Drehung. |
| TurnRightThenBearLeft |
Drehen Sie nach rechts, und tragen Sie dann links. |
| TurnRightThenBearRight |
Drehen Sie nach rechts, und tragen Sie dann rechts. |
| TurnRightThenTurnLeft |
Drehen Sie nach rechts, und drehen Sie dann nach links. |
| TurnRightThenTurnRight |
Rechts drehen und dann erneut nach rechts |
| TurnThenMerge |
Turn-Anweisung, gefolgt von einer Merge-Anweisung. |
| TurnToStayLeft |
Biegen Sie links, um auf derselben Straße zu bleiben. |
| TurnToStayRight |
Biegen Sie rechts ab, um auf derselben Straße zu bleiben. |
| Unknown |
Die Anweisung ist unbekannt. |
| UTurn |
Machen Sie eine U-Wende, um in die entgegengesetzte Richtung zu gehen. |
| Wait |
Wait |
| Walk |
Walk |
MapsErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
| details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
| innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
| message |
string |
Eine lesbare Darstellung des Fehlers. |
| target |
string |
Das Ziel des Fehlers. |
MapsErrorResponse
Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerdetails. |
MapsInnerError
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Der Fehlercode. |
| innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
MultiLineStringGeometry
Gibt das GeoJSON MultiLineString Geometry -Objekt an. Weitere Informationen finden Sie unter RFC 7946.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Multi |
Gibt den Geometrietyp für das |
OptimizedWaypoint
Optimierte Art des Punktobjekts.
| Name | Typ | Beschreibung |
|---|---|---|
| inputIndex |
integer (int64) |
Wegpunktindex, der vom Benutzer bereitgestellt wird. |
| optimizedIndex |
integer (int64) |
Optimierter Wegpunktindex aus dem System. |
Order
Reihenfolge für den Besuch von Wegpunkten.
| Name | Typ | Beschreibung |
|---|---|---|
| inputIndex |
integer (int64) |
Vom Benutzer bereitgestellter Index für den Wegpunkt |
| optimizedIndex |
integer (int64) |
Systemoptimierter Wegpunkt |
PointGeometry
Der Als gültige GeoJSON Geometry-Objekt übergebene Ursprungspunkt, aus dem das Bereichspolyck berechnet werden soll. Weitere Informationen finden Sie unter RFC 7946-.
Note: Die API nimmt den angeforderten Ursprungspunkt am nächstgelegenen Straßennetz ein und verwendet diese für die Bereichsberechnung. Sie wird als center Punkt in der Antwort zurückgegeben.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Ein |
| type |
string:
Point |
Gibt den Geometrietyp für das |
RouteDirectionOptimizeRouteEnum
Gibt den Parameter an, der zum Optimieren der Route verwendet werden soll. Wenn nicht definiert, ist der Standardwert "fastestWithoutTraffic", der die Route zurückgibt, um die Fahrzeit zu minimieren, ohne aktuelle Verkehrsinformationen zu verwenden.
Beispiel: "optimizeRoute":"kürzeste"
| Wert | Beschreibung |
|---|---|
| short |
Die Route ist so berechnet, dass sie ein Gleichgewicht zwischen schneller Reisezeit und kurzer Strecke herstellt, anstatt nur eine zu priorisieren. Es ist sowohl auf Geschwindigkeit als auch auf Effizienz optimiert. Datenverkehrsinformationen werden nicht verwendet. |
| shortest |
Die Route wird berechnet, um die Entfernung zu minimieren. Datenverkehrsinformationen werden nicht verwendet. |
| fastestWithoutTraffic |
Findet die schnellste Route, ohne die Verkehrsinformationen zu berücksichtigen. |
| fastestWithTraffic |
Die Route wird berechnet, um die Zeit mithilfe der aktuellen Datenverkehrsinformationen zu minimieren.
|
RouteDirectionsResponse
Dieses Objekt wird von einem erfolgreichen Aufruf zurückgegeben.
| Name | Typ | Beschreibung |
|---|---|---|
| alternativeRoutes |
Alternativweg. |
|
| features |
|
|
| type |
Gibt den |
RouteDirectionVehicleSpec
Gibt die Fahrzeugattribute an, z. B. Größe, Gewicht, Max. Geschwindigkeit, Frachttyp usw. nur für lkw-Routing. Dies trägt dazu bei, geringe Brückenabstände, Straßeneinschränkungen, schwierige Rechtsdrehungen zu vermeiden, um die optimierte Lkw-Route basierend auf den Fahrzeugspezifikationen bereitzustellen.
ISNote: Nur für Truck TravelMode unterstützt.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| adrTunnelRestrictionCode |
Der ADR-Tunneleinschränkungscode. ADR ist ein europäisches Abkommen über die internationale Beförderung gefährlicher Güter auf der Straße. Der ADR-Tunneleinschränkungscode wird verwendet, um zu bestimmen, ob ein Fahrzeug durch einen Tunnel mit Einschränkungen bei der Beförderung gefährlicher Güter durchfahren darf. |
||
| axleCount |
integer (int64) |
Die Anzahl der Achsen auf dem Fahrzeug. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Höhe des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden. |
| isVehicleCommercial |
boolean |
False |
Ob das Fahrzeug für gewerbliche Zwecke verwendet wird. Nutzfahrzeuge dürfen auf einigen Straßen möglicherweise nicht fahren. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Länge des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Längenbeschränkungen nicht berücksichtigt werden. |
| loadType |
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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
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. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Gewicht des Fahrzeugs in Kilogramm. Ein Wert von 0 bedeutet, dass Gewichtseinschränkungen nicht berücksichtigt werden. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Breite des Fahrzeugs in Metern. Ein Wert von 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden. |
RouteOutputOptionEnum
Fügen Sie die gewünschten Routeninformationen aus der Antwort ein. Standardmäßig ist die Reiseroute in der Antwort enthalten.
Unterstützt mehrere Werte, z. B. "routeOutputOptions": ["routePath", "itinerary"]
| Wert | Beschreibung |
|---|---|
| routeSummary |
Schließen Sie nur Die Reisezeit und Entfernung für die Route ein, und geben Sie keine anderen Informationen an. |
| routePath |
Schließen Sie einen GeoJSON MultiLineString RFC 7946, Abschnitt 3.1.5 ein, die den Pfad der Route in der Antwort beschreiben. |
| itinerary |
Fügen Sie detaillierte Wegbeschreibungen in die Antwort ein. Detaillierte Wegbeschreibungen werden als "Manöverpoints" bereitgestellt und enthalten Details wie Turn-by-Turn-Anweisungen. |
RoutePathPoint
Bezieht sich auf den Index eines Punkts innerhalb eines bestimmten Abschnitts einer Route.
| Name | Typ | Beschreibung |
|---|---|---|
| legIndex |
integer (int64) |
Der Routen-Leg-Index ist eine sequenzielle Nummer, die jedem Abschnitt der Route zugewiesen ist, um die Identifizierung und Unterscheidung zwischen verschiedenen Segmenten der Route zu erleichtern. |
| pointIndex |
integer (int64) |
Index eines Punkts innerhalb eines bestimmten Legs. |
RoutePathProperties
Gibt die Eigenschaften an, die den Pfad der Route in der Antwort beschreiben.
| Name | Typ | Beschreibung |
|---|---|---|
| arrivalAt |
string (date-time) |
Die geschätzte Ankunftszeit für das Bein, die die Verkehrsbedingungen berücksichtigt, wird als |
| departureAt |
string (date-time) |
Die geschätzte Abfahrtszeit für das Bein, die die Verkehrsbedingungen berücksichtigt, wird als |
| distanceInMeters |
number |
Die physische Entfernung in Metern, die von der gesamten Strecke bedeckt ist. |
| durationInSeconds |
integer (int64) |
Geschätzte Fahrzeit in Sekunden, die aufgrund von Verkehrsbedingungen keine Verzögerungen auf der Route enthält. |
| durationTrafficInSeconds |
integer (int64) |
Die Zeit, die es in Sekunden dauert, um eine entsprechende |
| legs |
Leg[] |
Ein Array von Streckenbeinen. Überprüfen Sie die Beschreibung des Route Leg-Objekts, um weitere Informationen zu finden. |
| optimizedWaypoints |
Optimierte Sequenz von Wegpunkten. Er zeigt den Index aus der vom Benutzer bereitgestellten Wegpunktsequenz für die ursprünglichen und optimierten Listen an. |
|
| trafficCongestion |
Die Verkehrsüberlastung entlang der Route.
|
|
| type |
string:
Route |
Art der Ausgabe. |
RoutePathRange
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| legIndex |
integer (int64) |
Der Routen-Leg-Index ist eine sequenzielle Nummer, die jedem Abschnitt der Route zugewiesen ist, um die Identifizierung und Unterscheidung zwischen verschiedenen Segmenten der Route zu erleichtern. |
| range |
integer[] (int64) |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
RoutePathTravelModeEnum
Der Reisemodus für den Routenpfad in der Antwort.
| Wert | Beschreibung |
|---|---|
| driving |
Für Autos optimierte Routen. |
| truck |
Routen, die für großgroße Lkw auf Der Grundlage der Fahrzeugspezifikation optimiert sind. |
| walking |
Für Fußgänger optimierte Routen. |
| other |
RouteTravelMode wird als "sonstige" für den Truck TravelMode zurückgegeben, wenn die Lkw-Route für einen bestimmten Abschnitt einer Route nicht verfügbar ist. |
SideOfStreetEnum
Die Seite der Straße, an der das Ziel basierend auf der Ankunftsrichtung gefunden wird. Dieses Feld gilt nur für das letzte ManöverPoint.
| Wert | Beschreibung |
|---|---|
| Left |
Left. |
| Right |
Right. |
| Unknown |
Unknown. |
Step
Ein Streckenabschnitt enthält Turn-by-Turn-Anweisungen. Ein Schritt bezieht sich auf einen Bereich einer Route zwischen zwei aufeinander folgenden ManöverPoint.
| Name | Typ | Beschreibung |
|---|---|---|
| maneuverType |
Die Art des Manövers, das in dieser detaillierten Sammlung beschrieben wird. Der Manövertyp liefert Informationen für einen Teil des Manövers, der durch die entsprechende Anweisung angegeben wird. Beispielsweise kann der Manövertyp einer Anweisung TurnLeftThenTurnRight angeben, während die zugehörigen Detailelemente Einzelheiten über die TurnLeft- und TurnRight-Manöver bereitstellen können. |
|
| names |
string[] |
Eine Straße, Autobahn oder Kreuzung, an der das Manöver stattfindet. Wenn das Manöver komplex ist, kann es mehr als ein Namensfeld in der Detailauflistung geben. Das Namensfeld hat möglicherweise auch keinen Wert. Dies kann vorkommen, wenn der Name nicht bekannt ist oder wenn eine Straße, Autobahn oder Kreuzung keinen Namen hat. |
| routePathRange |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
TrafficCongestionEnum
Die Verkehrsüberlastung entlang der Route.
Note: Nur für das Fahren von TravelMode unterstützt
| Wert | Beschreibung |
|---|---|
| Unknown |
Unknown. |
| None |
None. |
| Mild |
Mild. |
| Medium |
Medium. |
| Heavy |
Heavy. |
TravelModeEnum
Der Reisemodus für die angeforderte Route. Wenn nicht definiert, ist der Standardwert "Fahren", der die für Autos optimierte Route zurückgibt.
Note: Bei Truck TravelMode steht die angeforderte Lkw-Route möglicherweise nicht für die gesamte Route zur Verfügung. Wenn die Lkw-Route für einen bestimmten Abschnitt nicht verfügbar ist, lautet das TravelMode-Element der Antwort für diesen Abschnitt "other".
Beispiel: "travelMode":"fahren"
| Wert | Beschreibung |
|---|---|
| driving |
Die zurückgegebenen Routen sind für Autos optimiert. |
| truck |
Die zurückgegebenen Routen sind für großgroße Lkw basierend auf der Fahrzeugspezifikation optimiert. |
| walking |
Die zurückgegebenen Routen sind für Fußgänger optimiert, einschließlich des Einsatzes von Gehwegen. |
VehicleLoadTypeEnum
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. Werte, die mit USHazmat beginnen, gelten für US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType unterstützt mehrere Werte in einer Anforderung.
| Wert | Beschreibung |
|---|---|
| USHazmatClass1 |
Explosives |
| USHazmatClass2 |
Komprimiertes Gas |
| USHazmatClass3 |
Entzündbare Flüssigkeiten |
| USHazmatClass4 |
Entzündbare Feststoffe |
| USHazmatClass5 |
Oxidizers |
| USHazmatClass6 |
Poisons |
| USHazmatClass7 |
Radioactive |
| USHazmatClass8 |
Corrosives |
| USHazmatClass9 |
Miscellaneous |
| otherHazmatExplosive |
Explosives |
| otherHazmatGeneral |
Miscellaneous |
| otherHazmatHarmfulToWater |
Schädlich für Wasser |
WaypointProperties
Gibt die Eigenschaften eines Wegpunkts an, der eine bestimmte Position oder einen bestimmten Punkt entlang einer Route oder Reise ist, die als Bezugs- oder Haltepunkt dient.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| address |
Der Regierungsbezirk und die Landesregion für die Wegpunkte und Manöverpunkte auf der Route. |
||
| distanceInMeters |
number |
Die physische Entfernung in Metern, die von diesem Routenschritt abgedeckt wird. |
|
| durationInSeconds |
integer (int64) |
Die Zeit, die es in Sekunden dauert, um eine entsprechende |
|
| exitIdentifier |
string |
Der Name oder die Nummer des Exits, der diesem Routenschritt zugeordnet ist. |
|
| instruction |
Eine Beschreibung eines Manövers in einer Reihe von Richtungen. |
||
| order |
Reihenfolge für den Besuch von Wegpunkten. |
||
| routePathPoint |
Bezieht sich auf den Index eines Punkts innerhalb eines bestimmten Abschnitts einer Route. |
||
| sideOfStreet |
Die Seite der Straße, an der das Ziel basierend auf der Ankunftsrichtung gefunden wird. Dieses Feld gilt nur für das letzte ManöverPoint. |
||
| signs |
string[] |
Beschilderungstext für die Route. Möglicherweise gibt es mehrere Zeichenwerte. |
|
| steps |
Step[] |
Schritte zwischen zwei aufeinander folgenden Manöverpunkten. |
|
| towardsRoadName |
string |
Der Name der Straße, die die Route in die erste |
|
| travelMode | driving |
Der Reisemodus für den Routenpfad in der Antwort. |
|
| type |
string:
Waypoint |
Art der Ausgabe. |