Search - Get Search Address Reverse

Servizio:

Maps

Versione API:

1.0

Usare per ottenere un indirizzo e informazioni sulla posizione dalle coordinate di latitudine e longitudine.
L'API Get Search Address Reverse è e la richiesta HTTP GET che restituisce un indirizzo o una posizione quando vengono date coordinate di latitudine e longitudine.

Ci possono essere momenti in cui è 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à le 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ù entità come elenco delimitato da virgole, l'endpoint restituirà l'entità più piccola disponibile. È possibile usare l'ID geometria restituito per ottenere la geometria di tale area geografica tramite Get Search API Polygon. I parametri seguenti vengono ignorati quando entityType è impostato: Intestazione d'acquisto returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	Direzione direzionale del veicolo in gradi, per viaggiare lungo un segmento di strada. 0 è North, 90 è East e così via, i valori sono compresi tra -360 e 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 viene inviato un numero 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 di per limitare i risultati all'area definita
returnMatchType	query		boolean	Includere informazioni sul tipo di corrispondenza con il geocoder ottenuto nella risposta.
returnRoadUse	query		boolean	Proprietà di tipo Boolean. Per abilitare la restituzione della matrice di utilizzo della strada per i geocodice inversi a livello di strada
returnSpeedLimit	query		boolean	Proprietà di tipo Boolean. Per abilitare la restituzione 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 geocodificati inversa può essere una o più di LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view	query		LocalizedMapView	Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente contestate. Paesi/aree geografiche diverse 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. 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 contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.

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 Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

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

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. 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 Mappe di Azure API REST.

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.

Nota

• Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui 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 Microsoft Entra ID.
• Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, AZURE SDK o API REST.
• L'utilizzo di Mappe di Azure 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 quando si crea un account 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 alle applicazioni client riservate per accedere alle API REST 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 nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o 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

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	Riquadro delimitatore della posizione.
Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa, questa operazione è 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	Una posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
LocalizedMapView	Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN. Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.
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 Search riuscita
ReverseSearchAddressResultItem	Oggetto Result per una risposta Search Address Reverse
RoadUseType	Descrive gli usi possibili di una strada.
SearchSummary	Oggetto Riepilogo per una risposta API Search.

Address

Indirizzo del risultato

Nome	Tipo	Descrizione
boundingBox	BoundingBoxCompassNotation	Riquadro delimitatore della posizione.
buildingNumber	string	Numero di 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	State or Province
countrySubdivisionCode	string	countrySubdivisionCode prefisso da countryCode ( countryCode-countrySubdivisionCode ) e il trattino forma 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 sia presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito.
countryTertiarySubdivision	string	Area denominata
crossStreet	string	Nome della strada incrociata.
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/area geografica, il nome completo del paese o dell'area geografica.
localName	string	Componente di 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 freeformAddress proprietà . localName rappresenta il comune postale. A seconda della posizione, 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 invece di municipality.
municipality	string	Città/Città Nota: municipality rappresenta il comune residenziale. A seconda della posizione, il municipality valore può essere diverso dal nome comunemente noto di una città o di una città. Per il nome comunemente noto della città o della città, è consigliabile usare il localName valore anziché il municipality valore.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un quartiere è un'area geograficamente localizzata all'interno di una città o città con caratteristiche distintive e interazioni sociali tra gli abitanti.
postalCode	string	Cap/Cap
routeNumbers	string[]	Codici usati per identificare in modo non ambiguo la strada
street	string	Nome della strada. DEPRECATO, usare invece streetName.
streetName	string	Nome della strada.
streetNameAndNumber	string	Nome della strada e numero.
streetNumber	string	Numero di edificio sulla strada.

BoundingBoxCompassNotation

Riquadro delimitatore della posizione.

Nome	Tipo	Descrizione
entity	Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa, questa operazione è 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

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

Nome	Tipo	Descrizione
position	string	Entità Position

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.

GeographicEntityType

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

Nome	Tipo	Descrizione
Country	string	nome paese/area geografica
CountrySecondarySubdivision	string	Contea
CountrySubdivision	string	State or Province
CountryTertiarySubdivision	string	Area denominata
Municipality	string	Città/Città
MunicipalitySubdivision	string	Sub/Super City
Neighbourhood	string	Quartiere
PostalCodeArea	string	Codice postale/codice postale

LatLongPairAbbreviated

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

Nome	Tipo	Descrizione
lat	number	Latitudine, proprietà
lon	number	Proprietà Longitudine

LocalizedMapView

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

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

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

MatchType

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

Nome	Tipo	Descrizione
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

Nome	Tipo	Descrizione
NEARBY	string	Search è stato eseguito intorno a una determinata latitudine e longitudine con un raggio definito
NON_NEAR	string	Search è stata eseguita a livello globale, senza pregiudizi a una determinata latitudine e longitudine, e nessun raggio definito

ResponseFormat

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

Nome	Tipo	Descrizione
json	string	Formato di interscambio dati dell'oggetto JavaScript
xml	string	Linguaggio di markup estendibile

ReverseSearchAddressResult

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

Nome	Tipo	Descrizione
addresses	ReverseSearchAddressResultItem[]	Matrice di indirizzi
summary	SearchSummary	Oggetto Riepilogo per una risposta inversa di indirizzi Search

ReverseSearchAddressResultItem

Oggetto Result per una risposta Search Address Reverse

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

RoadUseType

Descrive gli usi possibili di una strada.

Nome	Tipo	Descrizione
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

Oggetto Riepilogo per una risposta API Search.

Nome	Tipo	Descrizione
fuzzyLevel	integer	Il livello massimo di fuzzy richiesto per fornire risultati.
geoBias	LatLongPairAbbreviated	Indicazione quando il motore di ricerca interno ha applicato un pregiudizio geospaziale per migliorare la classificazione dei risultati. In alcuni metodi questo può essere interessato impostando i parametri lat e lon in cui sono disponibili. In altri casi è puramente interna.
limit	integer	Numero massimo di risposte che verranno restituite
numResults	integer	Numero di risultati nella risposta.
offset	integer	Offset iniziale dei risultati restituiti all'interno del set di risultati completo.
query	string	Parametro di query usato per produrre questi risultati della ricerca.
queryTime	integer	Tempo trascorso per la risoluzione della query, in millisecondi.
queryType	QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
totalResults	integer	Numero totale di risultati trovati.