Spatial - Post Point In Polygon
Gunakan untuk menentukan apakah titik tertentu berada di dalam satu set poligon.
Post Point In Polygon
API adalah permintaan HTTP POST
yang mengembalikan nilai boolean yang menunjukkan apakah titik berada di dalam satu set poligon. Data pengguna mungkin berisi geometri Polygon dan MultiPolygon, geometri lain akan diabaikan jika disediakan. Jika titik berada di dalam atau di batas salah satu poligon ini, nilai yang dikembalikan adalah true. Dalam semua kasus lain, nilai yang dikembalikan adalah false. Ketika titik berada di dalam beberapa poligon, hasilnya akan memberikan bagian geometri yang bersinggungan untuk menampilkan semua geometri yang valid (direferensikan oleh geometryId) dalam data pengguna. Jumlah maksimum simpul yang diterima untuk membentuk Poligon adalah 10.000.
POST https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&lat={lat}&lon={lon}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Hanya |
|
geography
|
path | True |
string |
Lokasi Akun Azure Maps. Nilai yang valid adalah kita (US Timur, US Tengah Barat, AS Barat 2) dan Eropa (Eropa Utara, Eropa Barat). Parameter ini diperlukan ketika |
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
lat
|
query | True |
number |
Garis lintang lokasi yang dilewati. Contoh: 48.36. |
lon
|
query | True |
number |
Garis bujur lokasi yang dilewati. Contoh: -124.63. |
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. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
features | True |
Berisi daftar objek yang valid |
|
type | True |
string:
Feature |
Menentukan jenisnya |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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.
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 membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, ini saat ini dapat diperlakukan sebagai kunci master ke akun tempat mereka dikeluarkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server Azure Maps REST API tempat kunci ini dapat disimpan dengan aman.
Type:
apiKey
In:
header
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
PostPointInPolygon
Sample Request
POST https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&lat=33.5362475&lon=-111.9267386
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": 1001
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-111.9267386,
33.5362475
],
[
-111.9627875,
33.5104882
],
[
-111.9027061,
33.5004686
],
[
-111.9267386,
33.5362475
]
]
]
}
}
]
}
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 33.5362475,
"lon": -111.9267386
},
"udid": null,
"information": "1 polygons processed in user data"
},
"result": {
"pointInPolygons": true,
"intersectingGeometries": [
"1001"
]
}
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Geo |
Jenis objek yang valid |
Geo |
Jenis objek yang valid |
Geo |
Objek geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Json |
Format respons yang diinginkan. Hanya |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
Point |
Mengembalikan true jika titik berada dalam poligon, salah jika tidak |
Point |
Titik Dalam objek Ringkasan Poligon |
Result |
Titik dalam objek hasil poligon |
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
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: |
Objek geometri yang valid |
id |
string |
Pengidentifikasi untuk fitur tersebut. |
type |
string:
Feature |
Menentukan jenisnya |
GeoJsonFeatureCollection
Jenis objek yang valid GeoJSON FeatureCollection
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
features |
Berisi daftar objek yang valid |
|
type |
string:
Feature |
Menentukan jenisnya |
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 |
Geo |
Menentukan jenisnya |
GeoJsonGeometryCollection
Jenis objek yang valid GeoJSON GeometryCollection
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
geometries | GeoJsonGeometry[]: |
Berisi daftar objek geometri yang valid |
type |
string:
Geometry |
Menentukan jenisnya |
GeoJsonLineString
Jenis geometri yang valid GeoJSON LineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Line |
Menentukan jenisnya |
GeoJsonMultiLineString
Jenis geometri yang valid GeoJSON MultiLineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonMultiPoint
Jenis geometri yang valid GeoJSON MultiPoint
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonMultiPolygon
Jenis objek yang valid GeoJSON MultiPolygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Berisi daftar objek yang valid |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonPoint
Jenis geometri yang valid GeoJSON Point
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
|
type |
string:
Point |
Menentukan jenisnya |
GeoJsonPolygon
Jenis geometri yang valid GeoJSON Polygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Polygon |
Menentukan jenisnya |
JsonFormat
Format respons yang diinginkan. Hanya json
format yang didukung.
Nama | Jenis | Deskripsi |
---|---|---|
json |
string |
LatLongPairAbbreviated
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
Nama | Jenis | Deskripsi |
---|---|---|
lat |
number |
Properti garis lintang |
lon |
number |
Properti garis bujur |
PointInPolygonResult
Mengembalikan true jika titik berada dalam poligon, salah jika tidak
Nama | Jenis | Deskripsi |
---|---|---|
result |
Titik dalam objek hasil poligon |
|
summary |
Titik Dalam objek Ringkasan Poligon |
PointInPolygonSummary
Titik Dalam objek Ringkasan Poligon
Nama | Jenis | Deskripsi |
---|---|---|
information |
string |
Memproses informasi |
sourcePoint |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
|
udid |
string |
Id data unik (udid) untuk konten yang diunggah. Udid tidak berlaku untuk operasi spasial POST (diatur ke null) |
Result
Titik dalam objek hasil poligon
Nama | Jenis | Deskripsi |
---|---|---|
intersectingGeometries |
string[] |
Array geometri |
pointInPolygons |
boolean |
Properti Point In Polygons |