Spatial - Get Point In Polygon

Referentie

Service:: Maps

API Version:: 2022-08-01

Gebruik om te bepalen of een gegeven punt zich binnen een reeks veelhoeken bevindt.

De Get Point In Polygon API is een HTTP-aanvraag GET die een booleaanse waarde retourneert die aangeeft of een punt zich binnen een set veelhoeken bevindt. De set veelhoeken wordt geleverd door een GeoJSON-bestand dat wordt geüpload met behulp van de dataregisterservice en waarnaar wordt verwezen door een unieke udid. Het GeoJSON-bestand kan polygoon- en multipolygongeometrieën bevatten, andere geometrieën worden genegeerd indien opgegeven. Als het punt zich binnen of op de grens van een van deze veelhoeken bevindt, is de geretourneerde waarde waar. In alle andere gevallen is de geretourneerde waarde onwaar. Wanneer het punt zich in meerdere veelhoeken bevindt, krijgt het resultaat een sectie met snijdende geometrieën om alle geldige geometrieën (waarnaar wordt verwezen door geometryId) in gebruikersgegevens weer te geven. Het maximum aantal hoekpunten dat wordt geaccepteerd om een veelhoek te vormen, is 10.000.

Als u deze API wilt testen, kunt u de voorbeeldgegevens van Post Point In Polygon API-voorbeelden (Aanvraagbody) uploaden met behulp van de gegevensregisterservice en de {udid} uit de onderstaande voorbeeldaanvraag vervangen door de udid die wordt gebruikt bij het maken van het gegevensregister. Zie Gegevensregister maken voor meer informatie.

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

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
geography	path	True	string	Locatie van het Azure Maps-account. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west). Deze parameter is vereist wanneer een `udid` wordt opgegeven in de aanvraag. Als het Azure Maps-account zich bijvoorbeeld in VS - oost bevindt, worden alleen aanvragen aan ons geografisch gebied geaccepteerd.
api-version	query	True	string	Versienummer van Azure Maps API.
lat	query	True	number	De breedtegraad van de locatie die wordt doorgegeven. Voorbeeld: 48.36.
lon	query	True	number	De lengtegraad van de locatie die wordt doorgegeven. Voorbeeld: -124,63.
udid	query	True	string	De unieke id die wordt gebruikt bij het maken van een gegevensregister om een geldig GeoJSON FeatureCollection-object te uploaden. Raadpleeg RFC 7946 voor meer informatie. Alle eigenschappen van de functie moeten bevatten `geometryId`, die wordt gebruikt voor het identificeren van de geometrie en is hoofdlettergevoelig. Zie Gegevensregister maken voor meer informatie over de gegevensregisterservice.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	PointInPolygonResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

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

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

GetPointInPolygon

Sample Request

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

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"
    ]
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
PointInPolygonResult	Retourneert waar als punt zich binnen de veelhoek bevindt, anders onwaar
PointInPolygonSummary	Samenvattingsobject punt in veelhoek
Result	Resultaatobject punt in veelhoek

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name	Type	Description
lat	number	De eigenschap Breedtegraad
lon	number	De eigenschap Lengtegraad

PointInPolygonResult

Retourneert waar als punt zich binnen de veelhoek bevindt, anders onwaar

Name	Type	Description
result	Result	Resultaatobject punt in veelhoek
summary	PointInPolygonSummary	Samenvattingsobject punt in veelhoek

PointInPolygonSummary

Samenvattingsobject punt in veelhoek

Name	Type	Description
information	string	Informatie verwerken
sourcePoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
udid	string	Een unieke gegevens-id (udid) voor de geüploade inhoud. Udid is niet van toepassing op ruimtelijke POST-bewerkingen (ingesteld op null)

Result

Resultaatobject punt in veelhoek

Name	Type	Description
intersectingGeometries	string[]	Matrix geometrieën
pointInPolygons	boolean	Eigenschap Punt in veelhoeken