Partilhar via

Spatial - Post Point In Polygon

  • Referência
Serviço:
Maps
Versão da API:
2022-08-01

Utilizado para determinar se um determinado ponto está dentro de um conjunto de polígonos.

A Post Point In Polygon API é um pedido HTTP POST que devolve um valor booleano que indica se um ponto está dentro de um conjunto de polígonos. Os dados do utilizador podem conter geometrias de Polígono e Multipolygon, caso sejam fornecidas outras geometrias. Se o ponto estiver dentro ou no limite de um destes polígonos, o valor devolvido é verdadeiro. Em todos os outros casos, o valor devolvido é falso. Quando o ponto está dentro de vários polígonos, o resultado dará a secção geometrias de interseção para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do utilizador. O número máximo de vértices aceites para formar um Polígono é 10 000.

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

Parâmetros do URI

Name Em Necessário Tipo Description
format
 path True

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
geography
 path True

string

Localização da Conta do Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental). Este parâmetro é necessário quando um udid é fornecido no pedido. Por exemplo, se a Conta do Azure Maps estiver localizada nos E.U.A. Leste, apenas serão aceites pedidos para nós, geografia.
api-version
 query True

string

Número da versão da API do Azure Maps.
lat
 query True

number

A latitude da localização que está a ser transmitida. Exemplo: 48.36.
lon
 query True

number

A longitude da localização que está a ser transmitida. Exemplo: -124.63.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Corpo do Pedido

Name Necessário Tipo Description
features True

GeoJsonFeature[]

Contém uma lista de objetos válidos GeoJSON Feature .
type True string:

FeatureCollection

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Respostas

Name Tipo Description
200 OK

PointInPolygonResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

PostPointInPolygon

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
GeoJsonFeature

Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureCollection

Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.
GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
PointInPolygonResult

Devolve verdadeiro se o ponto estiver dentro do polígono, falso caso contrário
PointInPolygonSummary

Objeto Resumo do Polígono Ponto Em
Result

Objeto de Resultado de Polígono Com Ponto Em Polígono

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeoJsonFeature

Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
featureType

string

O tipo da funcionalidade. O valor depende do modelo de dados do qual a funcionalidade atual faz parte. Alguns modelos de dados podem ter um valor vazio.
geometry GeoJsonGeometry:

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
id

string

Identificador da funcionalidade.
type string:

Feature

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonFeatureCollection

Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
features

GeoJsonFeature[]

Contém uma lista de objetos válidos GeoJSON Feature .
type string:

FeatureCollection

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Name Tipo Description
type

GeoJsonObjectType

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria válidos GeoJSON . Tenha em atenção que as coordenadas em GeoJSON estão em x, y order (longitude, latitude).
type string:

GeometryCollection

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson LineString geometria.
type string:

LineString

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiLineString geometria.
type string:

MultiLineString

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiPoint geometria.
type string:

MultiPoint

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Contém uma lista de objetos válidos GeoJSON Polygon . Tenha em atenção que as coordenadas em GeoJSON estão em x, y order (longitude, latitude).
type string:

MultiPolygon

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

A Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para o GeoJson Polygon tipo de geometria.
type string:

Polygon

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

Name Tipo Description
lat

number

Propriedade Latitude
lon

number

Propriedade Longitude

PointInPolygonResult

Devolve verdadeiro se o ponto estiver dentro do polígono, falso caso contrário

Name Tipo Description
result

Result

Objeto de Resultado de Polígono Com Ponto Em Polígono
summary

PointInPolygonSummary

Objeto Resumo do Polígono Ponto Em

PointInPolygonSummary

Objeto Resumo do Polígono Ponto Em

Name Tipo Description
information

string

Informações de processamento
sourcePoint

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
udid

string

Um ID de dados exclusivo (udid) para o conteúdo carregado. A Udid não é aplicável para operações espaciais POST (definidas como nulas)

Result

Objeto de Resultado de Polígono Com Ponto Em Polígono

Name Tipo Description
intersectingGeometries

string[]

Matriz de geometrias
pointInPolygons

boolean

Propriedade Point In Polygons