Spatial - Get Closest Point

Ссылка

Service:: Maps

API Version:: 2022-08-01

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

Get Closest Point API — это HTTP-запросGET, который является ближайшей точкой между базовой точкой и заданным набором точек в отправленном пользователем наборе данных, определяемом .udid Набор целевых точек предоставляется файлом GeoJSON, который отправляется с помощью службы реестра данных и ссылается на него уникальный udid. Файл GeoJSON может содержать только коллекцию точечной геометрии. MultiPoint или другие геометрические объекты будут игнорироваться, если они указаны. Максимальное количество принятых баллов — 100 000. Алгоритм не учитывает маршрутизацию или трафик. Возвращаемые сведения включают широту ближайшей точки, долготу и расстояние в метрах от ближайшей точки.

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

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

With optional parameters:

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

Параметры 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`, который используется для идентификации геометрии и учитывает регистр. Дополнительные сведения о службе реестра данных см. в статье Создание реестра данных.
numberOfClosestPoints	query		integer	Число ближайших точек, ожидаемых от ответа. По умолчанию: 1, минимум: 1 и максимум: 50

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

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

Ответы

Имя	Тип	Описание
200 OK	ClosestPointResponse	ОК
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, пакетов SDK для Azure или 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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

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

Type: apiKey
In: header

Примеры

GetClosestPoint

Sample Request

HTTP

GET https://us.atlas.microsoft.com/spatial/closestPoint/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": 47.622942,
      "lon": -122.316456
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "10 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.51615340677395,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}

Определения

Имя	Описание
ClosestPoint	Объект ввода результатов ближайшей точки
ClosestPointResponse	Этот объект возвращается из успешного вызова пространственной ближайшей точки
ClosestPointSummary	Объект Ближайшей точки Summary
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

ClosestPoint

Объект ввода результатов ближайшей точки

Имя	Тип	Описание
distanceInMeters	number	Расстояние в метрах от исходной точки до ближайшей точки
geometryId	string	Уникальный идентификатор идентифицирует геометрию
position	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

ClosestPointResponse

Этот объект возвращается из успешного вызова пространственной ближайшей точки

Имя	Тип	Описание
result	ClosestPoint[]	Массив результатов ближайшей точки
summary	ClosestPointSummary	Объект Ближайшей точки Summary

ClosestPointSummary

Объект Ближайшей точки Summary

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

JsonFormat

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

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

LatLongPairAbbreviated

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

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