Route - Post Route Directions Batch

Referentie

Service:: Maps

API Version:: 1.0

Gebruik om een batch query's te verzenden naar de API Routebeschrijving ophalen in één asynchrone aanvraag.

De Post Route Directions Batch API is een HTTP-aanvraag POST die batches query's verzendt naar de API Routebeschrijving ophalen met behulp van één asynchrone aanvraag. U kunt API aanroepen Route Directions Batch om asynchroon (asynchroon) of synchroon (synchroon) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 700 query's batches uitvoeren en de API synchroniseren tot 100 query's. Zie Post Route Directions Batch Sync als u de Post Route Directions Batch API wilt aanroepen in een synchrone aanvraag.

Asynchrone batchaanvraag verzenden

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

Hiermee kunnen resultaten in een afzonderlijke aanroep worden opgehaald (meerdere downloads zijn mogelijk).
De asynchrone API is geoptimaliseerd voor betrouwbaarheid en er wordt geen time-out verwacht.
Het aantal batch-items is beperkt tot 700 voor deze API.

Wanneer u een aanvraag doet met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode samen met een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze na de verloopperiode wordt gebruikt.

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

Client verzendt een Route Directions Batch-aanvraag POST naar Azure Maps.

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

De server reageert met een van de volgende opties:

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.
Als de batchaanvraag is geaccepteerd, bevat de Location header in het antwoord de URL voor het downloaden van de resultaten van de batchaanvraag. 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}

Client verzendt een GET aanvraag op de download-URL die in stap 3 is verkregen om de batchresultaten te downloaden.

POST-hoofdtekst voor Batch-aanvraag

Als u de routebeschrijvingsquery's wilt verzenden, gebruikt u een POST aanvraag waarbij de aanvraagtekst 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 3 query's voor routebeschrijvingen :

{
    "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 routebeschrijvingsquery in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel. Het kan elk van de ondersteunde URI-parameters voor routebeschrijvingen accepteren. De tekenreekswaarden in de routebeschrijvingsquery moeten op de juiste manier worden ge escaped (bijvoorbeeld " teken moet worden ge escaped met \ ) en moeten ook correct zijn gecodeerd met URL's.

Met de asynchrone API kan de aanroeper maximaal 700 query's batches uitvoeren en de API synchroniseren tot 100 query's. De batch moet ten minste één query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynchrone batchresultaten wilt downloaden, verzendt u een GET aanvraag naar het eindpunt van de 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}

Dit is de gebruikelijke volgorde van bewerkingen voor het downloaden van de batchresultaten:

Client verzendt een GET aanvraag met behulp van de download-URL.
De server reageert met een van de volgende opties:

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 antwoordtekst bevat alle batchresultaten.

Batch-antwoordmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynchrone batchaanvraag downloadt en de batch is verwerkt, bevat de antwoordtekst het batchantwoord. Dit batchantwoord bevat een summary onderdeel dat aangeeft totalRequests dat deel uitmaakt van de oorspronkelijke batchaanvraag en successfulRequestsdat wil gezegd query's die met succes 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 die in de batchaanvraag zijn verzonden. Elk item in batchItems bevat statusCode en response velden. Elk response in batchItems heeft 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 het resultaat 1 geslaagd en 1 mislukt :

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

POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
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 Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

Name	Type	Description
batchItems	BatchRequestItem[]	De lijst met te verwerken query's.

Antwoorden

Name	Type	Description
200 OK	RouteDirectionsBatchResult	De batchaanvraag is verwerkt. De antwoordtekst bevat alle batchresultaten.
202 Accepted		Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de Locatieheader om de resultaten opnieuw te proberen of te openen. Headers Location: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Name

Type

Description

200 OK

RouteDirectionsBatchResult

De batchaanvraag is verwerkt. De antwoordtekst bevat alle batchresultaten.

202 Accepted

Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de Locatieheader om de resultaten opnieuw te proberen of te openen.

Headers

Location: string

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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 verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd 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 configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account Creatie in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully submit a route direction batch request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "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"
    }
  ]
}

Sample Response

Status code:: 200

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

Status code:: 202

operation-Location: URL to download the results of the long-running batch request.

Definities

Name	Description
BatchRequest	Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
BatchRequestItem	Batchaanvraagobject
DelayMagnitude	De omvang van de vertraging die door het incident wordt veroorzaakt. Deze waarden komen overeen met de waarden van het antwoordveld van de API Verkeersincidentdetails ophalen.
DrivingSide	Hiermee wordt links versus rechts rijden op het punt van de manoeuvre aangegeven.
EffectiveSetting	Effectieve parameter of gegevens die worden gebruikt bij het aanroepen van deze Route-API.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GuidanceInstructionType	Type van de instructie, bijvoorbeeld het draaien of wijzigen van het wegformulier.
GuidanceManeuver	Een code die de manoeuvre identificeert.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
JunctionType	Het type van de kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het in- en uitrijden van de rotonde.
LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
Response	Het resultaat van de query. RouteDirections als de query is voltooid, errorresponse anders.
ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
ResponseTravelMode	Reismodus voor de berekende route. De waarde wordt ingesteld op `other` als het aangevraagde transportmiddel niet mogelijk is in deze sectie
Route
RouteDirectionsBatchItem	Een item dat is geretourneerd door de Serviceaanroep Route Directions Batch.
RouteDirectionsBatchResult	Dit object wordt geretourneerd na een geslaagde Route Directions Batch-serviceoproep.
RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen beschikbaar wanneer om richtlijnen is gevraagd en beschikbaar is.
RouteInstruction	Een set kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechtsaf', 'Links aanhouden', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.
RouteInstructionGroup	Groepen een reeks instructie-elementen die aan elkaar zijn gerelateerd. Het reeksbereik wordt beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd), wordt in de instructionGroup een overzichtsbericht geretourneerd indien beschikbaar.
RouteLeg	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 poot in de geretourneerde route.
RouteLegSummary	Samenvattingsobject voor routesectie.
RouteOptimizedWaypoint	Geoptimaliseerd way point-object.
RouteReport	Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
RouteSection	Routesecties bevatten aanvullende informatie over onderdelen van een route. Elke sectie bevat ten minste de elementen `startPointIndex`, `endPointIndex`en `sectionType`.
RouteSectionTec	Details van de verkeersgebeurtenis, met behulp van definities in de TPEG2-TEC-standaard . Kan effectCode bevatten en elementen veroorzaken.
RouteSectionTecCause	De oorzaak van de verkeers gebeurtenis. Kan mainCauseCode- en subCauseCode-elementen bevatten. Kan worden gebruikt om iconografie en beschrijvingen te definiëren.
RouteSummary	Samenvattingsobject
SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OVERIG zijn. Zie 'tec' voor gedetailleerde informatie.
Summary	Samenvatting van de resultaten voor de batchaanvraag

BatchRequest

Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.

Name	Type	Description
batchItems	BatchRequestItem[]	De lijst met query's die moeten worden verwerkt.

BatchRequestItem

Batchaanvraagobject

Name	Type	Description
query	string	Deze parameter bevat een queryreeks die wordt gebruikt om een ongestructureerde geocoderingsbewerking uit te voeren. De queryreeks wordt exacte bewoordingen doorgegeven aan de zoek-API voor verwerking.

DelayMagnitude

De omvang van de vertraging die door het incident wordt veroorzaakt. Deze waarden komen overeen met de waarden van het antwoordveld van de API Verkeersincidentdetails ophalen.

Name	Type	Description
0	string	Onbekend.
1	string	Kleine.
2	string	Gemiddeld.
3	string	Belangrijke.
4	string	Ongedefinieerd, gebruikt voor wegafsluitingen en andere onbepaalde vertragingen.

DrivingSide

Hiermee wordt links versus rechts rijden op het punt van de manoeuvre aangegeven.

Name	Type	Description
LEFT	string	Linkerkant.
RIGHT	string	Rechterkant.

EffectiveSetting

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

Name	Type	Description
key	string	Naam van de gebruikte parameter.
value	string	Waarde van de gebruikte parameter.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GuidanceInstructionType

Type van de instructie, bijvoorbeeld het draaien of wijzigen van het wegformulier.

Name	Type	Description
DIRECTION_INFO	string	Richtingsinformatie.
LOCATION_ARRIVAL	string	Aankomstlocatie.
LOCATION_DEPARTURE	string	Vertreklocatie.
LOCATION_WAYPOINT	string	Locatie van way point.
ROAD_CHANGE	string	Wegwijziging.
TURN	string	Draai.

GuidanceManeuver

Een code die de manoeuvre identificeert.

Name	Type	Description
ARRIVE	string	Je bent gearriveerd.
ARRIVE_LEFT	string	Je bent gearriveerd. Uw bestemming bevindt zich aan de linkerkant.
ARRIVE_RIGHT	string	Je bent gearriveerd. Uw bestemming bevindt zich aan de rechterkant.
BEAR_LEFT	string	Houd links aan.
BEAR_RIGHT	string	Houd gelijk.
DEPART	string	Verlaten.
ENTER_FREEWAY	string	Neem de snelweg.
ENTER_HIGHWAY	string	Neem de snelweg.
ENTER_MOTORWAY	string	Neem de snelweg.
ENTRANCE_RAMP	string	Neem de helling.
FOLLOW	string	Volgen.
KEEP_LEFT	string	Blijf links.
KEEP_RIGHT	string	Rechts aanhouden.
MAKE_UTURN	string	Maak een U-bocht.
MOTORWAY_EXIT_LEFT	string	Neem de linkerafrit.
MOTORWAY_EXIT_RIGHT	string	Neem de rechterafrit.
ROUNDABOUT_BACK	string	Rond de rotonde.
ROUNDABOUT_CROSS	string	Steek de rotonde over.
ROUNDABOUT_LEFT	string	Op de rotonde neemt u de afslag aan de linkerkant.
ROUNDABOUT_RIGHT	string	Op de rotonde neemt u de afslag aan de rechterkant.
SHARP_LEFT	string	Ga scherp naar links.
SHARP_RIGHT	string	Draai scherp naar rechts.
STRAIGHT	string	Blijf rechtdoor.
SWITCH_MAIN_ROAD	string	Stap over op de hoofdweg.
SWITCH_PARALLEL_ROAD	string	Schakel over naar de parallelle weg.
TAKE_EXIT	string	Neem de afslag.
TAKE_FERRY	string	Neem de veerboot.
TRY_MAKE_UTURN	string	Probeer een u-bocht te maken.
TURN_LEFT	string	Ga linksaf.
TURN_RIGHT	string	Ga naar rechts.
WAYPOINT_LEFT	string	U hebt het waypoint bereikt. Het is aan de linkerkant.
WAYPOINT_REACHED	string	U hebt het waypoint bereikt.
WAYPOINT_RIGHT	string	U hebt het waypoint bereikt. Het is aan de rechterkant.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

JunctionType

Het type van de kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het in- en uitrijden van de rotonde.

Name	Type	Description
BIFURCATION	string	Bifurcatie
REGULAR	string	Regelmatige
ROUNDABOUT	string	Rotonde

LatLongPair

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number	De eigenschap Breedtegraad
longitude	number	De eigenschap Lengtegraad

Response

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

Name	Type	Description
error	ErrorDetail	Het foutobject.
formatVersion	string	De eigenschap Versie opmaken
optimizedWaypoints	RouteOptimizedWaypoint[]	Geoptimaliseerde volgorde van waypoints. Het toont de index van de door de gebruiker opgegeven waypoint-reeks voor de oorspronkelijke en geoptimaliseerde lijst. Bijvoorbeeld een antwoord: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` betekent dat de oorspronkelijke reeks [0, 1, 2] en de geoptimaliseerde volgorde [1, 2, 0] is. Omdat de index begint met 0, is het origineel 'eerste, tweede, derde' terwijl de geoptimaliseerde 'tweede, derde, eerste' is.
report	RouteReport	Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
routes	Route[]	Routes-matrix

ResponseSectionType

Sectietypen van het gerapporteerde routeantwoord

Name	Type	Description
CARPOOL	string	Delen van de route waarvoor carpoolrijen (HOV/High Occupancy Vehicle) moeten worden gebruikt.
CAR_TRAIN	string	Gedeelten van de route die auto's of treinen zijn.
COUNTRY	string	Secties waarin wordt aangegeven in welke landen/regio's de route zich bevindt.
FERRY	string	Gedeelten van de route die veerboten zijn.
MOTORWAY	string	Delen van de route die snelwegen zijn.
PEDESTRIAN	string	Gedeelten van de route die alleen geschikt zijn voor voetgangers.
TOLL_ROAD	string	Gedeelten van de route waarvoor een tol moet worden betaald.
TOLL_VIGNETTE	string	Gedeelten van de route waarvoor een tol-vignet aanwezig moet zijn.
TRAFFIC	string	Secties van de route die verkeersinformatie bevatten.
TRAVEL_MODE	string	Secties met betrekking tot de aanvraagparameter `travelMode`.
TUNNEL	string	Secties van de route die tunnels zijn.
URBAN	string	Delen van de route die zich binnen stedelijke gebieden bevinden.

ResponseTravelMode

Reismodus voor de berekende route. De waarde wordt ingesteld op other als het aangevraagde transportmiddel niet mogelijk is in deze sectie

Name	Type	Description
bicycle	string	De geretourneerde routes zijn geoptimaliseerd voor fietsen, inclusief het gebruik van fietsstroken.
bus	string	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busrijen. BETA-functionaliteit.
car	string	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	string	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BETA-functionaliteit.
other	string	De opgegeven wijze van vervoer is niet mogelijk in deze sectie
pedestrian	string	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, inclusief het gebruik van trottoirs.
taxi	string	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BETA-functionaliteit.
truck	string	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	string	De geretourneerde routes zijn geoptimaliseerd voor bestelauto's. BETA-functionaliteit.

Route

Name	Type	Description
guidance	RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen beschikbaar wanneer om richtlijnen is gevraagd en beschikbaar is.
legs	RouteLeg[]	Matrix Met benen
sections	RouteSection[]	Sectiematrix
summary	RouteSummary	Samenvattingsobject

RouteDirectionsBatchItem

Een item dat is geretourneerd door de Serviceaanroep Route Directions Batch.

Name	Type	Description
response	Response	Het resultaat van de query. RouteDirections als de query is voltooid, errorresponse anders.
statusCode	integer	Statuscode van HTTP-aanvraag.

RouteDirectionsBatchResult

Dit object wordt geretourneerd na een geslaagde Route Directions Batch-serviceoproep.

Name	Type	Description
batchItems	RouteDirectionsBatchItem[]	Matrix met de batchresultaten.
summary	Summary	Samenvatting van de resultaten voor de batchaanvraag

RouteGuidance

Bevat richtlijnen gerelateerde elementen. Dit veld is alleen beschikbaar wanneer om richtlijnen is gevraagd en beschikbaar is.

Name	Type	Description
instructionGroups	RouteInstructionGroup[]	Groepen een reeks instructie-elementen die aan elkaar zijn gerelateerd.
instructions	RouteInstruction[]	Een lijst met instructies voor het beschrijven van manoeuvre.

RouteInstruction

Een set kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechtsaf', 'Links aanhouden', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.

Name	Type	Description
combinedMessage	string	Een door mensen leesbaar bericht voor de manoeuvre in combinatie met het bericht uit de volgende instructie. Soms is het mogelijk om twee opeenvolgende instructies te combineren tot één instructie, waardoor deze gemakkelijker te volgen is. Als dit het geval is, is de vlag possibleCombineWithNext waar. Bijvoorbeeld: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` De vlag possibleCombineWithNext in instructie 10 is waar. Dit geeft aan de clients van gecodeerde richtlijnen aan dat deze kan worden gecombineerd met instructie 11. De instructies worden automatisch gecombineerd voor klanten die om door mensen leesbare richtlijnen vragen. Het veld combinedMessage bevat het gecombineerde bericht: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	ISO 3166-1 alfa-3-landcode van 3 tekens. B.v. VS.
drivingSide	DrivingSide	Hiermee wordt links versus rechts rijden op het punt van de manoeuvre aangegeven.
exitNumber	string	Het aantal(en) van een snelwegafrit genomen door de huidige manoeuvre. Als een uitgang meerdere afsluitnummers heeft, worden deze gescheiden door ',' en mogelijk geaggregeerd door '-', bijvoorbeeld '10, 13-15'.
instructionType	GuidanceInstructionType	Type van de instructie, bijvoorbeeld het draaien of wijzigen van het wegformulier.
junctionType	JunctionType	Het type van de kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het in- en uitrijden van de rotonde.
maneuver	GuidanceManeuver	Een code die de manoeuvre identificeert.
message	string	Een door mensen leesbaar bericht voor de manoeuvre.
point	LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
pointIndex	integer	De index van het punt in de lijst met polylijnpunten die overeenkomen met het punt van de instructie.
possibleCombineWithNext	boolean	Het is mogelijk om de instructie eventueel te combineren met de volgende. Dit kan worden gebruikt voor het samenstellen van berichten zoals 'Linksom en vervolgens rechts afslaan'.
roadNumbers	string[]	Het nummer van de weg(en) van de volgende significante wegsegment(en) na de manoeuvre, of van de te volgen weg(en). Voorbeeld: ["E34", "N205"]
roundaboutExitNumber	string	Hiermee wordt aangegeven welke afslag u moet nemen op een rotonde.
routeOffsetInMeters	integer	Afstand vanaf het begin van de route tot het punt van de instructie.
signpostText	string	De tekst op een wegwijzer die het meest relevant is voor de manoeuvre, of voor de richting die moet worden gevolgd.
stateCode	string	Een onderverdeling (bijvoorbeeld staat) van het land, vertegenwoordigd door het tweede deel van een ISO 3166-2-code . Dit is alleen beschikbaar voor bepaalde landen/regio's, zoals de VS, Canada en Mexico.
street	string	Straatnaam van het volgende belangrijke wegsegment na de manoeuvre, of van de straat die moet worden gevolgd.
travelTimeInSeconds	integer	Geschatte reistijd tot het punt dat overeenkomt met routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Geeft de richting van een instructie aan. Als junctionType een turn-instructie aangeeft: 180 = U-bocht [-179, -1] = Linksaf draaien 0 = Rechtdoor (een draai van 0 graden) [1, 179] = Rechts draaien Als junctionType een bifurcation-instructie aangeeft: <0 - links houden >0 - rechts houden

RouteInstructionGroup

Groepen een reeks instructie-elementen die aan elkaar zijn gerelateerd. Het reeksbereik wordt beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd), wordt in de instructionGroup een overzichtsbericht geretourneerd indien beschikbaar.

Name	Type	Description
firstInstructionIndex	integer	Index van de eerste instructie in de instructies en behorend tot deze groep.
groupLengthInMeters	integer	Lengte van de groep.
groupMessage	string	Samenvattingsbericht wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd).
lastInstructionIndex	integer	Index van de laatste instructie in de instructies en behorend tot deze groep.

RouteLeg

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 poot in de geretourneerde route.

Name	Type	Description
points	LatLongPair[]	Puntenmatrix
summary	RouteLegSummary	Samenvattingsobject voor routesectie.

RouteLegSummary

Samenvattingsobject voor routesectie.

Name	Type	Description
arrivalTime	string	De geschatte aankomsttijd voor de route of het traject. De tijd is in UTC.
batteryConsumptionInkWh	number	Geschat elektrisch energieverbruik in kilowattuur (kWh) met behulp van het model elektrisch verbruik. Opgenomen als vehicleEngineType is ingesteld op elektrisch en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan dus negatief zijn (wat wijst op het winnen van energie). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de batterij nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh en currentChargeInkWh niet zijn opgegeven, wordt uitgegaan van onbeperkte recuperatie in de verbruiksberekening.
departureTime	string	De geschatte vertrektijd voor de route of het traject. De tijd is in UTC.
fuelConsumptionInLiters	number	Geschat brandstofverbruik in liter met behulp van het verbrandingsverbruiksmodel. Opgenomen als vehicleEngineType is ingesteld op verbranding en constantSpeedConsumptionInLitersPerHundredkm is opgegeven. De waarde is niet-negatief.
historicTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend op basis van tijdafhankelijke historische verkeersgegevens. Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
lengthInMeters	integer	Lengte in meters eigenschap
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschatte reistijd berekend op basis van realtime snelheidsgegevens. Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
noTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend alsof er geen vertragingen zijn op de route als gevolg van verkeerssituaties (bijvoorbeeld congestie). Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door de realtime incident(s) op basis van verkeersinformatie. Voor routes die zijn gepland met de vertrektijd in de toekomst, is de vertraging altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet de parameter computeTravelTimeFor=all worden toegevoegd.
travelTimeInSeconds	integer	De eigenschap Geschatte reistijd in seconden met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer traffic=false travelTimeInSeconds nog steeds de vertraging als gevolg van verkeer bevat. Als DepartAt in de toekomst ligt, wordt de reistijd berekend op basis van tijdafhankelijke historische verkeersgegevens.

RouteOptimizedWaypoint

Geoptimaliseerd way point-object.

Name	Type	Description
optimizedIndex	integer	Geoptimaliseerde way point index van het systeem.
providedIndex	integer	Way point index geleverd door de gebruiker.

RouteReport

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

Name	Type	Description
effectiveSettings	EffectiveSetting[]	Effectieve parameters of gegevens die worden gebruikt bij het aanroepen van deze Route-API.

RouteSection

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

Name	Type	Description
delayInSeconds	integer	Vertraging in seconden veroorzaakt door het incident.
effectiveSpeedInKmh	integer	Effectieve snelheid van het incident in km/h, gemiddeld over de gehele lengte.
endPointIndex	integer	Index van het laatste punt (offset 0) in de route waar deze sectie op van toepassing is.
magnitudeOfDelay	DelayMagnitude	De omvang van de vertraging veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de API Details van verkeersincident ophalen.
sectionType	ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
simpleCategory	SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OVERIGE zijn. Zie 'tec' voor gedetailleerde informatie.
startPointIndex	integer	Index van het eerste punt (offset 0) in de route waar deze sectie op van toepassing is.
tec	RouteSectionTec	Details van de verkeersgebeurtenis, met behulp van definities in de TPEG2-TEC-standaard . Kan effectCode bevatten en veroorzaakt elementen.
travelMode	ResponseTravelMode	Reismodus voor de berekende route. De waarde wordt ingesteld op `other` als het aangevraagde transportmiddel in deze sectie niet mogelijk is

RouteSectionTec

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

Name	Type	Description
causes	RouteSectionTecCause[]	Oorzaken matrix
effectCode	integer	Het effect op de verkeersstroom. Bevat een waarde in de tabel tec001:EffectCode, zoals gedefinieerd in de TPEG2-TEC-standaard . Kan worden gebruikt om verkeersgebeurtenissen in kleur te coden op basis van de ernst.

RouteSectionTecCause

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

Name	Type	Description
mainCauseCode	integer	De hoofdoorzaak van de verkeers gebeurtenis. Bevat een waarde in de tabel tec002:CauseCode, zoals gedefinieerd in de TPEG2-TEC-standaard .
subCauseCode	integer	De subcause van de verkeers gebeurtenis. Bevat een waarde in de suboorzaaktabel die is gedefinieerd door de mainCauseCode, zoals gedefinieerd in de TPEG2-TEC-standaard .

RouteSummary

Samenvattingsobject

Name	Type	Description
arrivalTime	string	De geschatte aankomsttijd voor de route of het traject. Tijd is in UTC.
departureTime	string	De geschatte vertrektijd voor de route of het traject. Tijd is in UTC.
lengthInMeters	integer	Lengte in meters eigenschap
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door de realtime incident(s) op basis van verkeersinformatie. Voor routes die zijn gepland met de vertrektijd in de toekomst, is de vertraging altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet de parameter computeTravelTimeFor=all worden toegevoegd.
travelTimeInSeconds	integer	De eigenschap Geschatte reistijd in seconden met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer traffic=false travelTimeInSeconds nog steeds de vertraging als gevolg van verkeer bevat. Als DepartAt in de toekomst ligt, wordt de reistijd berekend op basis van tijdafhankelijke historische verkeersgegevens.

SimpleCategory

Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OVERIG zijn. Zie 'tec' voor gedetailleerde informatie.

Name	Type	Description
JAM	string	Verkeersopstopping.
OTHER	string	Iets anders.
ROAD_CLOSURE	string	Wegsluiting.
ROAD_WORK	string	Wegwerkzaamheden.

Summary

Samenvatting van de resultaten voor de batchaanvraag

Name	Type	Description
successfulRequests	integer	Aantal geslaagde aanvragen in de batch
totalRequests	integer	Totaal aantal aanvragen in de batch

Share via

Route - Post Route Directions Batch

Asynchrone batchaanvraag verzenden

POST-hoofdtekst voor Batch-aanvraag

Asynchrone batchresultaten downloaden

Batch-antwoordmodel

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Notities

Scopes

subscription-key

SAS Token

Voorbeelden

Successfully submit a route direction batch request

Sample Request

Sample Response

Definities

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Aanvullende resources