Delen via

@azure-rest/maps-route package

  • Referentie

Interfaces

BatchRequest

Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
BatchRequestItem

Batch-aanvraagobject
BatchResultItemOutput

Een item dat is geretourneerd vanuit batch-API. Uitbreiden met de eigenschap 'response'.
BatchResultOutput

Dit object wordt geretourneerd vanuit een geslaagde Batch-service-aanroep. Uitbreiden met de eigenschap batchItems.
BatchResultSummaryOutput

Samenvatting van de resultaten voor de batchaanvraag
EffectiveSettingOutput

Effectieve parameter of gegevens die worden gebruikt bij het aanroepen van deze Route-API.
ErrorDetailOutput

De foutdetails.
ErrorResponseOutput

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonLineStringData
GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPointData

Gegevens die zijn opgenomen in een GeoJson MultiPoint.
GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPointData

Gegevens die zijn opgenomen in een GeoJson Point.
GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
MapsRouteClientOptions

De optionele parameters voor de client
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Parameters voor de hoofdtekst voor routebeschrijvingen plaatsen.
RouteDirectionsBatchItemOutput

Een item dat wordt geretourneerd vanuit de Serviceaanroep routebeschrijving Batch.
RouteDirectionsBatchItemResponseOutput

Het resultaat van de query. RouteDirections als de query is voltooid, anders ErrorResponse.
RouteDirectionsBatchResultOutput

Dit object wordt geretourneerd door een geslaagde Batch-serviceoproep routebeschrijving.
RouteDirectionsOutput

Dit object wordt geretourneerd door een geslaagde aanroep Routebeschrijving
RouteGetRouteDirections200Response

De Get Route Directions-API is een HTTP-GET-aanvraag die een route retourneert tussen een oorsprong en een bestemming, waarbij waypoints worden doorgegeven, indien opgegeven. De route houdt rekening met factoren zoals huidig verkeer en de typische verkeerssnelheden op de aangevraagde dag van de week en het tijdstip van de dag.

De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Aanvullende routeringsinformatie, zoals geoptimaliseerde waypointvolgorde of turn by turn-instructies, is ook beschikbaar, afhankelijk van de geselecteerde opties.

Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van een voertuigspecifiek verbruiksmodel. Zie Consumption Modelvoor meer informatie.
RouteGetRouteDirectionsBatch200Response

De Get Route Directions Batch-API is een HTTP-GET-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen-API met één aanvraag. U kunt Get Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, geeft u een GET aanvraag uit naar het eindpunt voor batchdownload. Deze download-URL kan worden verkregen uit de Location header van een geslaagde POST batchaanvraag en ziet er als volgt uit:

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

Hier volgt de gebruikelijke reeks bewerkingen voor het downloaden van de batchresultaten:

  1. De client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

    HTTP-200 OK - Batch-aanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Get Route Directions Batch-API is een HTTP-GET-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen-API met één aanvraag. U kunt Get Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, geeft u een GET aanvraag uit naar het eindpunt voor batchdownload. Deze download-URL kan worden verkregen uit de Location header van een geslaagde POST batchaanvraag en ziet er als volgt uit:

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

Hier volgt de gebruikelijke reeks bewerkingen voor het downloaden van de batchresultaten:

  1. De client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

    HTTP-200 OK - Batch-aanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Get Route Directions-API is een HTTP-GET-aanvraag die een route retourneert tussen een oorsprong en een bestemming, waarbij waypoints worden doorgegeven, indien opgegeven. De route houdt rekening met factoren zoals huidig verkeer en de typische verkeerssnelheden op de aangevraagde dag van de week en het tijdstip van de dag.

De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Aanvullende routeringsinformatie, zoals geoptimaliseerde waypointvolgorde of turn by turn-instructies, is ook beschikbaar, afhankelijk van de geselecteerde opties.

Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van een voertuigspecifiek verbruiksmodel. Zie Consumption Modelvoor meer informatie.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

De Post Route Directions-API is een HTTP-POST-aanvraag die een route retourneert tussen een oorsprong en een bestemming, waarbij via waypoints wordt doorgegeven als deze zijn opgegeven. De route houdt rekening met factoren zoals huidig verkeer en de typische verkeerssnelheden op de aangevraagde dag van de week en het tijdstip van de dag.

De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Aanvullende routeringsinformatie, zoals geoptimaliseerde waypointvolgorde of turn by turn-instructies, is ook beschikbaar, afhankelijk van de geselecteerde opties.

Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van een voertuigspecifiek verbruiksmodel. Raadpleeg Verbruiksmodel voor gedetailleerde uitleg van de concepten en parameters die hierbij betrokken zijn.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

De Post Route Directions-API is een HTTP-POST-aanvraag die een route retourneert tussen een oorsprong en een bestemming, waarbij via waypoints wordt doorgegeven als deze zijn opgegeven. De route houdt rekening met factoren zoals huidig verkeer en de typische verkeerssnelheden op de aangevraagde dag van de week en het tijdstip van de dag.

De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Aanvullende routeringsinformatie, zoals geoptimaliseerde waypointvolgorde of turn by turn-instructies, is ook beschikbaar, afhankelijk van de geselecteerde opties.

Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van een voertuigspecifiek verbruiksmodel. Raadpleeg Verbruiksmodel voor gedetailleerde uitleg van de concepten en parameters die hierbij betrokken zijn.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

De Get Route Matrix-API is een HTTP-GET-aanvraag waarmee de reistijd en afstand voor alle mogelijke paren in een lijst met oorsprongen en bestemmingen worden berekend. In tegenstelling tot de Routebeschrijving ophalen API, die gedetailleerde route-instructies biedt, richt deze API zich op efficiëntie door u de kosten (reistijd en afstand) van routering van elke oorsprong naar elke bestemming te geven. Zie Aanbevolen procedures voor de Azure Maps Route-servicevoor meer informatie.

Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix GET-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een GET-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

De Get Route Matrix-API is een HTTP-GET-aanvraag waarmee de reistijd en afstand voor alle mogelijke paren in een lijst met oorsprongen en bestemmingen worden berekend. In tegenstelling tot de Routebeschrijving ophalen API, die gedetailleerde route-instructies biedt, richt deze API zich op efficiëntie door u de kosten (reistijd en afstand) van routering van elke oorsprong naar elke bestemming te geven. Zie Aanbevolen procedures voor de Azure Maps Route-servicevoor meer informatie.

Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix GET-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een GET-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteGetRouteRange200Response

De Get Route Range -API (Isochrone) is een HTTP-GET-aanvraag waarmee een set locaties wordt berekend die vanaf het oorspronkelijke punt kunnen worden bereikt op basis van brandstof, energie, tijd- of afstandsbudget dat is opgegeven. Een veelhoekgrens (of Isochrone) wordt geretourneerd in een richting linksom, evenals het precieze polygooncentrum dat het resultaat was van het oorsprongspunt.

De geretourneerde veelhoek kan worden gebruikt voor verdere verwerking, zoals Search Inside Geometry om te zoeken naar POIs binnen de opgegeven isochrone.
RouteGetRouteRangeDefaultResponse

De Get Route Range -API (Isochrone) is een HTTP-GET-aanvraag waarmee een set locaties wordt berekend die vanaf het oorspronkelijke punt kunnen worden bereikt op basis van brandstof, energie, tijd- of afstandsbudget dat is opgegeven. Een veelhoekgrens (of Isochrone) wordt geretourneerd in een richting linksom, evenals het precieze polygooncentrum dat het resultaat was van het oorsprongspunt.

De geretourneerde veelhoek kan worden gebruikt voor verdere verwerking, zoals Search Inside Geometry om te zoeken naar POIs binnen de opgegeven isochrone.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
RouteInstructionGroupOutput

Hiermee wordt een reeks instructie-elementen gegroepeerd die aan elkaar zijn gerelateerd. Het reeksbereik is beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare tekstberichten worden aangevraagd voor richtlijnen (instructionType=text of gelabeld), heeft de instructionGroup een samenvattingsbericht geretourneerd wanneer deze beschikbaar is.
RouteInstructionOutput

Een reeks kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts rechts', 'Links blijven', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.
RouteLegOutput

Een beschrijving van een deel van een route, bestaande uit een lijst met punten. Elk extra waypoint dat in de aanvraag wordt opgegeven, resulteert in een extra been in de geretourneerde route.
RouteMatrixOutput

Matrixresultaatobject
RouteMatrixQuery

Een object met een matrix met coördinaten.
RouteMatrixResultOutput

Dit object wordt geretourneerd door een geslaagde routematrix-aanroep. Als er bijvoorbeeld 2 oorsprongen en 3 bestemmingen worden opgegeven, worden er 2 matrices met 3 elementen in elk opgegeven. De inhoud van elk element is afhankelijk van de opties in de query.
RouteMatrixResultResponseOutput

Antwoordobject van de huidige cel in de invoermatrix.
RouteMatrixSummaryOutput

Samenvattingsobject
RouteOptimizedWaypointOutput

Geoptimaliseerd way point-object.
RouteOutput
RouteRangeOutput

Bereik bereikbaar
RouteRangeResultOutput

Dit object wordt geretourneerd vanuit een geslaagde routebereik-aanroep
RouteReportOutput

Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
RouteRequestRouteDirectionsBatch200Response

De Post Route Directions Batch-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen-API met behulp van één asynchrone aanvraag. U kunt Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. Zie Post Route Directions Batchom de API aan te roepen in een synchrone aanvraag.

Asynchrone batchaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeaanvragen

  • Hiermee kunt u resultaten ophalen in een afzonderlijke aanroep (er zijn meerdere downloads mogelijk).
  • De asynchrone API is geoptimaliseerd voor betrouwbaarheid en zal naar verwachting geen time-out hebben.
  • Het aantal batchitems is beperkt tot 700 voor deze API.

Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat een asynchrone batchaanvraag een langdurige bewerking is. Hier volgt een typische reeks bewerkingen:

  1. De client verzendt een Route directions Batch POST aanvraag naar Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Batch-aanvraag. Dit kan een 400 Bad Request of een andere Error statuscode zijn.

  2. Als de batchaanvraag is geaccepteerd, bevat de Location header in het antwoord de URL om de resultaten van de batchaanvraag te downloaden. Deze status-URI ziet er als volgt uit:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client geeft een GET aanvraag uit op de download-URL verkregen in stap 3 om de batchresultaten te downloaden.

POST-hoofdtekst voor Batch-aanvraag

Als u de routebeschrijvingen query's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type-header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met drie routebeschrijvingen query's:

{
    "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" }
    ]
}

Een routebeschrijving query in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel te. Het kan een van de ondersteunde routebeschrijvingenURI-parametersaccepteren. De tekenreekswaarden in de routebeschrijvingen query correct moeten worden escaped (bijvoorbeeld " teken moet worden escaped met \ ) en moet ook correct url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. De batch moet ten minste 1 query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, geeft u een GET aanvraag uit naar het eindpunt voor batchdownload. Deze download-URL kan worden verkregen uit de Location header van een geslaagde POST batchaanvraag en ziet er als volgt uit:

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

Hier volgt de gebruikelijke reeks bewerkingen voor het downloaden van de batchresultaten:

  1. De client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

    HTTP-200 OK - Batch-aanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Post Route Directions Batch-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen-API met behulp van één asynchrone aanvraag. U kunt Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. Zie Post Route Directions Batchom de API aan te roepen in een synchrone aanvraag.

Asynchrone batchaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeaanvragen

  • Hiermee kunt u resultaten ophalen in een afzonderlijke aanroep (er zijn meerdere downloads mogelijk).
  • De asynchrone API is geoptimaliseerd voor betrouwbaarheid en zal naar verwachting geen time-out hebben.
  • Het aantal batchitems is beperkt tot 700 voor deze API.

Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat een asynchrone batchaanvraag een langdurige bewerking is. Hier volgt een typische reeks bewerkingen:

  1. De client verzendt een Route directions Batch POST aanvraag naar Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Batch-aanvraag. Dit kan een 400 Bad Request of een andere Error statuscode zijn.

  2. Als de batchaanvraag is geaccepteerd, bevat de Location header in het antwoord de URL om de resultaten van de batchaanvraag te downloaden. Deze status-URI ziet er als volgt uit:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client geeft een GET aanvraag uit op de download-URL verkregen in stap 3 om de batchresultaten te downloaden.

POST-hoofdtekst voor Batch-aanvraag

Als u de routebeschrijvingen query's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type-header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met drie routebeschrijvingen query's:

{
    "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" }
    ]
}

Een routebeschrijving query in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel te. Het kan een van de ondersteunde routebeschrijvingenURI-parametersaccepteren. De tekenreekswaarden in de routebeschrijvingen query correct moeten worden escaped (bijvoorbeeld " teken moet worden escaped met \ ) en moet ook correct url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. De batch moet ten minste 1 query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, geeft u een GET aanvraag uit naar het eindpunt voor batchdownload. Deze download-URL kan worden verkregen uit de Location header van een geslaagde POST batchaanvraag en ziet er als volgt uit:

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

Hier volgt de gebruikelijke reeks bewerkingen voor het downloaden van de batchresultaten:

  1. De client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

    HTTP-200 OK - Batch-aanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Post Route Directions Batch Sync-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen API met behulp van één synchrone aanvraag. U kunt Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. Zie Post Route Directions Batchom de API aan te roepen in een asynchrone aanvraag.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

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

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Post Route Directions Batch Sync-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen API met behulp van één synchrone aanvraag. U kunt Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. Zie Post Route Directions Batchom de API aan te roepen in een asynchrone aanvraag.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

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

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Post Route Directions Batch Sync-API is een HTTP-POST-aanvraag waarmee batches query's worden verzonden naar de Routebeschrijving ophalen API met behulp van één synchrone aanvraag. U kunt Route Directions Batch API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batcheren en API synchroniseren tot 100 query's. Zie Post Route Directions Batchom de API aan te roepen in een asynchrone aanvraag.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

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

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Bij het downloaden van de resultaten van een asynchrone batchaanvraag, als de batch is verwerkt, bevat de hoofdtekst van het antwoord het batchantwoord. Dit batchantwoord bevat een summary-onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests, d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item in batchItems bevat statusCode- en response velden. Elke response in batchItems is van een van de volgende typen:

  • RouteDirections: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.

Hier volgt een voorbeeld van een Batch-antwoord met 1 geslaagde en 1 is mislukt resultaat:

{
    "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

De Post Route Matrix-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van een asynchrone (asynchrone) aanvraag. Zie Post Route Matrix Syncals u een synchrone (synchronisatie)-aanvraag wilt maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Opmerking

Alle oorsprongen en bestemmingen moeten zijn opgenomen in een begrenzingsvak van 400 km x 400 km. Anders worden sommige matrixcellen omgezet als OUT_OF_REGION.

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

De Post Route Matrix-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van een asynchrone (asynchrone) aanvraag. Zie Post Route Matrix Syncals u een synchrone (synchronisatie)-aanvraag wilt maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Opmerking

Alle oorsprongen en bestemmingen moeten zijn opgenomen in een begrenzingsvak van 400 km x 400 km. Anders worden sommige matrixcellen omgezet als OUT_OF_REGION.

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

De Post Route Matrix Sync-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van één synchrone aanvraag (synchronisatie). Zie Post Route Matrixom een asynchrone (asynchrone) aanvraag te maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteRequestRouteMatrixSync408Response

De Post Route Matrix Sync-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van één synchrone aanvraag (synchronisatie). Zie Post Route Matrixom een asynchrone (asynchrone) aanvraag te maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

De Post Route Matrix Sync-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van één synchrone aanvraag (synchronisatie). Zie Post Route Matrixom een asynchrone (asynchrone) aanvraag te maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

  1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

  2. De server reageert op een van de volgende manieren:

    HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

    HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

  3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Routesecties bevatten aanvullende informatie over onderdelen van een route. Elke sectie bevat ten minste de elementen startPointIndex, endPointIndexen sectionType.
RouteSectionTecCauseOutput

De oorzaak van de verkeers gebeurtenis. Kan mainCauseCode- en subCauseCode-elementen bevatten. Kan worden gebruikt om iconografie en beschrijvingen te definiëren.
RouteSectionTecOutput

Details van de verkeersgebeurtenis met behulp van definities in de TPEG2-TEC standaard. Kan effectCode bevatten en elementen veroorzaken.
RouteSummaryOutput

Samenvattingsobject
Routes
SimplePollerLike

Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen.

Type-aliassen

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonObject

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Functies

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Maak een hoofdtekst van een batchaanvraag van een aantal routerichtingsaanvragen.
default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsRouteClient op basis van een abonnementssleutel.

voorbeeld van

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)

Hiermee maakt u een exemplaar van MapsRoute op basis van een Azure Identity TokenCredential.

voorbeeld van

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)

Hiermee maakt u een exemplaar van MapsRoute op basis van een Azure Identity AzureSASCredential.

voorbeeld van

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, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

De Helper-functie waarmee een Poller-object wordt gebouwd om te helpen bij het peilen van een langdurige bewerking.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transformeer een matrix van [Latitude, Longtitute] naar een tekenreeks in de volgende indeling: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Functiedetails

buildMultiCollection(string[], string) 

function buildMultiCollection(items: string[], parameterName: string): string

Parameters

items

string[]

parameterName

string

Retouren

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Maak een hoofdtekst van een batchaanvraag van een aantal routerichtingsaanvragen.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parameters

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Een object van de queryparameters voor een routerichtingsaanvraag

Retouren

BatchRequest

De samengestelde batchaanvraag.

default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsRouteClient op basis van een abonnementssleutel.

voorbeeld van

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

Parameters

credential
AzureKeyCredential

Een AzureKeyCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

options
ClientOptions

Opties die worden gebruikt om de routeclient te configureren

Retouren

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Hiermee maakt u een exemplaar van MapsRoute op basis van een Azure Identity TokenCredential.

voorbeeld van

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

Parameters

credential
TokenCredential

Een TokenCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

mapsAccountClientId

string

De Azure Maps-client-id van een specifieke toewijzingsresource

options
ClientOptions

Opties die worden gebruikt om de routeclient te configureren

Retouren

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsRoute op basis van een Azure Identity AzureSASCredential.

voorbeeld van

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

Parameters

credential
AzureSASCredential

Een AzureSASCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

options
ClientOptions

Opties die worden gebruikt om de routeclient te configureren

Retouren

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

De Helper-functie waarmee een Poller-object wordt gebouwd om te helpen bij het peilen van een langdurige bewerking.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client

Client die moet worden gebruikt voor het verzenden van de aanvraag om extra pagina's op te halen.

initialResponse

TResult

Het eerste antwoord.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opties voor het instellen van een cv-status of aangepast polling-interval.

Retouren

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Een poller-object om te peilen naar updates van bewerkingsstatussen en uiteindelijk het uiteindelijke antwoord op te halen.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

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

Parameters

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Retouren

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parameters

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Retouren

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parameters

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Retouren

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parameters

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Retouren

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

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

Parameters

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Retouren

response

toColonDelimitedLatLonString(LatLon[])

Transformeer een matrix van [Latitude, Longtitute] naar een tekenreeks in de volgende indeling: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parameters

coordinates

LatLon[]

Een matrix van breedtegraad/longtitutepaar dat moet worden getransformeerd.

Retouren

string

De getransformeerde tekenreeks.