Use to get polygon data of a geographical area shape such as a city or a country region.

The Get Polygon API is an HTTP GET request that returns geometry data such as a city or country/region outline for a set of entities, previously retrieved from an online search request in GeoJSON format. The geometry ID is returned in the sourceGeometry object under "geometry" and "id" in either a Search Address or Search Fuzzy call.

A geometry ID retrieved from an online search endpoint has a limited lifetime, it is not recommended to store geometry IDs in persistent storage for later referral. It is expected that a request to the Polygon method is made within a few minutes of the request to the online search method that provided the ID. The service allows for batch requests up to 20 identifiers.

get/search/polygon/{format}

Query parameters

api-versionstring required

Version number of Azure Maps API.

geometriesstring[] required

Comma separated list of geometry UUIDs, previously retrieved from an online search request.

Parameters

../../../Common/preview/1.0/common.json#/components/parameters/ClientId — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/JsonFormat — unresolved $ref

Response

OK

Changes