Condividi tramite


Search - Post Search Inside Geometry

Usare per eseguire ricerche in formato libero all'interno di una più geometrie.

L'API è e POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a http POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSONcan be represented as atypes:<ul><li>**GeoJSON FeatureCollection** <br>Thegeometry GeoJSON FeatureCollection FeatureCollectioncan contain a max of 50object. This is the recommended option if the geometry contains both Polygons and Circles. TheGeoJSONobjects. Eachrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>Therepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>Thecan contain a max of 50object. This is the recommended option if the geometry contains a list of Polygons only. Theobjects. Eachcan be represented as aobject can have a max of 50 coordinates. Please see the Examples section below for a sampletype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sampleobject can have a max of 50 coordinates. Please see the Examples section below for a sampleobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>Aobject. This is the recommended option if the geometry contains a single Polygon. Theobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>Acan be represented as aobject for the Circle geometry is composed of a _center_ represented using a Feature GeoJSON Point FeatureCollection GeoJSON GeometryCollection GeoJSON GeometryCollection GeoJSON Polygon Post Search Inside GeometryRappresentazione poligono.

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&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.

query
query True

string

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

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)

extendedPostalCodesFor
query

SearchIndexes[]

Indici per i quali i codici postali estesi devono essere inclusi nei risultati.

Gli indici disponibili sono:

Addr = Intervalli di indirizzi

Geo = Aree geografiche

PAD = Indirizzi del punto

POI = Punti di interesse

Str = Strade

XStr = Cross Street (intersezioni)

Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice.

Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto devono essere richiesti in modo esplicito quando necessario.

Esempi di utilizzo:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr,POI

extendedPostalCodesFor=None

Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.

idxSet
query

SearchIndexes[]

Elenco delimitato da virgole di indici che devono essere usati per la ricerca. L'ordine degli elementi non è importante. Gli indici disponibili sono: Addr = Interpolazione dell'intervallo di indirizzi, Geo = Geographies, PAD = Indirizzi punto, POI = Punti di interesse, Str = Strade, Xstr = Cross Street (intersezioni)

language
query

string

Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag del linguaggio IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita.

Per informazioni dettagliate, vedere Lingue supportate .

limit
query

integer

Numero massimo di risposte restituite. Impostazione predefinita: 10, minimo: 1 e massimo: 100

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
geometry GeoJsonObject:

Oggetto GeoJSON valido. 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 inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Esempio di richiesta

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

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Risposta di esempio

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Esempio di richiesta

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Risposta di esempio

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Esempio di richiesta

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Risposta di esempio

{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

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.

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.

GeoJsonFeature

Tipo di oggetto valido GeoJSON Feature . Per informazioni dettagliate, vedere RFC 7946 .

GeoJsonFeatureCollection

Tipo di oggetto valido GeoJSON FeatureCollection . Per informazioni dettagliate, vedere RFC 7946 .

GeoJsonGeometry

Oggetto geometry valido GeoJSON . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .

GeoJsonGeometryCollection

Tipo di oggetto valido GeoJSON GeometryCollection . Per informazioni dettagliate, vedere RFC 7946 .

GeoJsonLineString

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

GeoJsonMultiLineString

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

GeoJsonMultiPoint

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

GeoJsonMultiPolygon

Tipo di oggetto valido GeoJSON MultiPolygon . Per informazioni dettagliate, vedere RFC 7946 .

GeoJsonPoint

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

GeoJsonPolygon

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

Geometry

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

LatLongPairAbbreviated

Una 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'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.

PointOfInterestCategorySet

Categoria POI

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

ResponseFormat

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

SearchAddressResult

Questo oggetto viene restituito da una chiamata di 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
SearchIndexes

Indici per i quali i codici postali estesi devono essere inclusi nei risultati.

Gli indici disponibili sono:

Addr = Intervalli di indirizzi

Geo = Aree geografiche

PAD = Indirizzi del punto

POI = Punti di interesse

Str = Strade

XStr = Cross Street (intersezioni)

Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice.

Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto devono essere richiesti in modo esplicito quando necessario.

Esempi di utilizzo:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr,POI

extendedPostalCodesFor=None

Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.

SearchInsideGeometryRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Search Inside Geometry.

SearchSummary

Oggetto Riepilogo per una risposta API Search.

Address

Indirizzo del risultato

Nome Tipo Descrizione
boundingBox

BoundingBoxCompassNotation

Casella di selezione della posizione.

buildingNumber

string

Numero di edificio sulla strada. DEPRECATO, usare invece streetNumber.

country

string

nome paese/area geografica

countryCode

string

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

countryCodeISO3

string

Codice paese ISO alfa-3

countrySecondarySubdivision

string

Contea

countrySubdivision

string

State or Province

countrySubdivisionCode

string

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

countrySubdivisionName

string

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

countryTertiarySubdivision

string

Area denominata

crossStreet

string

Nome della strada incrociata.

extendedPostalCode

string

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

freeformAddress

string

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

localName

string

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

municipality

string

Città/Città
Nota: municipality rappresenta il comune residenziale. A seconda della posizione, il municipality valore può essere diverso dal nome comunemente noto di una città o di una città. Per il nome comunemente noto della città o della città, è consigliabile usare il localName valore anziché il municipality valore.

municipalitySubdivision

string

Sub/Super City

neighbourhood

string

Un quartiere è un'area geograficamente localizzata all'interno di una città o città con caratteristiche distintive e interazioni sociali tra gli abitanti.

postalCode

string

Codice postale/codice postale

routeNumbers

string[]

Codici usati per identificare in modo non ambiguo la strada

street

string

Nome della strada. DEPRECATO, usare invece streetName.

streetName

string

Nome della strada.

streetNameAndNumber

string

Nome della strada e numero.

streetNumber

string

Numero di edificio sulla strada.

AddressRanges

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

Nome Tipo Descrizione
from

LatLongPairAbbreviated

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

rangeLeft

string

Intervallo di indirizzi sul lato sinistro della strada.

rangeRight

string

Intervallo di indirizzi sul lato destro della strada.

to

LatLongPairAbbreviated

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

BoundingBox

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

Nome Tipo Descrizione
btmRightPoint

LatLongPairAbbreviated

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

topLeftPoint

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

Casella di selezione della posizione.

Nome Tipo Descrizione
entity

Entity

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

northEast

string

Latitudine nord-est, coordinata longitudine del rettangolo di selezione come float delimitati da virgole

southWest

string

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

Brand

Il marchio associato all'entità di ricerca

Nome Tipo Descrizione
name

string

Nome del marchio

Classification

Classificazione dell'oggetto POI restituito

Nome Tipo Descrizione
code

string

Proprietà code

names

ClassificationName[]

Matrice nomi

ClassificationName

Nome per la classificazione

Nome Tipo Descrizione
name

string

Name (proprietà)

nameLocale

string

Proprietà Name Locale

DataSources

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

Nome Tipo Descrizione
geometry

Geometry

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

Entity

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

Nome Tipo Descrizione
position

string

Entità position

EntryPoint

Punto di ingresso per l'oggetto POI restituito.

Nome Tipo Descrizione
position

LatLongPairAbbreviated

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

type

EntryPointType

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

EntryPointType

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

Nome Tipo Descrizione
main

string

minor

string

ErrorAdditionalInfo

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

Codice postale/codice postale

GeoJsonFeature

Tipo di oggetto valido GeoJSON Feature . Per informazioni dettagliate, vedere RFC 7946 .

Nome Tipo Descrizione
featureType

string

Tipo di funzionalità. Il valore dipende dal modello di dati di cui fa parte la funzionalità corrente. Alcuni modelli di dati possono avere un valore vuoto.

geometry GeoJsonGeometry:

Oggetto geometry valido GeoJSON . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .

id

string

Identificatore per la funzionalità.

type string:

Feature

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.

GeoJsonFeatureCollection

Tipo di oggetto valido GeoJSON FeatureCollection . Per informazioni dettagliate, vedere RFC 7946 .

Nome Tipo Descrizione
features

GeoJsonFeature[]

Contiene un elenco di oggetti validi GeoJSON Feature .

type string:

FeatureCollection

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.

GeoJsonGeometry

Oggetto geometry valido GeoJSON . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .

Nome Tipo Descrizione
type

GeoJsonObjectType

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.

GeoJsonGeometryCollection

Tipo di oggetto valido GeoJSON GeometryCollection . Per informazioni dettagliate, vedere RFC 7946 .

Nome Tipo Descrizione
geometries GeoJsonGeometry[]:

Contiene un elenco di oggetti geometry validi GeoJSON . Si noti che le coordinate in GeoJSON sono in x, y ordine (longitudine, latitudine).

type string:

GeometryCollection

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.

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.

GeoJsonMultiLineString

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

Nome Tipo Descrizione
coordinates

number[]

Coordinate per la GeoJson MultiLineString geometria.

type string:

MultiLineString

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.

GeoJsonMultiPoint

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

Nome Tipo Descrizione
coordinates

number[]

Coordinate per la GeoJson MultiPoint geometria.

type string:

MultiPoint

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.

GeoJsonMultiPolygon

Tipo di oggetto valido GeoJSON MultiPolygon . Per informazioni dettagliate, vedere RFC 7946 .

Nome Tipo Descrizione
coordinates

number[]

Contiene un elenco di oggetti validi GeoJSON Polygon . Si noti che le coordinate in GeoJSON sono in x, y ordine (longitudine, latitudine).

type string:

MultiPolygon

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.

GeoJsonPoint

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

Nome Tipo Descrizione
coordinates

number[]

Una Position è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. Altitudine/Elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946 .

type string:

Point

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.

GeoJsonPolygon

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

Nome Tipo Descrizione
coordinates

number[]

Coordinate per il GeoJson Polygon tipo geometry.

type string:

Polygon

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

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

Nome Tipo Descrizione
lat

number

Latitudine, proprietà

lon

number

Proprietà Longitudine

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'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.

Nome Tipo Descrizione
brands

Brand[]

Matrice di marchi. Nome del marchio per il poi restituito.

categories

string[]

Matrice categorie

categorySet

PointOfInterestCategorySet[]

Elenco delle categorie più specifiche di POI

classifications

Classification[]

Matrice di classificazione

name

string

Nome della proprietà POI

openingHours

OperatingHours

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

phone

string

Proprietà Numero di telefono

url

string

Proprietà URL sito Web

PointOfInterestCategorySet

Categoria POI

Nome Tipo Descrizione
id

integer

ID della categoria

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

Nome Tipo Descrizione
NEARBY

string

Search è stato eseguito intorno a una determinata latitudine e longitudine con un raggio definito

NON_NEAR

string

Search è stata eseguita a livello globale, senza pregiudizi a una determinata 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 chiamata di Search riuscita.

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. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.

dataSources

DataSources

Sezione facoltativa. ID geometry di riferimento per l'uso con l'API Get Search Polygon.

detourTime

integer

Detour time in secondi. Restituito solo per le chiamate all'API Search Lungo 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. Tali informazioni descrivono i tipi di ingresso 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 indietro.

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'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.

position

LatLongPairAbbreviated

Una 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 usare questa operazione per determinare che il risultato x è due volte più probabile che sia rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra 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

Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a 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

SearchIndexes

Indici per i quali i codici postali estesi devono essere inclusi nei risultati.

Gli indici disponibili sono:

Addr = Intervalli di indirizzi

Geo = Aree geografiche

PAD = Indirizzi del punto

POI = Punti di interesse

Str = Strade

XStr = Cross Street (intersezioni)

Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice.

Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto devono essere richiesti in modo esplicito quando necessario.

Esempi di utilizzo:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr,POI

extendedPostalCodesFor=None

Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.

Nome Tipo Descrizione
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchInsideGeometryRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Search Inside Geometry.

Nome Tipo Descrizione
geometry GeoJsonObject:

Oggetto GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946 .

SearchSummary

Oggetto Riepilogo per una risposta API Search.

Nome Tipo Descrizione
fuzzyLevel

integer

Il livello massimo di fuzzy richiesto per fornire risultati.

geoBias

LatLongPairAbbreviated

Indicazione quando il motore di ricerca interno ha applicato un pregiudizio geospaziale per migliorare la classificazione dei risultati. In alcuni metodi questo può essere interessato impostando i parametri lat e lon in cui sono disponibili. In altri casi è puramente interna.

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 usato per produrre questi risultati della ricerca.

queryTime

integer

Tempo trascorso per la risoluzione della query, in millisecondi.

queryType

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

totalResults

integer

Numero totale di risultati trovati.