Condividi tramite

Search - Get Geocoding

Servizio:
Maps
Versione API:
2025-01-01

Utilizzare per ottenere le coordinate di longitudine e latitudine di un indirizzo stradale o il nome di un luogo.

L'API Get Geocoding è una richiesta HTTP GET che restituisce le coordinate di longitudine e latitudine della posizione in cui viene eseguita la ricerca.

In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. È anche possibile accedere alla ricerca dell'indirizzo in modo esclusivo. La geocodifica viene eseguita premendo l'endpoint di geocodifica con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun punto di interesse (POI). Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi esatti o strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee e stati. La risposta restituisce anche proprietà dettagliate relative agli indirizzi, ad esempio via, codice postale, comune e paese/area geografica.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01
Con parametri facoltativi: 
GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
 query True

string

Numero di versione dell'API mappe di Azure.
addressLine
 query

string

La linea stradale ufficiale di un indirizzo relativo all'area, come specificato dalla località, o postalCode, proprietà. L'uso tipico di questo elemento è quello di fornire un indirizzo o un indirizzo ufficiale.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
adminDistrict
 query

string

Parte del paese di suddivisione di un indirizzo, ad esempio WA.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
adminDistrict2
 query

string

Contea per l'indirizzo strutturato, ad esempio King.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
adminDistrict3
 query

string

Area denominata per l'indirizzo strutturato.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
bbox
 query

number[]

Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati dei rettangoli sono definiti dai valori di longitudine e latitudine. Quando si specifica questo parametro, l'area geografica viene presa in considerazione quando si calcolano i risultati di una query sulla posizione.

Esempio: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Punto sulla terra specificato come longitudine e latitudine. Quando si specifica questo parametro, la posizione dell'utente viene presa in considerazione e i risultati restituiti potrebbero essere più rilevanti per l'utente. Esempio: coordinate &=lon,lat
countryRegion
 query

string

Segnale per il risultato della geocodifica in un codice paese/area geografica ISO 3166-1 alfa-2 specificato, ad esempio FR./

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
locality
 query

string

Parte della località di un indirizzo, ad esempio Seattle.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
postalCode
 query

string

Parte del codice postale di un indirizzo.

Questo parametro non deve essere utilizzato quando il query parametro è incluso nella richiesta.
query
 query

string

Stringa che contiene informazioni su una posizione, ad esempio un indirizzo o un nome di punto di riferimento.
top
 query

integer (int32)

minimum: 1
maximum: 20

Numero massimo di risposte che verranno restituite. Impostazione predefinita: 5, minimo: 1 e massimo: 20.
view
 query

string

Stringa che rappresenta un codice ISO 3166-1 Alpha-2 region/country. In questo modo verranno modificati i bordi e le etichette geopolitici contestati per allinearsi all'area utente specificata. Per impostazione predefinita, il parametro View è impostato su "Auto" anche se non è stato definito nella richiesta.

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

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Accept-Language

string

Lingua in cui devono essere restituiti i risultati della ricerca.

Per informazioni dettagliate, vedere lingue supportate.
x-ms-client-id

string

Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza di Azure AD. 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 altre informazioni sull'uso della sicurezza dell'ID Microsoft Entra in Mappe di Azure, vedere Gestire l'autenticazione in Mappe di Azure.

Risposte

Nome Tipo Descrizione
200 OK

GeocodingResponse

Va bene

Media Types: "application/geo+json"

Intestazioni

x-ms-request-id: string
Other Status Codes

ErrorResponse

Errore imprevisto.

Media Types: "application/geo+json"

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.

Annotazioni

  • 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 di mappe .
  • 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 durante la creazione di un 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 questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.

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 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

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

Esempio di richiesta

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Risposta di esempio

Codice di stato:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Esempio di richiesta

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Risposta di esempio

Codice di stato:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Esempio di richiesta

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=15127 NE 24th Street Redmond WA

Risposta di esempio

Codice di stato:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Esempio di richiesta

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=empire state building

Risposta di esempio

Codice di stato:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Definizioni

Nome Descrizione
Address

Indirizzo del risultato
AdminDistricts

Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.
CalculationMethodEnum

Metodo usato per calcolare il punto di geocodifica.
ConfidenceEnum

Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza.

L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato.
CountryRegion
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
FeatureCollectionEnum

Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.
FeaturesItem
FeatureTypeEnum

Il tipo di una funzionalità deve essere Feature.
GeocodePoints

Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito.
GeocodingResponse

Questo oggetto viene restituito da una chiamata geocodifica riuscita
GeoJsonPoint

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
Intersection

Indirizzo del risultato.
MatchCodesEnum

Uno o più valori di codice corrispondenti che rappresentano il livello di geocodifica per ogni posizione nella risposta.

Ad esempio, una posizione geocodificata con codici di corrispondenza di Good e Ambiguous indica che sono state trovate più di una posizione geografica per le informazioni sulla posizione e che il servizio di geocodice non disponeva di una gerarchia di ricerca per trovare una corrispondenza.

Analogamente, una posizione geocodificata con codici di corrispondenza di Ambiguous e UpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio di geocodifica doveva cercare nella gerarchia superiore e trovare più corrispondenze a tale livello. Un esempio di Ambiguous e UpHierarchy risultato è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodice non riesce a individuare una corrispondenza per l'indirizzo stradale e restituisce invece informazioni per più di un valore RoadBlock.

I valori possibili sono:

Good: la posizione ha una sola corrispondenza o tutte le corrispondenze restituite vengono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze valide.

Ambiguous: la posizione è una delle possibili corrispondenze. Ad esempio, quando si esegue una query per l'indirizzo 128 Main St., la risposta può restituire due posizioni per 128 North Main St. e 128 South Main St. perché non sono disponibili informazioni sufficienti per determinare quale opzione scegliere.

UpHierarchy: la posizione rappresenta uno spostamento verso l'alto della gerarchia geografica. Ciò si verifica quando non è stata trovata una corrispondenza per la richiesta di posizione, quindi viene restituito un risultato meno preciso. Ad esempio, se non è possibile trovare una corrispondenza per l'indirizzo richiesto, potrebbe essere restituito un codice di corrispondenza di UpHierarchy con un tipo di entità RoadBlock.
Properties
UsageTypeEnum

Uso ottimale per il punto di geocodifica. Ogni punto di geocodice viene definito come punto Route, un punto Display o entrambi. Usare Route punti se si sta creando una route per la posizione. Usare Display punti se viene visualizzata la posizione in una mappa. Ad esempio, se la posizione è un parco, un punto di Route può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto Display può essere un punto che specifica il centro del parco.

Address

Object

Indirizzo del risultato

Nome Tipo Descrizione
addressLine

string

AddressLine che include nome e numero di strada
adminDistricts

AdminDistricts[]

Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.
countryRegion

CountryRegion

formattedAddress

string

Proprietà Address formattata
intersection

Intersection

Indirizzo del risultato.
locality

string

proprietà locality
neighborhood

string

proprietà di quartiere
postalCode

string

Postal Code - proprietà
streetName

string

Il nome della via da formattedAddress
streetNumber

string

Il numero nella via, se disponibile, da formattedAddress

AdminDistricts

Object

Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.

Nome Tipo Descrizione
name

string

Nome per il campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere il nome completo dello stato, ad esempio Washington, Per adminDistrict[1], potrebbe trattarsi del nome completo della contea
shortName

string

Nome breve per il campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere il nome breve dello stato, ad esempio WA, Per adminDistrict[1], questo potrebbe essere il nome breve della contea

CalculationMethodEnum

Enumerazione

Metodo usato per calcolare il punto di geocodifica.

Valore Descrizione
Interpolation

Il punto di geocodifica è stato abbinato a un punto su una strada utilizzando l'interpolazione.
InterpolationOffset

Il punto di geocodifica è stato abbinato a un punto di una strada utilizzando l'interpolazione con uno scostamento aggiuntivo per spostare il punto sul lato della strada.
Parcel

Il punto di geocodifica è stato abbinato al centro di una particella.
Rooftop

Il punto di geocodifica è stato abbinato al tetto di un edificio.

ConfidenceEnum

Enumerazione

Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza.

L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato.

Valore Descrizione
High

Se l'attendibilità è impostata su High, sono state trovate una o più corrispondenze forti. Più High corrispondenze di attendibilità vengono ordinate in ordine di classificazione in base all'importanza, se applicabile. Ad esempio, i punti di riferimento hanno importanza, ma gli indirizzi no.

Se una richiesta include una posizione o una vista, la classificazione potrebbe cambiare in modo appropriato. Ad esempio, una query di posizione per "Parigi" restituisce "Parigi, Francia" e "Parigi, TX" entrambi con High sicurezza. "Parigi, Francia" è sempre al primo posto in base all'importanza, a meno che la posizione di un utente non indichi che l'utente si trova a Parigi, Texas o molto vicino a essa, o la visualizzazione della mappa indichi che l'utente sta effettuando una ricerca in quell'area.
Medium

In alcune situazioni, la corrispondenza restituita potrebbe non essere allo stesso livello delle informazioni fornite nella richiesta. Ad esempio, una richiesta può specificare le informazioni sull'indirizzo e il servizio di geocodifica può essere in grado di corrispondere solo a un codice postale. In questo caso, se il servizio di geocodifica ha la certezza che il codice postale corrisponda ai dati, l'attendibilità viene impostata su Medium e il codice di corrispondenza viene impostato su UpHierarchy per specificare che non è possibile corrispondere a tutte le informazioni e ha dovuto eseguire la ricerca verso l'alto nella gerarchia.

Se le informazioni sulla posizione nella query sono ambigue e non sono disponibili informazioni aggiuntive per classificare le posizioni, ad esempio la posizione dell'utente o l'importanza relativa della posizione, l'attendibilità viene impostata su Medium. Ad esempio, una query di posizione per "148th Ave, Bellevue" può restituire "148th Ave SE" e "148th Ave NE" entrambi con Medium sicurezza.

Se le informazioni sulla posizione nella query non forniscono informazioni sufficienti per la geocodifica di una posizione specifica, è possibile che venga restituito un valore di posizione meno preciso e che l'attendibilità venga impostata su Medium. Ad esempio, se viene fornito un indirizzo, ma non viene trovata una corrispondenza per il numero civico, è possibile che venga restituito il risultato della geocodifica con un tipo di entità Roadblock.
Low

CountryRegion

Object
Nome Tipo Descrizione
ISO

string

ISO del paese/area geografica
name

string

nome del paese/area geografica

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.

FeatureCollectionEnum

Enumerazione

Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

Valore Descrizione
FeatureCollection

FeaturesItem

Object
Nome Tipo Descrizione
bbox

number[] (double)

Riquadro. Proiezione usata - EPSG:3857. Per informazioni dettagliate, vedere RFC 7946.
geometry

GeoJsonPoint

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
id

string

ID per la funzionalità restituita
properties

Properties

type

FeatureTypeEnum

Il tipo di una funzionalità deve essere Feature.

FeatureTypeEnum

Enumerazione

Il tipo di una funzionalità deve essere Feature.

Valore Descrizione
Feature

GeocodePoints

Object

Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito.

Nome Tipo Descrizione
calculationMethod

CalculationMethodEnum

Metodo usato per calcolare il punto di geocodifica.
geometry

GeoJsonPoint

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
usageTypes

UsageTypeEnum[]

Uso ottimale per il punto di geocodifica. Ogni punto di geocodice viene definito come punto Route, un punto Display o entrambi. Usare Route punti se si sta creando una route per la posizione. Usare Display punti se viene visualizzata la posizione in una mappa. Ad esempio, se la posizione è un parco, un punto di Route può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto Display può essere un punto che specifica il centro del parco.

GeocodingResponse

Object

Questo oggetto viene restituito da una chiamata geocodifica riuscita

Nome Tipo Descrizione
features

FeaturesItem[]

nextLink

string

è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo.
type

FeatureCollectionEnum

Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

GeoJsonPoint

Object

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.

Nome Tipo Descrizione
bbox

number[] (double)

Riquadro. Proiezione usata - EPSG:3857. Per informazioni dettagliate, vedere RFC 7946.
coordinates

number[] (double)

Un Position è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. altitudine/elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946.
type string:

Point

Specifica il tipo di GeoJSON. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

Object

Indirizzo del risultato.

Nome Tipo Descrizione
baseStreet

string

Strada principale per la posizione.
displayName

string

Nome completo dell'intersezione.
intersectionType

string

Tipo di intersezione.
secondaryStreet1

string

La prima strada che si interseca.
secondaryStreet2

string

In caso affermativo, la seconda strada intersecante.

MatchCodesEnum

Enumerazione

Uno o più valori di codice corrispondenti che rappresentano il livello di geocodifica per ogni posizione nella risposta.

Ad esempio, una posizione geocodificata con codici di corrispondenza di Good e Ambiguous indica che sono state trovate più di una posizione geografica per le informazioni sulla posizione e che il servizio di geocodice non disponeva di una gerarchia di ricerca per trovare una corrispondenza.

Analogamente, una posizione geocodificata con codici di corrispondenza di Ambiguous e UpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio di geocodifica doveva cercare nella gerarchia superiore e trovare più corrispondenze a tale livello. Un esempio di Ambiguous e UpHierarchy risultato è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodice non riesce a individuare una corrispondenza per l'indirizzo stradale e restituisce invece informazioni per più di un valore RoadBlock.

I valori possibili sono:

Good: la posizione ha una sola corrispondenza o tutte le corrispondenze restituite vengono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze valide.

Ambiguous: la posizione è una delle possibili corrispondenze. Ad esempio, quando si esegue una query per l'indirizzo 128 Main St., la risposta può restituire due posizioni per 128 North Main St. e 128 South Main St. perché non sono disponibili informazioni sufficienti per determinare quale opzione scegliere.

UpHierarchy: la posizione rappresenta uno spostamento verso l'alto della gerarchia geografica. Ciò si verifica quando non è stata trovata una corrispondenza per la richiesta di posizione, quindi viene restituito un risultato meno preciso. Ad esempio, se non è possibile trovare una corrispondenza per l'indirizzo richiesto, potrebbe essere restituito un codice di corrispondenza di UpHierarchy con un tipo di entità RoadBlock.

Valore Descrizione
Good
Ambiguous
UpHierarchy

Properties

Object
Nome Tipo Descrizione
address

Address

Indirizzo del risultato
confidence

ConfidenceEnum

Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza.

L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato.
geocodePoints

GeocodePoints[]

Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito.
matchCodes

MatchCodesEnum[]

Uno o più valori di codice corrispondenti che rappresentano il livello di geocodifica per ogni posizione nella risposta.

Ad esempio, una posizione geocodificata con codici di corrispondenza di Good e Ambiguous indica che sono state trovate più di una posizione geografica per le informazioni sulla posizione e che il servizio di geocodice non disponeva di una gerarchia di ricerca per trovare una corrispondenza.

Analogamente, una posizione geocodificata con codici di corrispondenza di Ambiguous e UpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio di geocodifica doveva cercare nella gerarchia superiore e trovare più corrispondenze a tale livello. Un esempio di Ambiguous e UpHierarchy risultato è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodice non riesce a individuare una corrispondenza per l'indirizzo stradale e restituisce invece informazioni per più di un valore RoadBlock.

I valori possibili sono:

Good: la posizione ha una sola corrispondenza o tutte le corrispondenze restituite vengono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze valide.

Ambiguous: la posizione è una delle possibili corrispondenze. Ad esempio, quando si esegue una query per l'indirizzo 128 Main St., la risposta può restituire due posizioni per 128 North Main St. e 128 South Main St. perché non sono disponibili informazioni sufficienti per determinare quale opzione scegliere.

UpHierarchy: la posizione rappresenta uno spostamento verso l'alto della gerarchia geografica. Ciò si verifica quando non è stata trovata una corrispondenza per la richiesta di posizione, quindi viene restituito un risultato meno preciso. Ad esempio, se non è possibile trovare una corrispondenza per l'indirizzo richiesto, potrebbe essere restituito un codice di corrispondenza di UpHierarchy con un tipo di entità RoadBlock.
type

string

Uno dei seguenti:

  • Indirizzo
  • Blocco stradale
  • RoadIntersection
  • Quartiere
  • PopulatedPlace
  • Codice postale1
  • AdminDivision1
  • AdminDivision2
  • Paese/Regione

UsageTypeEnum

Enumerazione

Uso ottimale per il punto di geocodifica. Ogni punto di geocodice viene definito come punto Route, un punto Display o entrambi. Usare Route punti se si sta creando una route per la posizione. Usare Display punti se viene visualizzata la posizione in una mappa. Ad esempio, se la posizione è un parco, un punto di Route può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto Display può essere un punto che specifica il centro del parco.

Valore Descrizione
Display
Route