Spatial - Get Closest Point

Riferimento

Servizio:: Maps

Versione API:: 2022-08-01

Usare per ottenere il punto più vicino tra un punto di base e un determinato set di punti di destinazione.

L'API Get Closest Point è una richiesta HTTP GET il punto più vicino tra un punto di base e un determinato set di punti nel set di dati caricato dall'utente identificato da udid. Il set di punti di destinazione viene fornito da un file GeoJSON che viene caricato usando il servizio Registro di sistema dati e a cui fa riferimento un udid univoco. Il file GeoJSON può contenere solo una raccolta di geometria Point. Se specificato, multipoint o altre geometrie, verranno ignorate. Il numero massimo di punti accettati è 100.000. L'algoritmo non tiene conto del routing o del traffico. Le informazioni restituite includono latitudine, la longitudine e la distanza più vicina in metri dal punto più vicino.

Per testare questa API, è possibile caricare i dati di esempio dagli esempi di API Post Closest Point (Corpo della richiesta) usando il servizio Registro di sistema dati e sostituire l'oggetto {udid} dalla richiesta di esempio seguente con l'oggetto udid usato durante la creazione del Registro di sistema dei dati. Per altre informazioni, vedere Come creare il Registro di sistema dei dati.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.
geography	path	True	string	Posizione dell'account mappe di Azure. I valori validi sono Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2 e eu (Europa settentrionale, Europa occidentale). Questo parametro è obbligatorio quando viene fornito un `udid` oggetto nella richiesta. Ad esempio, se l'account mappe di Azure si trova negli Stati Uniti orientali, verranno accettate solo le richieste all'area geografica.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
lat	query	True	number	Latitudine della posizione passata. Esempio: 48.36.
lon	query	True	number	Longitudine della posizione passata. Esempio: -124.63.
udid	query	True	string	ID univoco utilizzato durante la creazione di un registro dati per caricare un oggetto FeatureCollection GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946 . Tutte le proprietà della funzionalità devono contenere `geometryId`, che viene usato per identificare la geometria e fa distinzione tra maiuscole e minuscole. Per altre informazioni sul servizio registro dati, vedere Come creare il Registro di sistema dei dati.
numberOfClosestPoints	query		integer	Numero di punti più vicini previsti dalla risposta. Impostazione predefinita: 1, minimo: 1 e massimo: 50

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST. * L'utilizzo di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning durante la creazione di una risorsa di Mappe di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, queste chiavi possono essere considerate come chiavi master per l'account per cui vengono rilasciate.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

Tipo: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenca firma di accesso condiviso nella risorsa mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

GetClosestPoint

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
ClosestPoint	Oggetto Entry Risultato punto più vicino
ClosestPointResponse	Questo oggetto viene restituito da una chiamata al punto spaziale più vicino riuscita
ClosestPointSummary	Oggetto Summary punto più vicino
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.
LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

ClosestPoint

Oggetto Entry Risultato punto più vicino

Nome	Tipo	Descrizione
distanceInMeters	number	Distanza in metri dal punto di origine al punto più vicino
geometryId	string	L'ID univoco identifica una geometria
position	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

ClosestPointResponse

Questo oggetto viene restituito da una chiamata al punto spaziale più vicino riuscita

Nome	Tipo	Descrizione
result	ClosestPoint[]	Matrice dei risultati del punto più vicino
summary	ClosestPointSummary	Oggetto Summary punto più vicino

ClosestPointSummary

Oggetto Summary punto più vicino

Nome	Tipo	Descrizione
information	string	Elaborazione delle informazioni
sourcePoint	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
udid	string	ID dati univoco (udid) per il contenuto caricato

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

Nome	Tipo	Descrizione
json	string	Formato di interscambio dati notazione oggetto JavaScript

LatLongPairAbbreviated

Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

Nome	Tipo	Descrizione
lat	number	Proprietà Latitude
lon	number	Longitudine - proprietà

Condividi tramite