Sdílet prostřednictvím


Route - Get Route Range

Slouží k vytvoření mapy, která znázorňuje oblast přístupnou z daného bodu v rámci určité prahové hodnoty na základě času, vzdálenosti nebo kapacity paliva.

Rozhraní Get Route Range API (Isochrone) je požadavek HTTP GET , který na základě zadaného rozpočtu na palivo, energii, čas nebo vzdálenost vypočítá sadu umístění, ke kterým se dostanete z výchozího bodu. Hranice mnohoúhelníku (nebo Isochrone) je vrácena v proti směru hodinových ručiček a také přesný střed mnohoúhelníku, který byl výsledkem počátečního bodu.

Vrácený mnohoúhelník lze použít k dalšímu zpracování, jako je vyhledávání uvnitř geometrie , k vyhledání poi v rámci zadaného izochronu.

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parametry identifikátoru URI

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

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

api-version
query True

string

Číslo verze rozhraní API služby Azure Maps

query
query True

number[]

Souřadnice, od které má výpočet rozsahu začínat.

accelerationEfficiency
query

number

double

Určuje účinnost přeměny chemické energie uložené v palivu na kinetickou energii při zrychlování vozidla (tj. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se získává převodem spotřebovaného paliva na chemickou energii pomocí palivaEnergyDensityInMJoulesPerLiter.

Musí být spárovaný s deceleracíEfficiency.

Rozsah povolených hodnot je 0,0 až 1/deceleraceEfficiency.

Rozumné hodnoty : pro spalovací model : 0.33, pro elektrický model : 0.66

auxiliaryPowerInkW
query

number

double

Určuje množství energie spotřebované pomocnými systémy v kilowattech (kW).

Může být použit k určení spotřeby vzhledem k zařízením a systémům, jako jsou systémy střídavých, rádiových, topných atd.

Rozumné hodnoty : 1.7

auxiliaryPowerInLitersPerHour
query

number

double

Určuje množství paliva spotřebované pro udržování pomocných systémů vozidla v litrech za hodinu.

Může být použit k určení spotřeby vzhledem k zařízením a systémům, jako jsou systémy střídavých, rádiových, topných atd.

Rozumné hodnoty : 0,2

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

constantSpeedConsumptionInkWhPerHundredkm
query

string

Určuje součást spotřeby závislé na rychlosti.

Poskytuje se jako neuspořádaný seznam dvojic rychlost/spotřeba-sazba. Seznam definuje body na křivce spotřeby. Sazby spotřeby pro rychlosti, které nejsou v seznamu, jsou uvedeny takto:

  • lineární interpolací, pokud daná rychlost leží mezi dvěma rychlostmi v seznamu

  • v opačném případě lineární extrapolací za předpokladu konstanty (ΔConsumption/ΔSpeed) určené nejbližšími dvěma body v seznamu

Seznam musí obsahovat 1 až 25 bodů (včetně) a nesmí obsahovat duplicitní body pro stejnou rychlost. Pokud obsahuje pouze jeden bod, použije se míra spotřeby tohoto bodu bez dalšího zpracování.

Spotřeba zadaná pro největší rychlost musí být větší nebo rovna spotřebě předposlední největší rychlosti. Tím se zajistí, že extrapolace nepovede k negativním sazbám spotřeby.

Podobně hodnoty spotřeby zadané pro dvě nejmenší rychlosti v seznamu nemohou vést k záporné spotřebě pro jakoukoli menší rychlost.

Platný rozsah pro hodnoty spotřeby (vyjádřený v kWh/100 km) je mezi 0,01 a 10 0000,0.

Rozumné hodnoty : 50,8.2:130,21,3

Tento parametr je vyžadován pro model elektrické spotřeby.

constantSpeedConsumptionInLitersPerHundredkm
query

string

Určuje součást spotřeby závislé na rychlosti.

Poskytuje se jako neuspořádaný seznam dvojic rychlosti oddělených dvojtečkami & spotřeba-sazba. Seznam definuje body na křivce spotřeby. Sazby spotřeby pro rychlosti, které nejsou v seznamu, jsou uvedeny takto:

  • lineární interpolací, pokud daná rychlost leží mezi dvěma rychlostmi v seznamu

  • v opačném případě lineární extrapolací za předpokladu konstanty (ΔConsumption/ΔSpeed) určené nejbližšími dvěma body v seznamu

Seznam musí obsahovat 1 až 25 bodů (včetně) a nesmí obsahovat duplicitní body pro stejnou rychlost. Pokud obsahuje pouze jeden bod, použije se míra spotřeby tohoto bodu bez dalšího zpracování.

Spotřeba zadaná pro největší rychlost musí být větší nebo rovna spotřebě předposlední největší rychlosti. Tím se zajistí, že extrapolace nepovede k negativním sazbám spotřeby.

Podobně hodnoty spotřeby zadané pro dvě nejmenší rychlosti v seznamu nemohou vést k záporné spotřebě pro jakoukoli menší rychlost.

Platný rozsah pro hodnoty spotřeby (vyjádřený v l/100 km) je mezi 0,01 a 100000,0.

Rozumné hodnoty: 50,6.3:130,11,5

Poznámka : Tento parametr je povinný pro model spotřeby spalování.

currentChargeInkWh
query

number

double

Určuje aktuální zdroj elektrické energie v kilowatthodinách (kWh).

Tento parametr existuje společně s parametrem maxChargeInkWh .

Rozsah povolených hodnot je 0,0 až maxChargeInkWh.

Rozumné hodnoty : 43

currentFuelInLiters
query

number

double

Určuje aktuální dodávku paliva v litrech.

Rozumné hodnoty : 55

decelerationEfficiency
query

number

double

Určuje účinnost přeměny kinetické energie na uložené (nespotřebované) palivo při zpomalení vozidla (tj. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved se získává převodem uloženého (nespotřebovaného) paliva na energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárovaný s accelerationEfficiency.

Povolený rozsah hodnot je 0,0 až 1/accelerationEfficiency.

Rozumné hodnoty : pro spalovací model : 0.83, pro elektrický model : 0.91

departAt
query

string

date-time

Datum a čas odletu od bodu původu 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 počátečního bodu.

  • Výchozí hodnota: nyní
  • 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.

distanceBudgetInMeters
query

number

double

Rozpočet vzdálenosti v metrech, který určuje maximální rozsah, který lze ujet pomocí dojezdové vzdálenosti. Model consumption ovlivní rozsah pouze v případech, kdy je routeType eco.
Musí být použit přesně jeden rozpočet (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec nebo distanceBudgetInMeters).

downhillEfficiency
query

number

double

Určuje účinnost přeměny potenciální energie na úsporu (nespotřebované) palivo, když vozidlo ztratí výšku (tj. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved se získává převodem uloženého (nespotřebovaného) paliva na energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárován s uphillEfficiency.

Rozsah povolených hodnot je 0,0 až 1/uphillEfficiency.

Rozumné hodnoty : pro spalovací model : 0,51, pro elektrický model : 0,73

energyBudgetInkWh
query

number

double

Rozpočet elektrické energie v kilowatthodinách (kWh), který určuje maximální dojezd, který lze ujet pomocí zadaného modelu elektrické spotřeby.
Při použití energyBudgetInkWh je nutné zadat podrobný model spotřeby elektrické energie.
Musí být použit přesně jeden rozpočet (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec nebo distanceBudgetInMeters).

fuelBudgetInLiters
query

number

double

Rozpočet paliva v litrech, který určuje maximální dojezd, který lze ujet pomocí zadaného modelu spotřeby spalování.
Při použití palivuBudgetInLiters je nutné zadat podrobný model spotřeby spalování.
Musí být použit přesně jeden rozpočet (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec nebo distanceBudgetInMeters).

fuelEnergyDensityInMJoulesPerLiter
query

number

double

Určuje množství chemické energie uložené v jednom litru paliva v megajoulech (MJ). Používá se ve spojení s *parametry účinnosti pro převody mezi uloženou nebo spotřebovanou energií a palivem. Například hustota energie je 34,2 MJ/l pro benzín a 35,8 MJ/l pro naftu.

Tento parametr je povinný, pokud je nastaven parametr *Efficiency .

Rozumné hodnoty : 34,2

hilliness
query

InclineLevel

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

maxChargeInkWh
query

number

double

Určuje maximální dodávku elektrické energie v kilowatthodinách (kWh), která může být uložena v baterii vozidla.

Tento parametr existuje společně s parametrem currentChargeInkWh .

Minimální hodnota musí být větší než nebo rovna currentChargeInkWh.

Rozumné hodnoty : 85

routeType
query

RouteType

Typ požadované trasy.

timeBudgetInSec
query

number

double

Časový rozpočet v sekundách, který určuje maximální rozsah, který lze cestovat pomocí doby jízdy. Model consumption ovlivní rozsah pouze v případech, kdy je routeType eco.
Musí být použit přesně jeden rozpočet (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec nebo distanceBudgetInMeters).

traffic
query

boolean

Možné hodnoty:

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

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.

uphillEfficiency
query

number

double

Určuje účinnost přeměny chemické energie uložené v palivu na potenciální energii při zvýšení výšky vozidla (tj. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se získává převodem spotřebovaného paliva na chemickou energii pomocí palivaEnergyDensityInMJoulesPerLiter.

Musí být spárován s sjezdovýmEfficiency.

Povolený rozsah hodnot je 0,0 až 1/sjezdovýEfficiency.

Rozumné hodnoty : pro spalovací model : 0.27, pro elektrický model : 0.74

vehicleAxleWeight
query

integer

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se neúčtují omezení hmotnosti na nápravu.

vehicleCommercial
query

boolean

Zda je vozidlo používáno ke komerčním účelům. Na některých silnicích nesmí jezdit užitková vozidla.

vehicleEngineType
query

VehicleEngineType

Typ motoru vozidla. Když je zadán podrobný model spotřeby, musí být konzistentní s hodnotou vehicleEngineType.

vehicleHeight
query

number

double

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

vehicleLength
query

number

double

Délka vozidla v metrech. Hodnota 0 znamená, že se omezení délky nezohládají.

vehicleLoadType
query

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.

vehicleMaxSpeed
query

integer

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

  • Hodnota 0 znamená, že odpovídající hodnota pro vozidlo bude určena a použita během plánování trasy.

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

vehicleWeight
query

integer

Hmotnost vozidla v kilogramech.

  • Je povinný, pokud je nastaven kterýkoli z *parametrů efektivity.

  • Při použití v kontextu modelu spotřeby musí být přísně pozitivní. Zvažují se omezení hmotnosti.

  • Pokud není zadán žádný podrobný model spotřeby a hodnota hmotnosti vozidla je nenulová, zvažují se omezení hmotnosti.

  • Ve všech ostatních případech je tento parametr ignorován.

Rozumné hodnoty : pro spalovací model : 1600, pro elektrický model : 1900

vehicleWidth
query

number

double

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

windingness
query

WindingnessLevel

Úroveň zatáček pro vzrušující trasu. Tento parametr lze 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 Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Odpovědi

Name Typ Description
200 OK

RouteRangeResult

OK

Other Status Codes

ErrorResponse

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

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra 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 rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika úč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 několika oprávnění k rozhraním REST API služby Azure Maps.

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í prostředku Azure Maps, 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 webu 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í.

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 vytváření účtu Azure Maps na webu 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 rozhraním Rest API služby Azure Maps použít přístup k důvěrným klientským aplikacím , aby se váš klíč mohl 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 List SAS prostředku Azure Maps prostřednictvím roviny správy 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.

Typ: apiKey
V: header

Příklady

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Ukázkový požadavek

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Ukázková odpověď

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

Definice

Name Description
EffectiveSetting

Efektivní parametr nebo data použitá při volání tohoto rozhraní API směrování

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

InclineLevel

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

LatLongPair

Umístění reprezentované jako zeměpisná šířka a délka.

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

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.

RouteRange

Dostupný rozsah

RouteRangeResult

Tento objekt je vrácen úspěšným voláním rozsahu dosažitelné trasy.

RouteReport

Hlásí efektivní nastavení použitá v aktuálním volání.

RouteType

Typ požadované trasy.

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.

VehicleEngineType

Typ motoru vozidla. Když je zadán podrobný model spotřeby, musí být konzistentní s hodnotou vehicleEngineType.

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.

EffectiveSetting

Efektivní parametr nebo data použitá při volání tohoto rozhraní API směrování

Name Typ Description
key

string

Název použitého parametru

value

string

Hodnota použitého parametru

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.

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í

LatLongPair

Umístění reprezentované jako zeměpisná šířka a délka.

Name Typ Description
latitude

number

Vlastnost Zeměpisná šířka

longitude

number

Zeměpisná délka – vlastnost

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

Name Typ Description
json

string

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

xml

string

The Extensible Markup Language

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.

RouteRange

Dostupný rozsah

Name Typ Description
boundary

LatLongPair[]

Mnohoúhelník hranice dosažitelného rozsahu reprezentovaný jako seznam bodů.

center

LatLongPair

Středový bod dosažitelného rozsahu

RouteRangeResult

Tento objekt je vrácen úspěšným voláním rozsahu dosažitelné trasy.

Name Typ Description
formatVersion

string

Vlastnost Formát verze

reachableRange

RouteRange

Dostupný rozsah

report

RouteReport

Hlásí efektivní nastavení použitá v aktuálním volání.

RouteReport

Hlásí efektivní nastavení použitá v aktuálním volání.

Name Typ Description
effectiveSettings

EffectiveSetting[]

Efektivní parametry nebo data používaná při volání tohoto rozhraní API trasy

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

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

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.

VehicleEngineType

Typ motoru vozidla. Když je zadán podrobný model spotřeby, musí být konzistentní s hodnotou vehicleEngineType.

Name Typ Description
combustion

string

Spalovací motor.

electric

string

Elektrický motor.

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í činidla

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í