SuggestionResult Object

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and has been retired for all free (Basic) account customers. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all enterprise account customers using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by June 30th, 2028. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Represents the suggestion result from the Autosuggest manager.

Properties

Name	Type	Description
address	Address	A structured address object for the result.
bestView	LocationRect	A LocationRect that can be used to set the map view over the result.
entityId	string	Unique entity id to be used for searching the entity.
entityType	string	The type of the result; Address, Place
entitySubType	string	The sub type of result; Address, RoadBlock, PopulatedPlace, CountryRegion, etc.
subtitle	string	A secondary title that provides additional context to the title value of the suggestion.
formattedSuggestion	string	A nicely formatted suggestion string for the result based on market.
location	Location	The coordinate of the result. This value is only returned for place (city, landmarks) results and not for addresses. Street addresses will need to be geocoded to get their location.
title	string	The display title for the result (i.e. “Redmond”).