Condividi tramite

Search - Post Search Along Route

  • Riferimento
Servizio:
Maps
Versione API:
1.0

Usare per eseguire una ricerca fuzzy per i POI lungo una route specificata.

L'API Post Search Along Route è una richiesta HTTP POST che consente di eseguire una ricerca fuzzy per i POI lungo una route specificata. Questa ricerca è vincolata specificando la maxDetourTime misura di limitazione.

Per inviare i punti di route, si userà una POST richiesta in cui il corpo della richiesta conterrà l'oggetto route rappresentato come GeoJSON LineString tipo e l'intestazione Content-Type verrà impostata su application/json. Ogni punto di route in route è rappresentato come tipo, ovvero una GeoJSON Position matrice in cui il valore di longitudine è seguito dal valore di latitudine e il valore di altitudine viene ignorato. Deve route contenere almeno 2 punti di route.

È possibile che il percorso originale venga modificato, alcuni punti potrebbero essere ignorati. Se la route che passa attraverso il punto trovato è più veloce di quella originale, il detourTime valore nella risposta è negativo.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
Con parametri facoltativi: 
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

Parametri dell'URI

Nome In Necessario Tipo Descrizione
format
 path True

ResponseFormat

Formato desiderato della risposta. Il valore può essere json o xml.
api-version
 query True

string

Numero di versione dell'API Mappe di Azure.
maxDetourTime
 query True

integer

Tempo massimo di deviazione del punto di interesse in secondi. Il valore massimo è 3600 secondi
query
 query True

string

Il nome POI per cercare (ad esempio, "statua della libertà", "starbucks", "pizza"). Deve essere codificato correttamente con URL.
brandSet
 query

string[]

Elenco delimitato da virgole di nomi di marca che possono essere usati per limitare il risultato a marchi specifici. L'ordine degli elementi non è importante. Quando vengono forniti più marchi, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi forniti. I marchi che contengono un "," nel loro nome devono essere inseriti in virgolette.

Esempi di utilizzo:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Virgole",Barra
categorySet
 query

integer[]

Elenco delimitato da virgole degli ID set di categorie che possono essere usati per limitare il risultato a categorie specifiche di Punti di interesse. L'ordine ID non è importante. Il numero massimo di categorySet valori supportati per richiesta è 10. Quando vengono forniti più identificatori di categoria, verranno restituiti solo i POI che appartengono a (almeno) una delle categorie dell'elenco specificato. L'elenco delle categorie supportate può essere individuato usando l'API Categorie DI CRITERI . Esempi di utilizzo:

  • categorySet=7315 (Search Punti di interesse dalla categoria Ristorante)

  • categorySet=7315025.7315017 (Search Punti di interesse di categoria)
connectorSet
 query

ElectricVehicleConnector[]

Elenco delimitato da virgole di tipi di connettore che possono essere usati per limitare il risultato a Electric Vehicle Station che supporta tipi di connettore specifici. L'ordine degli elementi non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi specificati.

I tipi di connettore disponibili sono:

  • StandardHouseholdCountrySpecific - Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard. Vedere anche: Collegare & tipi di socket - Standard mondiali.
  • IEC62196Type1 - Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase.
  • IEC62196Type1CCS - Connettore combinato basato su tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type2CableAttached - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica.
  • IEC62196Type2Outlet - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica.
  • IEC62196Type2CCS - Connettore combinato basato su 2 tipo, come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 2, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type3 - Tipo 3 connettore definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi.
  • Chademo - Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce.
  • IEC60309AC1PhaseBlue - Connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h".
  • IEC60309DCWhite - Connettore Bianco industriale è un connettore DC definito nello standard IEC 60309.
  • Tesla - Il connettore Tesla è il connettore Tesla Supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa.

Esempi di utilizzo:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
limit
 query

integer

Numero massimo di risposte restituite. Il valore predefinito è 10. Il valore massimo è 20
openingHours
 query

OperatingHoursRange

Ore di operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays
view
 query

LocalizedMapView

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà eseguita l'applicazione. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.

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
route

GeoJsonLineString

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

Risposte

Nome Tipo Descrizione
200 OK

SearchAddressResult

OK
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

Search for burger joints along a route

Esempio di richiesta

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

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

Elenco delimitato da virgole di tipi di connettore che possono essere usati per limitare il risultato a Electric Vehicle Station che supporta tipi di connettore specifici. L'ordine degli elementi non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi specificati.

I tipi di connettore disponibili sono:

  • StandardHouseholdCountrySpecific - Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard. Vedere anche: Collegare & tipi di socket - Standard mondiali.
  • IEC62196Type1 - Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase.
  • IEC62196Type1CCS - Connettore combinato basato su tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type2CableAttached - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica.
  • IEC62196Type2Outlet - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica.
  • IEC62196Type2CCS - Connettore combinato basato su 2 tipo, come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 2, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type3 - Tipo 3 connettore definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi.
  • Chademo - Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce.
  • IEC60309AC1PhaseBlue - Connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h".
  • IEC60309DCWhite - Connettore Bianco industriale è un connettore DC definito nello standard IEC 60309.
  • Tesla - Il connettore Tesla è il connettore Tesla Supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa.

Esempi di utilizzo:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
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 sulla gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
GeographicEntityType

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

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

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

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

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà eseguita l'applicazione. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.
MatchType

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

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

Ore di operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays
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 POI
QueryType

Tipo di query restituito: NEARBY o NON_NEAR.
ResponseFormat

Formato desiderato della risposta. Il valore può essere json o xml.
SearchAddressResult

Questo oggetto viene restituito da una Search chiamate riuscite.
SearchAddressResultItem

Oggetto Result per una risposta api Search.
SearchAddressResultType

Uno dei valori possibili:

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

Questo tipo rappresenta il corpo della richiesta per il servizio Search Lungo la route.
SearchSummary

Oggetto Riepilogo per una risposta API Search.

Address

Indirizzo del risultato

Nome Tipo Descrizione
boundingBox

BoundingBoxCompassNotation

Casella di selezione 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 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 attraversata.
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'.

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.

ElectricVehicleConnector

Elenco delimitato da virgole di tipi di connettore che possono essere usati per limitare il risultato a Electric Vehicle Station che supporta tipi di connettore specifici. L'ordine degli elementi non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi specificati.

I tipi di connettore disponibili sono:

  • StandardHouseholdCountrySpecific - Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard. Vedere anche: Collegare & tipi di socket - Standard mondiali.
  • IEC62196Type1 - Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase.
  • IEC62196Type1CCS - Connettore combinato basato su tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type2CableAttached - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica.
  • IEC62196Type2Outlet - Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica.
  • IEC62196Type2CCS - Connettore combinato basato su 2 tipo, come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 2, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
  • IEC62196Type3 - Tipo 3 connettore definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi.
  • Chademo - Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce.
  • IEC60309AC1PhaseBlue - Connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h".
  • IEC60309DCWhite - Connettore Bianco industriale è un connettore DC definito nello standard IEC 60309.
  • Tesla - Il connettore Tesla è il connettore Tesla Supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa.

Esempi di utilizzo:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Nome Tipo Descrizione
Chademo

string

Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce.
IEC60309AC1PhaseBlue

string

Il connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h".
IEC60309DCWhite

string

Il connettore Bianco industriale è un connettore DC definito nello standard IEC 60309.
IEC62196Type1

string

Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase.
IEC62196Type1CCS

string

Connettore combinato basato sul tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
IEC62196Type2CCS

string

Connettore combinato basato su 2 tipo, come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 2, come definito nello standard IEC 62196-2, con due contatti dc (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio.
IEC62196Type2CableAttached

string

Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica
IEC62196Type2Outlet

string

Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica.
IEC62196Type3

string

Connettore di tipo 3 definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi.
StandardHouseholdCountrySpecific

string

Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard.

Vedere anche: Plug & socket type - World Standards
Tesla

string

Il connettore Tesla è il connettore Tesla supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa.

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

GeoJsonLineString

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

Nome Tipo Descrizione
coordinates

number[]

Coordinate per la GeoJson LineString geometria.
type string:

LineString

Specifica il tipo di oggetto GeoJSON. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

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.

LatLongPairAbbreviated

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

Nome Tipo Descrizione
lat

number

Proprietà Latitude
lon

number

Longitudine - proprietà

LocalizedMapView

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà eseguita l'applicazione. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.

Nome Tipo Descrizione
AE

string

Emirati Arabi Uniti (visualizzazione araba)
AR

string

Argentina (visualizzazione argentina)
Auto

string

Restituisce i dati della mappa in base all'indirizzo IP della richiesta.
BH

string

Bahrain (visualizzazione araba)
IN

string

India (visualizzazione indiana)
IQ

string

Iraq (visualizzazione araba)
JO

string

Giordania (visualizzazione araba)
KW

string

Kuwait (visualizzazione araba)
LB

string

Libano (visualizzazione araba)
MA

string

Marocco (visualizzazione marocchina)
OM

string

Oman (visualizzazione araba)
PK

string

Pakistan (visualizzazione pakistana)
PS

string

Autorità Palestinese (visualizzazione araba)
QA

string

Qatar (visualizzazione araba)
SA

string

Arabia Saudita (visualizzazione araba)
SY

string

Siria (visualizzazione araba)
Unified

string

Visualizzazione unificata (altri)
YE

string

Yemen (visualizzazione araba)

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

OperatingHoursRange

Ore di operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays

Nome Tipo Descrizione
nextSevenDays

string

Mostra le ore dell'operazione per la prossima settimana, a partire dal giorno corrente nell'ora locale dell'istanza di POI.

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

ResponseFormat

Formato desiderato della risposta. Il valore può essere json o xml.

Nome Tipo Descrizione
json

string

Formato di interscambio dati dell'oggetto JavaScript
xml

string

Linguaggio di markup estendibile

SearchAddressResult

Questo oggetto viene restituito da una Search chiamate riuscite.

Nome Tipo Descrizione
results

SearchAddressResultItem[]

Elenco dei risultati dell'API Search.
summary

SearchSummary

Oggetto Riepilogo per una risposta api di Search

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

SearchAlongRouteRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Search Lungo la route.

Nome Tipo Descrizione
route

GeoJsonLineString

Tipo di geometria valido GeoJSON LineString . Per informazioni dettagliate, vedere RFC 7946 .

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.