Search - Get Search Address Reverse Batch

API Batch inverso indirizzo di ricerca

Si applica a: vedere piani tariffari.

L'API Search Address Batch invia batch di query all'API inversa dell'indirizzo di ricerca usando solo una singola chiamata API. È possibile chiamare l'API Batch inverso 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 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/reverse/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 Posizione 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 è una richiesta a esecuzione prolungata. Ecco una sequenza tipica di operazioni:

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

  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/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 indirizzo di ricerca inverso :

{
    "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 dei parametri dell'URIinverso degli indirizzi di ricerca supportati. I valori di stringa nella query inversa 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/reverse/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 in cui le query originali sono state inviate nella richiesta batch. Ogni elemento in batchItems contiene statusCode e response campi. Ognuno response di essi batchItems è di uno dei tipi seguenti:

  • SearchAddressReverseResponse - 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 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."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parametri dell'URI

Name In Required Type Description
format
path True
  • string

ID batch per eseguire query sull'operazione.

api-version
query True
  • string

Numero di versione dell'API Mappe di Azure.

Intestazione della richiesta

Name Required Type Description
x-ms-client-id
  • string

Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza di Azure AD. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione Mappe di Azure. Per usare la sicurezza di Azure AD in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Name Type Description
200 OK

OK

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.

Headers

  • Location: string
Other Status Codes

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . 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.

Note

  • 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 dispongono di URL di autorizzazione univoci e configurazioni di Azure Active Directory. * 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 Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

  • Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli account Personali.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
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.

Type: 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.

Type: apiKey
In: header

Esempio

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

Sample Request

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

Sample Response

{
  "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",
              "countrySubdivision": "Î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",
              "countrySubdivision": "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",
              "countrySubdivision": "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"
          }
        ]
      }
    }
  ]
}

Definizioni

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.

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.

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. SearchAddressResponse se la query è stata completata correttamente, ErrorResponse in caso contrario.

ReverseSearchAddressBatchItem

Elemento restituito dalla chiamata al servizio Batch inverso dell'indirizzo di ricerca.

ReverseSearchAddressBatchProcessResult

Questo oggetto viene restituito da una chiamata al servizio Batch inverso dell'indirizzo di ricerca completata.

SearchAddressResultItem

Oggetto Result per una risposta dell'API di ricerca.

SearchAddressResultType

Uno dei valori possibili:

  • POI
  • Indirizzo
  • Area geografica
  • 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

Indirizzo del risultato

Name Type Description
boundingBox

Riquadro delimitatore della posizione.

buildingNumber
  • string

Il numero dell'edificio sulla strada. DEPRECATO, usare invece streetNumber.

country
  • string

Nome del paese

countryCode
  • string

Paese (Nota: si tratta di un codice di due lettere, non di un nome paese).

countryCodeISO3
  • string

Codice paese ISO alfa-3

countrySecondarySubdivision
  • string

Contea

countrySubdivision
  • string

State or Province

countrySubdivisionName
  • string

Nome completo di un primo livello di gerarchia amministrativa del paese. 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 di origine di un risultato, o nel caso di un paese, il nome completo del paese.

localName
  • string

Componente di indirizzo che rappresenta il nome di un'area geografica o di una località che raggruppa un numero di oggetti indirizzabili a scopo di indirizzamento, senza essere un'unità amministrativa. Questo campo viene usato per compilare la freeformAddress proprietà .

municipality
  • string

Città/Città

municipalitySubdivision
  • string

Sub/Super City

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.

Name Type Description
from

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

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

BoundingBox

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

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

Riquadro delimitatore della posizione.

Name Type Description
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

Name Type Description
name
  • string

Nome del marchio

Classification

Classificazione per il punto di interesse restituito

Name Type Description
code
  • string

Proprietà code

names

Matrice dei nomi

ClassificationName

Nome per la classificazione

Name Type Description
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 .

Name Type Description
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.

Name Type Description
position
  • string

Entità Position

EntryPoint

Punto di ingresso per il punto di interesse restituito.

Name Type Description
position

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

type

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.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Name Type Description
info
  • object

Informazioni aggiuntive.

type
  • string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Name Type Description
additionalInfo

Informazioni aggiuntive sull'errore.

code
  • string

Codice di errore.

details

Dettagli dell'errore.

message
  • string

Messaggio di errore.

target
  • string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Name Type Description
error

Oggetto error.

GeographicEntityType

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

Name Type Description
Country
  • string

Nome del paese

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.

Name Type Description
id
  • string

Passarlo come geometryId all'API Get Search Polygon per recuperare le informazioni geometriche per questo risultato.

LatLongPairAbbreviated

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

Name Type Description
lat
  • number

Proprietà Latitude

lon
  • number

Longitudine - proprietà

MatchType

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

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

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

Name Type Description
mode
  • string

Valore usato nella richiesta: nessuno o "nextSevenDays"

timeRanges

Elenco di intervalli di tempo per i prossimi 7 giorni

OperatingHoursTime

Rappresenta una data e un'ora

Name Type Description
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

Name Type Description
endTime

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

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.

Name Type Description
brands

Matrice marchi. Nome del marchio per il punto di interesse restituito.

categories
  • string[]

Matrice categorie

categorySet

Elenco delle categorie di punti di interesse più specifiche

classifications

Matrice di classificazione

name
  • string

Nome della proprietà punto di interesse

openingHours

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

Name Type Description
id
  • integer

ID della categoria

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

Name Type Description
NEARBY
  • string

La ricerca è stata eseguita intorno a una certa latitudine e longitudine con un raggio definito

NON_NEAR
  • string

La ricerca è stata eseguita a livello globale, senza distorsione su una determinata latitudine e longitudine e nessun raggio definito

Response

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

Name Type Description
error

Oggetto error.

results

Elenco dei risultati dell'API di ricerca.

summary

Oggetto Riepilogo per una risposta dell'API di ricerca

ReverseSearchAddressBatchItem

Elemento restituito dalla chiamata al servizio Batch inverso dell'indirizzo di ricerca.

Name Type Description
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 di ricerca completata.

Name Type Description
batchItems

Matrice contenente i risultati del batch.

summary

Riepilogo dei risultati per la richiesta batch

SearchAddressResultItem

Oggetto Result per una risposta dell'API di ricerca.

Name Type Description
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.

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

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

entryPoints

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

Informazioni sul tipo di corrispondenza.

Uno dei valori possibili:

  • AddressPoint
  • HouseNumberRange
  • Indirizzo
poi

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

position

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

Uno dei valori possibili:

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

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
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Oggetto riepilogo per una risposta dell'API di ricerca.

Name Type Description
fuzzyLevel
  • integer

Livello massimo fuzzy necessario per fornire risultati.

geoBias

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

Tipo di query restituito: NEARBY o NON_NEAR.

totalResults
  • integer

Numero totale di risultati trovati.

Summary

Riepilogo dei risultati per la richiesta batch

Name Type Description
successfulRequests
  • integer

Numero di richieste riuscite nel batch

totalRequests
  • integer

Numero totale di richieste nel batch