Sdílet prostřednictvím

Route - Post Route Matrix Sync

  • Reference
Služba:
Maps
Verze rozhraní API:
1.0

Umožňuje získat matici tras zobrazující dobu cesty a vzdálenost pro všechny možné páry v seznamu původu a cílů pomocí synchronní žádosti.

Rozhraní API Post Route Matrix Sync je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí jediné synchronní (synchronizační) žádosti. Pokud chcete vytvořit asynchronní (asynchronní) požadavek, přečtěte si téma Post Route Matrix. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete 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 dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na 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 dimenzí 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í požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. Když provedete požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by se měla pravidelně kontrolovat, dokud nebudou k dispozici data odpovědí nebo informace o chybě. Pokud je parametr waitForResults 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 24 hodin. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po uplynutí doby 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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

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

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci 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é výsledky načíst.

Stažení asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh 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 vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0
S volitelnými parametry: 
POST https://atlas.microsoft.com/route/matrix/sync/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 služby Azure Maps
arriveAt
 query

string

date-time

Datum a čas doručení v cílovém bodě formátovaný jako hodnota dateTime definovaná v RFC 3339, oddíl 5.6s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o cílový bod.

Příklady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

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

RouteAvoidType[]

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.
computeTravelTimeFor
 query

ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.
departAt
 query

string

date-time

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

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

Příklady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

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

InclineLevel

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

RouteType

Typ požadované trasy.
sectionType
 query

SectionType[]

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

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto
traffic
 query

boolean

Možné hodnoty:

  • true – Zvažte všechny dostupné informace o provozu během směrování.
  • false – Během směrování ignorujte aktuální data provozu. Mějte na paměti, že i když se aktuální data provozu během směrování ignorují, vliv historického provozu na efektivní rychlosti silničního provozu je stále začleněn.
travelMode
 query

TravelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.
vehicleAxleWeight
 query

integer

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nebere v úvahu omezení hmotnosti na nápravu.
vehicleHeight
 query

number

double

Výška vozidla v metrech. Hodnota 0 znamená, že se omezení výšky nepovažují.
vehicleLength
 query

number

double

Délka vozidla v metrech. Hodnota 0 znamená, že omezení délky se nepovažují.
vehicleLoadType
 query

VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.
vehicleMaxSpeed
 query

integer

Maximální rychlost vozidla v km/hodině. Maximální rychlost 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 se určí a použije příslušná hodnota pro vozidlo.

  • Během plánování trasy může být přepsána nenulová hodnota. Například aktuální tok provozu je 60 km/hodina. Pokud je maximální rychlost vozidla nastavená na 50 km/hodinu, bude směrovací motor považovat za aktuální situaci 60 km/hodinu. Pokud je maximální rychlost vozidla poskytována jako 80 km/hodina, ale aktuální tok provozu je 60 km/hodina, směrovací motor znovu použije 60 km/hodinu.
vehicleWeight
 query

integer

Hmotnost vozidla v kg.
vehicleWidth
 query

number

double

Šířka vozidla v metrech. Hodnota 0 znamená, že se omezení šířky nepovažují.
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 do 120 sekund. V opačném případě uživatel okamžitě obdrží odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API. Podporováno pouze pro asynchronní požadavek.
windingness
 query

WindingnessLevel

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

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 pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích s pokyny.

Text požadavku

Name Typ Description
destinations

GeoJsonMultiPoint

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

GeoJsonMultiPoint

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

Odpovědi

Name Typ Description
200 OK

RouteMatrixResult

Maticový požadavek byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
Other Status Codes

ErrorResponse

Časový limit: Dokončení požadavku trvalo delší dobu, než je maximální doba definovaná v rozhraní API.
Other Status Codes

ErrorResponse

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

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více účtům prostředků Nebo dílčím prostředkům Azure Maps. 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 rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit koncepty ověřování . Stručně ř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 rozsahy.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. To lze získat z rozhraní API pro správu Maps.

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

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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 vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč bezpečně uložit.

Typ: apiKey
V: query

SAS Token

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

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

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

Typ: apiKey
V: header

Příklady

Successfully retrieve a route matrix request result synchronously

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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
  }
}
Stavový kód:
408 
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definice

Name Description
ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.
ErrorAdditionalInfo

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

Podrobnosti o chybě.
ErrorResponse

Chybová odpověď
GeoJsonMultiPoint

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

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

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

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.
RouteLegSummary

Souhrnný objekt pro oddíl trasy
RouteMatrix

Objekt výsledku matice
RouteMatrixQuery

Objekt s maticí souřadnic.
RouteMatrixResult

Tento objekt se vrátí z úspěšného volání matice směrování. Pokud jsou k dispozici 2 původy a 3 cíle, bude v každém z nich 2 pole se 3 prvky. Obsah jednotlivých prvků závisí na možnostech uvedený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 trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto
TravelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.
VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.
WindingnessLevel

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

ComputeTravelTime

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

Name Typ Description
all

string

Vypočítá dobu cesty pro všechny typy informací o provozu a určuje všechny výsledky v polích noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds a liveTrafficIncidentsTravelTimeInSeconds zahrnuté do souhrnů v odpovědi trasy.
none

string

Nevypočítá další doby cestování.

ErrorAdditionalInfo

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

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

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ý typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.

Name Typ Description
coordinates

number[]

Souřadnice pro geometrii GeoJson MultiPoint.
type string:

MultiPoint

Určuje typ GeoJSON. 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í trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

Name Typ Description
high

string

vysoko
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 javascriptového objektu

RouteAvoidType

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.

Name Typ Description
alreadyUsedRoads

string

Nepoužívejte stejnou silnici vícekrát. Nejužitečnější ve spojení s routeType=vzrušující.
borderCrossings

string

Vyhne se překračování hranic při výpočtu trasy.
carpools

string

Vyhněte se trasám, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle.
ferries

string

Vyhněte se trajektům
motorways

string

Vyhněte se dálnicm
tollRoads

string

Vyhněte se silničním poplatkům.
unpavedRoads

string

Vyhněte se neprůpavným cestám.

RouteLegSummary

Souhrnný objekt pro oddíl trasy

Name Typ Description
arrivalTime

string

Odhadovaná doba příjezdu pro trasu nebo nohu. Čas je ve standardu UTC.
batteryConsumptionInkWh

number

Odhadovaná spotřeba elektrické energie v kilowatthodinách (kWh) pomocí modelu elektrické spotřeby. Zahrnuto, pokud je vozidloEngineType nastaveno na elektrické a konstantníSpeedConsumptionInkWhPerHundredkm je zadán. Hodnota baterieConsumptionInkWh zahrnuje recupe jmenovitou elektrickou energii, a proto může být negativní (což označuje získá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 nevyučovaná rekuperace.
departureTime

string

Odhadovaná doba odletu pro trasu nebo nohu. Čas je ve standardu UTC.
fuelConsumptionInLiters

number

Odhadovaná spotřeba paliva v literech pomocí modelu spotřeby spalování. Zahrnuto, pokud je vozidloEngineType nastaveno na spalování a constantSpeedConsumptionInLitersPerHundredkm je zadán. Hodnota bude nezáporná.
historicTrafficTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná pomocí historických dat historického provozu závislých na čase. Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
lengthInMeters

integer

Vlastnost Délka v metrech
liveTrafficIncidentsTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná pomocí dat o rychlosti v reálném čase Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
noTrafficTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná tak, jako kdyby nedošlo k žádným zpožděním na trase kvůli dopravním podmínkám (např. zahlcení). Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
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 odletu v budoucnu jsou 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 ve vlastnosti sekund, která zahrnuje zpoždění kvůli provozu v reálném čase. Mějte na paměti, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění kvůli provozu. Pokud je funkce DepartAt v budoucnu, doba jízdy se vypočítá pomocí historických dat o provozu 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

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

RouteMatrixQuery

Objekt s maticí souřadnic.

Name Typ Description
destinations

GeoJsonMultiPoint

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

GeoJsonMultiPoint

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

RouteMatrixResult

Tento objekt se vrátí z úspěšného volání matice směrování. Pokud jsou k dispozici 2 původy a 3 cíle, bude v každém z nich 2 pole se 3 prvky. Obsah jednotlivých prvků závisí na možnostech uvedených v dotazu.

Name Typ Description
formatVersion

string

Vlastnost Format Version
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

Trasa 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 nejvíce dálnic. Můžete zvolit úroveň otáček včetně a také stupeň kopcovitosti. Podívejte se na parametry kopcovitosti a vinutí, jak to nastavit. Na trasách plánovaných s routeType=vzrušující je limit 900 km.

SectionType

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

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto

Name Typ Description
carTrain

string

Oddíly trasy, které jsou auty nebo vlaky.
carpool

string

Úseky trasy, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle( HOV/ High Occupancy Vehicle).
country

string

Oddíly označující, ve kterých zemích nebo oblastech trasa je.
ferry

string

Úseky trasy, které jsou trajekty.
motorway

string

Úseky trasy, které jsou dálnicemi.
pedestrian

string

Úseky trasy, které jsou vhodné pouze pro chodce.
tollRoad

string

Oddíly trasy, které vyžadují uhrazení placené linky.
tollVignette

string

Oddíly trasy, které vyžadují, aby byla přítomna bezplatná dálniční známka.
traffic

string

Oddíly trasy, které obsahují informace o provozu
travelMode

string

Oddíly týkající se parametru požadavku travelMode.
tunnel

string

Oddíly 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 "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.

Name Typ Description
bicycle

string

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

string

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

string

Vrácené trasy jsou optimalizované pro auta.
motorcycle

string

Vrácené trasy jsou optimalizované pro motocykly. Funkce BETA.
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. Funkce BETA.
truck

string

Vrácené trasy jsou optimalizované pro komerční vozidla, jako jsou nákladní vozy.
van

string

Vrácené trasy jsou optimalizované pro dodávky. Funkce BETA.

VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za 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í činidla
USHazmatClass6

string

Jedy
USHazmatClass7

string

Radioaktivní
USHazmatClass8

string

Corrosives
USHazmatClass9

string

Rozmanitý
otherHazmatExplosive

string

Výbušniny
otherHazmatGeneral

string

Rozmanitý
otherHazmatHarmfulToWater

string

Škodlivé pro vodu

WindingnessLevel

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

Name Typ Description
high

string

vysoko
low

string

nízký
normal

string

normální