Route - Post Directions Batch
Dient zum Senden eines Batches von Abfragen an die Route Directions-API in einer einzigen synchronen Anforderung.
Anmerkung
Einstellung des Azure Maps-Route 2023-10-01-preview-Diensts
Der Azure Maps Route-Dienst Version 2023-10-01-preview ist jetzt veraltet und wird am 31.07.2025 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe des Route-Dienstes Version 2023-10-01-preview bis zum 31.07.2025 aktualisiert werden, um die neueste Version der Route-API zu verwenden.
Die Route Directions Batch
-API ist eine HTTP-POST
-Anforderung, die Batches von bis zu 100 Abfragen in einem einzigen Aufruf der Route Directions API sendet.
Wichtig
Durch die Verwendung dieses Features stimmen Sie den rechtlichen Bestimmungen der Vorschau zu. Weitere Details finden Sie in den Zusätzlichen Bedingungen für die Vorschau.
Synchrone Batchanforderung übermitteln
Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt.
POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview
POST-Text für Batchanforderung
Um die Wegbeschreibungen Abfragen zu senden, verwenden Sie eine POST
Anforderung, in der der Anforderungstext das batchItems
Array im json
Format enthält, und der Content-Type
Header wird auf application/json
festgelegt. Hier sehen Sie einen Beispielanforderungstext mit 2 Wegbeschreibungen Abfragen:
{
"batchItems": [
{
"optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.3368,
47.614988
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.316067,
47.606356
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "fastestWithoutTraffic",
"routeOutputOptions": [
"routeSummary"
],
"maxRouteCount": 3,
"travelMode": "driving"
},
{
"optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.3368,
47.614988
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.316067,
47.606356
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "shortest",
"routeOutputOptions": [
"routeSummary"
],
"maxRouteCount": 2,
"travelMode": "driving"
}
]
}
Eine Wegbeschreibung batchItem-Objekt kann jede der unterstützten WegbeschreibungenAnforderungstext
Der Batch sollte mindestens 1 Abfrage enthalten.
Batchantwortmodell
Die Batchantwort enthält eine summary
Komponente, die die totalRequests
angibt, die Teil der ursprünglichen Batchanforderung waren, und successfulRequests
d. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems
Array, das eine Antwort für jede und jede Abfrage in der Batchanforderung enthält. Die batchItems
enthält die Ergebnisse in der genauen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element weist einen der folgenden Typen auf:
DirectionsResponse
– Wenn die Abfrage erfolgreich abgeschlossen wurde.Error
– Wenn die Abfrage fehlgeschlagen ist. Die Antwort enthält in diesem Fall einecode
und einemessage
.
POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Die Liste der zu verarbeitenden Abfragen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse. |
|
Other Status Codes |
Multistatus. Mindestens ein Batchelemente konnte nicht verarbeitet werden und gibt einen anderen Statuscode zurück. |
|
Other Status Codes |
Unerwarteter Fehler. 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.
Anmerkung
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden. - Die
Authorization URL
ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. - Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
- Die Verwendung des Azure Maps Web SDK ermöglicht 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
A Route Directions Batch request containing 2 queries
Beispielanforderung
POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview
{
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.3368,
47.614988
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.316067,
47.606356
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "fastestWithTraffic",
"routeOutputOptions": [
"routeSummary"
],
"maxRouteCount": 3,
"travelMode": "driving"
},
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.3368,
47.614988
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.316067,
47.606356
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "fastestWithTraffic",
"routeOutputOptions": [
"routeSummary"
],
"maxRouteCount": 3,
"travelMode": "driving"
}
]
}
Beispiel für eine Antwort
{
"summary": {
"successfulRequests": 2,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": []
},
"properties": {
"type": "RoutePath",
"resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
"distanceInMeters": 1432.9,
"durationInSeconds": 524,
"durationTrafficInSeconds": 554
}
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": []
},
"properties": {
"type": "RoutePath",
"resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
"distanceInMeters": 1432.9,
"durationInSeconds": 524,
"durationTrafficInSeconds": 554
}
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
}
]
}
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": []
},
"properties": {
"type": "RoutePath",
"resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
"distanceInMeters": 1432.9,
"durationInSeconds": 524,
"durationTrafficInSeconds": 554
}
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"error": {
"code": "400 BadRequest",
"message": "Invalid request"
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
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. |
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", "tolls"] |
Directions |
Die Liste der Wegbeschreibungsabfragen/Anforderungen, die verarbeitet werden sollen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten. |
Directions |
Batchabfrageobjekt |
Directions |
Dieses Objekt wird von einem erfolgreichen Wegbeschreibungsbatchdienstaufruf zurückgegeben. |
Directions |
Batchantwortelement |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
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 |
Hint |
Zusätzliche Informationen, die beim Folgen einer Route hilfreich sein können. Zusätzlich zum Hinweistext weist dieses Element einen Attributhinweistyp auf, der angibt, auf was sich der Hinweis bezieht, z. B. "NextIntersection". Hinweis ist ein optionales Element.
|
Input |
Gibt den Eingabewegpunkt und überWaypoint |
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 von dieser Detailsammlung beschrieben wird. Der Manövertyp in einer Detailsammlung kann Informationen für einen Teil des Manövers bereitstellen, der durch das "maneuverType"-Attribut der entsprechenden Anweisung beschrieben wird. Beispielsweise kann das Attribut "maneuverType" einer Anweisung "TurnLeftThenTurnRight" als Manöver angeben, während die zugehörigen Detailelemente Einzelheiten zu den TurnLeft- und TurnRight-Manövern angeben 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 |
Optimize |
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":"shortest" |
Order |
Sequenz für Besuch von Wegpunkten und viaWaypoints. |
Point |
Gibt das |
Region |
Reisezusammenfassung über Entfernung, Zeit und mautpflichtige Straßenstrecke nach zwei Entitätstypen: Land (z. B. USA, Kanada) und Administrative Division oder Unterregion (z. B. "Staat" in DEN USA und "Provinz" in Kanada). |
Road |
Die Art der Straße.
|
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 wie "routeOutputOptions": ["routePath", "regionTravelSummary"] |
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. |
Sub |
Informationen zu einem Segment des Streckenabschnitts, der von den Wegpunkten der Route Leg definiert wird, sowie zu allen zwischengeschalteten Via-Way-Orten. Wenn z. B. die Strecke zwei Wegepunkte zusätzlich zu Start- und Endwegpunkten hat, gibt es drei (3) Streckenunterbeine. |
Summary |
Zusammenfassung für die Batchanforderung |
Traffic |
Die Verkehrsüberlastung entlang der Route.
|
Traffic |
Der Typ der Echtzeitdaten, die zum Generieren der Route verwendet werden. |
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":"driving" |
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. |
Vehicle |
Fahrzeugattribute werden in einer Fahrzeugangabe angegeben. Verschiedene Regionen können unterschiedliche Definitionen für die Lkw-Klassifizierung und -typen haben, z. B. leichte Lkw, mittlerer Lkw, schwerer Lkw usw. Um die genauesten Ergebnisse der Routeneinschränkungen basierend auf den Lkw-Spezifikationen zu erhalten, geben Sie die Fahrzeugattribute an.
|
Via |
Gibt die Eigenschaften eines |
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. |
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 |
---|---|---|
distanceInMeters |
number |
Die Gesamtdistanz, die in Metern innerhalb des Verwaltungsbezirks zurückgelegt wurde. |
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 |
longName |
string |
Der lange Name einer Adresse, z. B. Washington. |
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", "tolls"]
Wert | Beschreibung |
---|---|
borderCrossings |
Verhindert die Grenzüberquerung der Länder in der Route. |
ferries |
Vermeidet die Verwendung von Fähren auf der Route. |
limitedAccessHighways |
Vermeidet die Verwendung begrenzter Zugangsstraßen in der Route. |
lowEmissionZones |
Vermeidet emissionsarme Zonen in der Route.
|
tollRoads |
Vermeidet die Nutzung der mautpflichtigen Straßen auf der Route. |
tunnels |
Verhindert die Verwendung von Tunneln in der Route.
|
unpavedRoads |
Vermeidet nicht gepavte Straßen in der Route.
|
DirectionsBatchRequestBody
Die Liste der Wegbeschreibungsabfragen/Anforderungen, die verarbeitet werden sollen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten.
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Die Liste der zu verarbeitenden Abfragen. |
DirectionsBatchRequestItem
Batchabfrageobjekt
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 |
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", "tolls"] |
|
departAt |
string (date-time) |
Das Datum und die Uhrzeit des Abflugpunkts, der als Beispiel: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
features |
Fahr- und Wanderrouten werden durch eine Reihe von Wegpunkten(Haltestellen) und viaWaypoints (Zwischenpositionen, die die Route passieren muss) definiert. Sie können maximal 25 Wegpunkte und maximal 10 ViaWaypoints zwischen den einzelnen Wegpunkten haben. Lkw-Routen unterstützen bis zu 150 Wegpunkte und viaWaypoints werden nicht unterstützt. 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. Mögliche Werte 0-359 |
|
maxRouteCount |
integer (int64) minimum: 1maximum: 3 |
Die maximale Anzahl der zurückzugebenden Routen. Verfügbar für die Fahr- und Lkw-Reisemodi. Für Fahrrouten unterstützt dieser Parameter Routen mit bis zu zwei Wegpunkten zusätzlich zum Ursprung und Ziel, und der Parameter "Vermeiden" darf nicht festgelegt werden. Standard: "maxRouteCount":1 Mindestens: "maxRouteCount":1 Maximum: "maxRouteCount":3 |
|
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":"shortest" |
|
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.
|
optionalId |
string |
ID der Anforderung, die in dem entsprechenden batchItem angezeigt würde. |
|
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 wie "routeOutputOptions": ["routePath", "regionTravelSummary"] |
|
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":"driving" |
|
type |
Gibt den |
||
vehicleSpec |
Gibt die Fahrzeugattribute an, z. B. Größe, Gewicht, Max. Geschwindigkeit, Frachttyp 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.
|
DirectionsBatchResponse
Dieses Objekt wird von einem erfolgreichen Wegbeschreibungsbatchdienstaufruf zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
batchItems |
Array, das die Batchergebnisse enthält. |
|
nextLink |
string |
Dies ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist das Feld nicht vorhanden. |
summary |
Zusammenfassung für die Batchanforderung |
DirectionsBatchResponseItem
Batchantwortelement
Name | Typ | Beschreibung |
---|---|---|
alternativeRoutes |
Alternativweg. |
|
error |
Das Fehlerdetails. |
|
features |
|
|
nextLink |
string |
Dies ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist das Feld nicht vorhanden. |
optionalId |
string |
ID der Anforderung, die in dem entsprechenden batchItem angezeigt würde. |
type |
Gibt den |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
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 |
|
|
nextLink |
string |
Dies ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist das Feld nicht vorhanden. |
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 | Geometry: |
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 |
Hint
Zusätzliche Informationen, die beim Folgen einer Route hilfreich sein können. Zusätzlich zum Hinweistext weist dieses Element einen Attributhinweistyp auf, der angibt, auf was sich der Hinweis bezieht, z. B. "NextIntersection". Hinweis ist ein optionales Element.
Note
: Wird nur für das Fahren von travelMode unterstützt.
Name | Typ | Beschreibung |
---|---|---|
hintType |
string |
Tipp-Typ. |
text |
string |
Hinweistext. |
InputWaypointFeaturesItem
Gibt den Eingabewegpunkt und überWaypoint GeoJSON
Featureobjekt und zusätzliche Eigenschaften an. Weitere Informationen finden Sie unter RFC 7946.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
geometry | GeoJsonPoint: |
Ein gültiger |
|
properties.pointIndex |
integer (int64) |
Identifizieren und ordnen Sie die Abfolge von Wegpunkten in der Route an. Der Standardwert ist die |
|
properties.pointType | waypoint |
Wegpunkttyp auf der Route. Es kann sich um eine Haltestelle oder eine Zwischenposition sein, die die Route passieren muss. |
|
type |
Gibt den |
InputWaypointTypeEnum
Wegpunkttyp auf der Route. Es kann sich um eine Haltestelle oder eine Zwischenposition sein, die die Route passieren muss.
Wert | Beschreibung |
---|---|
viaWaypoint |
Ein viaWaypoint ist ein bestimmter Wegpunkt, der entlang einer Route oder Reise durchquert oder besucht werden muss.
|
waypoint |
Ein Wegpunkt ist ein bestimmter Ort oder Punkt entlang einer Route oder Reise, die als Bezugs- oder Haltepunkt dient. |
Instruction
Eine Beschreibung eines Manövers in einer Reihe von Richtungen.
Name | Typ | Beschreibung |
---|---|---|
formattedText |
string |
Die formatierte Textbeschreibung der Anweisung. |
hints |
Hint[] |
Zusätzliche Informationen, die beim Folgen einer Route hilfreich sein können. Zusätzlich zum Hinweistext weist dieses Element einen Attributhinweistyp auf, der angibt, auf was sich der Hinweis bezieht, z. B. "NextIntersection". Hinweis ist ein optionales Element, und ein Routenschritt kann mehrere Hinweise enthalten.
|
maneuverType |
Die Art des Manövers, das von dieser Detailsammlung beschrieben wird. Der Manövertyp in einer Detailsammlung kann Informationen für einen Teil des Manövers bereitstellen, der durch das "maneuverType"-Attribut der entsprechenden Anweisung beschrieben wird. Beispielsweise kann das Attribut "maneuverType" einer Anweisung "TurnLeftThenTurnRight" als Manöver angeben, während die zugehörigen Detailelemente Einzelheiten zu den TurnLeft- und TurnRight-Manövern angeben 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 |
---|---|---|
arrivalTime |
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 |
|
departureTime |
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 |
|
description |
string |
Eine kurze Beschreibung der Route. |
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 |
regionTravelSummary |
Schließen Sie die Reisezusammenfassung der Entfernung, der Zeit und der Mautstraßen durch zwei Entitätstypen ein: Land (z. B. USA, Kanada) und Administrative Division oder Unterregion (z. B. "State" in DEN USA und "Provinz" in Kanada). |
|
routePathRange |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
|
subLegs |
Sub |
Informationen zu einem Segment des Streckenabschnitts, der von den Wegpunkten der Route Leg definiert wird, sowie zu allen zwischengeschalteten Via-Way-Orten. Wenn z. B. die Strecke zwei Wegepunkte zusätzlich zu Start- und Endwegpunkten hat, gibt es drei (3) Streckenunterbeine. |
ManeuverPointProperties
Gibt die Fahranweisungen und zusätzlichen Eigenschaften für jeden Manöverpunkt im Streckenabschnitt an.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
compassDirection |
string |
Die Fahrtrichtung, die mit einem Manöver auf einer Route verbunden ist, z. B. Süd- oder Südwesten.
|
|
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 |
Sequenz für Besuch von Wegpunkten und viaWaypoints. |
||
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 |
Ausgabetyp. |
ManeuverTypeEnum
Die Art des Manövers, das von dieser Detailsammlung beschrieben wird. Der Manövertyp in einer Detailsammlung kann Informationen für einen Teil des Manövers bereitstellen, der durch das "maneuverType"-Attribut der entsprechenden Anweisung beschrieben wird. Beispielsweise kann das Attribut "maneuverType" einer Anweisung "TurnLeftThenTurnRight" als Manöver angeben, während die zugehörigen Detailelemente Einzelheiten zu den TurnLeft- und TurnRight-Manövern angeben können.
Wert | Beschreibung |
---|---|
ArriveFinish |
Kommen Sie am endgültigen Ziel an. |
ArriveIntermediate |
Kommen Sie zu einem Zwischenwegpunkt. |
BearLeft |
Bär 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 |
Bär 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. |
EnterThenExitRoundabout |
Geben Sie einen Kreisverkehr ein, und verlassen Sie ihn. |
ExitRoundabout |
Verlassen Sie einen Kreisverkehr. |
ExitRoundaboutLeft |
Im Kreisverkehr nehmen Sie die Ausfahrt auf der linken Seite. |
ExitRoundaboutRight |
Im Kreisverkehr nehmen Sie die Ausfahrt auf der rechten Seite. |
Follow |
Folgen. |
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. |
SwitchToMainRoad |
Wechseln Sie zur Hauptstraße. |
SwitchToParallelRoad |
Wechseln Sie zur parallelen Straße. |
Take |
Nehmen Sie die Straße. Diese Anweisung wird verwendet, wenn Sie eine Fähre betreten oder verlassen. |
TakeExit |
Nehmen Sie den Ausgang. |
TakeFerry |
Nehmen Sie die Fähre. |
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. |
UTurn |
Machen Sie eine U-Wende, um in die entgegengesetzte Richtung zu gehen. |
Unknown |
Die Anweisung ist unbekannt. |
Wait |
Warte |
Walk |
Gehen |
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 Geometrieobjekt 'GeoJSON' an. Weitere Informationen finden Sie unter RFC 7946. |
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":"shortest"
Wert | Beschreibung |
---|---|
fastestAvoidClosureWithoutTraffic |
Die Route wird berechnet, um die Zeit zu minimieren und Straßenschließungen zu vermeiden. In der Berechnung werden keine Verkehrsinformationen mit Ausnahme von Straßenschließungen verwendet.
|
fastestWithTraffic |
Die Route wird berechnet, um die Zeit mithilfe der aktuellen Datenverkehrsinformationen zu minimieren.
|
fastestWithoutTraffic |
Findet die schnellste Route, ohne die Verkehrsinformationen zu berücksichtigen. |
shortest |
Die Route wird berechnet, um die Entfernung zu minimieren. Datenverkehrsinformationen werden nicht verwendet. |
Order
Sequenz für Besuch von Wegpunkten und viaWaypoints.
Name | Typ | Beschreibung |
---|---|---|
inputIndex |
integer (int64) |
Vom Benutzer bereitgestellter Index für Waypoint- und viaWaypoint-Eingaben. |
optimizedIndex |
integer (int64) |
Systemoptimierte Waypoint- und viaWaypoint-Index. |
PointGeometry
Gibt das GeoJSON
Point Geometry -Objekt an. Weitere Informationen finden Sie unter RFC 7946.
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] (double) |
Ein |
type |
string:
Point |
Gibt den Geometrietyp für das Geometrieobjekt 'GeoJSON' an. Weitere Informationen finden Sie unter RFC 7946. |
RegionTravelSummary
Reisezusammenfassung über Entfernung, Zeit und mautpflichtige Straßenstrecke nach zwei Entitätstypen: Land (z. B. USA, Kanada) und Administrative Division oder Unterregion (z. B. "Staat" in DEN USA und "Provinz" in Kanada).
Name | Typ | Beschreibung |
---|---|---|
adminDistricts |
adminDistrict-Array. |
|
countryRegion |
string |
Name der Landregion. |
distanceInMeters |
number |
Length In Meter-Eigenschaft |
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 |
RoadTypeEnum
Die Art der Straße.
Note
: Wird nur für das Fahren von travelMode unterstützt.
Wert | Beschreibung |
---|---|
Arterial |
Arteriell. |
Ferry |
Fähre. |
Highway |
Landstraße. |
LimitedAccessHighway |
Eingeschränkter ZugangAutobahn. |
MajorRoad |
Hauptstraße. |
NotApplicable |
Nicht zulässig. |
Ramp |
Rampe. |
Street |
Straße. |
WalkingPath |
Spazierweg. |
RouteOutputOption
Fügen Sie die gewünschten Routeninformationen aus der Antwort ein. Standardmäßig ist die Reiseroute in der Antwort enthalten.
Unterstützt mehrere Werte wie "routeOutputOptions": ["routePath", "regionTravelSummary"]
Wert | Beschreibung |
---|---|
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. |
regionTravelSummary |
Schließen Sie die Reisezusammenfassung der Entfernung, der Zeit und der mautpflichtigen Straßen durch zwei Entitätstypen ein: Land (z. B. USA, Kanada) und Administrative Division oder Unterregion (z. B. "Staat" in DEN USA und "Provinz" in Kanada).
|
routePath |
Schließen Sie einen GeoJSON MultiLineString RFC 7946, Abschnitt 3.1.5 ein, die den Pfad der Route in der Antwort beschreiben. |
routeSummary |
Schließen Sie nur Die Reisezeit und Entfernung für die Route ein, und geben Sie keine anderen Informationen an. |
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 |
---|---|---|
arrivalTime |
Die geschätzte Ankunftszeit für das Bein, die die Verkehrsbedingungen berücksichtigt, wird als |
|
departureTime |
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. |
resourceId |
string |
Eine eindeutige ID für die Ressource. |
trafficCongestion |
Die Verkehrsüberlastung entlang der Route.
|
|
trafficDataUsed |
Der Typ der Echtzeitdaten, die zum Generieren der Route verwendet werden. |
|
type |
string:
Route |
Ausgabetyp. |
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. |
RouteTravelMode
Der Reisemodus für den Routenpfad in der Antwort.
Wert | Beschreibung |
---|---|
driving |
Für Autos 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. |
truck |
Routen, die für großgroße Lkw auf Der Grundlage der Fahrzeugspezifikation optimiert sind. |
walking |
Für Fußgänger optimierte Routen. |
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 |
Links. |
Right |
Rechts. |
Unknown |
Unbekannt. |
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 |
---|---|---|
compassDegrees |
number |
Die Richtung in Grad.
|
maneuverType |
Die Art des Manövers, das von dieser Detailsammlung beschrieben wird. Der Manövertyp in einer Detailsammlung kann Informationen für einen Teil des Manövers bereitstellen, der durch das "maneuverType"-Attribut der entsprechenden Anweisung beschrieben wird. Beispielsweise kann das Attribut "maneuverType" einer Anweisung "TurnLeftThenTurnRight" als Manöver angeben, während die zugehörigen Detailelemente Einzelheiten zu den TurnLeft- und TurnRight-Manövern angeben 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. |
roadType |
Die Art der Straße.
|
|
routePathRange |
Bezieht sich auf den Bereich, der von einem bestimmten Abschnitt einer Route oder eines Pfads abgedeckt wird. |
SubLeg
Informationen zu einem Segment des Streckenabschnitts, der von den Wegpunkten der Route Leg definiert wird, sowie zu allen zwischengeschalteten Via-Way-Orten. Wenn z. B. die Strecke zwei Wegepunkte zusätzlich zu Start- und Endwegpunkten hat, gibt es drei (3) Streckenunterbeine.
Name | Typ | Beschreibung |
---|---|---|
distanceInMeters |
number |
Der physische Abstand in Metern, der durch das Unterbein 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. |
Summary
Zusammenfassung für die Batchanforderung
Name | Typ | Beschreibung |
---|---|---|
successfulRequests |
integer (int32) |
Anzahl der erfolgreichen Anforderungen im Batch |
totalRequests |
integer (int32) |
Gesamtanzahl der Anforderungen im Batch |
TrafficCongestionEnum
Die Verkehrsüberlastung entlang der Route.
Note
: Nur für das Fahren von TravelMode unterstützt
Wert | Beschreibung |
---|---|
Heavy |
Schwer. |
Medium |
Mittel. |
Mild |
Leicht. |
None |
Nichts. |
Unknown |
Unbekannt. |
TrafficDataUsedEnum
Der Typ der Echtzeitdaten, die zum Generieren der Route verwendet werden.
Wert | Beschreibung |
---|---|
Closure |
Verwendete Echtzeit-Schließungsdaten, falls zutreffend. |
Flow |
Echtzeit-Verkehrsgeschwindigkeiten, die zum Berechnen der Fahrzeit verwendet werden. |
FlowAndClosure |
Fluss und Schließen. |
None |
Nichts. |
TravelMode
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":"driving"
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. |
VehicleLoadType
Ladungstypen, die als gefährliche Stoffe eingestuft und von einigen Straßen eingeschränkt werden können. Verfügbare vehicleLoadType-Werte sind US Hazmat Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. 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 |
Sprengstoff |
USHazmatClass2 |
Komprimiertes Gas |
USHazmatClass3 |
Brennbare Flüssigkeiten |
USHazmatClass4 |
Brennbare Feststoffe |
USHazmatClass5 |
Oxidizer |
USHazmatClass6 |
Gifte |
USHazmatClass7 |
Radioaktiv |
USHazmatClass8 |
Beizmittel |
USHazmatClass9 |
Verschiedenes |
otherHazmatExplosive |
Sprengstoff |
otherHazmatGeneral |
Verschiedenes |
otherHazmatHarmfulToWater |
Schädlich für Wasser |
VehicleSpec
Fahrzeugattribute werden in einer Fahrzeugangabe angegeben. Verschiedene Regionen können unterschiedliche Definitionen für die Lkw-Klassifizierung und -typen haben, z. B. leichte Lkw, mittlerer Lkw, schwerer Lkw usw. Um die genauesten Ergebnisse der Routeneinschränkungen basierend auf den Lkw-Spezifikationen zu erhalten, geben Sie die Fahrzeugattribute an.
Note
: Nur für Truck TravelMode unterstützt.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
axleCount |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Die Anzahl der Achsen auf dem Fahrzeug. Der Wert 0 bedeutet, dass Achseneinschränkungen nicht berücksichtigt werden. |
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. |
ViaWaypointProperties
Gibt die Eigenschaften eines ViaWaypoint
an, bei dem es sich um einen Wegpunkt handelt, der entlang einer Route oder Reise durchlaufen oder besucht werden muss.
Name | Typ | Beschreibung |
---|---|---|
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. |
order |
Sequenz für Besuch von Wegpunkten und viaWaypoints. |
|
routePathPoint |
Bezieht sich auf den Index eines Punkts innerhalb eines bestimmten Abschnitts einer Route. |
|
type |
string:
Via |
Ausgabetyp. |
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 |
---|---|---|---|
compassDirection |
string |
Die Fahrtrichtung, die mit einem Manöver auf einer Route verbunden ist, z. B. Süd- oder Südwesten.
|
|
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 |
Sequenz für Besuch von Wegpunkten und viaWaypoints. |
||
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 |
Ausgabetyp. |