Spatial - Post Closest Point
Verwenden Sie, um den nächstgelegenen Punkt zwischen einem Basispunkt und einem bestimmten Satz von Zielpunkten abzurufen.
Die Post Closest Point
API ist eine HTTP-Anforderung POST
, die den nächstgelegenen Punkt zwischen einem Basispunkt und einem bestimmten Satz von Zielpunkten zurückgibt. Der Satz von Zielpunkten wird durch Benutzerdaten im Text nach der Anforderung bereitgestellt. Die Benutzerdaten dürfen nur eine Auflistung der Punktgeometrie enthalten. MultiPoint oder andere Geometrien werden ignoriert, wenn dies angegeben ist. Der Algorithmus berücksichtigt weder Routing noch Datenverkehr. Die maximale Anzahl der akzeptierten Punkte beträgt 100.000. Die zurückgegebenen Informationen umfassen breiten, längengrad und entfernung des nächstgelegenen Punkts in Metern zum nächstgelegenen Punkt.
POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}
POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
format
|
path | True |
Gewünschtes Format der Antwort. Nur das |
|
geography
|
path | True |
string |
Standort des Azure Maps-Kontos. Gültige Werte sind us (USA, Osten, USA, Westen, Mitte, Usa, Westen 2) und eu (Europa, Norden, Europa, Westen). Dieser Parameter ist erforderlich, wenn ein |
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. |
number
|
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. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
features | True |
Enthält eine Liste gültiger |
|
type | True |
string:
Feature |
Gibt den |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0-Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
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.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in 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 genutzter 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. Mit anderen Worten, diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt werden.
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
Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Type:
apiKey
In:
header
Beispiele
PostClosestPoint
Sample Request
POST https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat=47.622942&lon=-122.316456
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": 1001
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02860293715861,
40.51615340677395
]
}
},
{
"type": "Feature",
"properties": {
"geometryId": 1002
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02860381672178,
40.51599099003731
]
}
},
{
"type": "Feature",
"properties": {
"geometryId": 1003
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02812292879467,
40.51605867808856
]
}
}
]
}
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 47.622942,
"lon": -122.316456
},
"udid": null,
"information": "3 points processed in user data"
},
"result": [
{
"distanceInMeters": 1587492.66,
"position": {
"lat": 40.51615340677395,
"lon": -105.02860293715861
},
"geometryId": "1001"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Closest |
Closest Point Result Entry-Objekt |
Closest |
Dieses Objekt wird von einem erfolgreichen Spatial Closest Point-Aufruf zurückgegeben. |
Closest |
Closest Point Summary-Objekt |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiges |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Geo |
Ein gültiger |
Json |
Das gewünschte Format der Antwort. Nur das |
Lat |
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 |
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 |
Nächstes Punktergebnisarray |
|
summary |
Closest Point Summary-Objekt |
ClosestPointSummary
Closest Point Summary-Objekt
Name | Typ | Beschreibung |
---|---|---|
information |
string |
Verarbeiten von Informationen |
sourcePoint |
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 |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
GeoJsonFeature
Ein gültiger GeoJSON Feature
Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
featureType |
string |
Der Funktionstyp Der Wert hängt vom Datenmodell ab, zu dem das aktuelle Feature gehört. Einige Datenmodelle verfügen möglicherweise über einen leeren Wert. |
geometry | GeoJsonGeometry: |
Ein gültiges |
id |
string |
Bezeichner für das Feature. |
type |
string:
Feature |
Gibt den |
GeoJsonFeatureCollection
Ein gültiger GeoJSON FeatureCollection
Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
features |
Enthält eine Liste gültiger |
|
type |
string:
Feature |
Gibt den |
GeoJsonGeometry
Ein gültiges GeoJSON
geometry-Objekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
type |
Geo |
Gibt den |
GeoJsonGeometryCollection
Ein gültiger GeoJSON GeometryCollection
Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
geometries | GeoJsonGeometry[]: |
Enthält eine Liste gültiger |
type |
string:
Geometry |
Gibt den |
GeoJsonLineString
Ein gültiger GeoJSON LineString
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Koordinaten für die |
type |
string:
Line |
Gibt den |
GeoJsonMultiLineString
Ein gültiger GeoJSON MultiLineString
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Koordinaten für die |
type |
string:
Multi |
Gibt den |
GeoJsonMultiPoint
Ein gültiger GeoJSON MultiPoint
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Koordinaten für die |
type |
string:
Multi |
Gibt den |
GeoJsonMultiPolygon
Ein gültiger GeoJSON MultiPolygon
Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Enthält eine Liste gültiger |
type |
string:
Multi |
Gibt den |
GeoJsonPoint
Ein gültiger GeoJSON Point
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Ein |
type |
string:
Point |
Gibt den |
GeoJsonPolygon
Ein gültiger GeoJSON Polygon
Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Name | Typ | Beschreibung |
---|---|---|
coordinates |
number[] |
Koordinaten für den |
type |
string:
Polygon |
Gibt den |
JsonFormat
Das gewünschte Format der Antwort. Nur das json
-Format wird unterstützt.
Name | Typ | Beschreibung |
---|---|---|
json |
string |
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 |