Route - Post Route Range Batch

De Batch-API voor routebereik verzendt batches van maximaal 100 query's als één aanroep naar de Route Range API-. Deze API maakt efficiënte verwerking van meerdere query's in één aanvraag mogelijk, waardoor de behoefte aan afzonderlijke aanroepen wordt verminderd.

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/range:batch?api-version=2025-01-01

POST-hoofdtekst voor Batch-aanvraag

Als u het routebereik 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 2 route_range query's:

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "optionalId": "300af787-589b-4088-accd-56828542e293",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "timeBudgetInSec": 2000
      }
    }
  ]
}

Een routebereik batchItem-object kan een van de ondersteunde uitlijnen op wegenaanvraagbody

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het 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 heeft een van de volgende typen:

• RouteRangeResponse: als de query is voltooid.

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

POST {endpoint}/route/range:batch?api-version=2025-01-01

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of servicehoofd kan toegang krijgen via een ingebouwde rol of een aangepaste rol bestaande uit één of meer permissies om REST-API's te Azure Maps.\n\nOm scenario's te implementeren raden we aan om authenticatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van applicatie(s) via objecten die toegang hebben tot specifieke API's en scopes.\n\n#### Notities\n* Deze beveiligingsdefinitie ree het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de applicatie toegang vraagt. Dit kan worden verkregen via de Maps management API.\n* \nDe Authorization URL is specifiek voor de Azure publieke cloud-instantie. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. \n* \nDe Azure rolgebaseerde toegangscontrole wordt geconfigureerd vanaf het Azure beheerplane via Azure portaal, PowerShell, CLI, Azure-SDK's of REST API's.\n* \nGebruik van de Azure Maps Web SDK maakt configuratie-gebaseerde opstelling van een applicatie voor meerdere gebruikssituaties mogelijk.\n* Voor meer informatie over Microsoft identity platform, zie Microsoft identity platform overzicht.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

subscription-key

Dit is een gedeelde sleutel die wordt ingesteld wanneer je > aanmaakt in het Azure portaal of met PowerShell, CLI, Azure-SDK's of REST API.\n\n Met deze sleutel kan elke applicatie toegang krijgen tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in de rekening waarin ze worden uitgegeven.\n\n Voor publiek blootgestelde applicaties is onze aanbeveling om de confidential client applications benadering te gebruiken om toegang te krijgen tot Azure Maps REST-API's, zodat je sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature token dat wordt aangemaakt vanuit de List SAS-operatie op de Azure Maps resource via het Azure beheervlak via Azure portaal, PowerShell, CLI, Azure-SDK's of REST API's.\n\n Met dit token is elke applicatie gemachtigd om toegang te krijgen met Azure rolgebaseerde toegangscontroles en fijnmazige controle over de vervaldatum, snelheid en regio(s) van gebruik voor de betreffende token. Met andere woorden, de SAS Token kan worden gebruikt om applicaties toegang op een veiligere manier te laten beheren dan de gedeelde sleutel.\n\n Voor publiek blootgestelde applicaties is onze aanbeveling om een specifieke lijst van toegestane oorsprongen in de Map-accountresource te configureren om rendermisbruik te beperken en de SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

A Route Range Batch request containing 1 query

POST {endpoint}/route/range:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          52.7109930507,
          -0.591556667114
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    }
  ]
}

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              5.86605,
              50.9745
            ]
          },
          "properties": {
            "type": "center"
          }
        },
        {
          "type": "Feature",
          "bbox": [
            3.62838,
            49.83259,
            7.9826,
            52.25674
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  5.73602,
                  52.03704
                ],
                [
                  5.59435,
                  52.09456
                ],
                [
                  5.42279,
                  52.16815
                ],
                [
                  5.21276,
                  52.25047
                ],
                [
                  5.15355,
                  52.21374
                ],
                [
                  4.96687,
                  52.25674
                ],
                [
                  4.739,
                  52.07834
                ],
                [
                  4.72513,
                  52.05647
                ],
                [
                  4.53237,
                  51.94553
                ],
                [
                  4.31165,
                  51.70119
                ],
                [
                  4.28917,
                  51.5837
                ],
                [
                  3.82685,
                  51.48463
                ],
                [
                  3.62838,
                  51.21096
                ],
                [
                  3.89244,
                  50.6814
                ],
                [
                  3.93493,
                  50.66791
                ],
                [
                  3.98156,
                  50.49042
                ],
                [
                  4.47995,
                  50.30944
                ],
                [
                  4.60502,
                  50.24448
                ],
                [
                  4.89999,
                  50.24467
                ],
                [
                  5.04206,
                  50.08735
                ],
                [
                  5.23042,
                  49.99214
                ],
                [
                  5.40994,
                  49.88478
                ],
                [
                  5.46178,
                  49.85797
                ],
                [
                  5.7196,
                  49.86279
                ],
                [
                  5.74151,
                  49.83259
                ],
                [
                  5.9387,
                  50.22239
                ],
                [
                  6.08535,
                  50.0011
                ],
                [
                  6.12089,
                  50.04616
                ],
                [
                  6.28373,
                  50.09472
                ],
                [
                  6.51654,
                  49.95863
                ],
                [
                  6.61034,
                  50.00485
                ],
                [
                  6.70295,
                  50.00587
                ],
                [
                  6.65865,
                  50.2947
                ],
                [
                  6.79276,
                  50.36903
                ],
                [
                  7.32163,
                  50.31614
                ],
                [
                  7.58782,
                  50.36737
                ],
                [
                  7.7626,
                  50.46919
                ],
                [
                  7.9826,
                  50.96246
                ],
                [
                  7.55924,
                  51.07086
                ],
                [
                  7.58138,
                  51.36614
                ],
                [
                  7.67861,
                  51.52015
                ],
                [
                  7.35175,
                  51.65781
                ],
                [
                  7.21664,
                  51.81916
                ],
                [
                  7.0467,
                  51.9587
                ],
                [
                  6.67267,
                  51.82713
                ],
                [
                  6.48424,
                  51.81133
                ],
                [
                  6.27316,
                  51.9368
                ],
                [
                  6.14452,
                  52.01701
                ],
                [
                  6.09312,
                  52.20847
                ],
                [
                  6.01297,
                  52.23705
                ],
                [
                  5.86605,
                  50.9745
                ],
                [
                  5.73602,
                  52.03704
                ]
              ]
            ]
          },
          "properties": {
            "type": "boundary"
          }
        }
      ]
    },
    {
      "error": {
        "code": "BadRequest",
        "message": "No routable road could be found near one or more specified points."
      }
    }
  ],
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  }
}

Definities

AdrTunnelRestrictionCodeEnum

De ADR-tunnelbeperkingscode. ADR is een Europese overeenkomst met betrekking tot het internationale vervoer van gevaarlijke goederen via de weg. De ADR-tunnelbeperkingscode wordt gebruikt om te bepalen of een voertuig een tunnel mag passeren met beperkingen voor het vervoer van gevaarlijke goederen.

CommonErrorDetail

De foutdetails.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

FeaturesItemTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is Functie. Zie RFC 7946voor meer informatie.

FeatureTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is FeatureCollection. Zie RFC 7946voor meer informatie.

GeoJsonObjectType

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

InputRouteRangeProperties

Hiermee geeft u de parameters te gebruiken voor de berekening van isochrone veelhoek.

MapsErrorDetail

De foutdetails.

MapsErrorResponse

Veelvoorkomende foutrespons voor Azure Maps API's om foutdetails terug te geven bij mislukte operaties.

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

RouteRangeAvoidEnum

Hiermee geeft u beperkingen op die de routeberekening moet respecteren bij het bepalen van de bereikbaar locaties. Vermijd ondersteunt meerdere waarden in een aanvraag. \n\nVoorbeeld: "vermijd": ["limitedAccessHighways", "tollRoads"]

RouteRangeBatchRequestBody

De lijst met routebereikquery's/aanvragen die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.

RouteRangeBatchRequestItem

BatchQuery-object

RouteRangeBatchResponse

Dit object wordt geretourneerd door een geslaagde Service-aanroep van Route Range Batch.

RouteRangeBatchResponseItem

foutdetails

RouteRangeBatchResponseSummary

Samenvatting voor de batchaanvraag

RouteRangeFeatureProperties

Eigenschappen van routebereiken.

RouteRangeFeaturesItem

GeoJSON-functieobject dat geometrieobject en aanvullende eigenschappen van de route bevat.

RouteRangeOptimizeRouteEnum

Hiermee geeft u de parameter die moet worden gebruikt om de route te optimaliseren. Als dit niet is gedefinieerd, is de standaardwaarde 'snelsteWithoutTraffic' die de route retourneert om de reistijd te minimaliseren zonder gebruik te maken van actuele verkeersinformatie.

Voorbeeld: 'optimizeRoute':'shortest'

RouteRangePointGeometry

Hiermee geeft u het GeoJSON puntgeometrieobject. Raadpleeg RFC 7946- voor meer informatie.

RouteRangePolygonGeometry

Hiermee geeft u de GeoJSON Polygon Geometrie object. Raadpleeg RFC 7946- voor meer informatie.

RouteRangeTravelModeEnum

Hiermee geeft u het reisprofiel om rekening mee te houden bij het berekenen van de veelhoek van het bereik. Als dit niet is opgegeven, is de standaardwaarde 'rijden'.

Voorbeeld: "travelMode":"driving"

RouteRangeTypeEnum

De functietypen voor de functieobjecten die in het antwoord worden geretourneerd.

RouteRangeVehicleSpec

Hiermee geeft u de voertuigkenmerken op, zoals voertuighoogte, gewicht, maximale snelheid, type lading, enz. om rekening mee te houden bij het berekenen van de bereikbaar locaties. Dit helpt bij het vermijden van lage brugmachtigingen, wegbeperkingen, moeilijke bochten om de geoptimaliseerde vrachtwagenroute te bieden op basis van de voertuigspecificaties. Voertuigkenmerken worden opgegeven in de eigenschap vehicleSpec.

VehicleLoadTypeEnum

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen.