Route - Post Route Directions Batch Sync

Referentie

Service:: Maps

API-versie:: 1.0

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

Notitie

azure Maps Route v1-service buiten gebruik

De Azure Maps Route v1-service is nu afgeschaft en wordt buiten gebruik gesteld op 3-31-28. Om serviceonderbrekingen te voorkomen, moeten alle aanroepen naar de Service Route v1 worden bijgewerkt voor gebruik van Route v2025-01-01-service tegen 3/31/28. Zie Azure Maps Route 1.0 API's migrerenvoor meer informatie.

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

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

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` 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 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	BatchRequestItem[]	De lijst met query's die moeten worden verwerkt.

Antwoorden

Name	Type	Description
200 OK	RouteDirectionsBatchResult	OK
Other Status Codes	ErrorResponse	Time-out: de aanvraag duurde langer om te voltooien dan de maximale tijd die is gedefinieerd in de API.
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

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.

Opmerkingen

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 wanneer u Een Azure Maps-account maken in 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 worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering 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 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

Successfully retrieve the route direction batch result synchronously

Voorbeeldaanvraag

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/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"
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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
  }
}

Statuscode:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definities

Name	Description
BatchRequest	Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
BatchRequestItem	Batch-aanvraagobject
DelayMagnitude	De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.
DrivingSide	Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.
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 instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.
GuidanceManeuver	Een code die de manoeuvre identificeert.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
JunctionType	Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten 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, anders ErrorResponse.
ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
ResponseTravelMode	De reismodus voor de berekende route. De waarde wordt ingesteld op `other` als de aangevraagde transportmodus niet mogelijk is in deze sectie
Route
RouteDirectionsBatchItem	Een item dat wordt geretourneerd vanuit de Serviceaanroep routebeschrijving Batch.
RouteDirectionsBatchResult	Dit object wordt geretourneerd door een geslaagde Batch-serviceoproep routebeschrijving.
RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
RouteInstruction	Een reeks kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts rechts', 'Links blijven', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.
RouteInstructionGroup	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.
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 been in de geretourneerde route.
RouteLegSummary	Overzichtsobject 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 OTHER zijn. Zie "tec" voor gedetailleerde informatie.
Summary	Samenvatting van de resultaten voor de batchaanvraag

BatchRequest

Object

Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.

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

BatchRequestItem

Object

Batch-aanvraagobject

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

DelayMagnitude

Inventarisatie

De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.

Waarde	Description
0	Onbekend.
1	Minderjarige.
2	Gematigd.
3	Majoor.
4	Niet gedefinieerd, gebruikt voor wegsluitingen en andere onbepaalde vertragingen.

DrivingSide

Inventarisatie

Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.

Waarde	Description
LEFT	Linkerkant.
RIGHT	Rechterzijde.

EffectiveSetting

Object

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

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

Object

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.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GuidanceInstructionType

Inventarisatie

Type instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.

Waarde	Description
DIRECTION_INFO	Richtingsinformatie.
LOCATION_ARRIVAL	Aankomstlocatie.
LOCATION_DEPARTURE	Vertreklocatie.
LOCATION_WAYPOINT	Way point location.
ROAD_CHANGE	Wegwijziging.
TURN	Draaien.

GuidanceManeuver

Inventarisatie

Een code die de manoeuvre identificeert.

Waarde	Description
ARRIVE	Je bent aangekomen.
ARRIVE_LEFT	Je bent aangekomen. Uw bestemming bevindt zich aan de linkerkant.
ARRIVE_RIGHT	Je bent aangekomen. Uw bestemming bevindt zich aan de rechterkant.
BEAR_LEFT	Houd de linkerbenedenhoek.
BEAR_RIGHT	Hou je recht.
DEPART	Verlaten.
ENTER_FREEWAY	Neem de snelweg.
ENTER_HIGHWAY	Neem de snelweg.
ENTER_MOTORWAY	Neem de snelweg.
ENTRANCE_RAMP	Neem de helling.
FOLLOW	Volgen.
KEEP_LEFT	Blijf links.
KEEP_RIGHT	Ga naar rechts.
MAKE_UTURN	Maak een U-turn.
MOTORWAY_EXIT_LEFT	Neem de linkeruitgang.
MOTORWAY_EXIT_RIGHT	Neem de rechteruitgang.
ROUNDABOUT_BACK	Ga rond de rotonde.
ROUNDABOUT_CROSS	Steek de rotonde over.
ROUNDABOUT_LEFT	Bij de rotonde neemt u de afslag aan de linkerkant.
ROUNDABOUT_RIGHT	Bij de rotonde neemt u de afslag aan de rechterkant.
SHARP_LEFT	Draai scherp naar links.
SHARP_RIGHT	Draai scherp rechts.
STRAIGHT	Blijf rechtdoor.
SWITCH_MAIN_ROAD	Ga naar de hoofdweg.
SWITCH_PARALLEL_ROAD	Schakel over naar de parallelle weg.
TAKE_EXIT	Neem de uitgang.
TAKE_FERRY	Neem de veerboot.
TRY_MAKE_UTURN	Probeer een U-turn te maken.
TURN_LEFT	Ga linksaf.
TURN_RIGHT	Ga naar rechts.
WAYPOINT_LEFT	U hebt het waypoint bereikt. Het is aan de linkerkant.
WAYPOINT_REACHED	U hebt het waypoint bereikt.
WAYPOINT_RIGHT	U hebt het waypoint bereikt. Het staat aan de rechterkant.

JsonFormat

Inventarisatie

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

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten

JunctionType

Inventarisatie

Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten van de rotonde.

Waarde	Description
BIFURCATION	tweesprong
REGULAR	regelmatig
ROUNDABOUT	rotonde

LatLongPair

Object

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number (double)	De eigenschap Breedtegraad
longitude	number (double)	Eigenschap Lengtegraad

Response

Object

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

Name	Type	Description
error	ErrorDetail	Het foutobject.
formatVersion	string	Eigenschap Versie opmaken
optimizedWaypoints	RouteOptimizedWaypoint[]	Geoptimaliseerde volgorde van waypoints. Het toont de index van de door de gebruiker verstrekte 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 geoptimaliseerde reeks [1, 2, 0] is. Omdat de index begint met 0, is het origineel 'eerste, tweede, derde' terwijl de geoptimaliseerde waarde 'tweede, derde, eerste' is.
report	RouteReport	Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
routes	Route[]	Matrix routes

ResponseSectionType

Inventarisatie

Sectietypen van het gerapporteerde routeantwoord

Waarde	Description
CARPOOL	Gedeelten van de route waarvoor het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) nodig is.
CAR_TRAIN	Secties van de route die auto's of treinen zijn.
COUNTRY	Secties die aangeven in welke landen/regio's de route zich bevindt.
FERRY	Secties van de route die veerboten zijn.
MOTORWAY	Gedeelten van de route die snelwegen zijn.
PEDESTRIAN	Gedeelten van de route die alleen geschikt zijn voor voetgangers.
TOLL_ROAD	Secties van de route waarvoor een tol moet worden betaald.
TOLL_VIGNETTE	Gedeelten van de route waarvoor een tol vignet aanwezig moet zijn.
TRAFFIC	Secties van de route die verkeersinformatie bevatten.
TRAVEL_MODE	Secties met betrekking tot de aanvraagparameter `travelMode`.
TUNNEL	Secties van de route die tunnels zijn.
URBAN	Gedeelten van de route die zich in stedelijke gebieden bevinden.

ResponseTravelMode

Inventarisatie

De reismodus voor de berekende route. De waarde wordt ingesteld op other als de aangevraagde transportmodus niet mogelijk is in deze sectie

Waarde	Description
bicycle	De geretourneerde routes zijn geoptimaliseerd voor fietsen, waaronder het gebruik van fietsbanen.
bus	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busbanen. BÈTA-functionaliteit.
car	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BÈTA-functionaliteit.
other	De opgegeven vervoerswijze is niet mogelijk in deze sectie
pedestrian	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, waaronder het gebruik van stoeppaden.
taxi	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BÈTA-functionaliteit.
truck	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	De geretourneerde routes zijn geoptimaliseerd voor bestelwagens. BÈTA-functionaliteit.

Route

Object

Name	Type	Description
guidance	RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
legs	RouteLeg[]	Matrice Benen
sections	RouteSection[]	Matrix secties
summary	RouteSummary	Samenvattingsobject

RouteDirectionsBatchItem

Object

Een item dat wordt geretourneerd vanuit de Serviceaanroep routebeschrijving Batch.

Name	Type	Description
response	Response	Het resultaat van de query. RouteDirections als de query is voltooid, anders ErrorResponse.
statusCode	integer	Http-aanvraagstatuscode.

RouteDirectionsBatchResult

Object

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

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

RouteGuidance

Object

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

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

RouteInstruction

Object

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

Name	Type	Description
combinedMessage	string	Een mensleesbaar 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 het gemakkelijker te volgen is. Als dit het geval is, is de vlag possibleCombineWithNext waar. Voorbeeld: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` De mogelijke VlagCombineWithNext op 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 door mensen leesbare richtlijnen aanvragen. 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	3 tekens ISO 3166-1 alfa-3 landcode. Bijvoorbeeld VS.
drivingSide	DrivingSide	Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.
exitNumber	string	Het aantal(en) van een snelweguitgang die door de huidige manoeuvre wordt genomen. Als een uitgang meerdere afsluitnummers heeft, worden deze gescheiden door ',' en mogelijk samengevoegd door '-', bijvoorbeeld '10, 13-15'.
instructionType	GuidanceInstructionType	Type instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.
junctionType	JunctionType	Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten van de rotonde.
maneuver	GuidanceManeuver	Een code die de manoeuvre identificeert.
message	string	Een mensleesbaar 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 eventueel de instructie te combineren met de volgende. Dit kan worden gebruikt om berichten te maken, zoals 'Links en vervolgens naar rechts'.
roadNumbers	string[]	Het wegnummer(en) van de volgende belangrijke wegsegment(en) na de manoeuvre of van de weg(en) die moeten worden gevolgd. Voorbeeld: ["E34", "N205"]
roundaboutExitNumber	integer (int64)	Dit geeft aan welke uitgang bij een rotonde moet worden uitgevoerd.
routeOffsetInMeters	integer	Afstand van het begin van de route naar het punt van de instructie.
signpostText	string	De tekst op een wegwijzer die het meest relevant is voor de manoeuvre of 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 sommige landen/regio's, zoals de VS, Canada en Mexico.
street	string	Straatnaam van het volgende significante 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 draaiinstructie aangeeft: 180 = U-draai [-179, -1] = Links 0 = Recht aan (een '0 graden' draai) [1, 179] = Rechts Als junctionType een bifurcation-instructie aangeeft: <0 - links houden >0 - rechts houden

RouteInstructionGroup

Object

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.

Name	Type	Description
firstInstructionIndex	integer	Index van de eerste instructie in de instructies en behoren tot deze groep.
groupLengthInMeters	integer	De lengte van de groep.
groupMessage	string	Samenvattingsbericht wanneer door mensen leesbare tekstberichten worden aangevraagd voor richtlijnen (instructionType=text of gelabeld).
lastInstructionIndex	integer	Index van de laatste instructie in de instructies en behoren tot deze groep.

RouteLeg

Object

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.

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

RouteLegSummary

Object

Overzichtsobject voor routesectie.

Name	Type	Description
arrivalTime	string (date-time)	De geschatte aankomsttijd voor de route of het been. De tijd is in UTC.
batteryConsumptionInkWh	number (double)	Geschat energieverbruik in kilowatturen (kWh) met behulp van het elektrische verbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op elektrische en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan daarom negatief zijn (wat aangeeft dat energie wordt gewonnen). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt de recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de batterij nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh of currentChargeInkWh niet zijn opgegeven, wordt niet-getrainde recuperatie verondersteld in de verbruiksberekening.
departureTime	string (date-time)	De geschatte vertrektijd voor de route of het been. De tijd is in UTC.
fuelConsumptionInLiters	number (double)	Geschat brandstofverbruik in liter met behulp van het verbrandingsverbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op verbranding en constantSpeedConsumptionInLitersPerHundredkm is opgegeven. De waarde is niet-negatief.
historicTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend met tijdafhankelijke historische verkeersgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
lengthInMeters	integer	Eigenschap Length In Meters
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschatte reistijd berekend met realtime snelheidsgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
noTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend alsof er geen vertragingen op de route zijn vanwege verkeersomstandigheden (bijvoorbeeld congestie). Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door het realtime incident(en) op basis van verkeersinformatie. Voor routes gepland met vertrektijd in de toekomst is vertragingen altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet u parameter computeTravelTimeFor=all toevoegen.
travelTimeInSeconds	integer	Geschatte reistijd in seconden eigenschap met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer verkeer=false travelTimeInSeconds de vertraging als gevolg van verkeer nog steeds bevat. Als DepartAt zich in de toekomst bevindt, wordt reistijd berekend met tijdafhankelijke historische verkeersgegevens.

RouteOptimizedWaypoint

Object

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

Object

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

Object

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 waarop deze sectie van toepassing is.
magnitudeOfDelay	DelayMagnitude	De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.
sectionType	ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
simpleCategory	SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OTHER 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 elementen veroorzaken.
travelMode	ResponseTravelMode	De reismodus voor de berekende route. De waarde wordt ingesteld op `other` als de aangevraagde transportmodus niet mogelijk is in deze sectie

RouteSectionTec

Object

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 van matrix
effectCode	integer	Het effect op de verkeersstroom. Bevat een waarde in de tabel tec001:EffectCode, zoals gedefinieerd in de standaard TPEG2-TEC. Kan worden gebruikt om verkeersgebeurtenissen in kleur te coden op basis van de ernst.

RouteSectionTecCause

Object

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 belangrijkste oorzaak van de verkeers gebeurtenis. Bevat een waarde in de tec002:CauseCode-tabel, zoals gedefinieerd in de standaard TPEG2-TEC.
subCauseCode	integer	De subcause van de verkeers gebeurtenis. Bevat een waarde in de suboorzaaktabel die is gedefinieerd door de mainCauseCode, zoals gedefinieerd in de standaard TPEG2-TEC.

RouteSummary

Object

Samenvattingsobject

Name	Type	Description
arrivalTime	string (date-time)	De geschatte aankomsttijd voor de route of het been. De tijd is in UTC.
departureTime	string (date-time)	De geschatte vertrektijd voor de route of het been. De tijd is in UTC.
lengthInMeters	integer	Eigenschap Length In Meters
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door het realtime incident(en) op basis van verkeersinformatie. Voor routes gepland met vertrektijd in de toekomst is vertragingen altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet u parameter computeTravelTimeFor=all toevoegen.
travelTimeInSeconds	integer	Geschatte reistijd in seconden eigenschap met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer verkeer=false travelTimeInSeconds de vertraging als gevolg van verkeer nog steeds bevat. Als DepartAt zich in de toekomst bevindt, wordt reistijd berekend met tijdafhankelijke historische verkeersgegevens.

SimpleCategory

Inventarisatie

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

Waarde	Description
JAM	File.
OTHER	Ander.
ROAD_CLOSURE	Wegsluiting.
ROAD_WORK	Wegwerk.

Summary

Object

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

Delen via

Route - Post Route Directions Batch Sync

Synchrone batchaanvraag verzenden

Batch-antwoordmodel

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Opmerkingen

Bereiken

subscription-key

SAS Token

Voorbeelden

Successfully retrieve the route direction batch result synchronously

Voorbeeldaanvraag

Voorbeeldrespons

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