Search - Get Polygon
Slouží k získání mnohoúhelníku obrazce zeměpisné oblasti, jako je město nebo oblast země.
Rozhraní Get Polygon
API je požadavek HTTP GET
, který poskytuje mnohoúhelníková data obrysu zeměpisné oblasti, jako je město nebo oblast země.
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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
coordinates
|
query | True |
number[] |
Bod na zemi zadaný jako zeměpisná délka a zeměpisná šířka. Příklad: &coordinates=lon,lat |
resolution
|
query |
Řešení určuje počet bodů, které se mají odeslat zpět. Pokud není zadáno, je výchozím nastavením střední rozlišení. |
||
result
|
query |
Geopolitický koncept, pro který se má vrátit hranice. Pokud není zadaný, je |
||
view
|
query |
string |
Řetězec, který představuje iso 3166-1 Alpha-2 kód oblasti nebo země. Tím se změní geopolitické sporné ohraničení a popisky tak, aby odpovídaly zadané oblasti uživatele. Ve výchozím nastavení je parametr View nastavený na "Auto", i když jste ho v požadavku nedefinoval. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Azure AD. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Azure AD zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
|
Accept-Language |
string |
Jazyk, ve kterém se mají vrátit výsledky hledání. Podrobnosti najdete v části Podporované jazyky . |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Došlo k neočekávané chybě. Media Types: "application/geo+json" |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámka
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API. - Je
Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. - Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
- Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu 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
Jedná se o sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.
U veřejně vystavených aplikací doporučujeme použít přístup mezi servery Azure Maps rozhraní REST API, kde je možné tento klíč bezpečně uložit.
Type:
apiKey
In:
header
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
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"
}
]
}
}
Definice
Name | Description |
---|---|
Boundary |
Upozorňujeme, že služba obvykle vrací GeometryCollection s podtypy Polygon nebo MultiPolygon. |
Boundary |
Geopolitický koncept, pro který se má vrátit hranice. Pokud není zadaný, je |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geometry |
Informace o autorských právech geometrie objektu Boundary. |
Resolution |
Řešení určuje množství bodů, které se mají odeslat zpět. Pokud není zadáno, je ve výchozím nastavení střední rozlišení. |
Boundary
GeoJSON GeocodingFeature
objekt, který popisuje hranice zeměpisné oblasti. Geometrie vlastnosti je popsána pomocí GeoJSON GeometryCollection
příkazu .
Upozorňujeme, že služba obvykle vrací GeometryCollection s podtypy Polygon nebo MultiPolygon.
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
copyright |
string |
Řetězec pro autorská práva. |
copyrightURL |
string |
Adresa URL, která uvádí mnoho poskytovatelů dat pro Azure Maps a související informace o autorských právech. |
featureType |
string |
Typ funkce. Hodnota závisí na datovém modelu, do který je aktuální funkce součástí. Některé datové modely můžou mít prázdnou hodnotu. |
geometriesCopyright |
Kolekce informací o autorských právech pro každou geometrii objektu Boundary ve stejném pořadí, v jakém se zobrazí. |
|
geometry | GeoJsonGeometry: |
Platný |
id |
string |
Identifikátor funkce. |
name |
string |
Název přidružený k zeměpisné oblasti. |
type |
string:
Feature |
Určuje |
BoundaryResultTypeEnum
Geopolitický koncept, pro který se má vrátit hranice. Pokud není zadaný, je countryRegion
výchozím typem výsledku.
Name | Typ | Description |
---|---|---|
adminDistrict |
string |
První správní úroveň na úrovni země nebo oblasti, jako je například stát nebo provincie. |
adminDistrict2 |
string |
Druhá správní úroveň na úrovni země/oblasti, například okresu. |
countryRegion |
string |
Země nebo oblast. |
locality |
string |
Soustředěná oblast lidského osídlení, jako je město, město nebo vesnice. |
neighborhood |
string |
Část zalidněného místa, které je obvykle dobře známé, ale často s nezřetelnými hranicemi. |
postalCode |
string |
Nejmenší kategorie PSČ, například PSČ. |
postalCode2 |
string |
Další největší kategorie PSČ za PSČ, která je vytvořena agregací oblastí POSTALCode. |
postalCode3 |
string |
Další největší kategorie PSČ za PSČ2, která se vytvoří agregací oblastí POSTALCode2. |
postalCode4 |
string |
Další největší kategorie PSČ za PSČ3, která je vytvořena agregací oblastí postalCode3. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
GeoJsonGeometry
Platný GeoJSON
objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
type |
Geo |
Určuje |
GeoJsonGeometryCollection
Platný GeoJSON GeometryCollection
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
geometries | GeoJsonGeometry[]: |
Obsahuje seznam platných |
type |
string:
Geometry |
Určuje |
GeoJsonLineString
Platný GeoJSON LineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
Souřadnice |
type |
string:
Line |
Určuje |
GeoJsonMultiLineString
Platný GeoJSON MultiLineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
Souřadnice |
type |
string:
Multi |
Určuje |
GeoJsonMultiPoint
Platný GeoJSON MultiPoint
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
Souřadnice |
type |
string:
Multi |
Určuje |
GeoJsonMultiPolygon
Platný GeoJSON MultiPolygon
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
Obsahuje seznam platných |
type |
string:
Multi |
Určuje |
GeoJsonPoint
Platný GeoJSON Point
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
A |
type |
string:
Point |
Určuje |
GeoJsonPolygon
Platný GeoJSON Polygon
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce – EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
Souřadnice typu |
type |
string:
Polygon |
Určuje |
GeometryCopyright
Informace o autorských právech geometrie objektu Boundary.
Name | Typ | Description |
---|---|---|
copyright |
string |
Řetězec autorských práv pro poskytovatele dat |
sourceName |
string |
Název poskytovatele dat |
ResolutionEnum
Řešení určuje množství bodů, které se mají odeslat zpět. Pokud není zadáno, je ve výchozím nastavení střední rozlišení.
Name | Typ | Description |
---|---|---|
huge |
string |
Vrátí geometrii ohraničení s více nebo stejným počtem bodů, které jsou velké. |
large |
string |
Vrátí geometrii ohraničení s více nebo stejným počtem bodů jako střední. |
medium |
string |
Vrátí geometrii ohraničení s více nebo stejným počtem bodů jako malý. |
small |
string |
Vrátí geometrii ohraničení s nejmenším počtem bodů. |