Route - Post Route Matrix

Umožňuje získat matici tras zobrazující dobu cesty a vzdálenost pro všechny možné páry v seznamu původů a cílů pomocí asynchronního požadavku.

Rozhraní Post Route Matrix API je požadavek HTTP POST , který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných počátečními a cílovými umístěními pomocí asynchronního (asynchronního) požadavku. Pokud chcete vytvořit synchronní (synchronizační) požadavek, přečtěte si téma Post Route Matrix Sync. Pro každý daný zdroj služba vypočítá náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a sadu cílů si lze představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle pro danou buňku. Řekněme například, že společnost, která má rozvoz jídla, má 20 řidičů a potřebuje najít nejbližšího řidiče, který si vyzvedne dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API směrování matice.

Pro každou trasu se vrátí časy jízdy a vzdálenosti. Vypočítané náklady můžete použít k určení podrobných tras, které se mají vypočítat, pomocí rozhraní API Trasy.

Maximální velikost matice pro asynchronní požadavek je 700 a pro požadavek synchronizace je to 100 (počet původů vynásobený počtem cílů).

Odeslání synchronní žádosti o matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných rozměrů matice: 10x10, 6x8, 9x8 (nemusí být čtvercové).

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

Odeslání asynchronního požadavku matice směrování

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 spolu s adresou URL pro přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Pokud waitForResults je parametr v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

Maximální velikost matice pro toto rozhraní API je 700 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 50x10, 10x10, 28x25. 10x70 (nemusí být čtvercové).

Asynchronní odpovědi se ukládají po dobu 14 dnů. Adresa URL přesměrování vrátí odpověď 404, pokud se použije po uplynutí období vypršení platnosti.

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

Tady je typická posloupnost asynchronních operací:

  1. Klient odešle požadavek POST matice směrování do Azure Maps

  2. Server odpoví jedním z následujících způsobů:

    HTTP 202 Accepted – Byl přijat požadavek na matici směrování.

    HTTP Error – Při zpracování požadavku Matice směrování došlo k chybě. Může se jednat o chybný požadavek 400 nebo jiný stavový kód chyby.

  3. Pokud byl požadavek matice trasy úspěšně přijat, hlavička Location v odpovědi obsahuje adresu URL pro stažení výsledků požadavku. Tento identifikátor URI stavu vypadá takto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient vydá požadavek GET na adresu URL pro stažení získanou v kroku 3, aby si stáhl výsledky.

Stáhnout výsledky synchronizace

Když vytvoříte požadavek POST pro rozhraní API synchronizace matice směrování, vrátí služba kód odpovědi 200 pro úspěšný požadavek a pole odpovědí. Tělo odpovědi bude obsahovat data a později nebude možné načíst výsledky.

Stáhnout asynchronní výsledky

Když požadavek vydá 202 Accepted odpověď, zpracovává se pomocí našeho asynchronního kanálu. Dostanete adresu URL ke kontrole průběhu asynchronního požadavku v hlavičce umístění odpovědi. Tento identifikátor URI stavu vypadá takto:

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

Adresa URL zadaná hlavičkou umístění vrátí následující odpovědi při GET vystavení požadavku.

HTTP 202 Accepted – Požadavek matice byl přijat, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.

HTTP 200 OK – Požadavek matice se úspěšně zpracoval. Text odpovědi obsahuje všechny výsledky.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0
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}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
path True

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

api-version
query True

string

Číslo verze rozhraní API Azure Maps.

arriveAt
query

string

date-time

Datum a čas příjezdu do cílového bodu formátované jako hodnota definovaná dateTime v dokumentu RFC 3339, oddíl 5.6, s volitelným posunem časového pásma. Pokud není zadaný posun časového pásma, předpokládá se, že se jedná o posun cílového bodu.

Příklady:

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

Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.

avoid
query

RouteAvoidType[]

Určuje něco, čeho by se měl výpočet trasy při určování trasy snažit vyhnout. V jednom požadavku je možné zadat vícekrát, například "&avoid=motorways&avoid=tollRoads&avoid=ferries". V požadavcích na rozsah tras nesmí být použita hodnota alreadyUsedRoads.

computeTravelTimeFor
query

ComputeTravelTime

Určuje, zda se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádný, historický, živý) a výchozího nejlepšího odhadu doby cesty.

departAt
query

string

date-time

Datum a čas odjezdu od počátečního bodu naformátované jako hodnota definovaná dateTime v dokumentu RFC 3339, oddíl 5.6, s volitelným posunem časového pásma. Pokud není zadaný posun časového pásma, předpokládá se, že je posunem počátečního bodu.

  • Výchozí hodnota: teď
  • Jiná hodnota: dateTime

Příklady:

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

Parametr departAt nelze použít ve spojení s parametrem arriveAt.

hilliness
query

InclineLevel

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr se dá použít pouze ve spojení s parametrem routeType=thrilling.

routeType
query

RouteType

Typ požadované trasy.

sectionType
query

SectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi na trasu.

Pokud například sectionType = pěší, vrátí se úseky, které jsou vhodné pouze pro chodce. Je možné použít více typů. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastavený na auto.

traffic
query

boolean

Možné hodnoty:

  • true – Při směrování zvažte všechny dostupné informace o provozu.
  • false – ignoruje aktuální data provozu během směrování. Všimněte si, že i když se aktuální data o provozu během směrování ignorují, vliv historického provozu na efektivní rychlost silnic je stále začleněný.
travelMode
query

TravelMode

Režim jízdy pro požadovanou trasu. Pokud není definováno, výchozí hodnota je "auto". Upozorňujeme, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro konkrétní oddíl k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že režimy cestování autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou k dispozici ve všech oblastech.

vehicleAxleWeight
query

integer

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nepřihlíží k hmotnostním omezením na nápravu.

vehicleHeight
query

number

double

Výška vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení výšky.

vehicleLength
query

number

double

Délka vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení délky.

vehicleLoadType
query

VehicleLoadType

Druhy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny z některých silnic. Dostupné hodnoty vehicleLoadType jsou americké třídy Hazmat 1 až 9 a navíc obecné klasifikace pro použití v jiných zemích nebo oblastech. Hodnoty začínající na USHazmat jsou pro směrování v USA, zatímco ostatníHazmat by se měly používat pro všechny ostatní země nebo oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr se v současné době uvažuje pouze pro travelMode=truck.

vehicleMaxSpeed
query

integer

Maximální rychlost vozidla v km/hod. Maximální rychlost v profilu vozidla se používá ke kontrole, zda je vozidlo povoleno na dálnicích.

  • Hodnota 0 znamená, že při plánování trasy bude určena a uplatněna odpovídající hodnota pro vozidlo.

  • Během plánování trasy může být přepsána nenulová hodnota. Aktuální tok provozu je například 60 km/h. Pokud je maximální rychlost vozidla nastavená na 50 km/h, bude směrovací motor brát v úvahu 60 km/h, protože se jedná o aktuální situaci. Pokud je maximální rychlost vozidla 80 km/h, ale aktuální dopravní tok je 60 km/h, bude směrovací motor opět používat 60 km/h.

vehicleWeight
query

integer

Hmotnost vozidla v kilogramech.

vehicleWidth
query

number

double

Šířka vozidla v metrech. Hodnota 0 znamená, že omezení šířky nejsou brána v úvahu.

waitForResults
query

boolean

Logická hodnota označující, jestli se má požadavek spustit synchronně. Pokud je nastavená hodnota true, uživatel obdrží odpověď 200, pokud je požadavek dokončen pod 120 sekund. V opačném případě uživatel dostane okamžitě odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API. Podporováno pouze pro asynchronní požadavek.

windingness
query

WindingnessLevel

Úroveň zatáček pro vzrušující trasu. Tento parametr se dá použít pouze ve spojení s parametrem routeType=thrilling.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Text požadavku

Name Typ Description
destinations

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

origins

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Odpovědi

Name Typ Description
200 OK

RouteMatrixResult

Požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.

202 Accepted

Podporuje se pouze pro asynchronní požadavek. Žádost byla přijata: Žádost byla přijata ke zpracování. K opakování nebo získání přístupu k výsledkům použijte adresu URL v hlavičce umístění.

Headers

Location: string

Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

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

Jedná se o sdílený klíč, který se zřídí při Create účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Type: apiKey
In: header

Příklady

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

{
  "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
  }
}
operation-Location: New URL to check the status of the long-running operation.

Definice

Name Description
ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty s použitím různých typů informací o provozu (žádný, historický, živý) a výchozího nejlepšího odhadu doby cesty.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

InclineLevel

Stupeň kopcovitosti pro vzrušující cestu. Tento parametr lze použít pouze ve spojení s parametrem routeType=thrilling.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

RouteAvoidType

Určuje něco, čeho by se měl výpočet trasy při určování trasy snažit vyhnout. V jednom požadavku lze zadat vícekrát, například "&avoid=motorways&avoid=tollRoads&avoid=ferries". V požadavcích na rozsah tras nesmí být použita hodnota alreadyUsedRoads.

RouteLegSummary

Souhrnný objekt pro oddíl trasy.

RouteMatrix

Objekt výsledku matice

RouteMatrixQuery

Objekt s maticí souřadnic.

RouteMatrixResult

Tento objekt je vrácen z úspěšného volání Matice směrování. Pokud jsou například k dispozici 2 počátky a 3 cíle, budou v každém z nich 2 pole se 3 prvky. Obsah jednotlivých elementů závisí na možnostech zadaných v dotazu.

RouteMatrixResultResponse

Objekt odpovědi aktuální buňky ve vstupní matici.

RouteMatrixSummary

Souhrnný objekt

RouteType

Typ požadované trasy.

SectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi na trasu.

Pokud například sectionType = chodec, vrátí se oddíly, které jsou vhodné pouze pro chodce. Je možné použít více typů. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastavený na car.

TravelMode

Režim cesty pro požadovanou trasu. Pokud není definováno, výchozí hodnota je "car". Upozorňujeme, že požadovaný režim travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není k dispozici pro konkrétní oddíl, bude prvek travelMode odpovědi pro tento oddíl "jiný". Upozorňujeme, že režimy cestování autobus, motocykl, taxi a dodávka jsou beta funkce. Úplná data omezení nejsou k dispozici ve všech oblastech.

VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některých silnicích. Dostupné hodnoty vehicleLoadType jsou americké třídy Hazmat 1 až 9 a navíc obecné klasifikace pro použití v jiných zemích nebo oblastech. Hodnoty začínající na USHazmat jsou určené pro směrování do USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země nebo oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr se v současné době zvažuje pouze pro travelMode=truck.

WindingnessLevel

Úroveň zatáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s parametrem routeType=thrilling.

ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty s použitím různých typů informací o provozu (žádný, historický, živý) a výchozího nejlepšího odhadu doby cesty.

Name Typ Description
all

string

Vypočítá dobu trvání cesty pro všechny typy informací o provozu a určuje všechny výsledky v polích noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds a liveTrafficIncidentsTravelTimeInSeconds zahrnutých v souhrnech v odpovědi na trasu.

none

string

Nevypočítá další doby trvání cesty.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

GeoJson MultiPoint Souřadnice geometrie.

type string:

MultiPoint

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

InclineLevel

Stupeň kopcovitosti pro vzrušující cestu. Tento parametr lze použít pouze ve spojení s parametrem routeType=thrilling.

Name Typ Description
high

string

high

low

string

Nízké

normal

string

Normální

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name Typ Description
json

string

Formát výměny dat zápisu objektů JavaScriptu

RouteAvoidType

Určuje něco, čeho by se měl výpočet trasy při určování trasy snažit vyhnout. V jednom požadavku lze zadat vícekrát, například "&avoid=motorways&avoid=tollRoads&avoid=ferries". V požadavcích na rozsah tras nesmí být použita hodnota alreadyUsedRoads.

Name Typ Description
alreadyUsedRoads

string

Vyhne se použití stejné cesty vícekrát. Nejužitečnější ve spojení s routeType=vzrušující.

borderCrossings

string

Vyhýbá se překračování hranic ve výpočtu tras.

carpools

string

Vyhýbá se trasám, které vyžadují použití jízdních pruhů HOV /High Occupancy Vehicle( HOV/ High Occupancy Vehicle).

ferries

string

Vyhýbá se trajektům

motorways

string

Vyhýbá se dálnici

tollRoads

string

Vyhýbá se placeným silnicm.

unpavedRoads

string

Vyhýbá se nezpavovaným cestám.

RouteLegSummary

Souhrnný objekt pro oddíl trasy.

Name Typ Description
arrivalTime

string

Odhadovaný čas příjezdu na trasu nebo úsek. Čas je ve standardu UTC.

batteryConsumptionInkWh

number

Odhadovaná spotřeba elektrické energie v kilowatthodinách (kWh) s využitím modelu elektrické spotřeby Zahrnuje, pokud je vlastnost vehicleEngineType nastavená na elektrický a je zadána konstantaSpeedConsumptionInkWhPerHundredkm. Hodnota batteryConsumptionInkWh zahrnuje recuperated elektrickou energii, a proto může být negativní (což značí získávání energie). Pokud jsou zadány hodnoty maxChargeInkWh i currentChargeInkWh, bude rekuperace omezena, aby se zajistilo, že úroveň nabití baterie nikdy nepřekročí maxChargeInkWh. Pokud není zadána hodnota maxChargeInkWh ani currentChargeInkWh, předpokládá se ve výpočtu spotřeby neomezená rekuperace.

departureTime

string

Odhadovaný čas odjezdu trasy nebo úseku. Čas je ve standardu UTC.

fuelConsumptionInLiters

number

Odhadovaná spotřeba paliva v litrech pomocí modelu spotřeby spalování. Zahrnuje, pokud je vlastnost vehicleEngineType nastavená na spalování a je zadána konstantaSpeedConsumptionInLitersPerHundredkm. Hodnota nebude záporná.

historicTrafficTravelTimeInSeconds

integer

Odhadovaná doba trvání cesty vypočítaná na základě historických dopravních dat závislých na čase Zahrne se jenom v případě, že se v dotazu použije computeTravelTimeFor = all.

lengthInMeters

integer

Vlastnost Length In Meters

liveTrafficIncidentsTravelTimeInSeconds

integer

Odhadovaná doba trvání cesty vypočítaná pomocí dat o rychlosti v reálném čase Zahrne se jenom v případě, že se v dotazu použije computeTravelTimeFor = all.

noTrafficTravelTimeInSeconds

integer

Odhadovaná doba trvání cesty vypočítaná, jako by na trase nedošlo k žádnému zpoždění kvůli dopravním podmínkám (např. zahlcení). Zahrne se jenom v případě, že se v dotazu použije computeTravelTimeFor = all.

trafficDelayInSeconds

integer

Odhadované zpoždění v sekundách způsobené incidenty v reálném čase podle informací o provozu U tras plánovaných s časem odjezdu v budoucnu je zpoždění vždy 0. Pokud chcete vrátit další doby cesty pomocí různých typů informací o provozu, je potřeba přidat parametr computeTravelTimeFor=all.

travelTimeInSeconds

integer

Odhadovaná doba trvání cesty v sekundách, která zahrnuje zpoždění způsobené provozem v reálném čase. Mějte na paměti, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění způsobené provozem. Pokud je DepartAt v budoucnosti, doba trvání cesty se počítá na základě historických dopravních dat závislých na čase.

RouteMatrix

Objekt výsledku matice

Name Typ Description
response

RouteMatrixResultResponse

Objekt odpovědi aktuální buňky ve vstupní matici.

statusCode

integer

StatusCode Vlastnost pro aktuální buňku ve vstupní matici.

RouteMatrixQuery

Objekt s maticí souřadnic.

Name Typ Description
destinations

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

origins

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

RouteMatrixResult

Tento objekt je vrácen z úspěšného volání Matice směrování. Pokud jsou například k dispozici 2 počátky a 3 cíle, budou v každém z nich 2 pole se 3 prvky. Obsah jednotlivých elementů závisí na možnostech zadaných v dotazu.

Name Typ Description
formatVersion

string

Vlastnost Formát verze

matrix

RouteMatrix[]

Výsledky jako 2rozměrné pole souhrnů tras.

summary

RouteMatrixSummary

Souhrnný objekt

RouteMatrixResultResponse

Objekt odpovědi aktuální buňky ve vstupní matici.

Name Typ Description
routeSummary

RouteLegSummary

Souhrnný objekt pro oddíl trasy.

RouteMatrixSummary

Souhrnný objekt

Name Typ Description
successfulRoutes

integer

Počet úspěšných tras v odpovědi

totalRoutes

integer

Celkový počet požadovaných tras Počet buněk ve vstupní matici

RouteType

Typ požadované trasy.

Name Typ Description
eco

string

Cesta vyvážená ekonomikou a rychlostí.

fastest

string

Nejrychlejší trasa.

shortest

string

Nejkratší trasa podle vzdálenosti.

thrilling

string

Zahrnuje zajímavé nebo náročné silnice a využívá co nejméně dálnic. Můžete zvolit úroveň zatáčky a také stupeň kopcovitosti. Informace o tom, jak to nastavit, najdete v parametrech hillness a windingness. Na trasách je naplánovaný limit 900 km s routeTypevzrušujícím

SectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi na trasu.

Pokud například sectionType = chodec, vrátí se oddíly, které jsou vhodné pouze pro chodce. Je možné použít více typů. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastavený na car.

Name Typ Description
carTrain

string

Úseky trasy, které jsou osobními nebo vlaky.

carpool

string

Úseky trasy, které vyžadují použití jízdních pruhů pro vozidla s vysokou obsazeností.

country

string

Oddíly označující, ve kterých zemích nebo oblastech se trasa nachází.

ferry

string

Části trasy, které jsou trajekty.

motorway

string

Úseky trasy, které jsou dálnicemi.

pedestrian

string

Úseky trasy, které jsou vhodné pouze pro pěší.

tollRoad

string

Úseky trasy, které vyžadují zaplacení placené linky.

tollVignette

string

Úseky trasy, které vyžadují placenou dálniční známku.

traffic

string

Části trasy, které obsahují informace o provozu.

travelMode

string

Oddíly ve vztahu k parametru travelModepožadavku .

tunnel

string

Části trasy, které jsou tunely.

urban

string

Úseky trasy, které se nacházejí v městských oblastech.

TravelMode

Režim cesty pro požadovanou trasu. Pokud není definováno, výchozí hodnota je "car". Upozorňujeme, že požadovaný režim travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není k dispozici pro konkrétní oddíl, bude prvek travelMode odpovědi pro tento oddíl "jiný". Upozorňujeme, že režimy cestování autobus, motocykl, taxi a dodávka jsou beta funkce. Úplná data omezení nejsou k dispozici ve všech oblastech.

Name Typ Description
bicycle

string

Vrácené trasy jsou optimalizované pro jízdní kola, včetně použití cyklostezek.

bus

string

Vrácené trasy jsou optimalizované pro autobusy, včetně použití jízdních pruhů pouze pro autobusy. Beta funkce.

car

string

Vrácené trasy jsou optimalizované pro auta.

motorcycle

string

Vrácené trasy jsou optimalizované pro motocykly. Beta funkce.

pedestrian

string

Vrácené trasy jsou optimalizované pro chodce, včetně použití chodníků.

taxi

string

Vrácené trasy jsou optimalizované pro taxislužby. Beta funkce.

truck

string

Vrácené trasy jsou optimalizované pro užitková vozidla, například pro nákladní vozy.

van

string

Vrácené trasy jsou optimalizované pro dodávky. Beta funkce.

VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některých silnicích. Dostupné hodnoty vehicleLoadType jsou americké třídy Hazmat 1 až 9 a navíc obecné klasifikace pro použití v jiných zemích nebo oblastech. Hodnoty začínající na USHazmat jsou určené pro směrování do USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země nebo oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr se v současné době zvažuje pouze pro travelMode=truck.

Name Typ Description
USHazmatClass1

string

Výbušniny

USHazmatClass2

string

Stlačený plyn

USHazmatClass3

string

Hořlavé kapaliny

USHazmatClass4

string

Hořlavé pevné látky

USHazmatClass5

string

Oxidační prostředky

USHazmatClass6

string

Jedy

USHazmatClass7

string

Radioaktivní látky

USHazmatClass8

string

Žíravé

USHazmatClass9

string

Různé

otherHazmatExplosive

string

Výbušniny

otherHazmatGeneral

string

Různé

otherHazmatHarmfulToWater

string

Škodlivé pro vodu

WindingnessLevel

Úroveň zatáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s parametrem routeType=thrilling.

Name Typ Description
high

string

high

low

string

Nízké

normal

string

Normální