Condividi tramite

Search - Post Search Address Reverse Batch Sync

  • Riferimento
Servizio:
Maps
Versione API:
1.0

Usare per inviare un batch di query all'API indirizzo Search in una singola richiesta sincrona.
L'API Get Search Address Batch è una richiesta HTTP GET che invia batch di query a Search'API Address in una singola chiamata API sincrona. È possibile chiamare Search'API Batch inversa degli 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 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 (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/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Inviare una richiesta batch asincrona

L'API asincrona è appropriata per l'elaborazione di volumi elevati 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:

  1. Il client invia una richiesta batch POST inversa Search indirizzo a Mappe di Azure.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. 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 codice di stato o di qualsiasi altro Error tipo.

  2. 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/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 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 inversa dell'indirizzo 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 ricerca inversa :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Una query inversa dell'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 qualsiasi dei parametri dell'URIinverso dell'indirizzo di ricerca supportato. I valori stringa nella query inversa dell'indirizzo di ricerca devono essere preceduti da un carattere di escape (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 di sincronizzare l'API fino a 100 query e il batch deve contenere almeno 1 query.

Scaricare risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata 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/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Ecco la sequenza tipica di operazioni per il download dei risultati del 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 : la richiesta batch è stata accettata ma è ancora in fase di elaborazione. Riprovare in qualche momento.

    HTTP 200 OK : la richiesta batch è stata 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 summary componente che indica totalRequests che fanno 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 in batchItems contiene statusCode campi e response . Ogni response in batchItems è di uno dei tipi seguenti:

  • SearchAddressReverseResponse - Se la query è stata completata correttamente.

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

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

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "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/reverse/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 account 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 di query da elaborare.

Risposte

Nome Tipo Descrizione
200 OK

ReverseSearchAddressBatchProcessResult

OK
Other Status Codes

ErrorResponse

Timeout: la richiesta ha richiesto più tempo rispetto alla quantità massima di tempo definita nell'API.
Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Nota

  • Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .
  • è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID.
  • Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, AZURE SDK o API REST.
  • L'utilizzo di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
  • Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si crea un account Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio alle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

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

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

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

Esempio di richiesta

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

{
  "batchItems": [
    {
      "query": "?query=48.858561,2.294911"
    },
    {
      "query": "?query=47.639765,-122.127896&radius=5000&limit=2"
    },
    {
      "query": "?query=47.621028,-122.348170"
    }
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}
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. Sono incluse le coordinate per le posizioni di inizio e fine dell'intervallo di indirizzi.
BatchRequest

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

Oggetto richiesta batch
BoundingBox

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

Riquadro delimitatore della posizione.
Brand

Il marchio associato al punto di interesse
Classification

Classificazione per il punto di interesse 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 geocodifica inversa, questa operazione è 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 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 type == 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 di indirizzi inversa.
OperatingHours

Orari 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'area di interesse restituita, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
PointOfInterestCategorySet

Categoria di 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.
ReverseSearchAddressBatchItem

Elemento restituito da Search chiamata al servizio Batch inverso dell'indirizzo.
ReverseSearchAddressBatchProcessResult

Questo oggetto viene restituito da una chiamata al servizio Batch inverso dell'indirizzo Search riuscita.
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

Riquadro delimitatore della posizione.
buildingNumber

string

Il 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

State or Province
countrySubdivisionCode

string

countrySubdivisionCode preceduto da countryCode ( countryCode-countrySubdivisionCode ) e dal trattino forma il codice ISO 3166-2. Esempi: TX per Texas, SCT per Scozia e ON per Ontario.
countrySubdivisionName

string

Nome completo di un primo livello di gerarchia amministrativa paese/area geografica. Questo campo viene visualizzato solo nel caso in cui countrySubdivision sia presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito.
countryTertiarySubdivision

string

Area denominata
crossStreet

string

Nome della strada attraversata.
extendedPostalCode

string

Codice postale esteso (la disponibilità dipende dall'area).
freeformAddress

string

Riga di indirizzo formattata in base alle regole di formattazione del paese o dell'area geografica di un risultato oppure, nel caso di un paese/area geografica, il nome completo del paese o dell'area geografica.
localName

string

Componente di indirizzo che rappresenta il nome di un'area geografica o di una località che raggruppa più oggetti indirizzabili a scopo di indirizzamento, senza essere un'unità amministrativa. Questo campo viene usato per compilare la freeformAddress proprietà . localName rappresenta il comune postale. A seconda della posizione, localName è il nome comunemente noto di una città o di una città. Per il nome comunemente noto di una città o di una città, usare localName invece di municipality.
municipality

string

Città/Città
Nota: municipality rappresenta il comune residenziale. A seconda della posizione, il municipality valore può 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 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 di una città con caratteristiche distintive e interazioni sociali tra gli abitanti.
postalCode

string

Cap/Cap
routeNumbers

string[]

I codici utilizzati 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

Il numero dell'edificio sulla strada.

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.

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

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

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

Riquadro delimitatore della posizione.

Nome Tipo Descrizione
entity

Entity

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

string

Latitudine nord-est,coordinata longitudine del rettangolo delimitatore come float delimitati da virgole
southWest

string

Latitudine sud-ovest,coordinata longitudine del rettangolo delimitatore come float delimitati da virgole

Brand

Il marchio associato al punto di interesse

Nome Tipo Descrizione
name

string

Nome del marchio

Classification

Classificazione per il punto di interesse restituito

Nome Tipo Descrizione
code

string

Proprietà code
names

ClassificationName[]

Matrice dei nomi

ClassificationName

Nome per la classificazione

Nome Tipo Descrizione
name

string

Name (proprietà)
nameLocale

string

Proprietà Delle impostazioni locali name

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

Entity

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

Nome Tipo Descrizione
position

string

Entità Position

EntryPoint

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

Cap/Cap

Geometry

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

Nome Tipo Descrizione
id

string

Passarlo come geometryId all'API Get Search Polygon per recuperare le informazioni di geometria 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 di indirizzi inversa.

Nome Tipo Descrizione
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Orari 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

Rappresenta una data e un'ora

Nome Tipo Descrizione
date

string

Rappresenta la data del calendario corrente nel fuso orario di calendario, ad esempio "2019-02-07".
hour

integer

Le ore sono nel formato di 24 ore nell'ora locale di un punto di interesse; i valori possibili sono 0 - 23.
minute

integer

I minuti sono nell'ora locale di un punto di interesse; I valori possibili sono compresi tra 0 e 59.

OperatingHoursTimeRange

Intervallo di tempo aperto per un giorno

Nome Tipo Descrizione
endTime

OperatingHoursTime

Punto nell'intervallo di 7 giorni successivo in cui viene chiuso un punto di interesse specificato o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo.
startTime

OperatingHoursTime

Punto nell'intervallo di 7 giorni successivo in cui viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo.

PointOfInterest

Dettagli dell'area di interesse restituita, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.

Nome Tipo Descrizione
brands

Brand[]

Matrice 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à punto di interesse
openingHours

OperatingHours

Orari di apertura per un punto di interesse (Punti di interesse).
phone

string

Proprietà numero di telefono
url

string

Proprietà URL sito Web

PointOfInterestCategorySet

Categoria di punti di interesse

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

ReverseSearchAddressBatchItem

Elemento restituito da Search chiamata al servizio Batch inverso dell'indirizzo.

Nome Tipo Descrizione
response

Response

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

integer

Codice di stato della richiesta HTTP.

ReverseSearchAddressBatchProcessResult

Questo oggetto viene restituito da una chiamata al servizio Batch inverso dell'indirizzo Search riuscita.

Nome Tipo Descrizione
batchItems

ReverseSearchAddressBatchItem[]

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