Delen via


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 https://atlas.microsoft.com/route/range:batch?api-version=2025-01-01

URI-parameters

Name In Vereist Type Description
api-version
query True

string

Versienummer van Azure Maps-API.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-id

string

Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Aanvraagbody

Name Type Description
batchItems

RouteRangeBatchRequestItem[]

De lijst met query's die moeten worden verwerkt.

Antwoorden

Name Type Description
200 OK

RouteRangeBatchResponse

Batchaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle batchresultaten.

Other Status Codes

MapsErrorResponse

Er is een onverwachte fout opgetreden.

Kopteksten

x-ms-error-code: string

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Notitie

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
  • De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
  • Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
  • Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

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

Bereiken

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen wordt aangeraden server-naar-servertoegang te gebruiken van Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

A Route Range Batch request containing 1 query

Voorbeeldaanvraag

POST https://atlas.microsoft.com/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
      }
    }
  ]
}

Voorbeeldrespons

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "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."
      }
    }
  ]
}

Definities

Name Description
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.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

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.

InputRouteRangeProperties

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

MapsErrorDetail

De foutdetails.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps-API's voor het retourneren van foutdetails voor mislukte bewerkingen.

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.

Voorbeeld: "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

Batch-antwoorditem

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.

Summary

Samenvatting voor de batchaanvraag

VehicleLoadTypeEnum

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen. vehicleLoadType ondersteunt meerdere waarden in een aanvraag.

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.

Waarde Description
B

Voertuigen met code B zijn beperkt van wegen met ADR-tunnelcategorieën B, C, D en E.

C

Voertuigen met code C zijn beperkt van wegen met ADR-tunnelcategorieën C, D en E

D

Voertuigen met code D zijn beperkt van wegen met ADR-tunnelcategorieën D en E.

E

Voertuigen met code E zijn beperkt van wegen met ADR-tunnelcategorie E.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

FeaturesItemTypeEnum

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

Waarde Description
Feature

Hiermee geeft u het objecttype GeoJSON Functie.

FeatureTypeEnum

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

Waarde Description
FeatureCollection

Hiermee geeft u het GeoJSONFeatureCollection objecttype.

InputRouteRangeProperties

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

Name Type Default value Description
avoid

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.

Voorbeeld: "vermijd": ["limitedAccessHighways", "tollRoads"]

departAt

string (date-time)

De datum en tijd van vertrek van het oorspronkelijke punt dat is opgemaakt als een datum/tijd-waarde die is gedefinieerd door RFC 3339, sectie 5,6. Wanneer er geen tijdzone-offset is opgegeven, wordt UTC aangenomen.

Als de departAt niet is ingesteld, is de standaardwaarde de huidige tijd.

Voorbeeld:

"departAt": "2023-06-01T09:30:00.000-07:00"

distanceBudgetInMeters

number (float)

minimum: 0
maximum: 500000

Het afstandsbudget geeft het maximumbereik aan in meters die vanuit het oorspronkelijke waypoint kunnen worden afgelegd. Deze kan niet worden ingesteld wanneer timeBudgetInSec is opgegeven.

De maximale ondersteunde afstand is 500.000 meter.

Voorbeeld: "distanceBudgetInMeters":5000

isSimplifiedPolygon

boolean

True

Gebruik deze optie om op te geven of vereenvoudigde veelhoeken vereist zijn, waardoor het aantal hoekpunten wordt verminderd terwijl de algehele vorm behouden blijft.

isSimplifiedPolygon Momenteel biedt alleen ondersteuning voor true. Ondersteuning voor high-definition veelhoeken is binnenkort beschikbaar. Zie Post Route Range in de openbare preview van de routeservice voor meer informatie en om veelhoeken met hoge definities te proberen.

optimizeRoute

RouteRangeOptimizeRouteEnum

fastestWithoutTraffic

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'

timeBudgetInSec

number (float)

minimum: 0
maximum: 21600

Het tijdbudget geeft de maximale tijd in seconden op die beschikbaar is voor reizen, waarbij wordt gedefinieerd hoe ver u binnen deze tijdsbeperking kunt gaan vanaf het oorspronkelijke waypoint. Deze kan niet worden ingesteld wanneer distanceBudgetInMeters is opgegeven.

De maximale tijd die wordt ondersteund, is 21.600 seconden.

Voorbeeld: "timeBudgetInSec":3600

travelMode

RouteRangeTravelModeEnum

driving

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"

vehicleSpec

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.

MapsErrorDetail

De foutdetails.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

MapsErrorDetail[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

innererror

MapsInnerError

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

message

string

Een leesbare weergave van de fout.

target

string

Het doel van de fout.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps-API's voor het retourneren van foutdetails voor mislukte bewerkingen.

Name Type Description
error

MapsErrorDetail

De foutdetails.

MapsInnerError

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

Name Type Description
code

string

De foutcode.

innererror

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.

Voorbeeld: "vermijd": ["limitedAccessHighways", "tollRoads"]

Waarde Description
borderCrossings

Vermijd het overschrijden van landgrenzen in de route.

carTrains

Vermijdt autotreinen.

carpools

Vermijdt routes waarvoor gebruik van carpool nodig is.

ferries

Vermijd het gebruik van veerboten in de route.

limitedAccessHighways

Vermijdt het gebruik van snelwegen met beperkte toegang in de route.

lowEmissionZones

Vermijdt zones met een lage emissie in de route.

tollRoads

Vermijdt het gebruik van tolwegen in de route.

tunnels

Vermijdt het gebruik van tunnels in de route.

unpavedRoads

Vermijdt onverharde wegen in de route.

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.

Name Type Description
batchItems

RouteRangeBatchRequestItem[]

De lijst met query's die moeten worden verwerkt.

RouteRangeBatchRequestItem

BatchQuery-object

Name Type Description
geometry

RouteRangePointGeometry

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

optionalId

string

Id van de aanvraag die in de bijbehorende batchItem wordt weergegeven.

properties

InputRouteRangeProperties

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

type

FeaturesItemTypeEnum

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

RouteRangeBatchResponse

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

Name Type Description
batchItems

RouteRangeBatchResponseItem[]

Matrix met de batchresultaten.

summary

Summary

Samenvatting voor de batchaanvraag

RouteRangeBatchResponseItem

Batch-antwoorditem

Name Type Description
error

ErrorDetail

De foutdetails.

features

RouteRangeFeaturesItem[]

GeoJSON functieobject dat geometrieobject en aanvullende eigenschappen bevat. Raadpleeg RFC 7946, sectie 3.2 voor meer informatie.

optionalId

string

Id van de aanvraag die in de bijbehorende batchItem wordt weergegeven.

type

FeatureTypeEnum

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

RouteRangeFeatureProperties

Eigenschappen van routebereiken.

Name Type Description
type

RouteRangeTypeEnum

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

RouteRangeFeaturesItem

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

Name Type Description
bbox

number[] (double)

Een rechthoekig gebied op de aarde gedefinieerd als een begrenzingsvakobject. De zijden van de rechthoeken worden gedefinieerd door de waarden voor breedtegraad en lengtegraad. Zie RFC 7946, Sectie 5voor meer informatie.

Voorbeeld: 'bbox': [-10.0, -10.0, 10.0, 10.0]

geometry RouteRangeGeometry:

Een geldig GeoJSON Geometrieobject. Raadpleeg RFC 7946- voor meer informatie.

properties

RouteRangeFeatureProperties

Eigenschappen van routebereiken.

type

FeaturesItemTypeEnum

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

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'

Waarde Description
fastestWithTraffic

De route wordt berekend om de tijd te minimaliseren met behulp van actuele verkeersinformatie. Note: Alleen ondersteund voor rijden en truck travelMode.

fastestWithoutTraffic

Zoekt de snelste route, zonder rekening te houden met verkeersinformatie.

shortest

De route wordt berekend om de afstand te minimaliseren. Verkeersinformatie wordt niet gebruikt.

RouteRangePointGeometry

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

Name Type Description
coordinates

number[] (double)

Een Position is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/Hoogte- is een optioneel derde element. Raadpleeg RFC 7946- voor meer informatie.

type string:

Point

Hiermee geeft u het geometrietype voor het object GeoJSON Geometrie. Raadpleeg RFC 7946- voor meer informatie.

RouteRangePolygonGeometry

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

Name Type Description
coordinates

number[] (double)

Coördinaten voor het type GeoJson Polygon geometrie.

type string:

Polygon

Hiermee geeft u het geometrietype voor het object GeoJSON Geometrie. 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"

Waarde Description
driving

Het routeringsprofiel dat geschikt is voor auto's, wordt gebruikt voor bereik veelhoekberekening.

truck

Het routeringsprofiel dat geschikt is voor bedrijfsvoertuigen zoals vrachtwagens, wordt gebruikt voor bereik veelhoekberekening.

RouteRangeTypeEnum

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

Waarde Description
boundary

Het type grensfunctie vertegenwoordigt de veelhoek van het bereik.

center

Het functietype middelpunt vertegenwoordigt het punt dat wordt gebruikt voor de bereikmagonberekening.

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.

Name Type Default value Description
adrTunnelRestrictionCode

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.

axleCount

integer (int64)

Het aantal assen op het voertuig.

axleWeight

integer (int64)

minimum: 0
maximum: 1000000
0

Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat gewichtsbeperkingen per as niet worden overwogen.

height

number (double)

minimum: 0
maximum: 1000000
0

Hoogte van het voertuig in meters. Een waarde van 0 betekent dat hoogtebeperkingen niet worden overwogen.

isVehicleCommercial

boolean

False

Of het voertuig wordt gebruikt voor commerciële doeleinden. Bedrijfsvoertuigen mogen mogelijk niet op sommige wegen rijden.

length

number (double)

minimum: 0
maximum: 1000000
0

Lengte van het voertuig in meters. Een waarde van 0 betekent dat lengtebeperkingen niet worden overwogen.

loadType

VehicleLoadTypeEnum[]

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen. vehicleLoadType ondersteunt meerdere waarden in een aanvraag.

maxSpeed

integer (int64)

minimum: 0
maximum: 250
0

Maximumsnelheid van het voertuig in km/uur. De maximale snelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig is toegestaan op snelwegen.

Een waarde van 0 betekent dat een passende waarde voor het voertuig wordt bepaald en toegepast tijdens de routeplanning.

Een niet-nulwaarde kan tijdens het plannen van de route worden overschreven. De huidige verkeersstroom is bijvoorbeeld 60 km/uur. Als de maximumsnelheid van het voertuig is ingesteld op 50 km/uur, zal de routeringsmotor rekening houden met 60 km/uur, aangezien dit de huidige situatie is. Als de maximumsnelheid van het voertuig wordt opgegeven als 80 km/uur, maar de huidige verkeersstroom 60 km/uur is, gebruikt de routeringsmotor opnieuw 60 km/uur.

weight

integer (int64)

minimum: 0
maximum: 1000000
0

Gewicht van het voertuig in kilogram. Een waarde van 0 betekent dat gewichtsbeperkingen niet worden overwogen.

width

number (double)

minimum: 0
maximum: 1000000
0

Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet worden overwogen.

Summary

Samenvatting voor de batchaanvraag

Name Type Description
successfulRequests

integer (int32)

Aantal geslaagde aanvragen in de batch

totalRequests

integer (int32)

Totaal aantal aanvragen in de batch

VehicleLoadTypeEnum

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen. vehicleLoadType ondersteunt meerdere waarden in een aanvraag.

Waarde Description
USHazmatClass1

Explosieven

USHazmatClass2

Gecomprimeerd gas

USHazmatClass3

Brandbare vloeistoffen

USHazmatClass4

Brandbare vaste stoffen

USHazmatClass5

Oxidizers

USHazmatClass6

Vergif

USHazmatClass7

Radioactief

USHazmatClass8

Corrosieven

USHazmatClass9

Allerlei

otherHazmatExplosive

Explosieven

otherHazmatGeneral

Allerlei

otherHazmatHarmfulToWater

Schadelijk voor water