Search - Get Polygon
Gebruik deze optie om veelhoekgegevens op te halen van een geografische gebiedsvorm, zoals een stad of een landregio.
De Get Polygon
API is een HTTP-aanvraag GET
die veelhoekgegevens levert van een geografisch gebiedsoverzicht, zoals een stad of een landregio.
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versienummer van Azure Maps API. |
coordinates
|
query | True |
number[] |
Een punt op de aarde dat is opgegeven als een lengtegraad en breedtegraad. Voorbeeld: &coördinaten=lon,lat |
resolution
|
query |
Resolutie bepaalt het aantal punten dat moet worden teruggestuurd. |
||
result
|
query |
Het geopolitieke concept om een grens voor terug te keren. |
||
view
|
query |
string |
Een tekenreeks die een ISO 3166-1 Alpha-2-regio-/landcode vertegenwoordigt. Hierdoor worden geopolitieke betwiste grenzen en labels gewijzigd, zodat deze overeenkomen met de opgegeven gebruikersregio. De parameter Weergave is standaard ingesteld op Automatisch, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Azure AD-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Azure AD beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp. |
|
Accept-Language |
string |
Taal waarin zoekresultaten moeten worden geretourneerd. Raadpleeg Ondersteunde talen voor meer informatie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. Media Types: "application/geo+json" |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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 verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.
Notitie
- Voor deze beveiligingsdefinitie is het gebruik van de
x-ms-client-id
header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API. - De
Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. - Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
- Het gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.
Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's, waar deze sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
SAS Token
Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Get polygon for a city at coordinates -122.204141,47.612560
Sample Request
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Sample Response
Content-Type: application/geo+json
{
"type": "Feature",
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.13035,
47.53502
],
[
-122.12882,
47.53567
],
[
-122.12638000000001,
47.535140000000006
],
[
-122.12378000000001,
47.53717
],
[
-122.12068000000001,
47.537620000000004
],
[
-122.12028000000001,
47.538000000000004
],
[
-122.11682,
47.537940000000006
],
[
-122.11527000000001,
47.53609
],
[
-122.11119000000001,
47.536080000000005
],
[
-122.11103000000001,
47.539280000000005
],
[
-122.10832,
47.539530000000006
],
[
-122.10830000000001,
47.54057
],
[
-122.11006,
47.54055
],
[
-122.10999000000001,
47.542640000000006
],
[
-122.11185,
47.54298000000001
],
[
-122.11183000000001,
47.54426
],
[
-122.1114,
47.543800000000005
],
[
-122.10936000000001,
47.54379
],
[
-122.10912,
47.54462
],
[
-122.10745000000001,
47.544830000000005
],
[
-122.10808000000002,
47.545190000000005
],
[
-122.10808000000002,
47.54656000000001
],
[
-122.10665000000002,
47.546580000000006
],
[
-122.10711,
47.544700000000006
],
[
-122.10530000000001,
47.54473
],
[
-122.1054,
47.546910000000004
],
[
-122.10434000000001,
47.54693
],
[
-122.10433,
47.544830000000005
],
[
-122.10056000000002,
47.544940000000004
],
[
-122.1007,
47.548500000000004
],
[
-122.10194000000001,
47.54849
],
[
-122.10194000000001,
47.54883
],
[
-122.10194000000001,
47.549510000000005
],
[
-122.10071,
47.54883
],
[
-122.10048,
47.54849
],
[
-122.10047000000002,
47.54883
],
[
-122.10038000000002,
47.55904
],
[
-122.09796000000001,
47.55923000000001
],
[
-122.09870000000001,
47.560570000000006
],
[
-122.09818000000001,
47.56248
],
[
-122.10011000000002,
47.56839
],
[
-122.09876000000001,
47.56884
],
[
-122.09942000000001,
47.569900000000004
],
[
-122.09782000000001,
47.56983
],
[
-122.09672,
47.58019
],
[
-122.09885000000001,
47.58666
],
[
-122.09796000000001,
47.59503
],
[
-122.09664000000001,
47.602230000000006
],
[
-122.09411000000001,
47.607240000000004
],
[
-122.09104,
47.610240000000005
],
[
-122.08366000000001,
47.615660000000005
],
[
-122.08008000000001,
47.61939
],
[
-122.07904,
47.62201
],
[
-122.07959000000001,
47.627520000000004
],
[
-122.08008000000001,
47.627520000000004
],
[
-122.09181000000001,
47.627520000000004
],
[
-122.09221000000001,
47.62717000000001
],
[
-122.09256,
47.627520000000004
],
[
-122.11094000000001,
47.62765
],
[
-122.11091,
47.636720000000004
],
[
-122.11091,
47.64609
],
[
-122.11431,
47.646060000000006
],
[
-122.11437000000001,
47.64533
],
[
-122.11597,
47.64374
],
[
-122.12254000000001,
47.638510000000004
],
[
-122.12542,
47.636720000000004
],
[
-122.12809000000001,
47.635200000000005
],
[
-122.13241000000001,
47.63515
],
[
-122.13234000000001,
47.63268
],
[
-122.13407000000001,
47.63156000000001
],
[
-122.13484000000001,
47.62935
],
[
-122.13626000000001,
47.62820000000001
],
[
-122.1372,
47.627860000000005
],
[
-122.14184000000002,
47.62787
],
[
-122.14321000000001,
47.62713
],
[
-122.14312000000001,
47.636720000000004
],
[
-122.14335000000001,
47.660590000000006
],
[
-122.1641,
47.66077000000001
],
[
-122.16453000000001,
47.646370000000005
],
[
-122.16797000000001,
47.64621
],
[
-122.19629,
47.64643
],
[
-122.19629,
47.64289
],
[
-122.19846000000001,
47.642860000000006
],
[
-122.19846000000001,
47.64242
],
[
-122.19982000000002,
47.6424
],
[
-122.20169000000001,
47.644600000000004
],
[
-122.20341,
47.643190000000004
],
[
-122.20818000000001,
47.6435
],
[
-122.21014000000001,
47.643130000000006
],
[
-122.20962000000002,
47.642920000000004
],
[
-122.20974000000001,
47.636720000000004
],
[
-122.21005000000001,
47.62107
],
[
-122.22268000000001,
47.62106000000001
],
[
-122.22268000000001,
47.62066
],
[
-122.22203,
47.620470000000005
],
[
-122.22282000000001,
47.619890000000005
],
[
-122.22142000000001,
47.618570000000005
],
[
-122.22248,
47.61838
],
[
-122.22271,
47.617200000000004
],
[
-122.22136,
47.617180000000005
],
[
-122.21985000000001,
47.61643
],
[
-122.22044000000001,
47.614470000000004
],
[
-122.22033,
47.603840000000005
],
[
-122.22043000000001,
47.59682
],
[
-122.21702,
47.59038
],
[
-122.21653,
47.59042
],
[
-122.21572,
47.588240000000006
],
[
-122.21067000000001,
47.58375
],
[
-122.20153,
47.57887
],
[
-122.20227000000001,
47.57864000000001
],
[
-122.20132000000001,
47.578770000000006
],
[
-122.20034000000001,
47.57822
],
[
-122.19901000000002,
47.57592
],
[
-122.19923000000001,
47.567460000000004
],
[
-122.20034000000001,
47.55962
],
[
-122.20072,
47.55966
],
[
-122.20114000000001,
47.557520000000004
],
[
-122.20119000000001,
47.54943
],
[
-122.20160000000001,
47.549440000000004
],
[
-122.20167000000001,
47.54883
],
[
-122.20200000000001,
47.54609000000001
],
[
-122.19676000000001,
47.54621
],
[
-122.19545000000001,
47.54609000000001
],
[
-122.19545000000001,
47.545750000000005
],
[
-122.19091000000002,
47.54580000000001
],
[
-122.1907,
47.54216
],
[
-122.18581,
47.542100000000005
],
[
-122.18116,
47.541140000000006
],
[
-122.17142000000001,
47.54086
],
[
-122.16987,
47.54008
],
[
-122.16797000000001,
47.540060000000004
],
[
-122.16554000000001,
47.54005
],
[
-122.16439000000001,
47.54281
],
[
-122.16433,
47.545480000000005
],
[
-122.15356000000001,
47.54538
],
[
-122.15359000000001,
47.541760000000004
],
[
-122.14280000000001,
47.541520000000006
],
[
-122.14288,
47.539370000000005
],
[
-122.13645000000001,
47.53826
],
[
-122.13035,
47.53502
]
],
[
[
-122.19957000000001,
47.58372000000001
],
[
-122.20448,
47.583830000000006
],
[
-122.20585000000001,
47.586780000000005
],
[
-122.19654000000001,
47.586740000000006
],
[
-122.19655000000002,
47.58379
],
[
-122.19957000000001,
47.58372000000001
]
]
]
}
]
},
"properties": {
"name": "Bellevue",
"copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
"copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
"geometriesCopyright": [
{
"sourceName": "TOM",
"copyright": "TomTom"
}
]
}
}
Definities
Name | Description |
---|---|
Boundary |
Houd er rekening mee dat de service doorgaans een GeometryCollection retourneert met polygoon- of multipolygon-subtypen. |
Boundary |
Het geopolitieke concept om een grens voor terug te keren. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geometry |
Copyrightinformatie van een geometrie van een Grensobject. |
Resolution |
Resolutie bepaalt het aantal punten dat moet worden teruggestuurd. |
Boundary
GeoJSON GeocodingFeature
-object dat de grenzen van een geografisch gebied beschrijft. Geometrie van de functie wordt beschreven met GeoJSON GeometryCollection
.
Houd er rekening mee dat de service doorgaans een GeometryCollection retourneert met polygoon- of multipolygon-subtypen.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
copyright |
string |
De copyrighttekenreeks. |
copyrightURL |
string |
Een URL met een lijst met veel van de gegevensproviders voor Azure Maps en hun gerelateerde auteursrechtinformatie. |
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. |
geometriesCopyright |
Een verzameling copyrightinformatie voor elke geometrie van het Boundary-object in dezelfde volgorde waarin ze worden weergegeven. |
|
geometry | GeoJsonGeometry: |
Een geldig |
id |
string |
Id voor de functie. |
name |
string |
De naam die is gekoppeld aan het geografische gebied. |
type |
string:
Feature |
Hiermee geeft u het |
BoundaryResultTypeEnum
Het geopolitieke concept om een grens voor terug te keren.
Name | Type | Description |
---|---|---|
adminDistrict |
string |
Eerste beheerniveau binnen het niveau van het land/de regio, zoals een staat of een provincie. |
adminDistrict2 |
string |
Het tweede administratieve niveau binnen het niveau van het land/de regio, zoals een provincie. |
countryRegion |
string |
Land of regio. |
locality |
string |
Een geconcentreerd gebied van menselijke nederzetting, zoals een stad, stad of dorp. |
neighborhood |
string |
Een sectie van een ingevulde plaats die doorgaans bekend is, maar vaak met onduidelijke grenzen. |
postalCode |
string |
De kleinste postcodecategorie, zoals een postcode. |
postalCode2 |
string |
De op één na grootste postcodecategorie na postcodeCode die wordt gemaakt door postcodegebieden te aggregeren. |
postalCode3 |
string |
De op één na grootste postcodecategorie na postcode2 die wordt gemaakt door postcode2-gebieden te aggregeren. |
postalCode4 |
string |
De op één na grootste postcodecategorie na postcode3 die wordt gemaakt door postcode3-gebieden te aggregeren. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het type aanvullende informatie. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
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.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
type |
Geo |
Hiermee geeft u het |
GeoJsonGeometryCollection
Een geldig GeoJSON GeometryCollection
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
geometries | GeoJsonGeometry[]: |
Bevat een lijst met geldige |
type |
string:
Geometry |
Hiermee geeft u het |
GeoJsonLineString
Een geldig GeoJSON LineString
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Line |
Hiermee geeft u het |
GeoJsonMultiLineString
Een geldig GeoJSON MultiLineString
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPoint
Een geldig GeoJSON MultiPoint
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPolygon
Een geldig GeoJSON MultiPolygon
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
Bevat een lijst met geldige |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonPoint
Een geldig GeoJSON Point
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
A |
type |
string:
Point |
Hiermee geeft u het |
GeoJsonPolygon
Een geldig GeoJSON Polygon
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Selectiekader. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
Coördinaten voor het |
type |
string:
Polygon |
Hiermee geeft u het |
GeometryCopyright
Copyrightinformatie van een geometrie van een Grensobject.
Name | Type | Description |
---|---|---|
copyright |
string |
De copyrighttekenreeks voor de gegevensprovider |
sourceName |
string |
De naam van de gegevensprovider |
ResolutionEnum
Resolutie bepaalt het aantal punten dat moet worden teruggestuurd.
Name | Type | Description |
---|---|---|
huge |
string |
Retourneert de geometrie van de grens met meer of hetzelfde aantal punten als groot. |
large |
string |
Retourneert de geometrie van de grens met meer of hetzelfde aantal punten als gemiddeld. |
medium |
string |
Retourneert de randgeometrie met meer of hetzelfde aantal punten als klein. |
small |
string |
Retourneer de geometrie van de grens met het minste aantal punten. |