Wayfinding - Get Path

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2023-03-01-preview

A használatával kiszámíthatja a legjobb útvonalat két létesítményen belüli hely között.

A Wayfinding Szolgáltatás a Létrehozó része, és megfelel az Open Geospatial Consortium szabványnak. A wayfinding az útvonalkészletből származó beltéri térképadatokat használja a legjobb útvonal kiszámításához két, ugyanazon létesítményen belüli hely között. További információ: Wayfinding in the Creator for indoor maps concepts ( Útdefiniálás a beltéri térképekhez készült fogalmak készítője ) című cikkben.

GET https:///wayfinding/path?api-version=2023-03-01-preview&routesetId={routesetId}&facilityId={facilityId}&fromPoint={fromPoint}&fromLevel={fromLevel}&toPoint={toPoint}&toLevel={toLevel}

Opcionális paraméterekkel:

GET https:///wayfinding/path?api-version=2023-03-01-preview&routesetId={routesetId}&facilityId={facilityId}&fromPoint={fromPoint}&fromLevel={fromLevel}&toPoint={toPoint}&toLevel={toLevel}&avoidFeatures={avoidFeatures}&minWidth={minWidth}

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	A Azure Maps API verziószáma.
facilityId	query	True	string	Az útvonalkészleten belüli létesítmény azonosítója, ahol az útvonal megtalálható.
fromLevel	query	True	integer int32	Az elérési út forrásszintje.
fromPoint	query	True	string	Az elérési út kezdőpontja a következő formátumban: {latitude},{longitude}.
routesetId	query	True	string	Annak az útvonalkészletnek az azonosítója, amelyről lekérdezhet.
toLevel	query	True	integer int32	Az elérési út célszintje.
toPoint	query	True	string	Az elérési út célhelye a következő formátumban: {latitude},{longitude}.
avoidFeatures	query		avoidFeatures[]	Az eredményként kapott útvonal bizonyos típusú összekötőinek elkerülése érdekében. Több érték is megadható.
minWidth	query		number	A keresett útvonalon lévő nyílások minimális szélessége (méterben). Ha például 0,85-ös minimális szélességet adott meg, a keresett útvonal elkerüli a 85 centiméternél kisebb nyílásokat. Megjegyzés: Ezzel az értékkel az eredményként kapott elérésiút-pontokat a megadott szélesség felével puffereljük a falakból és más függőleges akadályokból.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	WayfindResult	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a 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örrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt 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.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez 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 Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

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ókot hoz létre a Azure Portal vagy a PowerShell, a CLI, az Azure SDK-k vagy a 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.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, 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, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjeleníté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

Get the shortest path between two points in the facility.

Mintakérelem

HTTP

GET https:///wayfinding/path?api-version=2023-03-01-preview&routesetId=[routeset-Id]&facilityId=[facility-Id]&fromPoint=47.652882287901065,-122.13400410050512&fromLevel=-1&toPoint=47.652870534630466,-122.13382884389553&toLevel=0

Mintaválasz

Állapotkód:: 200

{
  "noResultExplanation": "NoExplanation",
  "paths": [
    {
      "lengthInMeters": 51.27548,
      "timeInSeconds": 60,
      "legs": [
        {
          "mode": "Default",
          "lengthInMeters": 14.7605,
          "timeInSeconds": 15,
          "startLevel": 0,
          "endLevel": 0,
          "points": [
            {
              "latitude": 47.6528823,
              "longitude": -122.1340041
            },
            {
              "latitude": 47.6528688,
              "longitude": -122.1340336
            },
            {
              "latitude": 47.6528591,
              "longitude": -122.1340534
            },
            {
              "latitude": 47.6528309,
              "longitude": -122.1341107
            },
            {
              "latitude": 47.6527984,
              "longitude": -122.1341556
            }
          ]
        },
        {
          "mode": "Stair",
          "lengthInMeters": 7.88608,
          "timeInSeconds": 16,
          "startLevel": 0,
          "endLevel": 1,
          "points": [
            {
              "latitude": 47.6527984,
              "longitude": -122.1341556
            },
            {
              "latitude": 47.6527843,
              "longitude": -122.1341395
            }
          ]
        },
        {
          "mode": "Default",
          "lengthInMeters": 28.6289,
          "timeInSeconds": 29,
          "startLevel": 1,
          "endLevel": 1,
          "points": [
            {
              "latitude": 47.6527843,
              "longitude": -122.1341395
            },
            {
              "latitude": 47.6527843,
              "longitude": -122.1341395
            },
            {
              "latitude": 47.6527843,
              "longitude": -122.1341395
            },
            {
              "latitude": 47.6527846,
              "longitude": -122.1341332
            },
            {
              "latitude": 47.652789,
              "longitude": -122.1341315
            },
            {
              "latitude": 47.6527898,
              "longitude": -122.1341312
            },
            {
              "latitude": 47.6527913,
              "longitude": -122.1341306
            },
            {
              "latitude": 47.6527938,
              "longitude": -122.1341295
            },
            {
              "latitude": 47.6528309,
              "longitude": -122.1341137
            },
            {
              "latitude": 47.652856,
              "longitude": -122.1340564
            },
            {
              "latitude": 47.6528694,
              "longitude": -122.1340372
            },
            {
              "latitude": 47.652873,
              "longitude": -122.1339296
            },
            {
              "latitude": 47.6528735,
              "longitude": -122.1339124
            },
            {
              "latitude": 47.6528733,
              "longitude": -122.1339095
            },
            {
              "latitude": 47.6528732,
              "longitude": -122.1338288
            }
          ]
        }
      ]
    }
  ]
}

Definíciók

Name	Description
avoidFeatures	Az eredményként kapott útvonal bizonyos típusú összekötőinek elkerülése érdekében. Több érték is megadható.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Leg	A teljes elérési út egy szakasza.
NoResultExplanation	Ha nem található elérési út, a `paths` tömb üres lesz. Ha nem található elérési út, ez a tulajdonság magyarázatot ad a miértre.
Path	A forrás és a cél közötti útvonal részletei. Egy vagy több lábból áll.
Point	Egy pont a létesítményen belül.
WayfindResult	A Wayfinding Path kérés által visszaadott objektum.

avoidFeatures

Az eredményként kapott útvonal bizonyos típusú összekötőinek elkerülése érdekében. Több érték is megadható.

Name	Típus	Description
elevators	string	Kerülje a lifteket.
stairs	string	Kerülje a lépcsőt.

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.

Leg

A teljes elérési út egy szakasza.

Name	Típus	Description
endLevel	integer	A padló, ahol ez a láb végződik.
lengthInMeters	number	Ennek a lábnak a lábhossza méterben.
mode	string	A láb bejárási módja ehhez a lábhoz. Ez lehet alapértelmezett (mind ugyanazon a szinten), liftek vagy lépcsők, amikor függőlegesen mozognak a szintek között.
points	Point[]	A láb alakzat pontjai. Függőleges pozíciójuk a következőképpen van meghatározva: minden pont azonos magasságban van, ha a startLevel és az endLevel azonos, ellenkező esetben a tömb csak két pontot tartalmaz: az elsőt a startLevelben, a másodikat pedig az endLevelben.
startLevel	integer	A padló, ahol ez a láb kezdődik.
timeInSeconds	integer	A láb utazási ideje másodpercben, a láb első és utolsó pontja közötti utazáshoz.

NoResultExplanation

Ha nem található elérési út, a paths tömb üres lesz. Ha nem található elérési út, ez a tulajdonság magyarázatot ad a miértre.

Name	Típus	Description
NoExplanation	string	Az eredmény visszaadásakor megadott alapértelmezett érték, vagy nem lehetett megállapítani, hogy miért nem található elérési út.

Path

A forrás és a cél közötti útvonal részletei. Egy vagy több lábból áll.

Name	Típus	Description
legs	Leg[]	Az útvonal különböző utazási szakaszai.
lengthInMeters	number	A teljes elérési út hossza méterben.
timeInSeconds	integer	Az elérési út teljes időtartama másodpercben a forrás és a cél között az útvonal követésekor.

Point

Egy pont a létesítményen belül.

Name	Típus	Description
latitude	number	a pont szélessége
longitude	number	a pont hosszúsága

WayfindResult

A Wayfinding Path kérés által visszaadott objektum.

Name	Típus	Description
noResultExplanation	NoResultExplanation	Ha nem található elérési út, a `paths` tömb üres lesz. Ha nem található elérési út, ez a tulajdonság magyarázatot ad a miértre.
paths	Path[]	Az elérési út eredményeinek tömbje. Ha nem található eredmény, a rendszer üres tömböt ad vissza.

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