Spatial - Get Point In Polygon

  • Referencia
Service:
Maps
API Version:
2022-08-01

A következőkre vonatkozik: lásd: tarifacsomagok.

Ez az API egy logikai értéket ad vissza, amely azt jelzi, hogy egy pont többszögek halmazában van-e. A sokszögek készletét egy GeoJSON-fájl biztosítja, amely a Data Upload API-val tölthető fel, és egy egyedi udid hivatkozik rá. A GeoJSON-fájl tartalmazhat sokszög- és többpoligongeometriát, más geometriákat a rendszer figyelmen kívül hagy, ha meg van adva. Ha a pont ezen sokszögek egyikén belül vagy annak határán van, a visszaadott érték igaz. Minden más esetben a visszaadott érték hamis. Ha a pont több sokszögben van, az eredmény metszeti geometriaszakaszt 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érelem törzse) az Adatfeltöltés API-val , és lecserélheti az alábbi mintakérés [udid] értékét az Adatfeltöltési API által visszaadott udid értékre.

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

A Azure Maps-fiók helye. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, 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 a udid kérelemben egy meg van adva. Ha például a Azure Maps-fiók az USA keleti régiójában található, akkor csak a földrajzra vonatkozó kérések lesznek elfogadva.
api-version
 query True

string

A 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

A Data Upload API-ból egy érvényes GeoJSON FeatureCollection objektum feltöltése után visszaadott egyedi azonosító. A részletekért tekintse meg az RFC 7946-ot . A funkció minden tulajdonságának tartalmaznia kell , geometryIdamely a geometria azonosítására szolgál, és megkülönbözteti a kis- és nagybetűk megkülönböztetését.

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 Azure AD 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. Ha Azure AD biztonságot szeretne használni Azure Maps tekintse meg az alábbi cikkeket.

Válaszok

Name Típus Description
200 OK

PointInPolygonResult

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.

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps erőforrást hoz 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 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 javasoljuk, hogy használja a Azure Maps REST API-k kiszolgálóról kiszolgálóra való hozzáférését, ahol ez a kulcs biztonságosan tárolható.

Type: apiKey
In: header

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.

Type: apiKey
In: header

Példák

GetPointInPolygon

Sample Request

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

Sample Response

Status code:
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 ábrázolt hely a "lat" "lon" & rövid nevek használatával.
PointInPolygonResult

Igaz értéket ad vissza, ha a pont a sokszögen belül van, máskülönben hamis
PointInPolygonSummary

Pont sokszögösszegző 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 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.

JsonFormat

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

Name Típus Description
json

string

A JavaScript-objektum jelölési adatcseréjének formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

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, máskülönben hamis

Name Típus Description
result

Result

Pont a sokszög eredményobjektumában
summary

PointInPolygonSummary

Pont sokszögösszegző objektumban

PointInPolygonSummary

Pont sokszögösszegző objektumban

Name Típus Description
information

string

Adatok feldolgozása
sourcePoint

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.
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 a sokszögek tulajdonságában