Search - Get Search Polygon

  • Riferimento
Service:
Maps
API Version:
1.0

Usare per ottenere i dati poligoni di una forma di area geografica, ad esempio una città o un'area geografica.

L'API Get Polygon è una richiesta HTTP GET che restituisce dati geometrici, ad esempio una struttura di città o paese/area geografica per un set di entità, recuperata in precedenza da una richiesta di ricerca online in formato GeoJSON. L'ID geometry viene restituito nell'oggetto sourceGeometry in "geometry" e "id" in una chiamata Search Address o Search Fuzzy.

Un ID geometria recuperato da un endpoint di ricerca online ha una durata limitata, non è consigliabile archiviare gli ID geometria nell'archiviazione permanente per le segnalazioni successive. È previsto che venga effettuata una richiesta al metodo Polygon entro pochi minuti dalla richiesta al metodo di ricerca online che ha fornito l'ID. Il servizio consente richieste batch fino a 20 identificatori.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
format
 path True

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.
api-version
 query True

string

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

string[]

Elenco delimitato da virgole di UUID geometry, precedentemente recuperato da una richiesta di ricerca online.

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.

Risposte

Nome Tipo Descrizione
200 OK

PolygonResult

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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
  • Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Esempio

Sample Request

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Sample Response

Status code:
200 
{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
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 .
JsonFormat

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

Questo oggetto viene restituito da una chiamata polygon Search riuscita

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.

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:
  • GeoJsonGeometryCollection
  • GeoJsonLineString
  • GeoJsonMultiLineString
  • GeoJsonMultiPoint
  • GeoJsonMultiPolygon
  • GeoJsonPoint
  • GeoJsonPolygon

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[]:
  • GeoJsonGeometryCollection[]
  • GeoJsonLineString[]
  • GeoJsonMultiLineString[]
  • GeoJsonMultiPoint[]
  • GeoJsonMultiPolygon[]
  • GeoJsonPoint[]
  • GeoJsonPolygon[]

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.

JsonFormat

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

Nome Tipo Descrizione
json

string

Formato di interscambio dati dell'oggetto JavaScript

Polygon

Nome Tipo Descrizione
geometryData GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Dati geometry in formato GeoJSON. Per informazioni dettagliate, vedere RFC 7946 . Presente solo se "error" non è presente.
providerID

string

ID dell'entità restituita

PolygonResult

Questo oggetto viene restituito da una chiamata polygon Search riuscita

Nome Tipo Descrizione
additionalData

Polygon[]

Matrice dei risultati