Search - Get Search Address Batch

Riferimento

Servizio:: Maps

Versione API:: 1.0

Usare per inviare un batch di query all'API indirizzo di ricerca in una singola richiesta asincrona.
L'API Get Search Address Batch è una richiesta http GET che invia batch di query a 'API di ricerca in una singola chiamata API asincrona. È possibile chiamare l'API Batch indirizzo di ricerca per eseguire in modo asincrono (asincrono) o in modo sincrono (sincronizzazione). L'API asincrona consente al chiamante di eseguire il batch fino a 10.000 query e di sincronizzare l'API fino a 100 query.

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 (una 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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Inviare una richiesta batch asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di ricerca relativamente complesse

Consente il recupero dei risultati in una chiamata separata (sono possibili più download).
L'API asincrona è ottimizzata per l'affidabilità e non dovrebbe verificarsi un timeout.
Il numero di elementi batch è limitato a 10.000 per questa API.

Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Le risposte asincrone vengono archiviate per 14 giorni. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

Si noti che la richiesta batch asincrona è un'operazione a esecuzione prolungata. Ecco una sequenza tipica di operazioni:

Il client invia una richiesta batch di indirizzi di ricerca POST a Mappe di Azure.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

Il server risponderà con uno dei seguenti elementi:

HTTP 202 Accepted: la richiesta batch è stata accettata.

HTTP Error: si è verificato un errore durante l'elaborazione della richiesta batch. Può trattarsi di un 400 Bad Request o di qualsiasi altro codice di stato Error.
Se la richiesta batch è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta batch. Questo URI di stato è simile al seguente:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Il client invia una richiesta di GET nell'URL di download ottenuto nel passaggio 3 per scaricare i risultati del batch.

Corpo POST per la richiesta batch

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

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Un indirizzo di ricerca query in un batch è solo un URL parziale senza il protocollo, l'URL di base, il percorso, la versione api e la chiave di sottoscrizione. Può accettare qualsiasi parametro dell'indirizzo di ricerca supportatoparametri URI. I valori stringa nell'indirizzo di ricerca query devono essere preceduti da un carattere di escape corretto ( ad esempio , il carattere deve essere preceduto da un carattere di escape con \ ) e deve anche essere codificato correttamente con URL.

L'API asincrona consente al chiamante di eseguire il batch fino a 10.000 query e l'API di sincronizzazione fino a 100 query e il batch deve contenere almeno 1 query.

Scaricare i risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata una richiesta di GET all'endpoint di download batch. Questo 'URL di download può essere ottenuto dall'intestazione Location di una richiesta batch di POST riuscita e ha un aspetto simile al seguente:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Ecco la sequenza tipica di operazioni per scaricare i risultati del batch:

Il client invia una richiesta di GET usando l'URL di download .
Il server risponderà con uno dei seguenti elementi:

HTTP 202 Accepted: la richiesta batch è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

Http 200 OK: richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

SearchAddressResult: se la query è stata completata correttamente.
Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.

Ecco un esempio di risposta batch con 2 riuscite e 1 risultato non riuscito:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	string	ID batch per l'esecuzione di query sull'operazione.
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 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	SearchAddressBatchProcessResult	Va bene
202 Accepted		Supportato solo per la richiesta asincrona. Richiesta accettata: la richiesta è stata accettata per l'elaborazione. Usare l'URL nell'intestazione percorso per riprovare o accedere ai risultati. Intestazioni Location: string
Other Status Codes	ErrorResponse	Errore imprevisto.

Nome

Tipo

Descrizione

200 OK

SearchAddressBatchProcessResult

Va bene

202 Accepted

Supportato solo per la richiesta asincrona. Richiesta accettata: la richiesta è stata accettata per l'elaborazione. Usare l'URL nell'intestazione percorso per riprovare o accedere ai risultati.

Intestazioni

Location: string

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

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/search/address/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Risposta di esempio

Codice di stato:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Codice di stato:: 202

Definizioni

Nome	Descrizione
Address	Indirizzo del risultato
AddressRanges	Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.
BoundingBox	Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.
BoundingBoxCompassNotation	Rettangolo di selezione della posizione.
Brand	Il marchio associato al punto di interesse
Classification	Classificazione per il punto di interesse restituito
ClassificationName	Nome della classificazione
DataSources	Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon.
Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
EntryPoint	Punto di ingresso per il punto di interesse restituito.
EntryPointType	Tipo di punto di ingresso. Il valore può essere principale o secondaria.
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.
Geometry	Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.
LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
MatchType	Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.
OperatingHours	Ore di apertura per un punto di interesse (punti di interesse).
OperatingHoursTime	Rappresenta una data e un'ora
OperatingHoursTimeRange	Aprire l'intervallo di tempo per un giorno
PointOfInterest	Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
PointOfInterestCategorySet	Categoria punti di interesse
QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
Response	Risultato della query. SearchAddressResult se la query è stata completata correttamente, ErrorResponse in caso contrario.
SearchAddressBatchItem	Elemento restituito dalla chiamata al servizio Batch indirizzo di ricerca.
SearchAddressBatchProcessResult	Questo oggetto viene restituito da una chiamata al servizio Batch indirizzo di ricerca riuscita.
SearchAddressResultItem	Oggetto Result per una risposta dell'API di ricerca.
SearchAddressResultType	Uno dei seguenti: POI (Punto di interesse) Via Geografia Punto di interesse Intervallo di indirizzi Incrocio
SearchSummary	Oggetto riepilogo per una risposta dell'API di ricerca.
Summary	Riepilogo dei risultati per la richiesta batch

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.

AddressRanges

Object

Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.

Nome	Tipo	Descrizione
from	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
rangeLeft	string	Intervallo di indirizzi sul lato sinistro della strada.
rangeRight	string	Intervallo di indirizzi sul lato destro della strada.
to	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

BoundingBox

Object

Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.

Nome	Tipo	Descrizione
btmRightPoint	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

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

Brand

Object

Il marchio associato al punto di interesse

Nome	Tipo	Descrizione
name	string	Nome del marchio

Classification

Object

Classificazione per il punto di interesse restituito

Nome	Tipo	Descrizione
code	string	Proprietà del codice
names	ClassificationName[]	Matrice nomi

ClassificationName

Object

Nome della classificazione

Nome	Tipo	Descrizione
name	string	Name - proprietà
nameLocale	string	Proprietà Delle impostazioni locali name

DataSources

Object

Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon.

Nome	Tipo	Descrizione
geometry	Geometry	Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.

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

EntryPoint

Object

Punto di ingresso per il punto di interesse restituito.

Nome	Tipo	Descrizione
position	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
type	EntryPointType	Tipo di punto di ingresso. Il valore può essere principale o secondaria.

EntryPointType

Enumerazione

Tipo di punto di ingresso. Il valore può essere principale o secondaria.

Valore	Descrizione
main
minor

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

Geometry

Object

Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.

Nome	Tipo	Descrizione
id	string	Passare questo valore come geometryId all'API get search polygon per recuperare le informazioni di geometria per questo risultato.

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à

MatchType

Enumerazione

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

Valore	Descrizione
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Ore di apertura per un punto di interesse (punti di interesse).

Nome	Tipo	Descrizione
mode	string	Valore usato nella richiesta: nessuno o "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Elenco di intervalli di tempo per i prossimi 7 giorni

OperatingHoursTime

Object

Rappresenta una data e un'ora

Nome	Tipo	Descrizione
date	string	Rappresenta la data del calendario corrente nel fuso orario dei punti di interesse, ad esempio "2019-02-07".
hour	integer	Le ore sono nel formato 24 ore nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 23.
minute	integer	I minuti sono nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 59.

OperatingHoursTimeRange

Object

Aprire l'intervallo di tempo per un giorno

Nome	Tipo	Descrizione
endTime	OperatingHoursTime	Punto nell'intervallo di 7 giorni successivo quando un punto di interesse specificato viene chiuso o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo.
startTime	OperatingHoursTime	Punto nell'intervallo di 7 giorni successivo quando viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo.

PointOfInterest

Object

Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.

Nome	Tipo	Descrizione
brands	Brand[]	Matrice di marchi. Nome del marchio per il punto di interesse restituito.
categories	string[]	Matrice categorie
categorySet	PointOfInterestCategorySet[]	Elenco delle categorie di punti di interesse più specifiche
classifications	Classification[]	Matrice di classificazione
name	string	Nome della proprietà POI
openingHours	OperatingHours	Ore di apertura per un punto di interesse (punti di interesse).
phone	string	Proprietà numero di telefono
url	string	Proprietà URL sito Web

PointOfInterestCategorySet

Object

Categoria punti di interesse

Nome	Tipo	Descrizione
id	integer	ID categoria

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

Response

Object

Risultato della query. SearchAddressResult se la query è stata completata correttamente, ErrorResponse in caso contrario.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.
results	SearchAddressResultItem[]	Elenco dei risultati dell'API di ricerca.
summary	SearchSummary	Oggetto Riepilogo per una risposta dell'API di ricerca

SearchAddressBatchItem

Object

Elemento restituito dalla chiamata al servizio Batch indirizzo di ricerca.

Nome	Tipo	Descrizione
response	Response	Risultato della query. SearchAddressResult se la query è stata completata correttamente, ErrorResponse in caso contrario.
statusCode	integer	Codice di stato della richiesta HTTP.

SearchAddressBatchProcessResult

Object

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

Nome	Tipo	Descrizione
batchItems	SearchAddressBatchItem[]	Matrice contenente i risultati del batch.
summary	Summary	Riepilogo dei risultati per la richiesta batch

SearchAddressResultItem

Object

Oggetto Result per una risposta dell'API di ricerca.

Nome	Tipo	Descrizione
address	Address	Indirizzo del risultato
addressRanges	AddressRanges	Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.
dataSources	DataSources	Sezione facoltativa. ID geometry di riferimento da usare con l'API get search polygon.
detourTime	integer	Tempo di deviazione in secondi. Restituito solo per le chiamate all'API Search Along Route.
dist	number (double)	Distanza linea retta tra il risultato e la posizione geobias in metri.
entityType	GeographicEntityType	Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.
entryPoints	EntryPoint[]	Matrice di Punti di ingresso. Questi descrivono i tipi di ingressi disponibili nella posizione. Il tipo può essere "principale" per gli ingressi principali, ad esempio una porta anteriore, o una hall, e "minore", per porte laterali e posteriore.
id	string	Id - proprietà
info	string	Informazioni sull'origine dati originale del risultato. Usato per le richieste di supporto.
matchType	MatchType	Informazioni sul tipo di corrispondenza. Uno dei seguenti: AddressPoint HouseNumberRange Via
poi	PointOfInterest	Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
position	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
score	number (double)	Valore all'interno di un set di risultati per indicare il punteggio di corrispondenza relativo tra i risultati. È possibile usarlo per determinare che il risultato x è il doppio delle probabilità di essere rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra le query e sono destinati solo a un valore relativo per un set di risultati.
type	SearchAddressResultType	Uno dei seguenti: POI (Punto di interesse) Via Geografia Punto di interesse Intervallo di indirizzi Incrocio
viewport	BoundingBox	Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.

SearchAddressResultType

Enumerazione

Uno dei seguenti:

POI (Punto di interesse)
Via
Geografia
Punto di interesse
Intervallo di indirizzi
Incrocio

Valore	Descrizione
Address Range
Cross Street
Geography
POI
Point Address
Street

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.

Summary

Object

Riepilogo dei risultati per la richiesta batch

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

Condividi tramite

Search - Get Search Address Batch

Inviare una richiesta batch sincrona

Inviare una richiesta batch asincrona

Corpo POST per la richiesta batch

Scaricare i risultati batch asincroni

Modello di risposta batch

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

Esempio di richiesta

Risposta di esempio

Definizioni

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Risorse aggiuntive