Route - Get Route Directions Batch

Gäller för: se prisnivåer.

Ladda ned asynkrona batchresultat

Om du vill ladda ned asynkrona batchresultat skickar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från rubriken för Location en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska åtgärdssekvensen för att ladda ned batchresultatet:

  1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran accepterades men bearbetas fortfarande. Försök igen om en stund.

    HTTP 200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran, om batchen har slutfört bearbetningen, innehåller svarstexten batchsvaret. Det här batchsvaret innehåller en summary komponent som anger totalRequests som var en del av den ursprungliga batchbegäran, dvs successfulRequests. frågor som har körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response in batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – Om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på Batch-svar med 1 lyckat och 1 misslyckat resultat:

{
    "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."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/route/directions/batch/{format}?api-version=1.0

URI-parametrar

Name I Obligatorisk Typ Description
format
path True

string

Batch-ID för att köra frågor mot åtgärden.

api-version
query True

string

Versionsnummer för Azure Maps API.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Typ Description
200 OK

RouteDirectionsBatchResult

Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

202 Accepted

Stöds endast för asynkron begäran. Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i platsrubriken för att försöka igen eller komma åt resultatet.

Headers

Location: string

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully retrieve the status for the route direction batch request

Sample Request

GET https://atlas.microsoft.com/route/directions/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

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

Definitioner

Name Description
DelayMagnitude

Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena för svarsfältet ty i API:et Get Traffic Incident Detail.

DrivingSide

Anger vänster kontra höger sida körning vid punkten för manövern.

EffectiveSetting

Effektiv parameter eller data som används när du anropar det här routnings-API:et.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

GuidanceManeuver

En kod som identifierar manövern.

JunctionType

Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

LatLongPair

En plats som representeras som latitud och longitud.

Response

Resultatet av frågan. RouteDirections om frågan har slutförts, ErrorResponse annars.

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

ResponseTravelMode

Resläge för den beräknade vägen. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

Route
RouteDirectionsBatchItem

Ett objekt som returneras från Route Directions Batch-tjänstanropet.

RouteDirectionsBatchResult

Det här objektet returneras från ett lyckat Route Directions Batch-tjänstanrop.

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

RouteInstruction

En uppsättning attribut som beskriver en manöver, t.ex. "Sväng höger", "Håll vänster", "Ta färjan", "Ta motorvägen", "Anländer".

RouteInstructionGroup

Grupperar en sekvens med instruktionselement som är relaterade till varandra. Sekvensintervallet är begränsat med firstInstructionIndex och lastInstructionIndex. När textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggas) returneras ett sammanfattningsmeddelande i instruktionsgruppen när det är tillgängligt.

RouteLeg

En beskrivning av en del av en väg som består av en lista med punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.

RouteLegSummary

Sammanfattningsobjekt för routningsavsnittet.

RouteOptimizedWaypoint

Optimerat way point-objekt.

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

RouteSection

Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen startPointIndex, endPointIndexoch sectionType.

RouteSectionTec

Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.

RouteSectionTecCause

Orsaken till trafikhändelsen. Kan innehålla elementen mainCauseCode och subCauseCode. Kan användas för att definiera ikonografi och beskrivningar.

RouteSummary

Sammanfattningsobjekt

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Se "tec" för detaljerad information.

Summary

Sammanfattning av resultatet för batchbegäran

DelayMagnitude

Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena för svarsfältet ty i API:et Get Traffic Incident Detail.

Name Typ Description
0

string

Okänt.

1

string

Mindre.

2

string

Medel.

3

string

Stora.

4

string

Odefinierad, används för vägavstängningar och andra obestämda förseningar.

DrivingSide

Anger vänster kontra höger sida körning vid punkten för manövern.

Name Typ Description
LEFT

string

Vänster.

RIGHT

string

Höger sida.

EffectiveSetting

Effektiv parameter eller data som används när du anropar det här routnings-API:et.

Name Typ Description
key

string

Namnet på den parameter som används.

value

string

Värdet för den parameter som används.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

Name Typ Description
DIRECTION_INFO

string

Riktningsinformation.

LOCATION_ARRIVAL

string

Ankomstplats.

LOCATION_DEPARTURE

string

Avgångsplats.

LOCATION_WAYPOINT

string

Plats för vägpunkt.

ROAD_CHANGE

string

Vägbyte.

TURN

string

Vända.

GuidanceManeuver

En kod som identifierar manövern.

Name Typ Description
ARRIVE

string

Du har kommit.

ARRIVE_LEFT

string

Du har kommit. Målet är till vänster.

ARRIVE_RIGHT

string

Du har kommit. Målet är till höger.

BEAR_LEFT

string

Björn till vänster.

BEAR_RIGHT

string

Ha rätt.

DEPART

string

Lämna.

ENTER_FREEWAY

string

Ta motorvägen.

ENTER_HIGHWAY

string

Ta motorvägen.

ENTER_MOTORWAY

string

Ta motorvägen.

ENTRANCE_RAMP

string

Ta rampen.

FOLLOW

string

Följa.

KEEP_LEFT

string

Behåll vänster.

KEEP_RIGHT

string

Håll dig till höger.

MAKE_UTURN

string

Gör en U-sväng.

MOTORWAY_EXIT_LEFT

string

Ta vänster utgång.

MOTORWAY_EXIT_RIGHT

string

Ta höger utgång.

ROUNDABOUT_BACK

string

Gå runt rondellen.

ROUNDABOUT_CROSS

string

Korsa rondellen.

ROUNDABOUT_LEFT

string

Vid rondellen tar du avfarten till vänster.

ROUNDABOUT_RIGHT

string

Vid rondellen tar du avfarten till höger.

SHARP_LEFT

string

Vrid skarpt åt vänster.

SHARP_RIGHT

string

Vänd dig skarpt åt höger.

STRAIGHT

string

Fortsätt rakt på.

SWITCH_MAIN_ROAD

string

Byt till huvudvägen.

SWITCH_PARALLEL_ROAD

string

Växla till den parallella vägen.

TAKE_EXIT

string

Ta avslutet.

TAKE_FERRY

string

Ta färjan.

TRY_MAKE_UTURN

string

Försök att göra en U-sväng.

TURN_LEFT

string

Sväng vänster.

TURN_RIGHT

string

Sväng höger.

WAYPOINT_LEFT

string

Du har nått vägpunkten. Det är till vänster.

WAYPOINT_REACHED

string

Du har nått vägpunkten.

WAYPOINT_RIGHT

string

Du har nått vägpunkten. Det är till höger.

JunctionType

Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

Name Typ Description
BIFURCATION

string

Bifurkation

REGULAR

string

Regelbundna

ROUNDABOUT

string

Rondellen

LatLongPair

En plats som representeras som latitud och longitud.

Name Typ Description
latitude

number

Latitude-egenskap

longitude

number

Longitudegenskap

Response

Resultatet av frågan. RouteDirections om frågan har slutförts, ErrorResponse annars.

Name Typ Description
error

ErrorDetail

Felobjektet.

formatVersion

string

Formatversionsegenskap

optimizedWaypoints

RouteOptimizedWaypoint[]

Optimerad sekvens av waypoints. Det visar indexet från den användardefinierade waypointsekvensen för den ursprungliga och optimerade listan. Till exempel ett svar:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

innebär att den ursprungliga sekvensen är [0, 1, 2] och optimerad sekvens är [1, 2, 0]. Eftersom indexet börjar med 0 är originalet "första, andra, tredje" medan det optimerade är "second, third, first".

report

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

routes

Route[]

Routningsmatris

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

Name Typ Description
CARPOOL

string

Delar av rutten som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).

CAR_TRAIN

string

Delar av rutten som är bilar eller tåg.

COUNTRY

string

Avsnitt som anger vilka länder/regioner som vägen finns i.

FERRY

string

Delar av rutten som är färjor.

MOTORWAY

string

Delar av rutten som är motorvägar.

PEDESTRIAN

string

Delar av rutten som endast lämpar sig för fotgängare.

TOLL_ROAD

string

Delar av vägen som kräver en avgift som ska betalas.

TOLL_VIGNETTE

string

Delar av rutten som kräver att en avgiftsbelagd vinjett finns.

TRAFFIC

string

Delar av vägen som innehåller trafikinformation.

TRAVEL_MODE

string

Avsnitt i förhållande till parametern travelModerequest .

TUNNEL

string

Delar av vägen som är tunnlar.

URBAN

string

Delar av rutten som finns i stadsområden.

ResponseTravelMode

Resläge för den beräknade vägen. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

Name Typ Description
bicycle

string

De returnerade vägarna är optimerade för cyklar, inklusive användning av cykelbanor.

bus

string

De returnerade vägarna är optimerade för bussar, inklusive användning av endast bussfiler. BETA-funktioner.

car

string

De returnerade vägarna är optimerade för bilar.

motorcycle

string

De returnerade vägarna är optimerade för motorcyklar. BETA-funktioner.

other

string

Det givna transportsättet är inte möjligt i det här avsnittet

pedestrian

string

De returnerade vägarna är optimerade för fotgängare, inklusive användning av trottoarer.

taxi

string

De returnerade vägarna är optimerade för taxibilar. BETA-funktioner.

truck

string

De returnerade vägarna är optimerade för nyttofordon, till exempel för lastbilar.

van

string

De returnerade vägarna är optimerade för skåpbilar. BETA-funktioner.

Route

Name Typ Description
guidance

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

legs

RouteLeg[]

Matris med ben

sections

RouteSection[]

Matris för avsnitt

summary

RouteSummary

Sammanfattningsobjekt

RouteDirectionsBatchItem

Ett objekt som returneras från Route Directions Batch-tjänstanropet.

Name Typ Description
response

Response

Resultatet av frågan. RouteDirections om frågan har slutförts, ErrorResponse annars.

statusCode

integer

Statuskod för HTTP-begäran.

RouteDirectionsBatchResult

Det här objektet returneras från ett lyckat Route Directions Batch-tjänstanrop.

Name Typ Description
batchItems

RouteDirectionsBatchItem[]

Matris som innehåller batchresultatet.

summary

Summary

Sammanfattning av resultatet för batchbegäran

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

Name Typ Description
instructionGroups

RouteInstructionGroup[]

Grupperar en sekvens med instruktionselement som är relaterade till varandra.

instructions

RouteInstruction[]

En lista med instruktioner som beskriver manövrar.

RouteInstruction

En uppsättning attribut som beskriver en manöver, t.ex. "Sväng höger", "Håll vänster", "Ta färjan", "Ta motorvägen", "Anländer".

Name Typ Description
combinedMessage

string

Ett läsbart meddelande för manövern kombinerat med meddelandet från nästa instruktion. Ibland är det möjligt att kombinera två efterföljande instruktioner i en enda instruktion som gör det lättare att följa. När så är fallet är flaggan possibleCombineWithNext sann. Exempel:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Flaggan possibleCombineWithNext på instruktion 10 är sann. Detta anger för klienterna i kodad vägledning att den kan kombineras med instruktion 11. Anvisningarna kombineras automatiskt för klienter som begär läsbar vägledning. Fältet combinedMessage innehåller det kombinerade meddelandet:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3 tecken ISO 3166-1 alfa-3 landskod. T.ex. USA.

drivingSide

DrivingSide

Anger vänster kontra höger sida körning vid punkten för manövern.

exitNumber

string

Antalet av en motorvägsavfart som tagits av den nuvarande manövern. Om en utgång har flera avslutsnummer avgränsas de med "" och eventuellt aggregeras med "-", t.ex. "10, 13–15".

instructionType

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

junctionType

JunctionType

Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

maneuver

GuidanceManeuver

En kod som identifierar manövern.

message

string

Ett mänskligt läsbart meddelande för manövern.

point

LatLongPair

En plats som representeras som latitud och longitud.

pointIndex

integer

Indexet för punkten i listan över polyline -punkter som motsvarar instruktionens punkt.

possibleCombineWithNext

boolean

Du kan också kombinera instruktionen med nästa. Detta kan användas för att skapa meddelanden som "Sväng vänster och sedan höger".

roadNumbers

string[]

Vägnummer för nästa betydande vägsegment efter manövern eller de vägar som ska följas. Exempel: ["E34", "N205"]

roundaboutExitNumber

string

Detta anger vilken avfart som ska köras i en rondell.

routeOffsetInMeters

integer

Avstånd från början av vägen till instruktionens punkt.

signpostText

string

Texten på en skylt som är mest relevant för manövern, eller till den riktning som ska följas.

stateCode

string

En underavdelning (t.ex. delstat) i landet, som representeras av den andra delen av en ISO 3166-2-kod . Detta är endast tillgängligt för vissa länder/regioner som USA, Kanada och Mexiko.

street

string

Gatunamn för nästa betydande vägsegment efter manövern, eller på gatan som bör följas.

travelTimeInSeconds

integer

Uppskattad restid upp till den punkt som motsvarar routeOffsetInMeters.

turnAngleInDecimalDegrees

integer

Anger instruktionens riktning. Om junctionType anger en turinstruktion:

  • 180 = U-sväng
  • [-179, -1] = Vänstersväng
  • 0 = Rakt på (en "0 graders" sväng)
  • [1, 179] = Högersväng

Om junctionType anger en bifurcation-instruktion:

  • <0 – behåll vänster
  • >0 – håll dig till höger

RouteInstructionGroup

Grupperar en sekvens med instruktionselement som är relaterade till varandra. Sekvensintervallet är begränsat med firstInstructionIndex och lastInstructionIndex. När textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggas) returneras ett sammanfattningsmeddelande i instruktionsgruppen när det är tillgängligt.

Name Typ Description
firstInstructionIndex

integer

Index för den första instruktionen i anvisningarna och tillhör den här gruppen.

groupLengthInMeters

integer

Gruppens längd.

groupMessage

string

Sammanfattningsmeddelande när textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggade).

lastInstructionIndex

integer

Index för den sista instruktionen i anvisningarna och tillhör den här gruppen.

RouteLeg

En beskrivning av en del av en väg som består av en lista med punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.

Name Typ Description
points

LatLongPair[]

Punktmatris

summary

RouteLegSummary

Sammanfattningsobjekt för routningsavsnittet.

RouteLegSummary

Sammanfattningsobjekt för routningsavsnittet.

Name Typ Description
arrivalTime

string

Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.

batteryConsumptionInkWh

number

Uppskattad elenergiförbrukning i kilowatttimmar (kWh) med hjälp av elförbrukningsmodellen. Ingår om vehicleEngineType är inställt på elektrisk och constantSpeedConsumptionInkWhPerHundredkm har angetts. Värdet för batteryConsumptionInkWh inkluderar den upprymda elenergin och kan därför vara negativ (vilket indikerar att energin ökar). Om både maxChargeInkWh och currentChargeInkWh anges begränsas återställningen för att säkerställa att batteriladdningsnivån aldrig överskrider maxChargeInkWh. Om varken maxChargeInkWh eller currentChargeInkWh anges antas obegränsad återhämtning i förbrukningsberäkningen.

departureTime

string

Den beräknade avgångstiden för rutten eller benet. Tiden är i UTC.

fuelConsumptionInLiters

number

Uppskattad bränsleförbrukning i liter med hjälp av förbränningsförbrukningsmodellen. Ingår om vehicleEngineType är inställt på förbränning och constantSpeedConsumptionInLitersPerHundredkm anges. Värdet blir icke-negativt.

historicTrafficTravelTimeInSeconds

integer

Beräknad restid som beräknas med hjälp av tidsberoende historiska trafikdata. Ingår endast om computeTravelTimeFor = alla används i frågan.

lengthInMeters

integer

Egenskapen Längd i meter

liveTrafficIncidentsTravelTimeInSeconds

integer

Beräknad restid som beräknas med hjälp av hastighetsdata i realtid. Ingår endast om computeTravelTimeFor = alla används i frågan.

noTrafficTravelTimeInSeconds

integer

Beräknad restid beräknad som om det inte finns några förseningar på rutten på grund av trafikförhållanden (t.ex. överbelastning). Ingår endast om computeTravelTimeFor = alla används i frågan.

trafficDelayInSeconds

integer

Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med olika typer av trafikinformation måste parameterberäkningTravelTimeFor=alla läggas till.

travelTimeInSeconds

integer

Uppskattad restid i sekunder som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med hjälp av tidsberoende historiska trafikdata.

RouteOptimizedWaypoint

Optimerat way point-objekt.

Name Typ Description
optimizedIndex

integer

Optimerat vägpunktindex från systemet.

providedIndex

integer

Way point-index som tillhandahålls av användaren.

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

Name Typ Description
effectiveSettings

EffectiveSetting[]

Effektiva parametrar eller data som används när du anropar det här routnings-API:et.

RouteSection

Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen startPointIndex, endPointIndexoch sectionType.

Name Typ Description
delayInSeconds

integer

Fördröjning i sekunder som orsakas av incidenten.

effectiveSpeedInKmh

integer

Effektiv hastighet för incidenten i km/h, i genomsnitt över hela sin längd.

endPointIndex

integer

Index för den sista punkten (offset 0) i den väg som det här avsnittet gäller för.

magnitudeOfDelay

DelayMagnitude

Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältets ty i API:et Hämta information om trafikincidenter.

sectionType

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

simpleCategory

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".

startPointIndex

integer

Index för den första punkten (förskjutning 0) i den väg som det här avsnittet gäller för.

tec

RouteSectionTec

Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.

travelMode

ResponseTravelMode

Reseläge för den beräknade rutten. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

RouteSectionTec

Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.

Name Typ Description
causes

RouteSectionTecCause[]

Orsaksmatris

effectCode

integer

Effekten på trafikflödet. Innehåller ett värde i tabellen tec001:EffectCode enligt definitionen i TPEG2-TEC-standarden . Kan användas för att färgkoda trafikhändelser efter allvarlighetsgrad.

RouteSectionTecCause

Orsaken till trafikhändelsen. Kan innehålla elementen mainCauseCode och subCauseCode. Kan användas för att definiera ikonografi och beskrivningar.

Name Typ Description
mainCauseCode

integer

Den främsta orsaken till trafikhändelsen. Innehåller ett värde i tabellen tec002:CauseCode enligt definitionen i TPEG2-TEC-standarden .

subCauseCode

integer

Undercause för trafikhändelsen. Innehåller ett värde i underorsakstabellen som definieras av mainCauseCode, enligt definitionen i TPEG2-TEC-standarden .

RouteSummary

Sammanfattningsobjekt

Name Typ Description
arrivalTime

string

Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.

departureTime

string

Den beräknade avgångstiden för rutten eller benet. Tiden är i UTC.

lengthInMeters

integer

Egenskapen Längd i meter

trafficDelayInSeconds

integer

Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med olika typer av trafikinformation måste parameterberäkningTravelTimeFor=alla läggas till.

travelTimeInSeconds

integer

Uppskattad restid i sekunder som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med hjälp av tidsberoende historiska trafikdata.

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Se "tec" för detaljerad information.

Name Typ Description
JAM

string

Trafikstockning.

OTHER

string

Annat.

ROAD_CLOSURE

string

Vägavstängning.

ROAD_WORK

string

Vägarbete.

Summary

Sammanfattning av resultatet för batchbegäran

Name Typ Description
successfulRequests

integer

Antal lyckade begäranden i batchen

totalRequests

integer

Totalt antal begäranden i batchen