Megosztás a következőn keresztül:

Route - Get Route Directions

  • Referencia
Szolgáltatás:
Maps
API-verzió:
1.0

Egy adott forrás és cél közötti útvonal kiszámítására használható, amely a megadott útpontokon halad át.

A Get Route Directions API egy HTTP-GET kérés, amely egy forrás és egy cél közötti útvonalat ad vissza, ha meg van adva. Az útvonal figyelembe veszi az olyan tényezőket, mint a jelenlegi forgalom és a hét kért napján és a nap idejének átlagos közúti sebessége.

A visszaadott információk közé tartozik a távolság, a becsült utazási idő és az útvonalgeometria ábrázolása. A kiválasztott beállításoktól függően további útválasztási információk is elérhetők, például az optimalizált útválasztási sorrend vagy a turn by turn utasítások.

Az útválasztási szolgáltatás paraméterkészletet biztosít egy járműspecifikus fogyasztási modell részletes leírásához. További információ: Használati modell.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
Opcionális paraméterekkel: 
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&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}

URI-paraméterek

Name In Kötelező Típus Description
format
 path True

ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.
api-version
 query True

string

Az Azure Maps API verziószáma.
query
 query True

string

Azok a koordináták, amelyeken keresztül az útvonal ki van számítva, kettősponttal elválasztva. Legalább két koordinátára van szükség. Az első a forrás, az utolsó pedig az útvonal célja. A választható koordináták a között, wayPointként működnek az útvonalon. Legfeljebb 150 WayPointot adhat át.
accelerationEfficiency
 query

number

double

Meghatározza az üzemanyagban tárolt kémiai energia kinetikus energiává alakításának hatékonyságát, amikor a jármű felgyorsítja (pl. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed úgy nyerik ki, hogy a felhasznált üzemanyagot kémiai energiává alakítja át üzemanyag, azEnergyDensityInMJoulesPerLiterhasználatával.

Párosítani kell decelerationEfficiency.

Az engedélyezett értékek tartománya 0,0 és 1/lassulásEfficiency.

Ésszerű értékek: égési modell esetén: 0,33, elektromos modellhez: 0,66
alternativeType
 query

AlternativeRouteType

Szabályozza a számított alternatívák optimálisságát a megadott tervezési kritériumok tekintetében a referenciaútvonalhoz képest.
arriveAt
 query

string

date-time

A célpontra való érkezés dátuma és időpontja dateTime értékként formázva, az RFC 3339 5.6 szakaszának5.6. szakaszában meghatározottak szerint, opcionális időzóna-eltolással. Ha nincs megadva időzóna-eltolás, a rendszer azt feltételezi, hogy a célpont értéke.

Példák:

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

A arriveAt paraméter nem használható departAt, minDeviationDistance vagy minDeviationTime.
auxiliaryPowerInkW
 query

number

double

A kiegészítő rendszerek fenntartásához felhasznált energia mennyiségét határozza meg kilowattokban (kW).

Az eszközök és rendszerek, például AC rendszerek, rádió, fűtés stb. miatti fogyasztás meghatározására használható.

Értelmes értékek: 1,7
auxiliaryPowerInLitersPerHour
 query

number

double

Meghatározza a jármű kiegészítő rendszereinek fenntartásához felhasznált üzemanyag mennyiségét óránként literben.

Az eszközök és rendszerek, például AC rendszerek, rádió, fűtés stb. miatti fogyasztás meghatározására használható.

Értelmes értékek: 0,2
avoid
 query

RouteAvoidType[]

Meghatároz valamit, amelyet az útvonalszámításnak el kell kerülnie az útvonal meghatározásakor. Egy kérelemben többször is megadható, például : "&avoid=autópályák&avoid=tollRoads&avoid=ferries". Az útvonaltartomány-kérelmekben a márUsedRoads értéket nem szabad használni.
computeBestOrder
 query

boolean

Rendezze újra az útvonalpontokat egy gyors heurisztikus algoritmussal az útvonal hosszának csökkentése érdekében. A routeType legrövidebbegyütt használva a legjobb eredményt adja. Figyelje meg, hogy a forrás és a cél nem szerepel az optimalizált útpontindexekben. Ha a válaszban fel szeretné venni a forrást és a célhelyet, növelje az összes indexet 1-gyel, hogy figyelembe vegye a forrást, majd adja hozzá a célhelyet végső indexként. A lehetséges értékek igazak vagy hamisak. A true függvény jobb sorrendet számít ki, ha lehetséges, de nem használható 0-nál nagyobb maxAlternatives értékkel vagy körútpontokkal együtt. A False a megadott sorrendben használja a helyeket, és nem használható a routeRepresentation nincs.
computeTravelTimeFor
 query

ComputeTravelTime

Meghatározza, hogy a forgalmi adatok különböző típusaival (nincs, történelmi, élő) és az alapértelmezett legjobb becslési utazási idővel adja-e vissza a további utazási időket.
constantSpeedConsumptionInkWhPerHundredkm
 query

string

A fogyasztás sebességfüggő összetevőjét adja meg.

A sebesség-/fogyasztás-arány párok rendezetlen listájaként van megadva. A lista egy használati görbe pontjait határozza meg. A listában nem szereplő sebességek fogyasztási arányai a következők:

  • lineáris interpolációval, ha a megadott sebesség a listában szereplő két sebesség között van

  • lineáris extrapolációval egyébként, feltételezve, hogy a lista legközelebbi két pontja által meghatározott állandó (ΔConsumption/ΔSpeed)

A lista 1 és 25 pont közötti (beleértve a pontokat is), és nem tartalmazhat azonos sebességre vonatkozó duplikált pontokat. Ha csak egyetlen pontot tartalmaz, akkor a rendszer további feldolgozás nélkül használja az adott pont használati arányát.

A legnagyobb sebességhez megadott fogyasztásnak nagyobbnak vagy egyenlőnek kell lennie, mint az utolsó előtti legnagyobb sebesség. Ez biztosítja, hogy az extrapoláció ne vezessen negatív fogyasztási arányokhoz.

Hasonlóképpen, a listában szereplő két legkisebb sebességhez megadott fogyasztási értékek nem vezethetnek negatív fogyasztási arányhoz kisebb sebesség esetén.

A fogyasztási értékek érvényes tartománya (kWh/100km-ben kifejezve) 0,01 és 100000,0 között van.

Értelmes értékek: 50,8.2:130,21.3

Ez a paraméter szükséges elektromos fogyasztási modell.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

A fogyasztás sebességfüggő összetevőjét adja meg.

A kettősponttal tagolt sebesség & fogyasztás-arány párok rendezetlen listájaként van megadva. A lista egy használati görbe pontjait határozza meg. A listában nem szereplő sebességek fogyasztási arányai a következők:

  • lineáris interpolációval, ha a megadott sebesség a listában szereplő két sebesség között van

  • lineáris extrapolációval egyébként, feltételezve, hogy a lista legközelebbi két pontja által meghatározott állandó (ΔConsumption/ΔSpeed)

A lista 1 és 25 pont közötti (beleértve a pontokat is), és nem tartalmazhat azonos sebességre vonatkozó duplikált pontokat. Ha csak egyetlen pontot tartalmaz, akkor a rendszer további feldolgozás nélkül használja az adott pont használati arányát.

A legnagyobb sebességhez megadott fogyasztásnak nagyobbnak vagy egyenlőnek kell lennie, mint az utolsó előtti legnagyobb sebesség. Ez biztosítja, hogy az extrapoláció ne vezessen negatív fogyasztási arányokhoz.

Hasonlóképpen, a listában szereplő két legkisebb sebességhez megadott fogyasztási értékek nem vezethetnek negatív fogyasztási arányhoz kisebb sebesség esetén.

A használati értékek érvényes tartománya (l/100km-ben kifejezve) 0,01 és 100000,0 között van.

Értelmes értékek: 50,6.3:130,11.5

Megjegyzés: Ez a paraméter az égési fogyasztási modellszükséges.
currentChargeInkWh
 query

number

double

A jelenlegi elektromos energiaellátást adja meg kilowatt óra (kWh) alatt.

Ez a paraméter maxChargeInkWh paraméterrel együtt létezik.

Az engedélyezett értékek tartománya 0,0 és maxChargeInkWh.

Értelmes értékek: 43
currentFuelInLiters
 query

number

double

Meghatározza az aktuális üzemanyag-kínálatot literben.

Értelmes értékek: 55
decelerationEfficiency
 query

number

double

Meghatározza a kinetikai energia megtakarított (nem felhasznált) üzemanyaggá alakításának hatékonyságát, amikor a jármű csökken (azaz ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved úgy nyerik ki, hogy a mentett (nem felhasznált) üzemanyagot üzemanyag energiává alakítják azEnergyDensityInMJoulesPerLiter.

Párosítani kell accelerationEfficiency.

Az engedélyezett értékek tartománya 0,0 és 1/gyorsulásEfficiencia.

Ésszerű értékek: égési modell esetén: 0,83, elektromos modellhez: 0,91
departAt
 query

string

date-time

A kiindulási ponttól való eltérés dátuma és időpontja dateTime értékként formázva, az RFC 3339 5.6. Ha nincs megadva időzóna-eltolás, a rendszer azt feltételezi, hogy az a kiindulási ponthoz tartozik.

  • Alapértelmezett érték: most
  • Egyéb érték: dateTime

Példák:

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

A departAt paraméter nem használható arriveAt.
downhillEfficiency
 query

number

double

Meghatározza a potenciális energia megtakarított (nem felhasznált) üzemanyaggá alakításának hatékonyságát, ha a jármű elveszíti a szintemelkedési (azaz ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved úgy nyerik ki, hogy a mentett (nem felhasznált) üzemanyagot üzemanyag energiává alakítják azEnergyDensityInMJoulesPerLiter.

Párosítani kell uphillEfficiency.

Az engedélyezett értékek tartománya 0,0 és 1/uphillEfficiency.

Ésszerű értékek: égési modell : 0,51, elektromos modellhez: 0,73
fuelEnergyDensityInMJoulesPerLiter
 query

number

double

Meghatározza a megajoulesben (MJ) tárolt egy liter üzemanyagban tárolt kémiai energia mennyiségét. A *hatékonysági paraméterekkel együtt használják a megtakarított vagy felhasznált energia és üzemanyag közötti átalakításokhoz. Az energia sűrűsége például benzin esetén 34,2 MJ/l, dízel üzemanyag esetén 35,8 MJ/l.

Ez a paraméter akkor szükséges, ha a *Hatékonyság paraméter be van állítva.

Értelmes értékek: 34,2
hilliness
 query

InclineLevel

A dombság foka az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.
instructionsType
 query

RouteInstructionsType

Ha meg van adva, a rendszer útmutatást ad vissza. Vegye figyelembe, hogy az instructionsType paraméter nem használható a routeRepresentation=none paraméterrel együtt.
language
 query

string

A nyelvi paraméter határozza meg az útmutató üzenetek nyelvét. A megfelelő főneveket (utcák, közterek stb.) a rendszer a megadott nyelven adja vissza, vagy ha ez nem érhető el, akkor a rendszer a hozzá közel álló, elérhető nyelven adja vissza őket. Az engedélyezett értékek az IETF nyelvcímkék (részhalmazai). A jelenleg támogatott nyelvek a Támogatott nyelvek szakaszban.

Alapértelmezett érték: en-GB
maxAlternatives
 query

integer

A kiszámítandó alternatív útvonalak száma. Alapértelmezett: 0, minimum: 0 és maximum: 5
maxChargeInkWh
 query

number

double

Meghatározza a jármű akkumulátorában tárolható maximális elektromos energiaellátást kilowatt óra (kWh) alatt.

Ez a paraméter currentChargeInkWh paraméterrel együtt létezik.

A minimális értéknek nagyobbnak vagy egyenlőnek kell lennie, mint currentChargeInkWh.

Értelmes értékek: 85
minDeviationDistance
 query

integer

Minden visszaadott alternatív útvonal a referenciaútvonalat követi (lásd a POST-kérelmek szakaszt) a calculateRoute-kérelem kiindulási pontjától legalább ennyi mérőszámra vonatkozóan. Csak útvonal rekonstruálásakor használható. A minDeviationDistance paraméter nem használható az arriveAt paraméterrel együtt
minDeviationTime
 query

integer

Az összes visszaadott alternatív útvonal a calculateRoute-kérelem kiindulási pontjának referenciaútvonalát követi (lásd a POST-kérelmek szakaszt) legalább ennyi másodpercig. Csak útvonal rekonstruálásakor használható. A minDeviationTime paraméter nem használható az arriveAt paraméterrel együtt. Az alapértelmezett érték 0. A )minDeviationTime_ nullánál nagyobb értékre való beállítása a következő következményekkel jár:

  • A calculateRoute Kérelem forráspontjának a bemeneti referenciaútvonalon (vagy nagyon közel) kell lennie.
    • Ha nem ez a helyzet, hibaüzenet jelenik meg.
    • A kiindulási pontnak azonban nem kell a bemeneti referenciaút elején lennie (a referenciaúton a jármű aktuális pozíciójára lehet gondolni).
  • A calculateRoute Response első útvonalaként visszaadott referenciaútvonal a calculateRoute-kérelemben megadott forrásponttól indul. A bemeneti referenciaútvonal kezdeti része egészen addig, amíg a forráspont ki nem kerül a Válaszból.
  • A minDeviationDistance és minDeviationTime értékei határozzák meg, hogy az alternatív útvonalak milyen messze lesznek garantáltan követve a referenciaútvonalat a kiindulási ponttól kezdve.
  • Az útvonalnak departAtkell használnia.
  • A vehicleHeading figyelmen kívül hagyja.
report
 query

Report

Meghatározza, hogy mely adatokat kell diagnosztikai célokra jelenteni. Az egyetlen lehetséges érték az effectiveSettings. Az API meghívásakor használt hatályos paramétereket vagy adatokat jelenti. Az alapértelmezett paraméterek esetében az alapértelmezett érték akkor jelenik meg, ha a hívó nem adta meg a paramétert.
routeRepresentation
 query

RouteRepresentationForBestOrder

A válaszként megadott útvonalak halmazának ábrázolását adja meg.
routeType
 query

RouteType

A kért útvonal típusa.
sectionType
 query

SectionType[]

Megadja, hogy a szakasztípusok közül melyiket jelenti a rendszer az útvonalválaszban.

Ha például a sectionType = gyalogos, akkor a csak gyalogosoknak megfelelő szakaszok lesznek visszaadva. Egy kérelemben többször is megadható, például : "§ionType=carTrain§ionType=gyalogos§ionType=autópálya". Az alapértelmezett sectionType a travelMode bemenetre hivatkozik. Alapértelmezés szerint a travelMode autóra van állítva
traffic
 query

boolean

Lehetséges értékek:

  • true – Az útválasztás során vegye figyelembe az összes rendelkezésre álló forgalmi információt
  • false – Az aktuális forgalmi adatok figyelmen kívül hagyása az útválasztás során. Vegye figyelembe, hogy bár az útválasztás során figyelmen kívül hagyja a jelenlegi forgalmi adatokat, a korábbi forgalom hatása a tényleges közúti sebességre továbbra is be van építve.
travelMode
 query

TravelMode

A kért útvonal utazási módja. Ha nincs definiálva, az alapértelmezett érték az "autó". Vegye figyelembe, hogy a kért travelMode nem érhető el a teljes útvonalon. Ha a kért travelMode nem érhető el egy adott szakaszhoz, az adott szakasz válaszának travelMode eleme "egyéb" lesz. Vegye figyelembe, hogy az utazási módok busszal, motorkerékpárral, taxival és kisteherautóval bétaverziós funkciók. A teljes korlátozási adatok nem érhetők el minden területen.
uphillEfficiency
 query

number

double

Meghatározza az üzemanyagban tárolt kémiai energia potenciális energiává alakításának hatékonyságát, amikor a jármű emelkedik (pl. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed úgy nyerik ki, hogy a felhasznált üzemanyagot kémiai energiává alakítja át üzemanyag, azEnergyDensityInMJoulesPerLiterhasználatával.

Párosítani kell downhillEfficiency.

Az engedélyezett értékek tartománya 0,0 és 1/downhillEfficiency.

Ésszerű értékek: égési modell : 0,27, elektromos modellhez: 0,74
vehicleAxleWeight
 query

integer

A jármű tengelyenkénti tömege kg-ban. A 0 érték azt jelenti, hogy a tengelyenkénti súlykorlátozásokat nem veszik figyelembe.
vehicleCommercial
 query

boolean

Azt, hogy a járművet kereskedelmi célokra használják-e. A haszongépjárművek bizonyos utakon nem vezethetnek.
vehicleEngineType
 query

VehicleEngineType

A jármű motortípusa. Részletes használati modell megadásakor konzisztensnek kell lennie vehicleEngineTypeértékével.
vehicleHeading
 query

integer

A jármű iránya fokban, a valódi északi iránytól indulva és az óramutató járásával megegyező irányban haladva. Észak 0 fok, keleten 90 fok, délen 180 fok, nyugaton 270 fok. Lehetséges értékek 0–359
vehicleHeight
 query

number

double

A jármű magassága méterben. A 0 érték azt jelenti, hogy a magasságkorlátozások nem tekinthetők meg.
vehicleLength
 query

number

double

A jármű hossza méterben. A 0 érték azt jelenti, hogy a hosszkorlátozások nem tekinthetők meg.
vehicleLoadType
 query

VehicleLoadType

Veszélyes anyagként besorolható és egyes utakról korlátozott rakománytípusok. A rendelkezésre álló vehicleLoadType értékek az US Hazmat 1–9. osztályai, valamint a más országokban/régiókban használható általános besorolások. Az USHazmat kezdetű értékek az USA útválasztására szolgálnak, míg az otherHazmatot minden más országban/régióban használni kell. A vehicleLoadType többször is megadható. Ez a paraméter jelenleg csak a travelMode=truck esetében tekinthető meg.
vehicleMaxSpeed
 query

integer

A jármű maximális sebessége km/óra sebességgel. A járműprofilban szereplő maximális sebesség annak ellenőrzésére szolgál, hogy a jármű autópályákon engedélyezett-e.

  • A 0 érték azt jelenti, hogy az útvonaltervezés során meg kell határozni és alkalmazni kell a járműre vonatkozó megfelelő értéket.

  • Az útvonaltervezés során felül lehet bírálni a nem nulla értéket. Az aktuális forgalom például 60 km/óra. Ha a jármű maximális sebessége 50 km/óra, az útválasztási motor 60 km/órát vesz figyelembe, mivel ez a jelenlegi helyzet. Ha a jármű maximális sebessége 80 km/óra, de az aktuális forgalom 60 km/óra, akkor az útválasztási motor ismét 60 km/órát használ.
vehicleWeight
 query

integer

A jármű súlya kilogrammban.

  • Ez kötelező, ha a *Hatékonyság paraméterek bármelyike be van állítva.

  • Szigorúan pozitívnak kell lennie, ha a használati modell kontextusában használják. A súlykorlátozásokat figyelembe kell venni.

  • Ha nincs megadva részletes fogyasztási modell, és az vehicleWeight értéke nem nulla, akkor súlykorlátozásokat kell figyelembe venni.

  • A rendszer minden más esetben figyelmen kívül hagyja ezt a paramétert.

Ésszerű értékek: égési modell : 1600, elektromos modell: 1900
vehicleWidth
 query

number

double

A jármű szélessége méterben. A 0 érték azt jelenti, hogy a szélességi korlátozások nem tekinthetők meg.
windingness
 query

WindingnessLevel

Fordulatok szintje az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-id

string

Megadja, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID-biztonság Azure Mapsben való használatához az alábbi cikkeket útmutatásért.

Válaszok

Name Típus Description
200 OK

RouteDirections

OKÉ
Other Status Codes

ErrorResponse

Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok . Ha Azure-beli szerepköralapú hozzáférés- vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörön vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörön keresztül.

Forgatókönyvek implementálásához javasoljuk, hogy tekintse meg hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást kínál az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Notes

  • Ez a biztonsági definíciós megköveteli, hogy a x-ms-client-id fejléc használatával jelezze, hogy melyik Azure Maps-erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps felügyeleti API-érhető el.

A Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra-azonosító konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés a Azure felügyeleti síkjáról van konfigurálva, az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esethez.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiók létrehozása az Azure Portalon, vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a bizalmas ügyfélalkalmazásokat, megközelítést az Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre a Azure Maps-erőforráson az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult az Azure szerepköralapú hozzáférés-vezérlőivel való hozzáférésre, valamint az adott jogkivonat lejáratának, sebességének és régióinak részletes szabályozására. Más szóval az SAS-jogkivonat segítségével az alkalmazások biztonságosabban szabályozhatják a hozzáférést, mint a megosztott kulcs.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfigurálja a -fiók erőforrás- engedélyezett forrásainak listáját a renderelési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

Successfully retrieve a route between an origin and a destination

Mintakérelem

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Mintaválasz

Állapotkód:
200 
{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definíciók

Name Description
AlternativeRouteType

Szabályozza a számított alternatívák optimálisságát a megadott tervezési kritériumok tekintetében a referenciaútvonalhoz képest.
ComputeTravelTime

Meghatározza, hogy a forgalmi adatok különböző típusaival (nincs, történelmi, élő) és az alapértelmezett legjobb becslési utazási idővel adja-e vissza a további utazási időket.
DelayMagnitude

Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részletei APIválaszmezőjének értékeinek felelnek meg.
DrivingSide

A bal és a jobb oldali vezetést jelzi a manőver pontján.
EffectiveSetting

A Route API meghívásakor használt érvényes paraméter vagy adatok.
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.
ErrorDetail

A hiba részletei.
ErrorResponse

Hibaválasz
GuidanceInstructionType

Az utasítás típusa, például az úttest forgása vagy módosítása.
GuidanceManeuver

Egy kód, amely azonosítja a manővert.
InclineLevel

A dombság foka az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.
JunctionType

A csomópont típusa, ahol a manőver történik. Nagyobb körforgalom esetén két külön utasítás jön létre a körforgalom be- és elhagyására.
LatLongPair

Földrajzi szélességként és hosszúságként ábrázolt hely.
Report

Meghatározza, hogy mely adatokat kell diagnosztikai célokra jelenteni. Az egyetlen lehetséges érték az effectiveSettings. Az API meghívásakor használt hatályos paramétereket vagy adatokat jelenti. Az alapértelmezett paraméterek esetében az alapértelmezett érték akkor jelenik meg, ha a hívó nem adta meg a paramétert.
ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.
ResponseSectionType

A jelentett útvonalválasz szakasztípusai
ResponseTravelMode

Utazási mód a számított útvonalhoz. Az érték other lesz beállítva, ha a kért átviteli mód ebben a szakaszban nem lehetséges
Route
RouteAvoidType

Meghatároz valamit, amelyet az útvonalszámításnak el kell kerülnie az útvonal meghatározásakor. Egy kérelemben többször is megadható, például : "&avoid=autópályák&avoid=tollRoads&avoid=ferries". Az útvonaltartomány-kérelmekben a márUsedRoads értéket nem szabad használni.
RouteDirections

Ezt az objektumot egy sikeres útvonalirány-hívás adja vissza
RouteGuidance

Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.
RouteInstruction

A manővert leíró attribútumok készlete, pl. "Jobbra fordulás", "Balra marad", "Szálljon a kompra", "Autópályára", "Érkezés".
RouteInstructionGroup

Egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja. A sorozattartományt az firstInstructionIndex és a lastInstructionIndex korlátozza. Ha emberi olvasásra alkalmas szöveges üzeneteket kérnek útmutatásért (instructionType=text vagy tagged), akkor az utasításcsoport egy összefoglaló üzenetet ad vissza, ha elérhető.
RouteInstructionsType

Ha meg van adva, a rendszer útmutatást ad vissza. Vegye figyelembe, hogy az instructionsType paraméter nem használható a routeRepresentation=none paraméterrel együtt.
RouteLeg

Az útvonal egy részének leírása, amely a pontok listájából áll. A kérésben megadott további útpontok további lábat eredményeznek a visszaadott útvonalon.
RouteLegSummary

Az útvonalszakasz összefoglaló objektuma.
RouteOptimizedWaypoint

Optimalizált útpont objektum.
RouteReport

Az aktuális hívásban használt érvényes beállításokat jelenti.
RouteRepresentationForBestOrder

A válaszként megadott útvonalak halmazának ábrázolását adja meg.
RouteSection

Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább a startPointIndex, endPointIndexés sectionTypeelemeket tartalmazza.
RouteSectionTec

A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okozhat.
RouteSectionTecCause

A forgalmi esemény oka. Tartalmazhat mainCauseCode és subCauseCode elemeket. Ikonográfia és leírások definiálására használható.
RouteSummary

Összegző objektum
RouteType

A kért útvonal típusa.
SectionType

Megadja, hogy a szakasztípusok közül melyiket jelenti a rendszer az útvonalválaszban.

Ha például a sectionType = gyalogos, akkor a csak gyalogosoknak megfelelő szakaszok lesznek visszaadva. Egy kérelemben többször is megadható, például : "§ionType=carTrain§ionType=gyalogos§ionType=autópálya". Az alapértelmezett sectionType a travelMode bemenetre hivatkozik. Alapértelmezés szerint a travelMode autóra van állítva
SimpleCategory

Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információt a "tec" című témakörben talál.
TravelMode

A kért útvonal utazási módja. Ha nincs definiálva, az alapértelmezett érték az "autó". Vegye figyelembe, hogy a kért travelMode nem érhető el a teljes útvonalon. Ha a kért travelMode nem érhető el egy adott szakaszhoz, az adott szakasz válaszának travelMode eleme "egyéb" lesz. Vegye figyelembe, hogy az utazási módok busszal, motorkerékpárral, taxival és kisteherautóval bétaverziós funkciók. A teljes korlátozási adatok nem érhetők el minden területen.
VehicleEngineType

A jármű motortípusa. Részletes használati modell megadásakor konzisztensnek kell lennie vehicleEngineTypeértékével.
VehicleLoadType

Veszélyes anyagként besorolható és egyes utakról korlátozott rakománytípusok. A rendelkezésre álló vehicleLoadType értékek az US Hazmat 1–9. osztályai, valamint a más országokban/régiókban használható általános besorolások. Az USHazmat kezdetű értékek az USA útválasztására szolgálnak, míg az otherHazmatot minden más országban/régióban használni kell. A vehicleLoadType többször is megadható. Ez a paraméter jelenleg csak a travelMode=truck esetében tekinthető meg.
WindingnessLevel

Fordulatok szintje az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.

AlternativeRouteType

Szabályozza a számított alternatívák optimálisságát a megadott tervezési kritériumok tekintetében a referenciaútvonalhoz képest.

Name Típus Description
anyRoute

string

Bármely alternatív útvonal visszaadásának engedélyezése, függetlenül attól, hogy hogyan viszonyul a referenciaútvonalhoz az optimálisság szempontjából.
betterRoute

string

Alternatív útvonalat csak akkor ad vissza, ha az jobb, mint a referenciaútvonal a megadott tervezési feltételeknek megfelelően.

ComputeTravelTime

Meghatározza, hogy a forgalmi adatok különböző típusaival (nincs, történelmi, élő) és az alapértelmezett legjobb becslési utazási idővel adja-e vissza a további utazási időket.

Name Típus Description
all

string

Kiszámítja az utazási időket az összes forgalmi információtípushoz, és megadja az összes eredményt a noTrafficTravelTimeInSeconds, a historicTrafficTravelTimeInSeconds és a liveTrafficIncidentsTravelTimeInSeconds mezőkben, amelyek szerepelnek az útvonalválasz összegzéseiben.
none

string

Nem számít ki további utazási időket.

DelayMagnitude

Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részletei APIválaszmezőjének értékeinek felelnek meg.

Name Típus Description
0

string

Ismeretlen.
1

string

Kiskorú.
2

string

Mérsékelt.
3

string

Őrnagy.
4

string

Meghatározatlan, útlezárásokhoz és egyéb határozatlan idejű késésekhez használják.

DrivingSide

A bal és a jobb oldali vezetést jelzi a manőver pontján.

Name Típus Description
LEFT

string

Bal oldalon.
RIGHT

string

Jobb oldalon.

EffectiveSetting

A Route API meghívásakor használt érvényes paraméter vagy adatok.

Name Típus Description
key

string

A használt paraméter neve.
value

string

A használt paraméter értéke.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.
type

string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.
code

string

A hibakód.
details

ErrorDetail[]

A hiba részletei.
message

string

A hibaüzenet.
target

string

A hibacél.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

GuidanceInstructionType

Az utasítás típusa, például az úttest forgása vagy módosítása.

Name Típus Description
DIRECTION_INFO

string

Irányadatok.
LOCATION_ARRIVAL

string

Érkezési hely.
LOCATION_DEPARTURE

string

Indulási hely.
LOCATION_WAYPOINT

string

Útpont helye.
ROAD_CHANGE

string

Útváltoztatás.
TURN

string

Fordít.

GuidanceManeuver

Egy kód, amely azonosítja a manővert.

Name Típus Description
ARRIVE

string

Megérkezett.
ARRIVE_LEFT

string

Megérkezett. A cél a bal oldalon található.
ARRIVE_RIGHT

string

Megérkezett. A cél a jobb oldalon van.
BEAR_LEFT

string

Medve balra.
BEAR_RIGHT

string

Meddő jobbra.
DEPART

string

Elhagy.
ENTER_FREEWAY

string

Az autópályán.
ENTER_HIGHWAY

string

Haladjon az autópályán.
ENTER_MOTORWAY

string

Haladjon az autópályán.
ENTRANCE_RAMP

string

A rámpa!
FOLLOW

string

Követ.
KEEP_LEFT

string

Maradjon balra.
KEEP_RIGHT

string

Tartsd jobbra!
MAKE_UTURN

string

Kapcsolja be az U-turnet.
MOTORWAY_EXIT_LEFT

string

A bal oldali kijáraton.
MOTORWAY_EXIT_RIGHT

string

A jobb oldali kijáratot.
ROUNDABOUT_BACK

string

Menj körbe a körforgalomban.
ROUNDABOUT_CROSS

string

Keresztezd a körforgalmat.
ROUNDABOUT_LEFT

string

A körforgalomnál lépjen a bal oldali kijáratra.
ROUNDABOUT_RIGHT

string

A körforgalomnál lépjen a jobb oldali kijáratra.
SHARP_LEFT

string

Forduljon balra élesen.
SHARP_RIGHT

string

Forduljon élesen jobbra.
STRAIGHT

string

Tartsd egyenesben.
SWITCH_MAIN_ROAD

string

Váltson a főútra.
SWITCH_PARALLEL_ROAD

string

Váltson a párhuzamos útra.
TAKE_EXIT

string

Lépjen a kijáratra.
TAKE_FERRY

string

A kompon.
TRY_MAKE_UTURN

string

Próbálja meg u-turn.
TURN_LEFT

string

Fordulj balra.
TURN_RIGHT

string

Fordulj jobbra.
WAYPOINT_LEFT

string

Elérte az útpontot. A bal oldalon van.
WAYPOINT_REACHED

string

Elérte az útpontot.
WAYPOINT_RIGHT

string

Elérte az útpontot. A jobb oldalon van.

InclineLevel

A dombság foka az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.

Name Típus Description
high

string

magas
low

string

alacsony
normal

string

normális

JunctionType

A csomópont típusa, ahol a manőver történik. Nagyobb körforgalom esetén két külön utasítás jön létre a körforgalom be- és elhagyására.

Name Típus Description
BIFURCATION

string

kétágúság
REGULAR

string

rendszeres
ROUNDABOUT

string

körforgalom

LatLongPair

Földrajzi szélességként és hosszúságként ábrázolt hely.

Name Típus Description
latitude

number

Latitude tulajdonság
longitude

number

Hosszúság tulajdonság

Report

Meghatározza, hogy mely adatokat kell diagnosztikai célokra jelenteni. Az egyetlen lehetséges érték az effectiveSettings. Az API meghívásakor használt hatályos paramétereket vagy adatokat jelenti. Az alapértelmezett paraméterek esetében az alapértelmezett érték akkor jelenik meg, ha a hívó nem adta meg a paramétert.

Name Típus Description
effectiveSettings

string

Az API meghívásakor használt hatályos paramétereket vagy adatokat jelenti.

ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.

Name Típus Description
json

string

A JavaScript objektum jelölési adatcseréjének formátuma
xml

string

Bővíthető korrektúranyelv

ResponseSectionType

A jelentett útvonalválasz szakasztípusai

Name Típus Description
CARPOOL

string

Az útvonal azon szakaszai, amelyek telekocsi (HOV/Magas kihasználtságú jármű) sávokat igényelnek.
CAR_TRAIN

string

Az útvonal szakaszai, amelyek autók vagy vonatok.
COUNTRY

string

Szakaszok, amelyek jelzik, hogy az útvonal mely országokban/régiókban található.
FERRY

string

A kompok útvonalának szakaszai.
MOTORWAY

string

Az útszakaszok, amelyek autópályák.
PEDESTRIAN

string

Az útvonal azon szakaszai, amelyek csak gyalogosok számára alkalmasak.
TOLL_ROAD

string

Az útvonal azon szakaszai, amelyek díjkötelesek.
TOLL_VIGNETTE

string

Az útvonal azon szakaszai, amelyeknél autópálya-matrica szükséges.
TRAFFIC

string

Az útvonal forgalmi adatokat tartalmazó szakaszai.
TRAVEL_MODE

string

A kérelemparaméterhez kapcsolódó szakaszok travelMode.
TUNNEL

string

Az útvonal alagútszakaszai.
URBAN

string

Az útvonalnak a városi területeken belüli szakaszai.

ResponseTravelMode

Utazási mód a számított útvonalhoz. Az érték other lesz beállítva, ha a kért átviteli mód ebben a szakaszban nem lehetséges

Name Típus Description
bicycle

string

A visszaadott útvonalak kerékpárokra vannak optimalizálva, beleértve a kerékpársávok használatát is.
bus

string

A visszaadott útvonalak buszokra vannak optimalizálva, beleértve a csak buszsávok használatát is. BÉTA-funkciók.
car

string

A visszaadott útvonalak autókhoz vannak optimalizálva.
motorcycle

string

A visszaadott útvonalak motorkerékpárokhoz vannak optimalizálva. BÉTA-funkciók.
other

string

Ebben a szakaszban a megadott szállítási mód nem lehetséges
pedestrian

string

A visszaadott útvonalak a gyalogosok számára vannak optimalizálva, beleértve a járdák használatát is.
taxi

string

A visszaadott útvonalak taxikra vannak optimalizálva. BÉTA-funkciók.
truck

string

A visszaadott útvonalak haszongépjárművekre, például teherautókra vannak optimalizálva.
van

string

A visszaadott útvonalak kisteherautókhoz vannak optimalizálva. BÉTA-funkciók.

Route

Name Típus Description
guidance

RouteGuidance

Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.
legs

RouteLeg[]

Lábtömb
sections

RouteSection[]

Szakaszok tömb
summary

RouteSummary

Összegző objektum

RouteAvoidType

Meghatároz valamit, amelyet az útvonalszámításnak el kell kerülnie az útvonal meghatározásakor. Egy kérelemben többször is megadható, például : "&avoid=autópályák&avoid=tollRoads&avoid=ferries". Az útvonaltartomány-kérelmekben a márUsedRoads értéket nem szabad használni.

Name Típus Description
alreadyUsedRoads

string

Elkerüli, hogy ugyanazt az utat többször is használja. Leginkább hasznos együtt routeType= izgalmas.
borderCrossings

string

Elkerüli a határátlépéseket az útvonal kiszámítása során.
carpools

string

Elkerüli azokat az útvonalakat, amelyekhez a carpool (HOV/High Occupancy Vehicle) sávok használata szükséges.
ferries

string

Elkerüli a kompokat
motorways

string

Elkerüli az autópályákat
tollRoads

string

Elkerüli a fizetős utakat.
unpavedRoads

string

Elkerüli a meg nem ásott utakat

RouteDirections

Ezt az objektumot egy sikeres útvonalirány-hívás adja vissza

Name Típus Description
formatVersion

string

Verzió formázása tulajdonság
optimizedWaypoints

RouteOptimizedWaypoint[]

Útpontok optimalizált sorozata. Megjeleníti az eredeti és optimalizált lista felhasználó által megadott waypoint-sorozatának indexét. Például egy válasz:

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

azt jelenti, hogy az eredeti sorozat [0, 1, 2] és az optimalizált sorozat [1, 2, 0]. Mivel az index 0-tal kezdődik, az eredeti "első, második, harmadik", míg az optimalizált "második, harmadik, első".
report

RouteReport

Az aktuális hívásban használt érvényes beállításokat jelenti.
routes

Route[]

Útvonaltömb

RouteGuidance

Útmutatással kapcsolatos elemeket tartalmaz. Ez a mező csak akkor jelenik meg, ha útmutatást kért, és elérhető.

Name Típus Description
instructionGroups

RouteInstructionGroup[]

Egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja.
instructions

RouteInstruction[]

A manővereket leíró utasítások listája.

RouteInstruction

A manővert leíró attribútumok készlete, pl. "Jobbra fordulás", "Balra marad", "Szálljon a kompra", "Autópályára", "Érkezés".

Name Típus Description
combinedMessage

string

Egy ember által olvasható üzenet a manőverhez a következő utasítás üzenetével kombinálva. Néha előfordulhat, hogy két egymást követő utasítást egyetlen utasításba egyesítünk, így könnyebben követhetők. Ebben az esetben a lehetségesCombineWithNext jelölő igaz lesz. Például:

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

A lehetségesCombineWithNext jelző a 10-es utasításban igaz. Ez azt jelzi a kódolt útmutató ügyfeleinek, hogy kombinálható a 11. utasítással. Az utasítások automatikusan össze lesznek olvasva azoknak az ügyfeleknek, aki ember által olvasható útmutatást kér. A combinedMessage mező a kombinált üzenetet tartalmazza:

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

string

3 karakteres ISO 3166-1 alfa-3 országkód. Pl. USA.
drivingSide

DrivingSide

A bal és a jobb oldali vezetést jelzi a manőver pontján.
exitNumber

string

Az aktuális manőver által végrehajtott autópálya-kijárat(ok) száma. Ha egy kilépés több kilépési számmal is rendelkezik, azokat a "", és lehetséges, hogy a "-", például "10, 13-15" szerint összesíti.
instructionType

GuidanceInstructionType

Az utasítás típusa, például az úttest forgása vagy módosítása.
junctionType

JunctionType

A csomópont típusa, ahol a manőver történik. Nagyobb körforgalom esetén két külön utasítás jön létre a körforgalom be- és elhagyására.
maneuver

GuidanceManeuver

Egy kód, amely azonosítja a manővert.
message

string

Egy ember által olvasható üzenet a manőverhez.
point

LatLongPair

Földrajzi szélességként és hosszúságként ábrázolt hely.
pointIndex

integer

Az utasítás pontjának megfelelő többsoros "pontok" listájában szereplő pont indexe.
possibleCombineWithNext

boolean

Opcionálisan kombinálhatja az utasítást a következővel. Ez olyan üzenetek létrehozására használható, mint a "Balra fordulás, majd jobbra fordulás".
roadNumbers

string[]

A következő jelentős útszakasz(ok) útszáma a manőver után, vagy a követendő út(ok)nak. Példa: ["E34", "N205"]
roundaboutExitNumber

integer

Ez azt jelzi, hogy melyik kijáratot kell behajtani egy körforgalomnál.
routeOffsetInMeters

integer

Távolság az útvonal kezdetétől az utasítás pontig.
signpostText

string

A jelzőtáblán lévő szöveg, amely a manőver szempontjából a leginkább releváns, vagy a követendő irányra vonatkozik.
stateCode

string

Az ország egy alosztálya (pl. állam), amelyet egy ISO 3166-2 kód második része jelöl. Ez csak néhány országban/régióban érhető el, például az Egyesült Államokban, Kanadában és Mexikóban.
street

string

A következő jelentős útszakasz utcaneve a manőver után, vagy a követendő utca neve.
travelTimeInSeconds

integer

Becsült utazási idő a routeOffsetInMetersnek megfelelő pontig.
turnAngleInDecimalDegrees

integer

Egy utasítás irányát jelzi. Ha a junctionType kanyarutasítást jelez:

  • 180 = U-turn
  • [-179, -1] = Balra fordulás
  • 0 = Egyenes bekapcsolás (0 fok)
  • [1, 179] = Jobbra fordulás

Ha a junctionType kétágú utasítást jelez:

  • <0 – maradjon balra
  • >0 – jobbra

RouteInstructionGroup

Egymáshoz kapcsolódó utasításelemek sorozatát csoportosítja. A sorozattartományt az firstInstructionIndex és a lastInstructionIndex korlátozza. Ha emberi olvasásra alkalmas szöveges üzeneteket kérnek útmutatásért (instructionType=text vagy tagged), akkor az utasításcsoport egy összefoglaló üzenetet ad vissza, ha elérhető.

Name Típus Description
firstInstructionIndex

integer

Az utasításokban szereplő és a csoporthoz tartozó első utasítás indexe.
groupLengthInMeters

integer

A csoport hossza.
groupMessage

string

Összefoglaló üzenet, ha az emberi olvasásra alkalmas szöveges üzenetek útmutatást kérnek (instructionType=text vagy tagged).
lastInstructionIndex

integer

Az utasítások utolsó utasításának indexe, amely ebbe a csoportba tartozik.

RouteInstructionsType

Ha meg van adva, a rendszer útmutatást ad vissza. Vegye figyelembe, hogy az instructionsType paraméter nem használható a routeRepresentation=none paraméterrel együtt.

Name Típus Description
coded

string

Nyers utasításadatokat ad vissza emberi olvasásra alkalmas üzenetek nélkül.
tagged

string

Nyers utasításadatokat ad vissza címkézett, emberi olvasásra alkalmas üzenetekkel a formázás engedélyezéséhez. Egy emberi olvasásra alkalmas üzenet ismétlődő azonosított elemekből épül fel. Ezek a címkék lehetővé teszik, hogy az ügyfélalkalmazások megfelelően formázsák őket. A következő üzenetösszetevők címkézve vannak, amikor az instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Példa a "Balra fordulás" üzenetre:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text

string

Nyers utasításokat ad vissza egyszerű szöveges üzenetekkel.

RouteLeg

Az útvonal egy részének leírása, amely a pontok listájából áll. A kérésben megadott további útpontok további lábat eredményeznek a visszaadott útvonalon.

Name Típus Description
points

LatLongPair[]

Ponttömb
summary

RouteLegSummary

Az útvonalszakasz összefoglaló objektuma.

RouteLegSummary

Az útvonalszakasz összefoglaló objektuma.

Name Típus Description
arrivalTime

string

Az útvonal vagy a láb becsült érkezési ideje. Az idő UTC-ben van.
batteryConsumptionInkWh

number

Becsült elektromos energiafogyasztás kilowattóra (kWh) alatt az elektromos fogyasztási modell használatával. Tartalmazza, ha a vehicleEngineType elektromos és constantSpeedConsumptionInkWhPerHundredkm értékre van állítva. Az batteryConsumptionInkWh értéke magában foglalja a visszaszerelt elektromos energiát, ezért negatív lehet (ami az energianövekedést jelzi). Ha a maxChargeInkWh és a currentChargeInkWh is meg van adva, a rendszer leképezi az újrafeltöltést, hogy az akkumulátor töltöttségi szintje soha ne haladja meg a maxChargeInkWh értéket. Ha sem a maxChargeInkWh, sem a currentChargeInkWh nincs megadva, akkor a rendszer nem konvenciókon alapuló újrafelvételt feltételez a felhasználás kiszámításában.
departureTime

string

Az útvonal vagy a láb becsült indulási ideje. Az idő UTC-ben van.
fuelConsumptionInLiters

number

Becsült üzemanyag-fogyasztás literben az égési fogyasztási modell használatával. Tartalmazza, ha a vehicleEngineType égési van beállítva, és konstansSpeedConsumptionInLitersPerHundredkm van megadva. Az érték nem lesz negatív.
historicTrafficTravelTimeInSeconds

integer

Az időfüggő korábbi forgalmi adatok alapján kiszámított becsült utazási idő. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
lengthInMeters

integer

Hossz a Meters tulajdonságban
liveTrafficIncidentsTravelTimeInSeconds

integer

Valós idejű sebességadatokkal kiszámított becsült utazási idő. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
noTrafficTravelTimeInSeconds

integer

Becsült utazási idő úgy számítva, mintha a forgalmi körülmények (pl. torlódás) miatt nem történnek késések az útvonalon. Csak akkor tartalmazza, ha a computeTravelTimeFor = az összeset használja a lekérdezésben.
trafficDelayInSeconds

integer

A valós idejű incidens(ek) által okozott becsült késés másodpercben a forgalmi információk alapján. A jövőben indulási idővel tervezett útvonalak esetében a késés mindig 0. Ha több utazási időt szeretne visszaadni különböző típusú forgalmi adatok használatával, a computeTravelTimeFor=összes paramétert hozzá kell adni.
travelTimeInSeconds

integer

Becsült utazási idő másodpercben tulajdonság, amely magában foglalja a késés miatt valós idejű forgalom. Vegye figyelembe, hogy még akkor is, ha a traffic=false travelTimeInSeconds továbbra is tartalmazza a forgalom miatti késést. Ha a DepartAt a jövőben lesz, az utazási idő az időfüggő korábbi forgalmi adatok alapján lesz kiszámítva.

RouteOptimizedWaypoint

Optimalizált útpont objektum.

Name Típus Description
optimizedIndex

integer

Optimalizált útpontindex a rendszerből.
providedIndex

integer

A felhasználó által megadott útpontindex.

RouteReport

Az aktuális hívásban használt érvényes beállításokat jelenti.

Name Típus Description
effectiveSettings

EffectiveSetting[]

A Route API meghívásakor használt érvényes paraméterek vagy adatok.

RouteRepresentationForBestOrder

A válaszként megadott útvonalak halmazának ábrázolását adja meg.

Name Típus Description
none

string

Csak az optimalizált útpontindexeket tartalmazza, de nem tartalmazza az útvonalgeometriát a válaszban. Ez a paraméterérték csak a computeBestOrder=true paraméterrel együtt használható.
polyline

string

Tartalmazza az útvonalgeometriát a válaszban.
summaryOnly

string

Összegzés a vonallánconként, de a válaszban szereplő útvonalak pontgeometriai elemeinek kivételével.

RouteSection

Az útvonalszakaszok további információkat tartalmaznak az útvonal egyes részeiről. Minden szakasz legalább a startPointIndex, endPointIndexés sectionTypeelemeket tartalmazza.

Name Típus Description
delayInSeconds

integer

Az incidens által okozott késleltetés másodpercekben.
effectiveSpeedInKmh

integer

Az incidens tényleges sebessége km/h-ban, teljes hosszában átlagolt.
endPointIndex

integer

A szakasz útvonalának utolsó pontjának (0. eltolásának) indexe érvényes.
magnitudeOfDelay

DelayMagnitude

Az incidens által okozott késés mértéke. Ezek az értékek a Forgalmi incidens részletei APIválaszmezőjének értékeinek felelnek meg.
sectionType

ResponseSectionType

A jelentett útvonalválasz szakasztípusai
simpleCategory

SimpleCategory

Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információt a "tec" című témakörben talál.
startPointIndex

integer

Az útvonal első pontjának (0. eltolásának) indexe az útvonalra vonatkozik.
tec

RouteSectionTec

A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okozhat.
travelMode

ResponseTravelMode

Utazási mód a számított útvonalhoz. Az érték other lesz beállítva, ha a kért átviteli mód ebben a szakaszban nem lehetséges

RouteSectionTec

A forgalmi esemény részletei a TPEG2-TEC szabvány definícióinak használatával. Tartalmazhatja az effectCode-ot, és elemeket okozhat.

Name Típus Description
causes

RouteSectionTecCause[]

A tömb okai
effectCode

integer

A forgalomra gyakorolt hatás. A TPEG2-TEC szabványban meghatározott tec001:EffectCode táblában lévő értéket tartalmazza. A forgalom eseményeinek színezésére használható a súlyosságnak megfelelően.

RouteSectionTecCause

A forgalmi esemény oka. Tartalmazhat mainCauseCode és subCauseCode elemeket. Ikonográfia és leírások definiálására használható.

Name Típus Description
mainCauseCode

integer

A forgalmi esemény fő oka. A TPEG2-TEC szabványban meghatározott értéket tartalmaz a tec002:CauseCode táblában.
subCauseCode

integer

A forgalmi esemény alkonyata. A mainCauseCode által meghatározott, a TPEG2-TEC szabványban meghatározott értéket tartalmaz a fő oktáblában.

RouteSummary

Összegző objektum

Name Típus Description
arrivalTime

string

Az útvonal vagy a láb becsült érkezési ideje. Az idő UTC-ben van.
departureTime

string

Az útvonal vagy a láb becsült indulási ideje. Az idő UTC-ben van.
lengthInMeters

integer

Hossz a Meters tulajdonságban
trafficDelayInSeconds

integer

A valós idejű incidens(ek) által okozott becsült késés másodpercben a forgalmi információk alapján. A jövőben indulási idővel tervezett útvonalak esetében a késés mindig 0. Ha több utazási időt szeretne visszaadni különböző típusú forgalmi adatok használatával, a computeTravelTimeFor=összes paramétert hozzá kell adni.
travelTimeInSeconds

integer

Becsült utazási idő másodpercben tulajdonság, amely magában foglalja a késés miatt valós idejű forgalom. Vegye figyelembe, hogy még akkor is, ha a traffic=false travelTimeInSeconds továbbra is tartalmazza a forgalom miatti késést. Ha a DepartAt a jövőben lesz, az utazási idő az időfüggő korábbi forgalmi adatok alapján lesz kiszámítva.

RouteType

A kért útvonal típusa.

Name Típus Description
eco

string

A gazdaságosság és a sebesség kiegyensúlyozott útvonala.
fastest

string

A leggyorsabb út.
shortest

string

A legrövidebb útvonal távolság szerint.
thrilling

string

Érdekes vagy kihívást jelentő utakat tartalmaz, és a lehető legkevesebb autópályát használja. Kiválaszthatja a kanyarok szintjét és a dombság fokát is. Ennek beállításához tekintse meg a dombossági és tekercselési paramétereket. A tervezett útvonalakon 900 km-es korlát routeType=izgalmas

SectionType

Megadja, hogy a szakasztípusok közül melyiket jelenti a rendszer az útvonalválaszban.

Ha például a sectionType = gyalogos, akkor a csak gyalogosoknak megfelelő szakaszok lesznek visszaadva. Egy kérelemben többször is megadható, például : "§ionType=carTrain§ionType=gyalogos§ionType=autópálya". Az alapértelmezett sectionType a travelMode bemenetre hivatkozik. Alapértelmezés szerint a travelMode autóra van állítva

Name Típus Description
carTrain

string

Az útvonal szakaszai, amelyek autók vagy vonatok.
carpool

string

Az útvonal azon szakaszai, amelyek telekocsi (HOV/Magas kihasználtságú jármű) sávokat igényelnek.
country

string

Szakaszok, amelyek jelzik, hogy az útvonal mely országokban/régiókban található.
ferry

string

A kompok útvonalának szakaszai.
motorway

string

Az útszakaszok, amelyek autópályák.
pedestrian

string

Az útvonal azon szakaszai, amelyek csak gyalogosok számára alkalmasak.
tollRoad

string

Az útvonal azon szakaszai, amelyek díjkötelesek.
tollVignette

string

Az útvonal azon szakaszai, amelyeknél autópálya-matrica szükséges.
traffic

string

Az útvonal forgalmi adatokat tartalmazó szakaszai.
travelMode

string

A kérelemparaméterhez kapcsolódó szakaszok travelMode.
tunnel

string

Az útvonal alagútszakaszai.
urban

string

Az útvonalnak a városi területeken belüli szakaszai.

SimpleCategory

Az incidens típusa. Jelenleg lehet JAM, ROAD_WORK, ROAD_CLOSURE vagy EGYÉB. Részletes információt a "tec" című témakörben talál.

Name Típus Description
JAM

string

Forgalmi dugó.
OTHER

string

Más.
ROAD_CLOSURE

string

Útlezárás.
ROAD_WORK

string

Közúti munka.

TravelMode

A kért útvonal utazási módja. Ha nincs definiálva, az alapértelmezett érték az "autó". Vegye figyelembe, hogy a kért travelMode nem érhető el a teljes útvonalon. Ha a kért travelMode nem érhető el egy adott szakaszhoz, az adott szakasz válaszának travelMode eleme "egyéb" lesz. Vegye figyelembe, hogy az utazási módok busszal, motorkerékpárral, taxival és kisteherautóval bétaverziós funkciók. A teljes korlátozási adatok nem érhetők el minden területen.

Name Típus Description
bicycle

string

A visszaadott útvonalak kerékpárokra vannak optimalizálva, beleértve a kerékpársávok használatát is.
bus

string

A visszaadott útvonalak buszokra vannak optimalizálva, beleértve a csak buszsávok használatát is. BÉTA-funkciók.
car

string

A visszaadott útvonalak autókhoz vannak optimalizálva.
motorcycle

string

A visszaadott útvonalak motorkerékpárokhoz vannak optimalizálva. BÉTA-funkciók.
pedestrian

string

A visszaadott útvonalak a gyalogosok számára vannak optimalizálva, beleértve a járdák használatát is.
taxi

string

A visszaadott útvonalak taxikra vannak optimalizálva. BÉTA-funkciók.
truck

string

A visszaadott útvonalak haszongépjárművekre, például teherautókra vannak optimalizálva.
van

string

A visszaadott útvonalak kisteherautókhoz vannak optimalizálva. BÉTA-funkciók.

VehicleEngineType

A jármű motortípusa. Részletes használati modell megadásakor konzisztensnek kell lennie vehicleEngineTypeértékével.

Name Típus Description
combustion

string

Belső égésű motor.
electric

string

Elektromos motor.

VehicleLoadType

Veszélyes anyagként besorolható és egyes utakról korlátozott rakománytípusok. A rendelkezésre álló vehicleLoadType értékek az US Hazmat 1–9. osztályai, valamint a más országokban/régiókban használható általános besorolások. Az USHazmat kezdetű értékek az USA útválasztására szolgálnak, míg az otherHazmatot minden más országban/régióban használni kell. A vehicleLoadType többször is megadható. Ez a paraméter jelenleg csak a travelMode=truck esetében tekinthető meg.

Name Típus Description
USHazmatClass1

string

Robbanóanyagok
USHazmatClass2

string

Sűrített gáz
USHazmatClass3

string

Gyúlékony folyadékok
USHazmatClass4

string

Gyúlékony szilárd anyagok
USHazmatClass5

string

Oxidálószerek
USHazmatClass6

string

Mérgek
USHazmatClass7

string

Radioaktív
USHazmatClass8

string

Maró anyagok
USHazmatClass9

string

Vegyes
otherHazmatExplosive

string

Robbanóanyagok
otherHazmatGeneral

string

Vegyes
otherHazmatHarmfulToWater

string

Káros a vízre

WindingnessLevel

Fordulatok szintje az izgalmas útvonalhoz. Ez a paraméter csak routeType=izgalmas együtt használható.

Name Típus Description
high

string

magas
low

string

alacsony
normal

string

normális