Search - Get Search Address Reverse

Riferimento

Servizio:: Maps

Versione API:: 1.0

Usa per ottenere un indirizzo e informazioni sulla posizione dalle coordinate di latitudine e longitudine.
L'API Get Search Address Reverse è e http GET richiesta che restituisce un indirizzo o una posizione quando si specificano coordinate di latitudine e longitudine.

In alcuni casi potrebbe essere necessario tradurre una coordinata (ad esempio: 37.786505, -122.3862) in un indirizzo comprensibile umano. Molto spesso questo è necessario nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera sapere quale indirizzo si trova la coordinata. Questo endpoint restituirà informazioni sull'indirizzo per una determinata coordinata.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

Con parametri facoltativi:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
api-version	query	True	string	Numero di versione dell'API mappe di Azure.
query	query	True	number[]	La query applicabile specificata come stringa delimitata da virgole composta da latitudine seguita da longitudine, ad esempio "47.641268,-122.125679".
allowFreeformNewline	query		boolean	Formato delle nuove righe nell'indirizzo formattato. Se true, l'indirizzo conterrà nuove righe. Se false, le righe nuove verranno convertite in virgole.
entityType	query		GeographicEntityType	Specifica il livello di filtro eseguito sulle aree geografiche. Restringe la ricerca dei tipi di entità geography specificati, ad esempio restituisce solo il comune. La risposta risultante conterrà l'ID geography e il tipo di entità corrispondente. Se si specificano più di un'entità come elenco delimitato da virgole, l'endpoint restituirà l'entità più piccola disponibile. L'ID geometry restituito può essere usato per ottenere la geometria di tale area geografica tramite 'API Get Search Polygon. Quando entityType è impostato, i parametri seguenti vengono ignorati: intestazione numero returnRoadUse returnSpeedLimit RoadUse returnMatchType
heading	query		integer minimum: -360 maximum: 360	La direzione direzionale del veicolo in gradi, per viaggiare lungo un segmento di strada. 0 è North, 90 è East e così via, i valori vanno da -360 a 360. La precisione può includere fino a una posizione decimale
language	query		string	Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di lingua IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita. Per informazioni dettagliate, vedere lingue supportate.
number	query		string	Numero di strada come stringa. Se un numero viene inviato insieme alla richiesta, la risposta può includere il lato della strada (sinistra/destra) e anche una posizione di offset per tale numero
radius	query		integer	Raggio in metri da cui limitare i risultati all'area definita
returnMatchType	query		boolean	Includere informazioni sul tipo di corrispondenza ottenuto dalla geocoder nella risposta.
returnRoadUse	query		boolean	Booleano. Per abilitare la restituzione della matrice di utilizzo stradale per i geocodifica inversi a livello di strada
returnSpeedLimit	query		boolean	Booleano. Per abilitare il ritorno del limite di velocità registrato
roadUse	query		RoadUseType[]	Per limitare i codici geografici inversi a un determinato tipo di utilizzo stradale. La matrice di utilizzo stradale per i geocodice inversi può essere una o più di LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view	query		LocalizedMapView	Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica quale 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 dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	ReverseSearchAddressResult	Va bene
Other Status Codes	ErrorResponse	Errore imprevisto.

Sicurezza

AADToken

Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, 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 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.

Nota

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 Maps.
Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni microsoft Entra ID.
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 della Sdk Web di Mappe di Azure 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 quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di 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 ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le 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 account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Searches addresses for coordinates 37.337,-121.89

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Risposta di esempio

Codice di stato:: 200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Definizioni

Nome	Descrizione
Address	Indirizzo del risultato
BoundingBoxCompassNotation	Rettangolo di selezione della posizione.
Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GeographicEntityType	Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.
LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
LocalizedMapView	Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.
MatchType	Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.
QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
ReverseSearchAddressResult	Questo oggetto viene restituito da una chiamata inversa dell'indirizzo di ricerca riuscita
ReverseSearchAddressResultItem	Oggetto Result per una risposta inversa dell'indirizzo di ricerca
RoadUseType	Descrive i possibili usi di una strada.
SearchSummary	Oggetto riepilogo per una risposta dell'API di ricerca.

Address

Object

Indirizzo del risultato

Nome	Tipo	Descrizione
boundingBox	BoundingBoxCompassNotation	Rettangolo di selezione della posizione.
buildingNumber	string	Numero dell'edificio sulla strada. DEPRECATO, usare invece streetNumber.
country	string	nome paese/area geografica
countryCode	string	Paese (Nota: si tratta di un codice di due lettere, non di un nome paese/area geografica.
countryCodeISO3	string	Codice paese ISO alfa-3
countrySecondarySubdivision	string	Contea
countrySubdivision	string	Stato o Provincia
countrySubdivisionCode	string	`countrySubdivisionCode` preceduti da `countryCode` ( countryCode-countrySubdivisionCode ) e il trattino costituisce il codice ISO 3166-2. Esempi: TX per Texas, SCT per Scozia e ON per Ontario.
countrySubdivisionName	string	Nome completo di un primo livello di gerarchia amministrativa paese/area geografica. Questo campo viene visualizzato solo nel caso in cui countrySubdivision venga presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito.
countryTertiarySubdivision	string	Area denominata
crossStreet	string	Il nome della strada da attraversare.
extendedPostalCode	string	Codice postale esteso (la disponibilità dipende dall'area).
freeformAddress	string	Riga di indirizzo formattata in base alle regole di formattazione del paese o dell'area geografica di un risultato oppure, nel caso di un paese o area geografica, il nome completo del paese o dell'area geografica.
localName	string	Componente dell'indirizzo che rappresenta il nome di un'area geografica o di una località che raggruppa più oggetti indirizzabili a scopo di indirizzamento, senza essere un'unità amministrativa. Questo campo viene usato per compilare la proprietà `freeformAddress`. `localName` rappresenta il comune postale. A seconda della località, `localName` è il nome comunemente noto di una città o di una città. Per il nome comunemente noto di una città o di una città, usare `localName` anziché `municipality`.
municipality	string	Città/Città Nota: `municipality` rappresenta il comune residenziale. A seconda della località, il valore `municipality` può differire dal nome comunemente noto di una città o di una città. Per il nome comunemente noto della città o della città, è consigliabile usare il valore `localName` anziché il valore `municipality`.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un quartiere è un'area geograficamente localizzata all'interno di una città o di una città con caratteristiche distintive e interazioni sociali tra gli abitanti.
postalCode	string	Codice postale/Cap
routeNumbers	string[]	I codici usati per identificare in modo univoco la strada
street	string	Nome della strada. DEPRECATO, usare invece streetName.
streetName	string	Nome della strada.
streetNameAndNumber	string	Nome e numero della strada.
streetNumber	string	Numero dell'edificio sulla strada.

BoundingBoxCompassNotation

Object

Rettangolo di selezione della posizione.

Nome	Tipo	Descrizione
entity	Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
northEast	string	Latitudine nord-est, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole
southWest	string	Latitudine sud-ovest, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole

Entity

Enumerazione

Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.

Valore	Descrizione
position	Entità Position

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

Object

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

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GeographicEntityType

Enumerazione

Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.

Valore	Descrizione
Country	nome paese/area geografica
CountrySecondarySubdivision	Contea
CountrySubdivision	Stato o Provincia
CountryTertiarySubdivision	Area denominata
Municipality	Città/Città
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Quartiere
PostalCodeArea	Codice postale/Cap

LatLongPairAbbreviated

Object

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

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

LocalizedMapView

Enumerazione

Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN.

Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.

Valore	Descrizione
AE	Emirati Arabi Uniti (visualizzazione Araba)
AR	Argentina (vista argentina)
Auto	Restituisce i dati della mappa in base all'indirizzo IP della richiesta.
BH	Bahrein (vista araba)
IN	India (vista indiana)
IQ	Iraq (visualizzazione araba)
JO	Giordania (visualizzazione araba)
KW	Kuwait (vista araba)
LB	Libano (vista araba)
MA	Marocco (vista marocchina)
OM	Oman (vista araba)
PK	Pakistan (vista pakistana)
PS	Autorità palestinese (visualizzazione araba)
QA	Qatar (vista araba)
SA	Arabia Saudita (vista araba)
SY	Siria (visualizzazione araba)
Unified	Visualizzazione unificata (altri)
YE	Yemen (vista araba)

MatchType

Enumerazione

Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.

Valore	Descrizione
AddressPoint
HouseNumberRange
Street

QueryType

Enumerazione

Tipo di query restituito: NEARBY o NON_NEAR.

Valore	Descrizione
NEARBY	La ricerca è stata eseguita intorno a una certa latitudine e longitudine con un raggio definito
NON_NEAR	La ricerca è stata eseguita a livello globale, senza distorsioni a una certa latitudine e longitudine e nessun raggio definito

ResponseFormat

Enumerazione

Formato desiderato della risposta. Il valore può essere json o xml.

Valore	Descrizione
json	il formato dell'interscambio dati notazione oggetto JavaScript
xml	la extensible markup language

ReverseSearchAddressResult

Object

Questo oggetto viene restituito da una chiamata inversa dell'indirizzo di ricerca riuscita

Nome	Tipo	Descrizione
addresses	ReverseSearchAddressResultItem[]	Matrice di indirizzi
summary	SearchSummary	Oggetto Riepilogo per una risposta inversa dell'indirizzo di ricerca

ReverseSearchAddressResultItem

Object

Oggetto Result per una risposta inversa dell'indirizzo di ricerca

Nome	Tipo	Descrizione
address	Address	Indirizzo del risultato
matchType	MatchType	Informazioni sul tipo di corrispondenza. Uno dei seguenti: AddressPoint HouseNumberRange Via
position	string	Proprietà Position sotto forma di "{latitudine},{longitudine}"
roadUse	RoadUseType[]	Descrive i possibili usi di una strada.

RoadUseType

Enumerazione

Descrive i possibili usi di una strada.

Valore	Descrizione
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Object

Oggetto riepilogo per una risposta dell'API di ricerca.

Nome	Tipo	Descrizione
fuzzyLevel	integer	Livello massimo di fuzzy necessario per fornire risultati.
geoBias	LatLongPairAbbreviated	Indicazione quando il motore di ricerca interno ha applicato una distorsione geospaziale per migliorare la classificazione dei risultati. In alcuni metodi, questa operazione può essere influenzata impostando i parametri lat e lon, se disponibili. In altri casi è puramente interno.
limit	integer	Numero massimo di risposte che verranno restituite
numResults	integer	Numero di risultati nella risposta.
offset	integer	Offset iniziale dell'oggetto Results restituito all'interno del set di risultati completo.
query	string	Parametro di query usato per produrre questi risultati della ricerca.
queryTime	integer	Tempo impiegato per la risoluzione della query, espresso in millisecondi.
queryType	QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
totalResults	integer	Numero totale di risultati trovati.

Condividi tramite

Search - Get Search Address Reverse

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

Searches addresses for coordinates 37.337,-121.89

Esempio di richiesta

Risposta di esempio

Definizioni

Address

BoundingBoxCompassNotation

Entity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

LatLongPairAbbreviated

LocalizedMapView

MatchType

QueryType

ResponseFormat

ReverseSearchAddressResult

ReverseSearchAddressResultItem

RoadUseType

SearchSummary

Risorse aggiuntive