Share via

Spatial - Post Point In Polygon

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

Använd för att avgöra om en viss punkt finns inuti en uppsättning polygoner.

API:et Post Point In Polygon är en HTTP-begäran POST som returnerar ett booleskt värde som anger om en punkt finns i en uppsättning polygoner. Användardata kan innehålla polygon- och multipolygongeometrier, andra geometrier ignoreras om de tillhandahålls. Om punkten finns inuti eller på gränsen till en av dessa polygoner är värdet som returneras sant. I alla andra fall är värdet som returneras falskt. När punkten är inuti flera polygoner ger resultatet tvärsnitt av geometrier för att visa alla giltiga geometrier (refererade med geometriId) i användardata. Det maximala antalet hörn som accepteras för att bilda en polygon är 10 000.

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

URI-parametrar

Name I Obligatorisk Typ Description
format
 path True

JsonFormat

Önskat format för svaret. Endast json format stöds.
geography
 path True

string

Platsen för Azure Maps-kontot. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). Den här parametern krävs när en udid anges i begäran. Om till exempel Azure Maps-kontot finns i USA, östra godkänns endast begäranden till oss geografi.
api-version
 query True

string

Versionsnummer för Azure Maps API.
lat
 query True

number

Latitud för den plats som skickas. Exempel: 48.36.
lon
 query True

number

Longitud för den plats som skickas. Exempel: -124.63.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

Name Obligatorisk Typ Description
features True

GeoJsonFeature[]

Innehåller en lista över giltiga GeoJSON Feature objekt.
type True string:

FeatureCollection

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Svar

Name Typ Description
200 OK

PointInPolygonResult

OK
Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

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

Det här är en delad nyckel som etableras när du skapar en Azure Maps resurs via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Type: apiKey
In: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

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

Status code:
200 
{
  "summary": {
    "sourcePoint": {
      "lat": 33.5362475,
      "lon": -111.9267386
    },
    "udid": null,
    "information": "1 polygons processed in user data"
  },
  "result": {
    "pointInPolygons": true,
    "intersectingGeometries": [
      "1001"
    ]
  }
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
GeoJsonFeature

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946 .
GeoJsonFeatureCollection

En giltig GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946 .
GeoJsonGeometry

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946 .
GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946 .
GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .
GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946 .
JsonFormat

Önskat format för svaret. Endast json format stöds.
LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
PointInPolygonResult

Returnerar sant om punkten ligger inom polygonen, annars falskt
PointInPolygonSummary

Punkt i polygonsammanfattningsobjekt
Result

Punkt i polygonresultatobjekt

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GeoJsonFeature

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946 .

Name Typ Description
featureType

string

Funktionens typ. Värdet beror på vilken datamodell den aktuella funktionen är en del av. Vissa datamodeller kan ha ett tomt värde.
geometry GeoJsonGeometry:

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
id

string

Identifierare för funktionen.
type string:

Feature

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonFeatureCollection

En giltig GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946 .

Name Typ Description
features

GeoJsonFeature[]

Innehåller en lista över giltiga GeoJSON Feature objekt.
type string:

FeatureCollection

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometry

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .

Name Typ Description
type

GeoJsonObjectType

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946 .

Name Typ Description
geometries GeoJsonGeometry[]:

Innehåller en lista över giltiga GeoJSON geometriobjekt. Observera att koordinaterna i GeoJSON är i x- och y-ordning (longitud, latitud).
type string:

GeometryCollection

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Koordinater för geometrin GeoJson LineString .
type string:

LineString

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Koordinater för geometrin GeoJson MultiLineString .
type string:

MultiLineString

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Koordinater för geometrin GeoJson MultiPoint .
type string:

MultiPoint

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Innehåller en lista över giltiga GeoJSON Polygon objekt. Observera att koordinaterna i GeoJSON är i x- och y-ordning (longitud, latitud).
type string:

MultiPolygon

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

A Position är en matris med tal med två eller flera element. De två första elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946 .
type string:

Point

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946 .

Name Typ Description
coordinates

number[]

Koordinater för GeoJson Polygon geometritypen.
type string:

Polygon

Anger GeoJSON typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name Typ Description
json

string

Datautbytesformat för JavaScript-objektnotation

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

Name Typ Description
lat

number

Latitude-egenskap
lon

number

Longitudegenskap

PointInPolygonResult

Returnerar sant om punkten ligger inom polygonen, annars falskt

Name Typ Description
result

Result

Punkt i polygonresultatobjekt
summary

PointInPolygonSummary

Punkt i polygonsammanfattningsobjekt

PointInPolygonSummary

Punkt i polygonsammanfattningsobjekt

Name Typ Description
information

string

Bearbeta information
sourcePoint

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
udid

string

Ett unikt data-ID (udid) för det uppladdade innehållet. Udid gäller inte för post spatiala åtgärder (inställt på null)

Result

Punkt i polygonresultatobjekt

Name Typ Description
intersectingGeometries

string[]

Matris för geometrier
pointInPolygons

boolean

Punkt i Polygons-egenskap