Azure Maps Search Service (preview:1.0)

2025/04/29 • 5 updated methods

Search_GetSearchAddressReverse (updated)
Description :  The `Get Search Address Reverse` API is and HTTP `GET` request that returns a street address or location when given latitude and longitude coordinates. There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_GetSearchAddressReverse",
  "Description": {
    "new": "\n\nThe `Get Search Address Reverse` API is and HTTP `GET` request that returns a street address or location when given latitude and longitude coordinates.\n\nThere may be times when you need to translate a  coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often  this is needed in tracking applications where you  receive a GPS feed from the device or asset and  wish to know what address where the coordinate is  located. This endpoint will return address  information for a given coordinate.",
    "old": "The `Get Search Address Reverse` API is and HTTP `GET` request that returns a street address or location when given latitude and longitude coordinates.\n\nThere may be times when you need to translate a  coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often  this is needed in tracking applications where you  receive a GPS feed from the device or asset and  wish to know what address where the coordinate is  located. This endpoint will return address  information for a given coordinate."
  }
}

⚼ Request

GET:  /search/address/reverse/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
array ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
returnSpeedLimit:
{
Description: Boolean. To enable return of the posted speed limit ,
Required: False ,
}
boolean ,
heading:
{
Description: The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place ,
Required: False ,
}
integer ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
integer ,
number:
{
Description: Street number as a string. If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number ,
Required: False ,
}
string ,
returnRoadUse:
{
Description: Boolean. To enable return of the road use array for reverse geocodes at street level ,
Required: False ,
}
boolean ,
roadUse:
{
Description: To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet ,
Required: False ,
}
array ,
allowFreeformNewline:
{
Description: Format of newlines in the formatted address. If true, the address will contain newlines. If false, newlines will be converted to commas. ,
Required: False ,
}
boolean ,
returnMatchType:
{
Description: Include information on the type of match the geocoder achieved in the response. ,
Required: False ,
}
boolean ,
entityType:
{
Description: Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API. The following parameters are ignored when entityType is set: * heading * number * returnRoadUse * returnSpeedLimit * roadUse * returnMatchType ,
Required: False ,
}
string ,
view:
{
Description: The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Address Reverse response ,
Required: False ,
}
{
query:
{
Description: The query parameter that was used to produce these search results. ,
Required: False ,
}
string ,
queryType:
{
Description: The type of query being returned: NEARBY or NON_NEAR. ,
Enum:
{
NEARBY: Search was performed around a certain latitude and longitude with a defined radius ,
NON_NEAR: Search was performed globally, without biasing to a certain latitude and longitude, and no defined radius ,
}
,
Required: False ,
}
enum ,
queryTime:
{
Description: Time spent resolving the query, in milliseconds. ,
Required: False ,
}
integer ,
numResults:
{
Description: Number of results in the response. ,
Required: False ,
}
integer ,
limit:
{
Description: Maximum number of responses that will be returned ,
Required: False ,
}
integer ,
offset:
{
Description: The starting offset of the returned Results within the full Result set. ,
Required: False ,
}
integer ,
totalResults:
{
Description: The total number of Results found. ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: The maximum fuzzy level required to provide Results. ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
addresses:
{
Description: Addresses array ,
Required: False ,
}
[
{
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: The building number on the street. DEPRECATED, use streetNumber instead. ,
Required: False ,
}
string ,
street:
{
Description: The street name. DEPRECATED, use streetName instead. ,
Required: False ,
}
string ,
crossStreet:
{
Description: The name of the street being crossed. ,
Required: False ,
}
string ,
streetNumber:
{
Description: The building number on the street. ,
Required: False ,
}
string ,
routeNumbers:
{
Description: The codes used to unambiguously identify the street ,
Required: False ,
}
[
string ,
]
,
streetName:
{
Description: The street name. ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: The street name and number. ,
Required: False ,
}
string ,
neighbourhood:
{
Description: A Neighbourhood is a geographically localized area within a city or town with distinctive characteristics and social interactions between inhabitants. ,
Required: False ,
}
string ,
municipality:
{
Description: City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the `localName` value be used instead of the `municipality` value. ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Sub / Super City ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: State or Province ,
Required: False ,
}
string ,
countrySubdivisionCode:
{
Description: `countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario. ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Named Area ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: County ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code / Zip Code ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended postal code (availability is dependent on the region). ,
Required: False ,
}
string ,
countryCode:
{
Description: Country (Note: This is a two-letter code, not a country/region name.) ,
Required: False ,
}
string ,
country:
{
Description: country/region name ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: ISO alpha-3 country code ,
Required: False ,
}
string ,
freeformAddress:
{
Description: An address line formatted according to the formatting rules of a Result's country/region of origin, or in the case of a country/region, its full country/region name. ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: The full name of a first level of country/region administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom. ,
Required: False ,
}
string ,
localName:
{
Description: An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. `localName` represents the postal municipality. Depending on the location, `localName` is the commonly known name of a city or town. For the commonly known name of a city or town, use `localName` instead of `municipality`. ,
Required: False ,
}
string ,
boundingBox:
{
Description: The bounding box of the location. ,
Required: False ,
}
{
northEast:
{
Description: North-east latitude,longitude coordinate of the bounding box as comma-separated floats ,
Required: False ,
}
string ,
southWest:
{
Description: South-west latitude,longitude coordinate of the bounding box as comma-separated floats ,
Required: False ,
}
string ,
entity:
{
Description: Entity type source of the bounding box. For reverse-geocoding this is always equal to position. ,
Enum:
{
position: Position entity ,
}
,
Required: False ,
}
enum ,
}
,
}
,
position:
{
Description: Position property in the form of "{latitude},{longitude}" ,
Required: False ,
}
string ,
roadUse:
{
Required: False ,
}
[
string ,
]
,
matchType:
{
Description: Information on the type of match. One of: * AddressPoint * HouseNumberRange * Street ,
Enum:
{
AddressPoint: No description available. ,
HouseNumberRange: No description available. ,
Street: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_PostSearchInsideGeometry (updated)
Description :  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.

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:
  • **GeoJSON FeatureCollection**
    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:
    • A `Feature` object for the Polygon geometry can have up to 50 coordinates and it's properties must be empty.
    • 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'.

    See the [Examples](#examples) for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    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](#examples) for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    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](#examples) for a sample `Polygon` representation.

.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_PostSearchInsideGeometry",
  "Description": {
    "new": "\n\nThe `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.

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:
  • **GeoJSON FeatureCollection** 
    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:
    • A `Feature` object for the Polygon geometry can have up to 50 coordinates and it's properties must be empty.
    • 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'.

    See the [Examples](#examples) for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    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](#examples) for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    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](#examples) for a sample `Polygon` representation.

.

",
    "old": "\n\nThe `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.

To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type 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:
  • **GeoJSON FeatureCollection** 
    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 a max of 50 `GeoJSON Feature` objects. Each `Feature` object should represent either a Polygon or a Circle with the following conditions:
    • A `Feature` object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • 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'.

     Please see the Examples section below for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    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 a max of 50 `GeoJSON Polygon` objects. Each `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    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 a max of 50 coordinates. Please see the Examples section below for a sample `Polygon` representation.

.

"
  }
}

⚼ Request

POST:  /search/geometry/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded. ,
Required: True ,
}
string ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
categorySet:
{
Description: 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](https://aka.ms/AzureMapsPOICategoryTree) 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) ,
Required: False ,
}
array ,
extendedPostalCodesFor:
{
Description: 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. ,
Required: False ,
}
array ,
idxSet:
{
Description: 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) ,
Required: False ,
}
array ,
searchInsideGeometryRequestBody:
{
Description: This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. ,
Required: True ,
}
{
geometry:
{
Description: A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details. ,
Required: False ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection. ,
Enum:
{
Point: `GeoJSON Point` geometry. ,
MultiPoint: `GeoJSON MultiPoint` geometry. ,
LineString: `GeoJSON LineString` geometry. ,
MultiLineString: `GeoJSON MultiLineString` geometry. ,
Polygon: `GeoJSON Polygon` geometry. ,
MultiPolygon: `GeoJSON MultiPolygon` geometry. ,
GeometryCollection: `GeoJSON GeometryCollection` geometry. ,
Feature: `GeoJSON Feature` object. ,
FeatureCollection: `GeoJSON FeatureCollection` object. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
view:
{
Description: The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: 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 ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search API response ,
Required: False ,
}
{
query:
{
Description: The query parameter that was used to produce these search results. ,
Required: False ,
}
string ,
queryType:
{
Description: The type of query being returned: NEARBY or NON_NEAR. ,
Enum:
{
NEARBY: Search was performed around a certain latitude and longitude with a defined radius ,
NON_NEAR: Search was performed globally, without biasing to a certain latitude and longitude, and no defined radius ,
}
,
Required: False ,
}
enum ,
queryTime:
{
Description: Time spent resolving the query, in milliseconds. ,
Required: False ,
}
integer ,
numResults:
{
Description: Number of results in the response. ,
Required: False ,
}
integer ,
limit:
{
Description: Maximum number of responses that will be returned ,
Required: False ,
}
integer ,
offset:
{
Description: The starting offset of the returned Results within the full Result set. ,
Required: False ,
}
integer ,
totalResults:
{
Description: The total number of Results found. ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: The maximum fuzzy level required to provide Results. ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
results:
{
Description: A list of Search API results. ,
Required: False ,
}
[
{
type:
{
Description: One of: * POI * Street * Geography * Point Address * Address Range * Cross Street ,
Enum:
{
POI: No description available. ,
Street: No description available. ,
Geography: No description available. ,
Point Address: No description available. ,
Address Range: No description available. ,
Cross Street: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Format: double ,
Required: False ,
}
number ,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Format: double ,
Required: False ,
}
number ,
info:
{
Description: Information about the original data source of the Result. Used for support requests. ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: country/region name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the request: none or "nextSevenDays" ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current calendar date in POI time zone, e.g. "2019-02-07". ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current calendar date in POI time zone, e.g. "2019-02-07". ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: The building number on the street. DEPRECATED, use streetNumber instead. ,
Required: False ,
}
string ,
street:
{
Description: The street name. DEPRECATED, use streetName instead. ,
Required: False ,
}
string ,
crossStreet:
{
Description: The name of the street being crossed. ,
Required: False ,
}
string ,
streetNumber:
{
Description: The building number on the street. ,
Required: False ,
}
string ,
routeNumbers:
{
Description: The codes used to unambiguously identify the street ,
Required: False ,
}
[
string ,
]
,
streetName:
{
Description: The street name. ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: The street name and number. ,
Required: False ,
}
string ,
neighbourhood:
{
Description: A Neighbourhood is a geographically localized area within a city or town with distinctive characteristics and social interactions between inhabitants. ,
Required: False ,
}
string ,
municipality:
{
Description: City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the `localName` value be used instead of the `municipality` value. ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Sub / Super City ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: State or Province ,
Required: False ,
}
string ,
countrySubdivisionCode:
{
Description: `countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario. ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Named Area ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: County ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code / Zip Code ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended postal code (availability is dependent on the region). ,
Required: False ,
}
string ,
countryCode:
{
Description: Country (Note: This is a two-letter code, not a country/region name.) ,
Required: False ,
}
string ,
country:
{
Description: country/region name ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: ISO alpha-3 country code ,
Required: False ,
}
string ,
freeformAddress:
{
Description: An address line formatted according to the formatting rules of a Result's country/region of origin, or in the case of a country/region, its full country/region name. ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: The full name of a first level of country/region administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom. ,
Required: False ,
}
string ,
localName:
{
Description: An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. `localName` represents the postal municipality. Depending on the location, `localName` is the commonly known name of a city or town. For the commonly known name of a city or town, use `localName` instead of `municipality`. ,
Required: False ,
}
string ,
boundingBox:
{
Description: The bounding box of the location. ,
Required: False ,
}
{
northEast:
{
Description: North-east latitude,longitude coordinate of the bounding box as comma-separated floats ,
Required: False ,
}
string ,
southWest:
{
Description: South-west latitude,longitude coordinate of the bounding box as comma-separated floats ,
Required: False ,
}
string ,
entity:
{
Description: Entity type source of the bounding box. For reverse-geocoding this is always equal to position. ,
Enum:
{
position: Position entity ,
}
,
Required: False ,
}
enum ,
}
,
}
,
position:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Array of EntryPoints. Those describe the types of entrances available at the location. The type can be "main" for main entrances such as a front door, or a lobby, and "minor", for side and back doors. ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
addressRanges:
{
Description: Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included. ,
Required: False ,
}
{
rangeLeft:
{
Description: Address range on the left side of the street. ,
Required: False ,
}
string ,
rangeRight:
{
Description: Address range on the right side of the street. ,
Required: False ,
}
string ,
from:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
to:
{
Description: A location represented as a latitude and longitude using short names 'lat' & 'lon'. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
dataSources:
{
Description: Optional section. Reference geometry id for use with the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API. ,
Required: False ,
}
{
geometry:
{
Description: Information about the geometric shape of the result. Only present if type == Geography. ,
Required: False ,
}
{
id:
{
Description: Pass this as geometryId to the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API to fetch geometry information for this result. ,
Required: False ,
}
string ,
}
,
}
,
matchType:
{
Description: Information on the type of match. One of: * AddressPoint * HouseNumberRange * Street ,
Enum:
{
AddressPoint: No description available. ,
HouseNumberRange: No description available. ,
Street: No description available. ,
}
,
Required: False ,
}
enum ,
detourTime:
{
Description: Detour time in seconds. Only returned for calls to the Search Along Route API. ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_PostSearchFuzzyBatch (updated)
Description :  The `Post Search Fuzzy Batch` API is an HTTP `POST` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. ``` POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key} ``` 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries: ```json { "batchItems": [ {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"}, {"query": "?query=Statue Of Liberty&limit=2"}, {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"}, {"query": "?query=Space Needle"}, {"query": "?query=pizza&limit=10"} ] } ``` A _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "query": "atm" }, "results": [ { "type": "POI", "poi": { "name": "ATM at Wells Fargo" }, "address": { "country": "United States Of America", "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052" } } ] } }, { "statusCode": 200, "response": { "summary": { "query": "statue of liberty" }, "results": [ { "type": "POI", "poi": { "name": "Statue of Liberty" }, "address": { "country": "United States Of America", "freeformAddress": "New York, NY 10004" } } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_PostSearchFuzzyBatch",
  "Description": {
    "new": "\n\nThe `Post Search Fuzzy Batch` API is an HTTP `POST` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n        {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n        {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n        {\"query\": \"?query=Space Needle\"},\n        {\"query\": \"?query=pizza&limit=10\"}\n    ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"atm\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"ATM at Wells Fargo\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"statue of liberty\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"Statue of Liberty\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"New York, NY 10004\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```",
    "old": "The `Post Search Fuzzy Batch` API is an HTTP `POST` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n        {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n        {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n        {\"query\": \"?query=Space Needle\"},\n        {\"query\": \"?query=pizza&limit=10\"}\n    ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"atm\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"ATM at Wells Fargo\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"statue of liberty\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"Statue of Liberty\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"New York, NY 10004\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```"
  }
}

⚼ Request

POST:  /search/fuzzy/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
searchFuzzyBatchRequestBody:
{
Description: The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
{
query:
{
Description: This parameter contains a query string used to perform an unstructured geocoding operation. The query string will be passed verbatim to the search API for processing. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
{
response:
{
Description: The result of the query. SearchAddressResult if the query completed successfully, ErrorResponse otherwise. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_GetSearchFuzzyBatch (updated)
Description :  The `Get Search Fuzzy Batch` API is and HTTP `GET` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. ``` POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key} ``` 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries: ```json { "batchItems": [ {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"}, {"query": "?query=Statue Of Liberty&limit=2"}, {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"}, {"query": "?query=Space Needle"}, {"query": "?query=pizza&limit=10"} ] } ``` A _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "query": "atm" }, "results": [ { "type": "POI", "poi": { "name": "ATM at Wells Fargo" }, "address": { "country": "United States Of America", "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052" } } ] } }, { "statusCode": 200, "response": { "summary": { "query": "statue of liberty" }, "results": [ { "type": "POI", "poi": { "name": "Statue of Liberty" }, "address": { "country": "United States Of America", "freeformAddress": "New York, NY 10004" } } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_GetSearchFuzzyBatch",
  "Description": {
    "new": "\n\nThe `Get Search Fuzzy Batch` API is and HTTP `GET` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n        {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n        {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n        {\"query\": \"?query=Space Needle\"},\n        {\"query\": \"?query=pizza&limit=10\"}\n    ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"atm\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"ATM at Wells Fargo\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"statue of liberty\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"Statue of Liberty\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"New York, NY 10004\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```",
    "old": "The `Get Search Fuzzy Batch` API is and HTTP `GET` request that sends batches of queries to [Search Fuzzy](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n        {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n        {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n        {\"query\": \"?query=Space Needle\"},\n        {\"query\": \"?query=pizza&limit=10\"}\n    ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"atm\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"ATM at Wells Fargo\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"statue of liberty\"\n                },\n                \"results\": [\n                    {\n                        \"type\": \"POI\",\n                        \"poi\": {\n                            \"name\": \"Statue of Liberty\"\n                        },\n                        \"address\": {\n                            \"country\": \"United States Of America\",\n                            \"freeformAddress\": \"New York, NY 10004\"\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```"
  }
}

⚼ Request

GET:  /search/fuzzy/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Batch id for querying the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
{
response:
{
Description: The result of the query. SearchAddressResult if the query completed successfully, ErrorResponse otherwise. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_GetSearchAddressBatch (updated)
Description :  The `Get Search Address Batch` API is an HTTP `GET` request that sends batches of queries to [Search Address](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Address Batch `POST` request to Azure Maps. ``` POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key} ``` 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries: ```json { "batchItems": [ {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"}, {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"}, {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"}, {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"}, {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"} ] } ``` A _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "query": "one microsoft way redmond wa 98052" }, "results": [ { "position": { "lat": 47.63989, "lon": -122.12509 } } ] } }, { "statusCode": 200, "response": { "summary": { "query": "pike pl seattle wa 98101" }, "results": [ { "position": { "lat": 47.60963, "lon": -122.34215 } } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_GetSearchAddressBatch",
  "Description": {
    "new": "\n\nThe `Get Search Address Batch` API is an HTTP `GET` request that sends batches of queries to [Search Address](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n        {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n        {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n        {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n        {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n    ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"one microsoft way redmond wa 98052\"\n                },\n                \"results\": [\n                    {\n                        \"position\": {\n                            \"lat\": 47.63989,\n                            \"lon\": -122.12509\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"pike pl seattle wa 98101\"\n                },\n                \"results\": [\n                    {\n                        \"position\": {\n                            \"lat\": 47.60963,\n                            \"lon\": -122.34215\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```",
    "old": "The `Get Search Address Batch` API is an HTTP `GET` request that sends batches of queries to [Search Address](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) API in a single asynchronous API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps. \n\r```\nPOST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n    This status URI looks like following:\n\n```\n    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n    \"batchItems\": [\n        {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n        {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n        {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n        {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n        {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n    ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n  - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n    \"summary\": {\n        \"successfulRequests\": 2,\n        \"totalRequests\": 3\n    },\n    \"batchItems\": [\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"one microsoft way redmond wa 98052\"\n                },\n                \"results\": [\n                    {\n                        \"position\": {\n                            \"lat\": 47.63989,\n                            \"lon\": -122.12509\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"response\":\n            {\n                \"summary\": {\n                    \"query\": \"pike pl seattle wa 98101\"\n                },\n                \"results\": [\n                    {\n                        \"position\": {\n                            \"lat\": 47.60963,\n                            \"lon\": -122.34215\n                        }\n                    }\n                ]\n            }\n        },\n        {\n            \"statusCode\": 400,\n            \"response\":\n            {\n                \"error\":\n                {\n                    \"code\": \"400 BadRequest\",\n                    \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n                }\n            }\n        }\n    ]\n}\n```"
  }
}

⚼ Request

GET:  /search/address/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Batch id for querying the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
{
response:
{
Description: The result of the query. SearchAddressResult if the query completed successfully, ErrorResponse otherwise. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}