Search - Get Search Polygon

Referens

Tjänst:: Maps

API-version:: 1.0

Använd för att hämta polygondata för en geografisk områdesform, till exempel en stad eller en landregion.

Get Polygon-API:et är en HTTP-GET begäran som returnerar geometridata, till exempel en stads- eller lands-/regiondisposition för en uppsättning entiteter som tidigare hämtats från en onlinesökningsbegäran i GeoJSON-format. Geometri-ID:t returneras i objektet sourceGeometry under "geometri" och "id" i antingen en sökadress eller ett fuzzy-anrop för sökning.

Ett geometri-ID som hämtats från en slutpunkt för onlinesökning har en begränsad livslängd. Det rekommenderas inte att lagra geometri-ID:t i beständiga lagringsenheter för senare hänvisning. En begäran till Polygon-metoden förväntas göras inom några minuter efter begäran till den onlinesökmetod som tillhandahöll ID:t. Tjänsten tillåter batchbegäranden på upp till 20 identifierare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.
geometries	query	True	string[]	Kommaavgränsad lista över UUID:er för geometri, som tidigare hämtats från en sökbegäran online.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar för vägledning.

Svar

Name	Typ	Description
200 OK	PolygonResult	OK
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anmärkning

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hantering-API:et.
Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Get the Geometry using the geometry id returned by the previous Search

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
          }
        ]
      }
    }
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeoJsonFeature	En giltig `GeoJSON Feature` objekttyp. Mer information finns i RFC 7946.
GeoJsonFeatureCollection	En giltig `GeoJSON FeatureCollection` objekttyp. Mer information finns i RFC 7946.
GeoJsonGeometry	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
GeoJsonGeometryCollection	En giltig `GeoJSON GeometryCollection` objekttyp. Mer information finns i RFC 7946.
GeoJsonLineString	En giltig `GeoJSON LineString` geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiLineString	En giltig `GeoJSON MultiLineString` geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiPoint	En giltig `GeoJSON MultiPoint` geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiPolygon	En giltig `GeoJSON MultiPolygon` objekttyp. Mer information finns i RFC 7946.
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946.
GeoJsonPolygon	En giltig `GeoJSON Polygon` geometrityp. Mer information finns i RFC 7946.
JsonFormat	Önskat format för svaret. Endast `json` format stöds.
Polygon
PolygonResult	Det här objektet returneras från ett lyckat Search Polygon-anrop

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GeoJsonFeature

Objekt

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946.

Name	Typ	Description
featureType	string	Typ av funktion. Värdet beror på datamodellen som den aktuella funktionen ingår i. Vissa datamodeller kan ha ett tomt värde.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
id	string	Identifierare för funktionen.
type	string: Feature	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonFeatureCollection

Objekt

En giltig GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946.

Name	Typ	Description
features	GeoJsonFeature[]	Innehåller en lista över giltiga `GeoJSON Feature` objekt.
type	string: FeatureCollection	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometry

Objekt

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.

Name	Typ	Description
type	GeoJsonObjectType	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometryCollection

Objekt

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946.

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Innehåller en lista över giltiga `GeoJSON` geometriobjekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: GeometryCollection	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonLineString

Objekt

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Koordinater för `GeoJson LineString` geometri.
type	string: LineString	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiLineString

Objekt

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Koordinater för `GeoJson MultiLineString` geometri.
type	string: MultiLineString	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPoint

Objekt

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Koordinater för `GeoJson MultiPoint` geometri.
type	string: MultiPoint	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPolygon

Objekt

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Innehåller en lista över giltiga `GeoJSON Polygon` objekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: MultiPolygon	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPoint

Objekt

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	En `Position` är en matris med tal med två eller flera element. De första två elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946.
type	string: Point	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPolygon

Objekt

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Koordinater för `GeoJson Polygon` geometrityp.
type	string: Polygon	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

JsonFormat

Uppräkning

Önskat format för svaret. Endast json format stöds.

Värde	Description
json	JavaScript-objekt notationens datautbytesformat

Polygon

Objekt

Name	Typ	Description
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Geometridata i GeoJSON-format. Mer information finns i RFC 7946. Presentera endast om "fel" inte finns.
providerID	string	ID för den returnerade entiteten

PolygonResult

Objekt

Det här objektet returneras från ett lyckat Search Polygon-anrop

Name	Typ	Description
additionalData	Polygon[]	Resultatmatris

Dela via

Search - Get Search Polygon

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Omfattningar

subscription-key

SAS Token

Exempel

Get the Geometry using the geometry id returned by the previous Search

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Ytterligare resurser