Spatial - Get Point In Polygon

Reference

Služba:: Maps

Verze rozhraní API:: 2022-08-01

Slouží k určení, zda se daný bod nachází uvnitř sady mnohoúhelníků.

Rozhraní Get Point In Polygon API je požadavek HTTP GET , který vrací logickou hodnotu označující, jestli se bod nachází uvnitř sady mnohoúhelníků. Sada mnohoúhelníků je poskytována souborem GeoJSON, který se nahraje pomocí služby registru dat a odkazuje na něho jedinečný identifikátor udid. Soubor GeoJSON může obsahovat geometrie Polygon a MultiPolygon, ostatní geometrie budou ignorovány, pokud jsou zadané. Pokud je bod uvnitř nebo na hranici jednoho z těchto mnohoúhelníků, je vrácená hodnota true. Ve všech ostatních případech je vrácená hodnota false. Když je bod uvnitř více mnohoúhelníku, výsledek poskytne oddíl protínající se geometrie, který zobrazí všechny platné geometrie (na které odkazuje geometryId) v uživatelských datech. Maximální počet vrcholů přijatých k vytvoření mnohoúhelníku je 10 000.

K otestování tohoto rozhraní API můžete nahrát ukázková data z příkladů post point in Polygon API (text požadavku) pomocí služby registru dat a nahradit {udid} z níže uvedené ukázkové žádosti vzory použitými udid při vytváření registru dat. Další informace najdete v tématu Vytvoření registru dat.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
geography	path	True	string	Umístění účtu Azure Maps Platné hodnoty jsou my (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). Tento parametr je povinný, pokud `udid` je v požadavku zadán parametr . Pokud se například účet Azure Maps nachází v oblasti USA – východ, budou přijímány pouze požadavky na geografickou oblast.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
lat	query	True	number	Zeměpisná šířka předávaného umístění. Příklad: 48,36.
lon	query	True	number	Zeměpisná délka předávaného umístění Příklad: -124,63.
udid	query	True	string	Jedinečné ID použité při vytváření registru dat k nahrání platné GeoJSON FeatureCollection objektu. Podrobnosti najdete v dokumentu RFC 7946 . Všechny vlastnosti prvku by měly obsahovat `geometryId`, který slouží k identifikaci geometrie a rozlišuje malá a velká písmena. Další informace o službě registru dat najdete v tématu Vytvoření registru dat.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Odpovědi

Name	Typ	Description
200 OK	PointInPolygonResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo několika oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.

U veřejně vystavených aplikací doporučujeme použít přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

GetPointInPolygon

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
    ]
  }
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
PointInPolygonResult	Vrátí hodnotu true, pokud se bod nachází v mnohoúhelníku, jinak vrátí hodnotu false.
PointInPolygonSummary	Bod v objektu Souhrn mnohoúhelníku
Result	Bod v objektu výsledku mnohoúhelníku

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu

LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

Name	Typ	Description
lat	number	Vlastnost Zeměpisná šířka
lon	number	Zeměpisná délka – vlastnost

PointInPolygonResult

Vrátí hodnotu true, pokud se bod nachází v mnohoúhelníku, jinak vrátí hodnotu false.

Name	Typ	Description
result	Result	Bod v objektu výsledku mnohoúhelníku
summary	PointInPolygonSummary	Bod v objektu Souhrn mnohoúhelníku

PointInPolygonSummary

Bod v objektu Souhrn mnohoúhelníku

Name	Typ	Description
information	string	Zpracování informací
sourcePoint	LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
udid	string	Jedinečné ID dat (udid) pro nahraný obsah. Udid se nevztahuje na prostorové operace POST (nastaveno na hodnotu null).

Result

Bod v objektu výsledku mnohoúhelníku

Name	Typ	Description
intersectingGeometries	string[]	Matice geometrie
pointInPolygons	boolean	Point in Mnohoúhelníky – vlastnost

Sdílet prostřednictvím