Search - Get Search Polygon

Referensi

Layanan:: Maps

Versi API:: 1.0

Gunakan untuk mendapatkan data poligon dari bentuk area geografis seperti kota atau wilayah negara.

Get Polygon API adalah permintaan HTTP GET yang mengembalikan data geometri seperti kerangka kota atau negara/wilayah untuk sekumpulan entitas, yang sebelumnya diambil dari permintaan pencarian online dalam format GeoJSON. ID geometri dikembalikan dalam objek di sourceGeometry bawah "geometri" dan "id" dalam Alamat Search atau panggilan Fuzzy Search.

ID geometri yang diambil dari titik akhir pencarian online memiliki masa pakai terbatas, tidak disarankan untuk menyimpan ID geometri di penyimpanan persisten untuk rujukan nanti. Diharapkan bahwa permintaan ke metode Poligon dibuat dalam beberapa menit setelah permintaan ke metode pencarian online yang memberikan ID. Layanan ini memungkinkan permintaan batch hingga 20 pengidentifikasi.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
api-version	query	True	string	Nomor versi API Azure Maps.
geometries	query	True	string[]	Daftar UUID geometri yang dipisahkan koma, yang sebelumnya diambil dari permintaan pencarian online.

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	PolygonResult	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. 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 Microsoft Entra ID.
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.
Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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.

Jenis: apiKey
Dalam: 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.

Jenis: apiKey
Dalam: header

Contoh

Get the Geometry using the geometry id returned by the previous Search

Permintaan sampel

HTTP

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Respon sampel

Kode status:: 200

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GeoJsonFeature	Jenis objek yang valid `GeoJSON Feature` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonFeatureCollection	Jenis objek yang valid `GeoJSON FeatureCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometry	Objek geometri yang valid `GeoJSON` . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometryCollection	Jenis objek yang valid `GeoJSON GeometryCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonLineString	Jenis geometri yang valid `GeoJSON LineString` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiLineString	Jenis geometri yang valid `GeoJSON MultiLineString` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPoint	Jenis geometri yang valid `GeoJSON MultiPoint` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPolygon	Jenis objek yang valid `GeoJSON MultiPolygon` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPoint	Jenis geometri yang valid `GeoJSON Point` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPolygon	Jenis geometri yang valid `GeoJSON Polygon` . Silakan merujuk ke RFC 7946 untuk detailnya.
JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
Polygon
PolygonResult	Objek ini dikembalikan dari panggilan Poligon Search berhasil

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.

GeoJsonFeature

Jenis objek yang valid GeoJSON Feature . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
featureType	string	Jenis fitur. Nilai tergantung pada model data yang menjadi bagian dari fitur saat ini. Beberapa model data mungkin memiliki nilai kosong.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objek geometri yang valid `GeoJSON` . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
id	string	Pengidentifikasi untuk fitur tersebut.
type	string: Feature	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonFeatureCollection

Jenis objek yang valid GeoJSON FeatureCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
features	GeoJsonFeature[]	Berisi daftar objek yang valid `GeoJSON Feature` .
type	string: FeatureCollection	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
type	GeoJsonObjectType	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Berisi daftar objek geometri yang valid `GeoJSON` . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: GeometryCollection	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson LineString` untuk geometri.
type	string: LineString	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson MultiLineString` untuk geometri.
type	string: MultiLineString	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson MultiPoint` untuk geometri.
type	string: MultiPoint	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Berisi daftar objek yang valid `GeoJSON Polygon` . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: MultiPolygon	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	`Position` adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah garis bujur dan lintang, tepatnya dalam urutan tersebut. Ketinggian/Elevasi adalah elemen ketiga opsional. Silakan merujuk ke RFC 7946 untuk detailnya.
type	string: Point	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson Polygon` untuk jenis geometri.
type	string: Polygon	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript

Polygon

Nama	Jenis	Deskripsi
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Data geometri dalam format GeoJSON. Silakan merujuk ke RFC 7946 untuk detailnya. Hanya ada jika "kesalahan" tidak ada.
providerID	string	ID entitas yang dikembalikan

PolygonResult

Objek ini dikembalikan dari panggilan Poligon Search berhasil

Nama	Jenis	Deskripsi
additionalData	Polygon[]	Array hasil

Bagikan melalui