@azure-rest/maps-route package

Schnittstellen

BatchRequest

Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.

BatchRequestItem

Batch-Anforderungsobjekt

BatchResultItemOutput

Ein von der Batch-API zurückgegebenes Element. Erweitern Sie mit der Eigenschaft "response".

BatchResultOutput

Dieses Objekt wird von einem erfolgreichen Batch-Dienstaufruf zurückgegeben. Erweitern Sie mit der Eigenschaft "batchItems".

BatchResultSummaryOutput

Zusammenfassung der Ergebnisse für die Batchanforderung

EffectiveSettingOutput

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

ErrorDetailOutput

Die Fehlerdetails.

ErrorResponseOutput

Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.).

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonLineStringData
GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiLineStringData
GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPointData

Daten, die in einem GeoJson MultiPointenthalten sind.

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPolygonData
GeoJsonObjectParent

Ein gültiges GeoJSON-Objekt. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPointData

Daten, die in einem GeoJson Pointenthalten sind.

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

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

RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Posttextparameter für Routenrichtungen.

RouteDirectionsBatchItemOutput

Ein Element, das vom Batch-Dienstaufruf "Route Directions" zurückgegeben wird.

RouteDirectionsBatchItemResponseOutput

Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, ErrorResponse andernfalls.

RouteDirectionsBatchResultOutput

Dieses Objekt wird von einem erfolgreichen Batch-Dienstaufruf für Routenanweisungen zurückgegeben.

RouteDirectionsOutput

Dieses Objekt wird von einem erfolgreichen Routenanweisungsaufruf zurückgegeben.

RouteGetRouteDirections200Response

Gilt für: Siehe Tarife.

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück und durchläuft Wegpunkte, sofern sie angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am gewünschten Wochentag und zur Tageszeit.

Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn-by-Turn-Anweisungen sind ebenfalls verfügbar, abhängig von den ausgewählten Optionen.

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um die konzepte und parameter ausführlich zu erläutern.

RouteGetRouteDirectionsBatch200Response

Gilt für: Siehe Tarife.

Herunterladen asynchroner Batchergebnisse

Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location Kopfzeile einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

  1. Der Client sendet eine GET Anforderung über die Download-URL.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

    HTTP 200 OK : Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Gilt für: Siehe Tarife.

Herunterladen asynchroner Batchergebnisse

Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location Kopfzeile einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

  1. Der Client sendet eine GET Anforderung mithilfe der Download-URL.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

    HTTP 200 OK : Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn die Verarbeitung des Batches abgeschlossen ist, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , die Teil der ursprünglichen Batchanforderung waren, und successfulRequestsabfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede einzelne Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode Felder und response . Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall eine code und eine message .

Hier sehen Sie ein Beispiel für eine Batchantwort mit 1 erfolgreichem ergebnis und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

Gilt für: Siehe Tarife.

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit.

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

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden.

RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Gilt für: Siehe Tarife.

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit.

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

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden.

RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Gilt für: Siehe Tarife.

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit.

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

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden.

RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Gilt für: Siehe Tarife.

Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP 202 Accepted : Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Gilt für: Siehe Tarife.

Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP 202 Accepted : Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteGetRouteRange200Response

Routenbereichs-API (Isochrone)

Gilt für: Siehe Tarife.

Dieser Dienst berechnet eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Kraftstoff-, Energie-, Zeit- oder Entfernungsbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war.

Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z . B. "Innerhalb der Geometrie suchen", um innerhalb der bereitgestellten Isochrone nach POIs zu suchen.

RouteGetRouteRangeDefaultResponse

Routenbereichs-API (Isochrone)

Gilt für: Siehe Tarife.

Dieser Dienst berechnet eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Kraftstoff-, Energie-, Zeit- oder Entfernungsbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war.

Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z . B. "Innerhalb der Geometrie suchen", um innerhalb der bereitgestellten Isochrone nach POIs zu suchen.

RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

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

RouteInstructionGroupOutput

Gruppiert eine Sequenz von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged), erhält die instructionGroup eine Zusammenfassungsmeldung, wenn sie verfügbar ist.

RouteInstructionOutput

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

RouteLegOutput

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

RouteMatrixOutput

Matrixergebnisobjekt

RouteMatrixQuery

Ein -Objekt mit einer Matrix von Koordinaten.

RouteMatrixResultOutput

Dieses Objekt wird von einem erfolgreichen Route Matrix-Aufruf zurückgegeben. Wenn z. B. 2 Ursprünge und 3 Ziele angegeben werden, werden zwei Arrays mit jeweils drei Elementen verwendet. Der Inhalt jedes Elements hängt von den in der Abfrage bereitgestellten Optionen ab.

RouteMatrixResultResponseOutput

Antwortobjekt der aktuellen Zelle in der Eingabematrix.

RouteMatrixSummaryOutput

Summary-Objekt

RouteOptimizedWaypointOutput

Optimiertes Wegepunktobjekt.

RouteOutput
RouteRangeOutput

Erreichbarer Bereich

RouteRangeResultOutput

Dieses Objekt wird von einem erfolgreichen Aufruf von Route Reachable Range zurückgegeben.

RouteReportOutput

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

RouteRequestRouteDirectionsBatch200Response

Batch-API für Routenbeschreibungen

Gilt für: Siehe Tarife.

Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen.

Übermitteln einer asynchronen Batchanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.

  • Es ermöglicht das Abrufen von Ergebnissen in einem separaten Aufruf (mehrere Downloads sind möglich).
  • Die asynchrone API ist auf Zuverlässigkeit optimiert und es wird nicht erwartet, dass ein Timeout auftritt.
  • Die Anzahl der Batchelemente ist für diese API auf 700 begrenzt.

Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

Beachten Sie, dass es sich bei der asynchronen Batchanforderung um eine Anforderung mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:

  1. Der Client sendet eine Batchanforderung POST für Routenanweisungen an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Batch-Anforderung. Dies kann entweder ein oder ein 400 Bad Request anderer Error status Code sein.

  3. Wenn die Batchanforderung erfolgreich angenommen wurde, enthält der Location Header in der Antwort die URL zum Herunterladen der Ergebnisse der Batchanforderung. Dieser status-URI sieht wie folgt aus:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0Hinweis: Denken Sie daran, dem status-URI AUTH-Informationen (Abonnementschlüssel/azure_auth – siehe Sicherheit) hinzuzufügen, bevor Sie ihn ausführen.
4. Der Client stellt eine GET Anforderung für die Download-URL aus, die in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Zum Senden der Routenbeschreibungsabfragen verwenden Sie eine POST Anforderung, bei der der Anforderungstext das batchItems Array im json Format enthält und der Content-Type Header auf application/jsonfestgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 3 Routenbeschreibungsabfragen :

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Eine Routenbeschreibungsabfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, api-Version und Abonnementschlüssel. Er kann alle unterstützten Routenbeschreibungs-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibungsabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. "zeichen sollte mit \ ) gekennzeichnet werden, und es sollte auch ordnungsgemäß URL-codiert sein.

Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 700 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten.

Herunterladen asynchroner Batchergebnisse

Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location Kopfzeile einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

  1. Der Client sendet eine GET Anforderung über die Download-URL.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

    HTTP 200 OK : Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

Batch-API für Routenbeschreibungen

Gilt für: Siehe Tarife.

Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen.

Übermitteln einer asynchronen Batchanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.

  • Es ermöglicht das Abrufen von Ergebnissen in einem separaten Aufruf (mehrere Downloads sind möglich).
  • Die asynchrone API ist auf Zuverlässigkeit optimiert und es wird nicht erwartet, dass ein Timeout auftritt.
  • Die Anzahl der Batchelemente ist für diese API auf 700 begrenzt.

Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

Beachten Sie, dass es sich bei der asynchronen Batchanforderung um eine Anforderung mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:

  1. Der Client sendet eine Batchanforderung POST für Routenanweisungen an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Batch-Anforderung. Dies kann entweder ein oder ein 400 Bad Request anderer Error status Code sein.

  3. Wenn die Batchanforderung erfolgreich angenommen wurde, enthält der Location Header in der Antwort die URL zum Herunterladen der Ergebnisse der Batchanforderung. Dieser status-URI sieht wie folgt aus:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0Hinweis: Denken Sie daran, dem status-URI AUTH-Informationen (Abonnementschlüssel/azure_auth – siehe Sicherheit) hinzuzufügen, bevor Sie ihn ausführen.
4. Der Client stellt eine GET Anforderung für die Download-URL aus, die in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Zum Senden der Routenbeschreibungsabfragen verwenden Sie eine POST Anforderung, bei der der Anforderungstext das batchItems Array im json Format enthält und der Content-Type Header auf application/jsonfestgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 3 Routenbeschreibungsabfragen :

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Eine Routenbeschreibungsabfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, api-Version und Abonnementschlüssel. Er kann alle unterstützten Routenbeschreibungs-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibungsabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. "zeichen sollte mit \ ) gekennzeichnet werden, und es sollte auch ordnungsgemäß URL-codiert sein.

Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 700 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten.

Herunterladen asynchroner Batchergebnisse

Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location Kopfzeile einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

  1. Der Client sendet eine GET Anforderung über die Download-URL.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

    HTTP 200 OK : Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Batch-API für Routenbeschreibungen

Gilt für: Siehe Tarife.

Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen.

Senden einer synchronen Batchanforderung

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Batch-API für Routenbeschreibungen

Gilt für: Siehe Tarife.

Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen.

Senden einer synchronen Batchanforderung

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Batch-API für Routenbeschreibungen

Gilt für: Siehe Tarife.

Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen.

Senden einer synchronen Batchanforderung

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • RouteDirections – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Gilt für: Siehe Tarife.

Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln synchroner Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf TRUE festgelegt ist, erhält der Benutzer eine Antwort von 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:

  1. Der Client sendet eine POST-Anforderung der Route Matrix an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Route Matrix-Anforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400 ungültige Anforderung oder ein anderer Fehler status Code sein.

  3. Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP 202 Accepted : Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Gilt für: Siehe Tarife.

Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die durch Ursprungs- und Zielstandorte definiert sind, indem eine asynchrone (asynchrone) oder synchrone POST-Anforderung verwendet wird. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu lösen, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderungen 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln einer synchronen Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie eine synchrone Anforderung durchführen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung erstellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf true festgelegt ist, erhält der Benutzer eine 200-Antwort, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Dies ist eine typische Abfolge von asynchronen Vorgängen:

  1. Der Client sendet eine POST-Anforderung der Routenmatrix an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Route Matrix-Anforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400 ungültige Anforderung oder ein anderer Fehler status Code sein.

  3. Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgegeben wird.

HTTP 202 Accepted : Matrixanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Gilt für: Siehe Tarife.

Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die durch Ursprungs- und Zielstandorte definiert sind, indem eine asynchrone (asynchrone) oder synchrone POST-Anforderung verwendet wird. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu lösen, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderungen 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln einer synchronen Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie eine synchrone Anforderung durchführen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung erstellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf true festgelegt ist, erhält der Benutzer eine 200-Antwort, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Dies ist eine typische Abfolge von asynchronen Vorgängen:

  1. Der Client sendet eine POST-Anforderung der Routenmatrix an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Route Matrix-Anforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400 ungültige Anforderung oder ein anderer Fehler status Code sein.

  3. Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Herunterladen von Asynchronen Ergebnissen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Adressheader der Antwort zu überprüfen. Dieser status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader angegebene URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgestellt wird.

DIE HTTP-Matrixanforderung 202 Accepted wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteRequestRouteMatrixSync408Response

Gilt für: Siehe Tarife.

Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln synchroner Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf TRUE festgelegt ist, erhält der Benutzer eine Antwort von 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:

  1. Der Client sendet eine POST-Anforderung der Route Matrix an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted – Route Matrix-Anforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400-Ungültige Anforderung oder ein anderer Fehler status Code sein.

  3. Wenn die MatrixRoute-Anforderung erfolgreich angenommen wurde, enthält der Header Location in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API stellen, gibt der Dienst 200 Antwortcode für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Asynchrone Ergebnisse herunterladen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Speicherortheader der Antwort zu überprüfen. Dieser status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader angegebene URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgestellt wird.

DIE HTTP-Matrixanforderung 202 Accepted wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Gilt für: Siehe Tarife.

Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen.

Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen.

Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele).

Übermitteln synchroner Routenmatrixanforderung

Wenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Übermitteln einer asynchronen Routenmatrixanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn waitForResults der Parameter in der Anforderung auf TRUE festgelegt ist, erhält der Benutzer eine Antwort von 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist.

Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:

  1. Der Client sendet eine POST-Anforderung der Route Matrix an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted – Route Matrix-Anforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Route Matrix-Anforderung. Dies kann entweder eine 400-Ungültige Anforderung oder ein anderer Fehler status Code sein.

  3. Wenn die MatrixRoute-Anforderung erfolgreich angenommen wurde, enthält der Header Location in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Der Client stellt eine GET-Anforderung für die in Schritt 3 abgerufene Download-URL aus, um die Ergebnisse herunterzuladen.

Herunterladen von Synchronisierungsergebnissen

Wenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API stellen, gibt der Dienst 200 Antwortcode für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen.

Asynchrone Ergebnisse herunterladen

Wenn eine Anforderung eine 202 Accepted Antwort ausgibt, wird die Anforderung mithilfe unserer asynchronen Pipeline verarbeitet. Sie erhalten eine URL, um den Fortschritt Ihrer asynchronen Anforderung im Speicherortheader der Antwort zu überprüfen. Dieser status-URI sieht wie folgt aus:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Die vom Standortheader angegebene URL gibt die folgenden Antworten zurück, wenn eine GET Anforderung ausgestellt wird.

DIE HTTP-Matrixanforderung 202 Accepted wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

HTTP 200 OK : Matrixanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Ergebnisse.

RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

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

RouteSectionTecCauseOutput

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

RouteSectionTecOutput

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

RouteSummaryOutput

Zusammenfassungsobjekt

Routes

Typaliase

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonObject

Ein gültiges GeoJSON-Objekt. Weitere Informationen finden Sie unter RFC 7946 .

MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Functions

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Erstellen Sie einen Batchanforderungstext aus einer Reihe von Routenrichtungsanforderungen.

default(AzureKeyCredential, ClientOptions)

Erstellt eine instance von MapsRouteClient aus einem Abonnementschlüssel.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Erstellt eine instance von MapsRoute aus einer Azure Identity TokenCredential.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Erstellt eine instance von MapsRoute aus einer Azure Identity AzureSASCredential.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, LroEngineOptions<TResult, PollOperationState<TResult>>)

Hilfsfunktion, die ein Poller-Objekt erstellt, um einen Vorgang mit langer Ausführung abzufragen.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transformieren Sie ein Array von [Latitude, Longtitute] in eine Zeichenfolge im folgenden Format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Details zur Funktion

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Erstellen Sie einen Batchanforderungstext aus einer Reihe von Routenrichtungsanforderungen.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parameter

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Ein Objekt der Abfrageparameter für eine Routenrichtungsanforderung

Gibt zurück

Die zusammengesetzte Batchanforderung.

default(AzureKeyCredential, ClientOptions)

Erstellt eine instance von MapsRouteClient aus einem Abonnementschlüssel.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Parameter

credential
AzureKeyCredential

Eine AzureKeyCredential-instance, die zum Authentifizieren von Anforderungen beim Dienst verwendet wird

options
ClientOptions

Optionen zum Konfigurieren des Route-Clients

Gibt zurück

default(TokenCredential, string, ClientOptions)

Erstellt eine instance von MapsRoute aus einer Azure Identity TokenCredential.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Parameter

credential
TokenCredential

Eine TokenCredential-instance, die zum Authentifizieren von Anforderungen beim Dienst verwendet wird

mapsAccountClientId

string

Die Azure Maps Client-ID einer bestimmten Kartenressource

options
ClientOptions

Optionen zum Konfigurieren des Route-Clients

Gibt zurück

default(AzureSASCredential, ClientOptions)

Erstellt eine instance von MapsRoute aus einer Azure Identity AzureSASCredential.

Beispiel

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Parameter

credential
AzureSASCredential

Eine AzureSASCredential-instance, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

options
ClientOptions

Optionen zum Konfigurieren des Route-Clients

Gibt zurück

getLongRunningPoller<TResult>(Client, TResult, LroEngineOptions<TResult, PollOperationState<TResult>>)

Hilfsfunktion, die ein Poller-Objekt erstellt, um einen Vorgang mit langer Ausführung abzufragen.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>

Parameter

client
Client

Client, der zum Senden der Anforderung zum Abrufen zusätzlicher Seiten verwendet werden soll.

initialResponse

TResult

Die anfängliche Antwort.

options

LroEngineOptions<TResult, PollOperationState<TResult>>

Optionen zum Festlegen eines Fortsetzungszustands oder eines benutzerdefinierten Abrufintervalls.

Gibt zurück

PollerLike<PollOperationState<TResult>, TResult>

  • Ein Pollerobjekt, um nach Vorgangsstatusaktualisierungen abzufragen und schließlich die endgültige Antwort zu erhalten.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parameter

Gibt zurück

response

toColonDelimitedLatLonString(LatLon[])

Transformieren Sie ein Array von [Latitude, Longtitute] in eine Zeichenfolge im folgenden Format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parameter

coordinates

LatLon[]

Ein Array von zu transformierenden Latitude/Longtitute-Paaren.

Gibt zurück

string

Die transformierte Zeichenfolge.