Spatial - Get Point In Polygon

Referência

Serviço:: Maps

Versão da API:: 2022-08-01

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

A Get Point In Polygon API é uma solicitação HTTP GET que retorna um valor booliano que indica se um ponto está dentro de um conjunto de polígonos. O conjunto de polígonos é fornecido por um arquivo GeoJSON que é carregado usando o serviço registro de dados e referenciado por um udid exclusivo. O arquivo GeoJSON pode conter geometrias Polygon e MultiPolygon, outras geometrias serão ignoradas se fornecidas. Se o ponto estiver dentro ou no limite de um desses polígonos, o valor retornado será true. Em todos os outros casos, o valor retornado é false. Quando o ponto estiver dentro de vários polígonos, o resultado fornecerá a seção geometrias interseccionais para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do usuário. O número máximo de vértices aceitos para formar um Polígono é 10.000.

Para testar essa API, você pode carregar os dados de exemplo dos exemplos da API Post Point in Polygon (Corpo da Solicitação) usando o serviço registro de dados e substituir o {udid} da solicitação de exemplo abaixo pelo udid usado ao criar o registro de dados. Para obter mais informações, confira Como criar um registro de dados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
geography	path	True	string	Local da conta do Azure Mapas. Os valores válidos são nós (Leste dos EUA, Centro-Oeste dos EUA, Oeste dos EUA 2) e UE (Norte da Europa, Europa Ocidental). Esse parâmetro é necessário quando um `udid` é fornecido na solicitação. Por exemplo, se a Conta do Azure Mapas estiver localizada no Leste dos EUA, somente as solicitações para nós geografia serão aceitas.
api-version	query	True	string	Número de versão da API de Mapas Azure.
lat	query	True	number	A latitude do local que está sendo passado. Exemplo: 48.36.
lon	query	True	number	A longitude do local que está sendo passado. Exemplo: -124.63.
udid	query	True	string	A ID exclusiva usada ao criar um Registro de dados para carregar um objeto FeatureCollection GeoJSON válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades do recurso devem conter `geometryId`, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas. Para obter mais informações sobre o serviço de registro de dados, consulte Como criar registro de dados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança de ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte os artigos a seguir para obter diretrizes .

Respostas

Nome	Tipo	Description
200 OK	PointInPolygonResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte Visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor de APIs REST do Azure Mapas em que essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

GetPointInPolygon

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
    ]
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
LatLongPairAbbreviated	Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
PointInPolygonResult	Retornará true se o ponto estiver dentro do polígono; caso contrário, false
PointInPolygonSummary	Objeto Point In Polygon Summary
Result	Ponto no objeto de resultado de polígono

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

Nome	Tipo	Description
lat	number	Propriedade Latitude
lon	number	Propriedade Longitude

PointInPolygonResult

Retornará true se o ponto estiver dentro do polígono; caso contrário, false

Nome	Tipo	Description
result	Result	Ponto no objeto de resultado de polígono
summary	PointInPolygonSummary	Objeto Point In Polygon Summary

PointInPolygonSummary

Objeto Point In Polygon Summary

Nome	Tipo	Description
information	string	Informações de processamento
sourcePoint	LatLongPairAbbreviated	Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
udid	string	Uma ID de dados exclusiva (udid) para o conteúdo carregado. Udid não é aplicável a operações espaciais POST (definidas como nulas)

Result

Ponto no objeto de resultado de polígono

Nome	Tipo	Description
intersectingGeometries	string[]	Matriz de geometrias
pointInPolygons	boolean	Propriedade Point In Polygons

Compartilhar via