Search - Get Search Polygon

Referentie

Service:: Maps

API-versie:: 1.0

Gebruik deze functie om veelhoekgegevens op te halen van een geografische gebiedsvorm, zoals een stad of een landregio.

De Get Polygon-API is een HTTP-GET-aanvraag die geometriegegevens retourneert, zoals een stads- of land-/regiooverzicht voor een set entiteiten, die eerder zijn opgehaald uit een onlinezoekaanvraag in GeoJSON-indeling. De geometrie-id wordt geretourneerd in het sourceGeometry object onder 'geometrie' en 'id' in een zoekadres of zoek fuzzy-aanroep.

Een geometrie-id die is opgehaald uit een onlinezoekeindpunt heeft een beperkte levensduur. Het wordt afgeraden geometrie-id's op te slaan in permanente opslag voor latere verwijzingen. Er wordt verwacht dat een aanvraag voor de polygonmethode binnen een paar minuten na de aanvraag wordt ingediend bij de onlinezoekmethode die de id heeft opgegeven. De service biedt batchaanvragen tot 20 id's.

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

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps-API.
geometries	query	True	string[]	Door komma's gescheiden lijst met geometrie-UUID's, eerder opgehaald uit een onlinezoekaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	PolygonResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Notitie

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Maps Management-API.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeoJsonFeature	Een geldig `GeoJSON Feature` objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonFeatureCollection	Een geldig `GeoJSON FeatureCollection` objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometry	Een geldig `GeoJSON` geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometryCollection	Een geldig `GeoJSON GeometryCollection` objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonLineString	Een geldig `GeoJSON LineString` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiLineString	Een geldig `GeoJSON MultiLineString` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPoint	Een geldig `GeoJSON MultiPoint` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPolygon	Een geldig `GeoJSON MultiPolygon` objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPolygon	Een geldig `GeoJSON Polygon` geometrietype. Raadpleeg RFC 7946- voor meer informatie.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
Polygon
PolygonResult	Dit object wordt geretourneerd door een geslaagde aanroep Veelhoek zoeken

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeoJsonFeature

Object

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
featureType	string	Het type functie. De waarde is afhankelijk van het gegevensmodel waarvan de huidige functie deel uitmaakt. Sommige gegevensmodellen hebben mogelijk een lege waarde.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Een geldig `GeoJSON` geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
id	string	Id voor de functie.
type	string: Feature	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonFeatureCollection

Object

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
features	GeoJsonFeature[]	Bevat een lijst met geldige `GeoJSON Feature` objecten.
type	string: FeatureCollection	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometry

Object

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
type	GeoJsonObjectType	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometryCollection

Object

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Bevat een lijst met geldige `GeoJSON` geometrieobjecten. Let op dat coördinaten in GeoJSON zich in x, y volgorde (lengtegraad, breedtegraad) bevinden.
type	string: GeometryCollection	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonLineString

Object

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Coördinaten voor de `GeoJson LineString` geometrie.
type	string: LineString	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiLineString

Object

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Coördinaten voor de `GeoJson MultiLineString` geometrie.
type	string: MultiLineString	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPoint

Object

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Coördinaten voor de `GeoJson MultiPoint` geometrie.
type	string: MultiPoint	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPolygon

Object

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Bevat een lijst met geldige `GeoJSON Polygon` objecten. Let op dat coördinaten in GeoJSON zich in x, y volgorde (lengtegraad, breedtegraad) bevinden.
type	string: MultiPolygon	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPoint

Object

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Een `Position` is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/Hoogte- is een optioneel derde element. Raadpleeg RFC 7946- voor meer informatie.
type	string: Point	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPolygon

Object

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name	Type	Description
coordinates	number[] (double)	Coördinaten voor het type `GeoJson Polygon` geometrie.
type	string: Polygon	Hiermee geeft u het `GeoJSON` type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

JsonFormat

Inventarisatie

Gewenste indeling van het antwoord. Alleen json indeling wordt ondersteund.

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten

Polygon

Object

Name	Type	Description
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Geometriegegevens in GeoJSON-indeling. Raadpleeg RFC 7946- voor meer informatie. Alleen aanwezig als 'fout' niet aanwezig is.
providerID	string	Id van de geretourneerde entiteit

PolygonResult

Object

Dit object wordt geretourneerd door een geslaagde aanroep Veelhoek zoeken

Name	Type	Description
additionalData	Polygon[]	Resultatenmatrix

Delen via

Search - Get Search Polygon

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Bereiken

subscription-key

SAS Token

Voorbeelden

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

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Aanvullende resources