Route - Post Route Matrix

  • Referens
Service:
Maps
API Version:
1.0

Använd för att hämta en routningsmatris som visar restiden och avståndet för alla möjliga par i en lista över ursprung och mål med hjälp av en asynkron begäran.

API:et Post Route Matrix är en HTTP-begäran POST som gör det möjligt att beräkna en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprung och målplatser med hjälp av en asynkron (asynkron) begäran. Information om hur du gör en synkron (synkron) begäran finns i Synkronisera efter routningsmatris. För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Ursprungsuppsättningen och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje rutt returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Route Directions.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100 kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer av relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en async-begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

De asynkrona svaren lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

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

    HTTP 202 Accepted – Begäran om routningsmatris har accepterats.

    HTTP Error – Det uppstod ett fel när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran godkändes innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i platshuvudet för svaret. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

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

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0
With optional parameters: 
POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI-parametrar

Name I Obligatorisk Typ Description
format
 path True

JsonFormat

Önskat format för svaret. Endast json format stöds.
api-version
 query True

string

Versionsnummer för Azure Maps API.
arriveAt
 query

string

date-time

Datum och tid för ankomst till målplatsen formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas den vara målpunktens.

Exempel:

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

Parametern arriveAt kan inte användas tillsammans med departAt, minDeviationDistance eller minDeviationTime.
avoid
 query

RouteAvoidType[]

Anger något som vägberäkningen ska försöka undvika när du fastställer vägen. Kan anges flera gånger i en begäran, till exempel "&avoid=motorways&avoid=tollRoads&avoid=ferries". I Begäranden om routningsintervall får värdet redanUsedRoads inte användas.
computeTravelTimeFor
 query

ComputeTravelTime

Anger om du vill returnera ytterligare restider med hjälp av olika typer av trafikinformation (ingen, historisk, live) samt bästa möjliga restid.
departAt
 query

string

date-time

Datum och tid för avresa från ursprungspunkten formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas det vara ursprungspunktens.

  • Standardvärde: nu
  • Annat värde: dateTime

Exempel:

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

Parametern departAt kan inte användas tillsammans med arriveAt.
hilliness
 query

InclineLevel

Grad av bergighet för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.
routeType
 query

RouteType

Den typ av väg som begärs.
sectionType
 query

SectionType

Anger vilken av avsnittstyperna som rapporteras i routningssvaret.

Till exempel om sectionType = fotgängare de sektioner som är lämpade för fotgängare endast returneras. Flera typer kan användas. StandardavsnittTypen refererar till travelMode-indata. Som standard är travelMode inställt på bil
traffic
 query

boolean

Möjliga värden:

  • true – Överväg all tillgänglig trafikinformation under routning
  • false – Ignorera aktuella trafikdata under routning. Observera att även om aktuella trafikdata ignoreras under routningen införlivas fortfarande effekten av historisk trafik på effektiva väghastigheter.
travelMode
 query

TravelMode

Färdsätt för den begärda rutten. Om det inte definieras är standardvärdet "bil". Observera att den begärda travelMode kanske inte är tillgänglig för hela vägen. Om den begärda travelMode inte är tillgänglig för ett visst avsnitt är travelMode-elementet i svaret för det avsnittet "annat". Observera att färdlägena buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.
vehicleAxleWeight
 query

integer

Fordonets vikt per axel i kg. Värdet 0 innebär att viktbegränsningar per axel inte beaktas.
vehicleHeight
 query

number

double

Fordonets höjd i meter. Värdet 0 innebär att höjdbegränsningar inte beaktas.
vehicleLength
 query

number

double

Fordonets längd i meter. Värdet 0 innebär att längdbegränsningar inte beaktas.
vehicleLoadType
 query

VehicleLoadType

Typer av last som kan klassificeras som farligt material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till och med 9, plus generiska klassificeringar för användning i andra länder/regioner. Värden som börjar med USHazmat är för USA-routning medan andraHazmat ska användas för alla andra länder/regioner. vehicleLoadType kan anges flera gånger. Den här parametern beaktas för närvarande endast för travelMode=truck.
vehicleMaxSpeed
 query

integer

Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon är tillåtet på motorvägar.

  • Värdet 0 innebär att ett lämpligt värde för fordonet bestäms och tillämpas under ruttplaneringen.

  • Ett värde som inte är noll kan åsidosättas under routningsplaneringen. Det aktuella trafikflödet är till exempel 60 km/timme. Om fordonets högsta hastighet är inställd på 50 km/timme, kommer routningsmotorn att överväga 60 km/timme eftersom detta är den aktuella situationen. Om fordonets högsta hastighet anges som 80 km/timme, men det aktuella trafikflödet är 60 km/timme, kommer routningsmotorn återigen att använda 60 km/timme.
vehicleWeight
 query

integer

Fordonets vikt i kg.
vehicleWidth
 query

number

double

Fordonets bredd i meter. Värdet 0 innebär att breddbegränsningar inte beaktas.
waitForResults
 query

boolean

Booleskt värde för att ange om begäran ska köras synkront. Om värdet är true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder. Annars får användaren ett 202-svar direkt. Mer information om 202-svaret finns i API-beskrivningen. Stöds endast för asynkron begäran.
windingness
 query

WindingnessLevel

Nivå av svängar för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

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. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

Name Typ Description
destinations

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .
origins

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Svar

Name Typ Description
200 OK

RouteMatrixResult

Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
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 ett 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 ha å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-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure 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 Skapa ett Azure Maps konto i Azure Portal eller med hjälp av 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 huvudnyckel i det konto som de har utfärdats 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully submit a route matrix request

Sample Request

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:
200 
{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}
Status code:
202 
operation-Location: New URL to check the status of the long-running operation.

Definitioner

Name Description
ComputeTravelTime

Anger om du vill returnera ytterligare restider med olika typer av trafikinformation (ingen, historisk, live) samt bästa möjliga restid.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .
InclineLevel

Grad av bergighet för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.
JsonFormat

Önskat format för svaret. Endast json format stöds.
RouteAvoidType

Anger något som vägberäkningen bör försöka undvika när du fastställer vägen. Kan anges flera gånger i en begäran, till exempel "&avoid=motorways&avoid=tollRoads&avoid=ferries". I Begäranden om routningsintervall får värdet alreadyUsedRoads inte användas.
RouteLegSummary

Sammanfattningsobjekt för routningsavsnittet.
RouteMatrix

Matrisresultatobjekt
RouteMatrixQuery

Ett objekt med en matris med koordinater.
RouteMatrixResult

Det här objektet returneras från ett lyckat Route Matrix-anrop. Om till exempel 2 ursprung och 3 mål tillhandahålls kommer det att finnas 2 matriser med 3 element i varje. Varje elements innehåll beror på de alternativ som anges i frågan.
RouteMatrixResultResponse

Svarsobjekt för den aktuella cellen i indatamatrisen.
RouteMatrixSummary

Sammanfattningsobjekt
RouteType

Den typ av väg som begärs.
SectionType

Anger vilken av avsnittstyperna som rapporteras i vägsvaret.

Till exempel om sectionType = fotgängare de sektioner som passar för fotgängare endast returneras. Flera typer kan användas. Standard-sectionType refererar till travelMode-indata. Som standard är travelMode inställt på bil
TravelMode

Färdmedel för den begärda rutten. Om det inte definieras är standardvärdet "car". Observera att den begärda travelMode kanske inte är tillgänglig för hela rutten. Om den begärda travelMode inte är tillgänglig för ett visst avsnitt, kommer travelMode-elementet i svaret för det avsnittet att vara "annat". Observera att reslägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.
VehicleLoadType

Typer av last som kan klassificeras som farliga material och begränsas från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till och med 9, plus generiska klassificeringar för användning i andra länder/regioner. Värden som börjar med USHazmat är för USA-routning medan andraHazmat ska användas för alla andra länder/regioner. vehicleLoadType kan anges flera gånger. Den här parametern beaktas för närvarande endast för travelMode=truck.
WindingnessLevel

Nivå av svängar för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

ComputeTravelTime

Anger om du vill returnera ytterligare restider med olika typer av trafikinformation (ingen, historisk, live) samt bästa möjliga restid.

Name Typ Description
all

string

Beräknar restider för alla typer av trafikinformation och anger alla resultat i fälten noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds och liveTrafficIncidentsTravelTimeInSeconds som ingår i sammanfattningarna i vägsvaret.
none

string

Beräknar inte ytterligare restider.

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.

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Koordinater för GeoJson MultiPoint geometrin.
type string:

MultiPoint

Anger GeoJSON typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

InclineLevel

Grad av bergighet för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

Name Typ Description
high

string

hög
low

string

Låg
normal

string

Normal

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name Typ Description
json

string

Datautbytesformat för JavaScript-objektnotation

RouteAvoidType

Anger något som vägberäkningen bör försöka undvika när du fastställer vägen. Kan anges flera gånger i en begäran, till exempel "&avoid=motorways&avoid=tollRoads&avoid=ferries". I Begäranden om routningsintervall får värdet alreadyUsedRoads inte användas.

Name Typ Description
alreadyUsedRoads

string

Undviker att använda samma väg flera gånger. Mest användbart tillsammans med routeType=spännande.
borderCrossings

string

Undviker gränsövergångar i vägberäkningen.
carpools

string

Undviker vägar som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).
ferries

string

Undviker färjor
motorways

string

Undviker motorvägar
tollRoads

string

Undviker avgiftsbelagda vägar.
unpavedRoads

string

Undviker osparade vägar

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 kilowattimmar (kWh) med hjälp av modellen för elektrisk förbrukning. Ingår om vehicleEngineType är inställt på elektrisk och constantSpeedConsumptionInkWhPerHundredkm anges. Värdet för batteryConsumptionInkWh inkluderar den återhämtningsbara 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.

RouteMatrix

Matrisresultatobjekt

Name Typ Description
response

RouteMatrixResultResponse

Svarsobjekt för den aktuella cellen i indatamatrisen.
statusCode

integer

StatusCode-egenskapen för den aktuella cellen i indatamatrisen.

RouteMatrixQuery

Ett objekt med en matris med koordinater.

Name Typ Description
destinations

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .
origins

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

RouteMatrixResult

Det här objektet returneras från ett lyckat Route Matrix-anrop. Om till exempel 2 ursprung och 3 mål tillhandahålls kommer det att finnas 2 matriser med 3 element i varje. Varje elements innehåll beror på de alternativ som anges i frågan.

Name Typ Description
formatVersion

string

Formatversionsegenskap
matrix

RouteMatrix[]

Resultat som en 2-dimensionell matris med vägsammanfattningar.
summary

RouteMatrixSummary

Sammanfattningsobjekt

RouteMatrixResultResponse

Svarsobjekt för den aktuella cellen i indatamatrisen.

Name Typ Description
routeSummary

RouteLegSummary

Sammanfattningsobjekt för routningsavsnittet.

RouteMatrixSummary

Sammanfattningsobjekt

Name Typ Description
successfulRoutes

integer

Antal lyckade vägar i svaret.
totalRoutes

integer

Totalt antal begärda vägar. Antal celler i indatamatrisen.

RouteType

Den typ av väg som begärs.

Name Typ Description
eco

string

En väg balanserad av ekonomi och hastighet.
fastest

string

Den snabbaste rutten.
shortest

string

Den kortaste rutten med avstånd.
thrilling

string

Innehåller intressanta eller utmanande vägar och använder så få motorvägar som möjligt. Du kan välja vilken nivå av svängar som ingår och även graden av bergighet. Se parametrarna för hilliness och windingness för hur du ställer in detta. Det finns en gräns på 900 km på rutter planerade med routeType= spännande

SectionType

Anger vilken av avsnittstyperna som rapporteras i vägsvaret.

Till exempel om sectionType = fotgängare de sektioner som passar för fotgängare endast returneras. Flera typer kan användas. Standard-sectionType refererar till travelMode-indata. Som standard är travelMode inställt på bil

Name Typ Description
carTrain

string

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

string

Delar av rutten som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).
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.
tollRoad

string

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

string

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

string

Delar av vägen som innehåller trafikinformation.
travelMode

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.

TravelMode

Färdmedel för den begärda rutten. Om det inte definieras är standardvärdet "car". Observera att den begärda travelMode kanske inte är tillgänglig för hela rutten. Om den begärda travelMode inte är tillgänglig för ett visst avsnitt, kommer travelMode-elementet i svaret för det avsnittet att vara "annat". Observera att reslägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.

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

VehicleLoadType

Typer av last som kan klassificeras som farliga material och begränsas från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till och med 9, plus generiska klassificeringar för användning i andra länder/regioner. Värden som börjar med USHazmat är för USA-routning medan andraHazmat ska användas för alla andra länder/regioner. vehicleLoadType kan anges flera gånger. Den här parametern beaktas för närvarande endast för travelMode=truck.

Name Typ Description
USHazmatClass1

string

Explosiva ämnen och föremål
USHazmatClass2

string

Komprimerad gas
USHazmatClass3

string

Brandfarliga vätskor
USHazmatClass4

string

Brandfarliga fasta ämnen
USHazmatClass5

string

Oxidatorer
USHazmatClass6

string

Gifter
USHazmatClass7

string

Radioaktiva ämnen
USHazmatClass8

string

Frätande
USHazmatClass9

string

Övriga farliga ämnen
otherHazmatExplosive

string

Explosiva ämnen och föremål
otherHazmatGeneral

string

Övriga farliga ämnen
otherHazmatHarmfulToWater

string

Skadligt för vatten

WindingnessLevel

Nivå av svängar för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

Name Typ Description
high

string

hög
low

string

Låg
normal

string

Normal