Spatial - Get Closest Point

Referenz

Service:: Maps

API Version:: 2022-08-01

Verwenden Sie , um den nächstgelegenen Punkt zwischen einem Basispunkt und einem bestimmten Satz von Zielpunkten zu erhalten.

Die Get Closest Point API ist eine HTTP-Anforderung GET , der nächstgelegene Punkt zwischen einem Basispunkt und einem bestimmten Satz von Punkten im vom Benutzer hochgeladenen Dataset, das durch identifiziert wird udid. Der Satz von Zielpunkten wird von einer GeoJSON-Datei bereitgestellt, die mithilfe des Datenregistrierungsdiensts hochgeladen und durch eine eindeutige udid referenziert wird. Die GeoJSON-Datei darf nur eine Auflistung der Punktgeometrie enthalten. MultiPoint oder andere Geometrien werden ignoriert, wenn sie angegeben werden. Die maximale Anzahl der akzeptierten Punkte beträgt 100.000. Routing oder Datenverkehr werden vom Algorithmus nicht berücksichtigt. Die zurückgegebenen Informationen umfassen den nächsten Breitengrad, längengrad und entfernung in Metern vom nächstgelegenen Punkt.

Zum Testen dieser API können Sie die Beispieldaten aus Beispielen der Post Closest Point-API (Anforderungstext) mithilfe des Datenregistrierungsdiensts hochladen und den {udid} aus der folgenden Beispielanforderung durch die udid beim Erstellen der Datenregistrierung verwendete ersetzen. Weitere Informationen finden Sie unter So erstellen Sie eine Datenregistrierung.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
geography	path	True	string	Speicherort des Azure Maps-Kontos. Gültige Werte sind us (USA, Osten, USA, Westen-Mitte, USA, Westen-Mitte 2) und eu (Europa, Norden, Europa, Westen). Dieser Parameter ist erforderlich, wenn in der Anforderung angegeben `udid` wird. Wenn sich das Azure Maps-Konto beispielsweise in "USA, Osten" befindet, werden nur Anforderungen an uns geografie akzeptiert.
api-version	query	True	string	Versionsnummer der Azure Maps API.
lat	query	True	number	Der Breitengrad des übergebenen Standorts. Beispiel: 48.36.
lon	query	True	number	Der Längengrad des übergebenen Standorts. Beispiel: -124.63.
udid	query	True	string	Die eindeutige ID, die beim Erstellen einer Datenregistrierung zum Hochladen eines gültigen GeoJSON FeatureCollection-Objekts verwendet wird. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten `geometryId`, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet. Weitere Informationen zum Datenregistrierungsdienst finden Sie unter Erstellen einer Datenregistrierung.
numberOfClosestPoints	query		integer	Die Anzahl der nächstgelegenen Punkte, die von der Antwort erwartet werden. Standard: 1, Minimum: 1 und Maximum: 50

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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

Scopes

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Anders ausgedrückt: Diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt wurden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: header

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
ClosestPoint	Closest Point Result Entry-Objekt
ClosestPointResponse	Dieses Objekt wird von einem erfolgreichen Spatial Closest Point-Aufruf zurückgegeben.
ClosestPointSummary	Closest Point Summary-Objekt
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

ClosestPoint

Closest Point Result Entry-Objekt

Name	Typ	Beschreibung
distanceInMeters	number	Der Abstand in Metern vom Quellpunkt zum nächstgelegenen Punkt
geometryId	string	Die eindeutige ID identifiziert eine Geometrie.
position	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

ClosestPointResponse

Dieses Objekt wird von einem erfolgreichen Spatial Closest Point-Aufruf zurückgegeben.

Name	Typ	Beschreibung
result	ClosestPoint[]	Nächstes Punktergebnisarray
summary	ClosestPointSummary	Closest Point Summary-Objekt

ClosestPointSummary

Closest Point Summary-Objekt

Name	Typ	Beschreibung
information	string	Verarbeiten von Informationen
sourcePoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
udid	string	Eine eindeutige Daten-ID (udid) für den hochgeladenen Inhalt

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number	Latitude-Eigenschaft
lon	number	Longitude-Eigenschaft

Share via