Use to perform free form searches inside a one more more geometries.
The Post Search Inside Geometry API is and HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POST request where the request body will contain the geometry object represented as GeoJSON and the Content-Type header will be set to application/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON types:<ul><li>GeoJSON FeatureCollection <br>The geometry can be represented as a GeoJSON FeatureCollection object. This is the recommended option if the geometry contains both Polygons and Circles. The FeatureCollection can contain up to 50 GeoJSON Feature objects. Each Feature object should represent either a Polygon or a Circle with the following conditions:<ul><li>A Feature object for the Polygon geometry can have up to 50 coordinates and it's properties must be empty.</li><li>A Feature object for the Circle geometry is composed of a center represented using a GeoJSON Point type and a radius value (in meters) which must be specified in the object's properties along with the subType property whose value should be 'Circle'.</li></ul><br>See the Examples for a sample FeatureCollection representation.<br><br></li><li>GeoJSON GeometryCollection<br>The geometry can be represented as a GeoJSON GeometryCollection object. This is the recommended option if the geometry contains a list of Polygons only. The GeometryCollection can contain up to 50 GeoJSON Polygon objects. Each Polygon object can have up to 50 coordinates. See the Examples for a sample GeometryCollection representation.<br><br></li><li>GeoJSON Polygon<br>The geometry can be represented as a GeoJSON Polygon object. This is the recommended option if the geometry contains a single Polygon. The Polygon object can have up to 50 coordinates. See the Examples for a sample Polygon representation.<br><br></li></ul>.<br><br>
Query parameters
Version number of Azure Maps API.
The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded.
Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100
A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. Maximum number of categorySet values supported per request is 10. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using POI Categories API. Usage examples:
-
categorySet=7315 (Search Points of Interest from category Restaurant)
-
categorySet=7315025,7315017 (Search Points of Interest of category either Italian or French Restaurant)
Indexes for which extended postal codes should be included in the results.
Available indexes are:
Addr = Address ranges
Geo = Geographies
PAD = Point Addresses
POI = Points of Interest
Str = Streets
XStr = Cross Streets (intersections)
Value should be a comma separated list of index types (in any order) or None for no indexes.
By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.
Usage examples:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.
A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)
Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays
Parameters
Request body
Response
OK