Wayfinding - Get Path

Referensi

Service:: Maps Creator

API Version:: 2023-03-01-preview

Gunakan untuk menghitung jalur terbaik antara dua lokasi dalam fasilitas.

Layanan Wayfinding adalah bagian dari Pembuat, dan mematuhi standar Konsorsium Geospasial Terbuka . Wayfinding menggunakan data peta dalam ruangan dari set rute untuk menghitung jalur terbaik antara dua lokasi dalam fasilitas yang sama. Untuk informasi selengkapnya, lihat artikel Wayfinding di artikel Pembuat untuk konsep peta dalam ruangan .

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

With optional parameters:

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Nomor versi API Azure Maps.
facilityId	query	True	string	Pengidentifikasi fasilitas dalam set rute tempat menemukan jalur.
fromLevel	query	True	integer int32	Tingkat asal jalur.
fromPoint	query	True	string	Titik asal jalur dalam format berikut: {lintang},{bujur}.
routesetId	query	True	string	ID set rute untuk dikueri.
toLevel	query	True	integer int32	Tingkat tujuan jalur.
toPoint	query	True	string	Tujuan jalur dalam format berikut: {lintang},{bujur}.
avoidFeatures	query		avoidFeatures[]	Untuk menghindari jenis konektor tertentu di jalur yang dihasilkan. Beberapa nilai dapat ditentukan.
minWidth	query		number	Lebar minimum (dalam meter) bukaan di jalur yang dicari. Misalnya, jika Anda menentukan lebar minimum 0,85, jalur yang dicari akan menghindari bukaan dengan lebar kurang dari 85 sentimeter. Catatan: dengan menggunakan nilai ini, titik jalur yang dihasilkan akan di-buffer dari dinding dan rintangan vertikal lainnya dengan setengah dari lebar yang disediakan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	WayfindResult	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory . Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi direktori Azure Active. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

Get the shortest path between two points in the facility.

Sample Request

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

Sample Response

Status code:: 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
            }
          ]
        }
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
avoidFeatures	Untuk menghindari jenis konektor tertentu di jalur yang dihasilkan. Beberapa nilai dapat ditentukan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
Leg	Bagian dari jalur keseluruhan.
NoResultExplanation	Jika tidak ada jalur yang ditemukan, `paths` array akan kosong. Jika alasan tidak ada jalur yang ditemukan yang dapat ditentukan, properti ini akan memberikan penjelasan mengapa.
Path	Detail tentang jalur tertentu antara asal dan tujuan. Ini dapat terdiri dari satu atau beberapa kaki.
Point	Titik di dalam fasilitas.
WayfindResult	Objek yang dikembalikan oleh permintaan Wayfinding Path ini.

avoidFeatures

Untuk menghindari jenis konektor tertentu di jalur yang dihasilkan. Beberapa nilai dapat ditentukan.

Nama	Jenis	Deskripsi
elevators	string	Hindari lift.
stairs	string	Hindari tangga.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

Leg

Bagian dari jalur keseluruhan.

Nama	Jenis	Deskripsi
endLevel	integer	Lantai dimana kaki ini berakhir.
lengthInMeters	number	Panjang kaki, dalam meter, dari kaki ini.
mode	string	Mode kaki traversal untuk kaki ini. Ini bisa default (semua pada tingkat yang sama), lift atau tangga saat bergerak vertikal di antara tingkat.
points	Point[]	Titik bentuk kaki. Posisi vertikalnya ditentukan sebagai berikut: semua titik berada pada ketinggian yang sama ketika startLevel dan endLevel sama, jika tidak, array hanya akan berisi dua titik: yang pertama di startLevel dan yang kedua di endLevel.
startLevel	integer	Lantai di mana kaki ini dimulai.
timeInSeconds	integer	Waktu perjalanan kaki, dalam hitungan detik, untuk melakukan perjalanan antara titik pertama dan terakhir kaki ini.

NoResultExplanation

Jika tidak ada jalur yang ditemukan, paths array akan kosong. Jika alasan tidak ada jalur yang ditemukan yang dapat ditentukan, properti ini akan memberikan penjelasan mengapa.

Nama	Jenis	Deskripsi
NoExplanation	string	Nilai default yang disediakan saat hasil dikembalikan atau tidak mungkin untuk menentukan mengapa jalur tidak ditemukan.

Path

Detail tentang jalur tertentu antara asal dan tujuan. Ini dapat terdiri dari satu atau beberapa kaki.

Nama	Jenis	Deskripsi
legs	Leg[]	Bagian perjalanan yang berbeda dari jalur ini.
lengthInMeters	number	Panjang jalur, dalam meter, dari seluruh jalur.
timeInSeconds	integer	Total waktu jalur, dalam detik, untuk melakukan perjalanan antara asal dan tujuan saat mengikuti jalur ini.

Point

Titik di dalam fasilitas.

Nama	Jenis	Deskripsi
latitude	number	garis lintang titik
longitude	number	garis bujur titik

WayfindResult

Objek yang dikembalikan oleh permintaan Wayfinding Path ini.

Nama	Jenis	Deskripsi
noResultExplanation	NoResultExplanation	Jika tidak ada jalur yang ditemukan, `paths` array akan kosong. Jika alasan tidak ada jalur yang ditemukan yang dapat ditentukan, properti ini akan memberikan penjelasan mengapa.
paths	Path[]	Array hasil jalur wayfinding. Array kosong akan dikembalikan jika tidak ada hasil yang ditemukan.