Spatial - Get Point In Polygon

Referencia

Szolgáltatás:: Maps

API-verzió:: 2022-08-01

Segítségével megállapíthatja, hogy egy adott pont sokszögek halmazában van-e.

Az Get Point In Polygon API egy HTTP-kérés GET , amely egy logikai értéket ad vissza, amely azt jelzi, hogy egy pont sokszögek halmazában van-e. A sokszögek halmazát egy GeoJSON-fájl biztosítja, amely az Adatregisztrációs adatbázis szolgáltatással tölthető fel, és egy egyedi udid hivatkozik gombra. A GeoJSON-fájl sokszöget és többpolygonos geometriát tartalmazhat, más geometriákat a rendszer figyelmen kívül hagy, ha meg van adva. Ha a pont ezen sokszögek egyikének belsejében vagy határán van, a visszaadott érték igaz. Minden más esetben a visszaadott érték hamis. Ha a pont több sokszögen belül van, az eredmény metszeti geometriák szakaszt ad a felhasználói adatokban az összes érvényes (geometriaazonosítóval hivatkozott) geometria megjelenítéséhez. A sokszög létrehozásához elfogadott csúcspontok maximális száma 10 000.

Az API teszteléséhez feltöltheti a mintaadatokat a Post Point In Polygon API-példákból (kérelemtörzs) az Adatregisztrációs adatbázis szolgáltatással, és lecserélheti az {udid}alábbi mintakérésből származó adatokat az udid adatregisztrációs adatbázis létrehozásakor használtra. További információ: Adatregisztrációs adatbázis létrehozása.

GET https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
geography	path	True	string	Az Azure Maps-fiók helye. Az érvényes értékek az USA keleti régiója, az USA nyugati középső régiója, az USA 2. nyugati régiója és az EU (Észak-Európa, Nyugat-Európa). Erre a paraméterre akkor van szükség, ha `udid` egy meg van adva a kérelemben. Ha például az Azure Maps-fiók az USA keleti régiójában található, a rendszer csak a hozzánk intézett földrajzi kérelmeket fogadja el.
api-version	query	True	string	Az Azure Maps API verziószáma.
lat	query	True	number	Az átadott hely szélessége. Példa: 48.36.
lon	query	True	number	Az átadott hely hosszúsága. Példa: -124.63.
udid	query	True	string	Az érvényes GeoJSON FeatureCollection objektum feltöltéséhez használt egyedi azonosító, amely egy adatjegyzék létrehozásakor használatos. A részleteket az RFC 7946-os verziójában találja. A funkció minden tulajdonságának tartalmaznia kell a `geometryId`elemet, amely a geometria azonosítására szolgál, és megkülönbözteti a kis- és nagybetűk megkülönböztetését. Az adatregisztrációs adatbázis szolgáltatásával kapcsolatos további információkért lásd: Adatregisztrációs adatbázis létrehozása.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez 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 security Azure Mapsben való használatához az alábbi cikkek nyújtanak útmutatást.

Válaszok

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

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok . Az 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ése egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 Azure Maps REST API-ra vonatkozó engedélyből álló 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ás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ehhez a biztonsági definícióhoz a x-ms-client-id fejléc használatával kell jelezni, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure-beli szerepköralapú hozzáférés-vezérlés az 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 esetben.

További információ a Microsoft identitásplatformról: A Microsoft identitásplatformjának áttekintése.

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-erőforrást hoz létre az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy az Azure Maps REST API-k kiszolgálóról kiszolgálóra történő elérését használja, ahol ez a kulcs biztonságosan tárolható.

Típus: apiKey
In: header

SAS Token

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

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Típus: apiKey
In: header

Példák

GetPointInPolygon

Mintakérelem

HTTP

GET https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=47.622942&lon=-122.316456

Mintaválasz

Állapotkód:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 33.5362475,
      "lon": -111.9267386
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "4 polygons processed in user data"
  },
  "result": {
    "pointInPolygons": true,
    "intersectingGeometries": [
      "1001",
      "1003"
    ]
  }
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".
PointInPolygonResult	Igaz értéket ad vissza, ha a pont a sokszögen belül van, ellenkező esetben hamis értéket ad vissza.
PointInPolygonSummary	Pont a sokszög összegzése objektumban
Result	Pont a sokszög eredményobjektumában

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 adattí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 hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript object Notation Data Interchange formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

Name	Típus	Description
lat	number	Latitude tulajdonság
lon	number	Hosszúság tulajdonság

PointInPolygonResult

Igaz értéket ad vissza, ha a pont a sokszögen belül van, ellenkező esetben hamis értéket ad vissza.

Name	Típus	Description
result	Result	Pont a sokszög eredményobjektumában
summary	PointInPolygonSummary	Pont a sokszög összegzése objektumban

PointInPolygonSummary

Pont a sokszög összegzése objektumban

Name	Típus	Description
information	string	Adatok feldolgozása
sourcePoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".
udid	string	A feltöltött tartalom egyedi adatazonosítója (udid). Az Udid nem alkalmazható a POST térbeli műveletekre (null értékre állítva)

Result

Pont a sokszög eredményobjektumában

Name	Típus	Description
intersectingGeometries	string[]	Geometriai tömb
pointInPolygons	boolean	Pont sokszögek tulajdonsága

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