Spatial - Get Point In Polygon

Ссылка

Service:: Maps

API Version:: 2022-08-01

Используйте , чтобы определить, находится ли заданная точка внутри набора многоугольников.

Get Point In Polygon API — это HTTP-запросGET, который возвращает логическое значение, указывающее, находится ли точка внутри набора многоугольников. Набор многоугольников предоставляется файлом GeoJSON, который отправляется с помощью службы реестра данных и ссылается на него уникальный идентификатор udid. Файл GeoJSON может содержать геометрические объекты Polygon и MultiPolygon, а другие геометрические объекты будут игнорироваться, если они указаны. Если точка находится внутри или на границе одного из этих многоугольников, возвращается значение true. Во всех остальных случаях возвращается значение false. Если точка находится внутри нескольких многоугольников, результат даст раздел пересекающихся геометрических объектов, чтобы отобразить все допустимые геометрические объекты (на которые ссылается geometryId) в пользовательских данных. Максимальное число вершин, принятых для формирования многоугольника, составляет 10 000.

Чтобы протестировать этот API, можно передать примеры данных из примеров API Post Point In Polygon (текст запроса) с помощью службы реестра данных и заменить {udid} из примера запроса ниже на объект , используемый udid при создании реестра данных. Дополнительные сведения см. в статье Создание реестра данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
geography	path	True	string	Расположение учетной записи Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа). Этот параметр является обязательным при указании `udid` в запросе . Например, если учетная запись Azure Maps находится в восточной части США, будут приниматься только запросы к географическому региону.
api-version	query	True	string	Номер версии API Azure Maps
lat	query	True	number	Широта передаваемого расположения. Пример: 48.36.
lon	query	True	number	Долгота передаваемого расположения. Пример: -124.63.
udid	query	True	string	Уникальный идентификатор, используемый при создании реестра данных для отправки допустимого объекта GeoJSON FeatureCollection. Дополнительные сведения см. в документе RFC 7946 . Все свойства компонента должны содержать `geometryId`, который используется для идентификации геометрии и учитывает регистр. Дополнительные сведения о службе реестра данных см. в статье Создание реестра данных.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	PointInPolygonResult	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps с помощью плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которой они выдаются.

Для общедоступных приложений мы рекомендуем использовать межсерверный доступ Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: header

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
PointInPolygonResult	Возвращает значение true, если точка находится в многоугольнике, в противном случае — значение false.
PointInPolygonSummary	Объект Point In Polygon Summary
Result	Объект результата "Точка в многоугольнике"

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

Имя	Тип	Описание
lat	number	Свойство Latitude
lon	number	Свойство Longitude

PointInPolygonResult

Возвращает значение true, если точка находится в многоугольнике, в противном случае — значение false.

Имя	Тип	Описание
result	Result	Объект результата "Точка в многоугольнике"
summary	PointInPolygonSummary	Объект Point In Polygon Summary

PointInPolygonSummary

Объект Point In Polygon Summary

Имя	Тип	Описание
information	string	Обработка информации
sourcePoint	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
udid	string	Уникальный идентификатор данных (udid) для отправленного содержимого. Udid неприменим для пространственных операций POST (задано значение NULL)

Result

Объект результата "Точка в многоугольнике"

Имя	Тип	Описание
intersectingGeometries	string[]	Массив geometries
pointInPolygons	boolean	Свойство Point In Polygons