Search - Get Reverse Geocoding Batch

Servizio:

Maps

Versione API:

2023-06-01

Usare per inviare un batch di query all'API di geocodifica inversa in una singola richiesta.

L'API Get Reverse Geocoding Batch è una richiesta HTTP POST che invia batch di un massimo di 100 query all'API di geocodifica inversa usando una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Corpo POST per la richiesta batch

Per inviare le query di geocodifica inversa , si userà una POST richiesta in cui il corpo della richiesta conterrà la batchItems matrice in json formato e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica inversa :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Un oggetto batchItem di geocodifica inverso può accettare uno dei parametri URI di geocodifica inversa supportati.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un summary componente che indica che totalRequests faceva parte della richiesta batch originale e successfulRequests , ad esempio, le query eseguite correttamente. La risposta batch include anche una batchItems matrice che contiene una risposta per ogni query e ogni query nella richiesta batch. batchItems Conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

• GeocodingResponse - Se la query è stata completata correttamente.

• Error - Se la query non è riuscita. La risposta conterrà e code in message questo caso.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.

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 di Azure AD. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione mappe di Azure. Per usare la sicurezza di Azure AD in Mappe di Azure, vedere gli articoli seguenti per indicazioni.
Accept-Language		string	Lingua in cui devono essere restituiti i risultati della ricerca. Per informazioni dettagliate, vedere Lingue supportate .

Corpo della richiesta

Nome	Tipo	Descrizione
batchItems	ReverseGeocodingBatchRequestItem[]	Elenco delle query da elaborare.

Risposte

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

Sicurezza

AADToken

Si tratta dei flussi di Microsoft Entra OAuth 2.0 . Quando è associato 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 basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure o alle sotto-risorse. 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 riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Nota

• Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare la risorsa mappe di Azure a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.
• L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di 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 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
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Sample request

HTTP

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Sample response

Status code:

200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ]
    },
    {
      "optionalId": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Address	Indirizzo del risultato
AdminDistricts	Nome di 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 codice geografico.
ConfidenceEnum	Il livello di attendibilità del risultato della posizione geografica è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza. L'attendibilità di una posizione geocoded si basa su molti fattori, tra cui l'importanza relativa della posizione geografica 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 codice geografico che differiscono dal modo in cui sono stati calcolati e dal loro uso suggerito.
GeocodingBatchResponse	Questo oggetto viene restituito da una chiamata al servizio Batch di geocodifica riuscita.
GeocodingBatchResponseItem
GeoJsonPoint	Tipo geometry valido GeoJSON Point . Per informazioni dettagliate, vedere RFC 7946 .
Intersection	Indirizzo del risultato.
MatchCodesEnum	Uno o più valori di codice corrispondenti che rappresentano il livello di geocodatura per ogni posizione nella risposta. Ad esempio, una posizione geocodificata con codici di corrispondenza di Good e Ambiguous significa che è stata trovata più di una posizione geografica per le informazioni sulla posizione e che il servizio geocode non disponeva di una gerarchia di ricerca per trovare una corrispondenza. Analogamente, una posizione geocoded con codici di corrispondenza e AmbiguousUpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio geocode deve cercare la gerarchia e trovare più corrispondenze a tale livello. Un esempio di up an Ambiguous and UpHierarchy result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio geocode non riesce a individuare una corrispondenza per l'indirizzo di strada 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 sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze buone. Ambiguous: la posizione è una delle corrispondenze possibili. Ad esempio, quando si esegue una query per l'indirizzo di strada 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 con un tipo di UpHierarchy entità RoadBlock.
Properties
ResultTypeEnum	Specificare i tipi di entità desiderati nella risposta. Verranno restituiti solo i tipi specificati. Se il punto non può essere mappato ai tipi di entità specificati, nella risposta non vengono restituite informazioni sulla posizione. Il valore predefinito è tutte le entità possibili. Elenco delimitato da virgole di tipi di entità selezionati dalle opzioni seguenti. Indirizzo Quartiere PopulatedPlace Codice postale1 AdminDivision1 AdminDivision2 CountryRegion Questi tipi di entità vengono ordinati dall'entità più specifica all'entità meno specifica. Quando vengono trovate entità di più tipi di entità, viene restituita solo l'entità più specifica. Ad esempio, se si specifica Address e AdminDistrict1 come tipi di entità e entità sono state trovate per entrambi i tipi, nella risposta vengono restituite solo le informazioni sull'entità Address.
ReverseGeocodingBatchRequestBody	Elenco di query/richieste di geocodifica inversa da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.
ReverseGeocodingBatchRequestItem	Oggetto Query batch
Summary	Riepilogo per la richiesta batch
UsageTypeEnum	Uso ottimale per il punto di codice geografico. Ogni punto di codice geografico è definito come Route punto, un Display punto o entrambi. Usare Route i punti se si sta creando una route alla posizione. Usare Display i punti se si mostra la posizione in una mappa. Ad esempio, se la posizione è un parco, un Route punto può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto può essere un Display punto che specifica il centro del parco.

Address

Indirizzo del risultato

Nome	Tipo	Descrizione
addressLine	string	AddressLine che include nome e numero di strada
adminDistricts	AdminDistricts[]	Nome di 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	località, proprietà
neighborhood	string	proprietà di quartiere
postalCode	string	Proprietà Postal Code

AdminDistricts

Nome di 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	Il nome del campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere il nome completo dello stato, ad esempio Washington, For adminDistrict[1], questo potrebbe essere il nome completo della contea
shortName	string	Nome breve per il campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere un nome breve di stato, ad esempio WA, Per adminDistrict[1], questo potrebbe essere il nome breve della contea

CalculationMethodEnum

Metodo usato per calcolare il punto di codice geografico.

Nome	Tipo	Descrizione
Interpolation	string	Il punto di codice geografico è stato corrispondente a un punto su una strada usando l'interpolazione.
InterpolationOffset	string	Il punto di codice geografico è stato abbinato a un punto su una strada usando l'interpolazione con un offset aggiuntivo per spostare il punto sul lato della strada.
Parcel	string	Il punto di codice geografico corrisponde al centro di un pacco.
Rooftop	string	Il punto di geocodice è stato abbinato al tetto di un edificio.

ConfidenceEnum

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

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

Nome	Tipo	Descrizione
High	string	Se l'attendibilità è impostata su High, sono state trovate una o più corrispondenze forti. Se applicabile, le corrispondenze di attendibilità multiple High vengono ordinate in ordine classificato in base all'importanza. Ad esempio, i punti di riferimento hanno importanza, ma gli indirizzi non sono. Se una richiesta include una posizione o una visualizzazione, la classificazione può cambiare in modo appropriato. Ad esempio, una query di posizione per "Parigi" restituisce "Parigi, Francia" e "Parigi, TX" con High attendibilità. "Parigi, Francia" è sempre classificato in primo luogo a causa dell'importanza, a meno che una posizione utente indica che l'utente è in o molto vicino a Parigi, TX o la visualizzazione mappa indica che l'utente sta cercando in quell'area.
Low	string
Medium	string	In alcune situazioni, la corrispondenza restituita potrebbe non essere allo stesso livello delle informazioni fornite nella richiesta. Ad esempio, una richiesta può specificare informazioni sull'indirizzo e il servizio geocode può essere in grado di corrispondere solo a un codice postale. In questo caso, se il servizio geocode ha un'attendibilità che il codice postale corrisponda ai dati, l'attendibilità è impostata su Medium e il codice di corrispondenza è impostato su per specificare che non può corrispondere a UpHierarchy tutte le informazioni e deve cercare la gerarchia up-hierarchy. Se le informazioni sulla posizione nella query sono ambigue e non sono presenti informazioni aggiuntive per classificare le posizioni (ad esempio la posizione utente o l'importanza relativa della posizione), l'attendibilità è impostata su Medium. Ad esempio, una query di posizione per "148th Ave, Bellevue" può restituire "148th Ave SE" e "148th Ave NE" con Medium attendibilità. Se le informazioni sulla posizione nella query non forniscono informazioni sufficienti per decodificare una posizione specifica, un valore di posizione meno preciso può essere restituito e la attendibilità è impostata su Medium. Ad esempio, se viene fornito un indirizzo, ma non viene trovata una corrispondenza per il numero di casa, il risultato del codice geografico con un tipo di entità Roadblock può essere restituito.

CountryRegion

Nome	Tipo	Descrizione
ISO	string	ISO del paese/area geografica
name	string	nome del paese/area geografica

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.

FeatureCollectionEnum

Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

Nome	Tipo	Descrizione
FeatureCollection	string

FeaturesItem

Nome	Tipo	Descrizione
bbox	number[]	Riquadro. Proiezione usata : EPSG:3857. Per informazioni dettagliate, vedere RFC 7946 .
geometry	GeoJsonPoint	Tipo di geometria valido GeoJSON Point . 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

Il tipo di una funzionalità deve essere Feature.

Nome	Tipo	Descrizione
Feature	string

GeocodePoints

Raccolta di punti di codice geografico che differiscono dal modo in cui sono stati calcolati e dal loro uso suggerito.

Nome	Tipo	Descrizione
calculationMethod	CalculationMethodEnum	Metodo usato per calcolare il punto di codice geografico.
geometry	GeoJsonPoint	Tipo geometry valido GeoJSON Point . Per informazioni dettagliate, vedere RFC 7946 .
usageTypes	UsageTypeEnum[]	Uso ottimale per il punto di codice geografico. Ogni punto di codice geografico è definito come Route punto, un Display punto o entrambi. Usare Route i punti se si sta creando una route alla posizione. Usare Display i punti se si mostra la posizione in una mappa. Ad esempio, se la posizione è un parco, un Route punto può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto può essere un Display punto che specifica il centro del parco.

GeocodingBatchResponse

Questo oggetto viene restituito da una chiamata al servizio Batch di geocodifica riuscita.

Nome	Tipo	Descrizione
batchItems	GeocodingBatchResponseItem[]	Matrice contenente i risultati del batch.
nextLink	string	è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo.
summary	Summary	Riepilogo per la richiesta batch

GeocodingBatchResponseItem

Nome	Tipo	Descrizione
error	ErrorDetail	Dettagli dell'errore.
features	FeaturesItem[]
nextLink	string	è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo.
optionalId	string	ID dell'oggetto batchItem che corrisponde all'ID nella richiesta
type	FeatureCollectionEnum	Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

GeoJsonPoint

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

Nome	Tipo	Descrizione
bbox	number[]	Riquadro. Proiezione usata : EPSG:3857. Per informazioni dettagliate, vedere RFC 7946 .
coordinates	number[]	Una 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 oggetto GeoJSON. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

Indirizzo del risultato.

Nome	Tipo	Descrizione
baseStreet	string	Strada primaria per la posizione.
displayName	string	Nome completo dell'intersezione.
intersectionType	string	Tipo di intersezione.
secondaryStreet1	string	La prima strada intersecante.
secondaryStreet2	string	Se presente, la seconda strada intersecante.

MatchCodesEnum

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

Ad esempio, una posizione geocodificata con codici di corrispondenza di Good e Ambiguous significa che è stata trovata più di una posizione geografica per le informazioni sulla posizione e che il servizio geocode non disponeva di una gerarchia di ricerca per trovare una corrispondenza.

Analogamente, una posizione geocoded con codici di corrispondenza e AmbiguousUpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio geocode deve cercare la gerarchia e trovare più corrispondenze a tale livello. Un esempio di up an Ambiguous and UpHierarchy result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio geocode non riesce a individuare una corrispondenza per l'indirizzo di strada 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 sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze buone.

Ambiguous: la posizione è una delle corrispondenze possibili. Ad esempio, quando si esegue una query per l'indirizzo di strada 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 con un tipo di UpHierarchy entità RoadBlock.

Nome	Tipo	Descrizione
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nome	Tipo	Descrizione
address	Address	Indirizzo del risultato
confidence	ConfidenceEnum	Il livello di confidenza 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 codice geografico che differiscono dal modo in cui sono stati calcolati e dal loro 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ù posizioni geocodificate per le informazioni sulla posizione e che il servizio di geocodifica non ha eseguito ricerche nella gerarchia superiore 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 geocodice doveva cercare in alto la gerarchia e trovare più corrispondenze a quel livello. Un esempio di up an Ambiguous e UpHierarchy result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodifica non è in grado di individuare una corrispondenza per l'indirizzo stradale e restituisce invece le informazioni per più di un valore RoadBlock. I valori possibili sono: Good: il percorso ha una sola corrispondenza o tutte le corrispondenze restituite sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze Valide. Ambiguous: il percorso è uno dei set di 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 nella 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 con un tipo di UpHierarchy entità RoadBlock.
type	string	Uno dei valori possibili: Indirizzo Blocco stradale RoadIntersection Quartiere PopulatedPlace Codice postale1 AdminDivision1 AdminDivision2 CountryRegion

ResultTypeEnum

Specificare i tipi di entità desiderati nella risposta. Verranno restituiti solo i tipi specificati. Se il punto non può essere mappato ai tipi di entità specificati, nella risposta non vengono restituite informazioni sulla posizione. Il valore predefinito è tutte le entità possibili. Elenco delimitato da virgole di tipi di entità selezionati dalle opzioni seguenti.

• Indirizzo
• Quartiere
• PopulatedPlace
• Codice postale1
• AdminDivision1
• AdminDivision2
• CountryRegion

Questi tipi di entità vengono ordinati dall'entità più specifica all'entità meno specifica. Quando vengono trovate entità di più tipi di entità, viene restituita solo l'entità più specifica. Ad esempio, se si specifica Address e AdminDistrict1 come tipi di entità e entità sono state trovate per entrambi i tipi, nella risposta vengono restituite solo le informazioni sull'entità Address.

Nome	Tipo	Descrizione
Address	string
AdminDivision1	string
AdminDivision2	string
CountryRegion	string
Neighborhood	string
PopulatedPlace	string
Postcode1	string

ReverseGeocodingBatchRequestBody

Elenco di query/richieste di geocodifica inversa da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.

Nome	Tipo	Descrizione
batchItems	ReverseGeocodingBatchRequestItem[]	Elenco di query da elaborare.

ReverseGeocodingBatchRequestItem

Oggetto Query batch

Nome	Tipo	Descrizione
coordinates	number[]	Coordinate della posizione da invertire il codice geografico. Esempio: [lon,lat]
optionalId	string	ID della richiesta che verrebbe visualizzata nell'oggetto batchItem corrispondente
resultTypes	ResultTypeEnum[]	Specificare i tipi di entità desiderati nella risposta. Verranno restituiti solo i tipi specificati. Se il punto non può essere mappato ai tipi di entità specificati, nella risposta non vengono restituite informazioni sulla posizione. Il valore predefinito è tutte le entità possibili. Elenco delimitato da virgole di tipi di entità selezionati dalle opzioni seguenti. Indirizzo Quartiere PopulatedPlace Codice postale1 AdminDivision1 AdminDivision2 CountryRegion Questi tipi di entità vengono ordinati dall'entità più specifica all'entità meno specifica. Quando vengono trovate entità di più tipi di entità, viene restituita solo l'entità più specifica. Ad esempio, se si specifica Address e AdminDistrict1 come tipi di entità e entità sono state trovate per entrambi i tipi, nella risposta vengono restituite solo le informazioni sull'entità Address.
view	string	Stringa che specifica un codice di area/paese ISO 3166-1 Alfa-2. In questo modo verranno modificati i bordi e le etichette geopolitici contestati per allinearsi all'area utente specificata.

Summary

Riepilogo per la richiesta batch

Nome	Tipo	Descrizione
successfulRequests	integer	Numero di richieste riuscite nel batch
totalRequests	integer	Numero totale di richieste nel batch

UsageTypeEnum

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

Nome	Tipo	Descrizione
Display	string
Route	string