Search - Post Search Address Batch Sync

Servizio:

Maps

Versione API:

1.0

Usare per inviare un batch di query all'API Search Fuzzy in una singola richiesta sincrona.
API batch di indirizzi Search

L'API Post Search Address Batch sync invia batch di query a Search API Address in una singola chiamata API sincrona. È possibile chiamare Search API Batch di indirizzi 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 l'API di sincronizzazione fino a 100 query.

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

Invia 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 deve essere eseguita in 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 di risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sugli errori. 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:

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

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

2. 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. Questo potrebbe essere un 400 Bad Request o qualsiasi altro Error codice di stato.

3. 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}

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

CORPO POST per la richiesta batch

Per inviare le query degli indirizzi di ricerca , 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 della richiesta di esempio contenente 5 query di indirizzi 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"}
    ]
}

Una query di indirizzo di ricerca 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 uno dei parametri dell'URIdegli indirizzi di ricerca supportati. I valori di stringa nella query dell'indirizzo di ricerca devono essere eliminati correttamente (ad esempio , il carattere deve essere 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 batch asincroni, verrà eseguita una GET richiesta all'endpoint di download batch. Questo URL di download può essere ottenuto dall'intestazione Location di una richiesta batch riuscita POST 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 il download dei risultati batch:

1. Il client invia una GET richiesta usando l'URL di download.

2. Il server risponderà con uno dei seguenti elementi:

   HTTP 202 Accepted : richiesta batch accettata ma ancora in fase di elaborazione. Riprovare in qualche momento.

   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 alle richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha completato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un summary componente che indica la totalRequests parte della richiesta batch originale e successfulRequests, ad esempio, le query eseguite correttamente. La risposta batch include anche una matrice che contiene una batchItems risposta per ogni query e ogni query nella richiesta batch. Conterrà batchItems i risultati nello stesso ordine di invio delle query originali nella richiesta batch. Ogni elemento in batchItems contiene statusCode e response campi. Ognuno response di essi batchItems è di uno dei tipi seguenti:

• SearchAddressResult - Se la query è stata completata correttamente.

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

Ecco un esempio di Risposta batch con esito positivo e 1 risultato negativo :

{
    "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."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo il formato json.
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 Microsoft Entra ID. 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 Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Corpo della richiesta

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

Risposte

Nome	Tipo	Descrizione
200 OK	SearchAddressBatchProcessResult	OK
Other Status Codes	ErrorResponse	Timeout: la richiesta richiede più tempo rispetto al tempo massimo definito nell'API.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

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

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 quale Mappe di Azure risorsa 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 hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID.
• Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
• L'utilizzo dell'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 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 eseguito il provisioning quando si crea un account Mappe di Azure nell'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 delle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul 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 account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

A Sync Address Geocoding Batch API call containing 5 Address Geocoding API queries

Esempio di richiesta

HTTP

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0

{
  "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"
    }
  ]
}

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:

408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definizioni

Nome	Descrizione
Address	Indirizzo del risultato
AddressRanges	Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.
BatchRequest	Questo tipo rappresenta il corpo della richiesta per il servizio Batch.
BatchRequestItem	Oggetto richiesta batch
BoundingBox	Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione.
BoundingBoxCompassNotation	Casella di selezione della posizione.
Brand	Il marchio associato all'entità di ricerca
Classification	Classificazione dell'oggetto POI restituito
ClassificationName	Nome per la 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 geocodatura inversa, questa operazione è sempre uguale alla posizione.
EntryPoint	Punto di ingresso per l'oggetto POI restituito.
EntryPointType	Tipo di punto di ingresso. Il valore può essere principale o secondario.
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 tipo == Geography.
JsonFormat	Formato desiderato della risposta. È supportato solo il formato json.
LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
MatchType	Tipi di corrispondenza per un'operazione di ricerca degli indirizzi inversa.
OperatingHours	Ore di apertura per un punto di interesse (punti di interesse).
OperatingHoursTime	Rappresenta una data e un'ora
OperatingHoursTimeRange	Intervallo di tempo aperto per un giorno
PointOfInterest	Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.
PointOfInterestCategorySet	Categoria POI
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 di indirizzi Search.
SearchAddressBatchProcessResult	Questo oggetto viene restituito da una chiamata al servizio Batch address Search completata.
SearchAddressResultItem	Oggetto Result per una risposta api Search.
SearchAddressResultType	Uno dei valori possibili: POI Indirizzo Area geografica Punto di interesse Intervallo di indirizzi Incrocio
SearchSummary	Oggetto Riepilogo per una risposta API Search.
Summary	Riepilogo dei risultati per la richiesta batch

Address

Indirizzo del risultato

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

AddressRanges

Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.

Nome	Tipo	Descrizione
from	LatLongPairAbbreviated	Una 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	Una posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

BatchRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Batch.

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

BatchRequestItem

Oggetto richiesta batch

Nome	Tipo	Descrizione
query	string	Questo parametro contiene una stringa di query usata per eseguire un'operazione di geocodifica non strutturata. La stringa di query verrà passata verbatim all'API di ricerca per l'elaborazione.

BoundingBox

Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione.

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

BoundingBoxCompassNotation

Casella di selezione della posizione.

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

Brand

Il marchio associato all'entità di ricerca

Nome	Tipo	Descrizione
name	string	Nome del marchio

Classification

Classificazione dell'oggetto POI restituito

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

ClassificationName

Nome per la classificazione

Nome	Tipo	Descrizione
name	string	Name (proprietà)
nameLocale	string	Proprietà Name Locale

DataSources

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 tipo == Geography.

Entity

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

Nome	Tipo	Descrizione
position	string	Entità position

EntryPoint

Punto di ingresso per l'oggetto POI restituito.

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

EntryPointType

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

Nome	Tipo	Descrizione
main	string
minor	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GeographicEntityType

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

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

Geometry

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

Nome	Tipo	Descrizione
id	string	Passare questo valore come geometryId all'API Get Search Polygon per recuperare le informazioni geometry per questo risultato.

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

Nome	Tipo	Descrizione
json	string	Formato di interscambio dati notazione oggetto JavaScript

LatLongPairAbbreviated

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

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

MatchType

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

Nome	Tipo	Descrizione
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

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

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

OperatingHoursTime

Rappresenta una data e un'ora

Nome	Tipo	Descrizione
date	string	Rappresenta la data del calendario corrente nel fuso orario poi, ad esempio "2019-02-07".
hour	integer	Le ore sono in formato 24 ore nell'ora locale di un POI; i valori possibili sono 0 - 23.
minute	integer	I minuti si trovano nell'ora locale di un PUNTO; i valori possibili sono 0 - 59.

OperatingHoursTimeRange

Intervallo di tempo aperto per un giorno

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

PointOfInterest

Dettagli dell'oggetto POI 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 poi restituito.
categories	string[]	Matrice categorie
categorySet	PointOfInterestCategorySet[]	Elenco delle categorie più specifiche di POI
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

Categoria POI

Nome	Tipo	Descrizione
id	integer	ID della categoria

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

Nome	Tipo	Descrizione
NEARBY	string	Search è stato eseguito intorno a una certa latitudine e longitudine con un raggio definito
NON_NEAR	string	Search è stato eseguito a livello globale, senza distorsione su una certa latitudine e longitudine e nessun raggio definito

Response

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 Search.
summary	SearchSummary	Oggetto Riepilogo per una risposta api di Search

SearchAddressBatchItem

Elemento restituito dalla chiamata al servizio Batch di indirizzi Search.

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

Questo oggetto viene restituito da una chiamata al servizio Batch address Search completata.

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

SearchAddressResultItem

Oggetto Result per una risposta api Search.

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 di inizio e fine 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	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 valori possibili: AddressPoint HouseNumberRange Indirizzo
poi	PointOfInterest	Dettagli dell'area di interesse restituita, 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	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 della probabilità che sia 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 valori possibili: POI Indirizzo Area geografica 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

Uno dei valori possibili:

• POI
• Indirizzo
• Area geografica
• Punto di interesse
• Intervallo di indirizzi
• Incrocio

Nome	Tipo	Descrizione
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Oggetto Riepilogo per una risposta API Search.

Nome	Tipo	Descrizione
fuzzyLevel	integer	Livello massimo fuzzy necessario per fornire risultati.
geoBias	LatLongPairAbbreviated	Indica quando il motore di ricerca interno ha applicato una distorsione geospaziale per migliorare la classificazione dei risultati. In alcuni metodi è possibile influire sull'impostazione dei 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 dei risultati restituiti all'interno del set di risultati completo.
query	string	Parametro di query utilizzato 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

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