Spatial - Post Closest Point
Använd för att hämta den närmaste punkten mellan en baspunkt och en viss uppsättning målpunkter.
API:et Post Closest Point
är en HTTP-begäran POST
som returnerar den närmaste punkten mellan en baspunkt och en viss uppsättning målpunkter. Uppsättningen målpunkter tillhandahålls av användardata i brödtexten efter begäran. Användardata får bara innehålla en samling punktgeometri. MultiPoint eller andra geometrier ignoreras om de tillhandahålls. Algoritmen tar inte hänsyn till routning eller trafik. Det maximala antalet godkända poäng är 100 000. Informationen som returneras omfattar närmaste punkt latitud, longitud och avstånd i meter från närmaste 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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Önskat format för svaret. Endast |
|
geography
|
path | True |
string |
Platsen för Azure Maps-kontot. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). Den här parametern krävs när en |
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
lat
|
query | True |
number |
Latitud för den plats som skickas. Exempel: 48.36. |
lon
|
query | True |
number |
Longitud för den plats som skickas. Exempel: -124.63. |
number
|
query |
integer |
Antalet närmaste punkter som förväntas av svaret. Standard: 1, minimum: 1 och max: 50 |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
features | True |
Innehåller en lista över giltiga |
|
type | True |
string:
Feature |
Anger |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
* Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du skapar en Azure Maps resurs via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.
För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.
Type:
apiKey
In:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.
Type:
apiKey
In:
header
Exempel
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"
}
]
}
Definitioner
Name | Description |
---|---|
Closest |
Närmaste postobjekt för punktresultat |
Closest |
Det här objektet returneras från ett lyckat Spatial Closest Point-anrop |
Closest |
Närmaste punktsammanfattningsobjekt |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Geo |
En giltig |
Geo |
En giltig |
Geo |
Ett giltigt |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Json |
Önskat format för svaret. Endast |
Lat |
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon". |
ClosestPoint
Närmaste postobjekt för punktresultat
Name | Typ | Description |
---|---|---|
distanceInMeters |
number |
Avståndet i meter från källpunkten till närmaste punkt |
geometryId |
string |
Det unika ID:t identifierar en geometri |
position |
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon". |
ClosestPointResponse
Det här objektet returneras från ett lyckat Spatial Closest Point-anrop
Name | Typ | Description |
---|---|---|
result |
Närmaste punktresultatmatris |
|
summary |
Närmaste punktsammanfattningsobjekt |
ClosestPointSummary
Närmaste punktsammanfattningsobjekt
Name | Typ | Description |
---|---|---|
information |
string |
Bearbeta information |
sourcePoint |
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon". |
|
udid |
string |
Ett unikt data-ID (udid) för det uppladdade innehållet |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
GeoJsonFeature
En giltig GeoJSON Feature
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
featureType |
string |
Funktionens typ. Värdet beror på vilken datamodell som den aktuella funktionen ingår i. Vissa datamodeller kan ha ett tomt värde. |
geometry | GeoJsonGeometry: |
Ett giltigt |
id |
string |
Identifierare för funktionen. |
type |
string:
Feature |
Anger |
GeoJsonFeatureCollection
En giltig GeoJSON FeatureCollection
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
features |
Innehåller en lista över giltiga |
|
type |
string:
Feature |
Anger |
GeoJsonGeometry
Ett giltigt GeoJSON
geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
type |
Geo |
Anger |
GeoJsonGeometryCollection
En giltig GeoJSON GeometryCollection
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Innehåller en lista över giltiga |
type |
string:
Geometry |
Anger |
GeoJsonLineString
En giltig GeoJSON LineString
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Line |
Anger |
GeoJsonMultiLineString
En giltig GeoJSON MultiLineString
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Multi |
Anger |
GeoJsonMultiPoint
En giltig GeoJSON MultiPoint
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Multi |
Anger |
GeoJsonMultiPolygon
En giltig GeoJSON MultiPolygon
objekttyp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Innehåller en lista över giltiga |
type |
string:
Multi |
Anger |
GeoJsonPoint
En giltig GeoJSON Point
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Anger |
GeoJsonPolygon
En giltig GeoJSON Polygon
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Koordinater för |
type |
string:
Polygon |
Anger |
JsonFormat
Önskat format för svaret. Endast json
format stöds.
Name | Typ | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".
Name | Typ | Description |
---|---|---|
lat |
number |
Latitude-egenskap |
lon |
number |
Longitudegenskap |