MapLocationMatchCode Enumeration

Note

Bing Maps SDK for Android and iOS retirement

Bing Maps SDK for Android and iOS is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps SDK for Android and iOS until June 30th, 2025. Enterprise account customers can continue to use Bing Maps SDK for Android and iOS until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps SDK for Android and iOS will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type.

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.

The geocoding level for each geopoint for a location returned from a geocoding request.

For example, a geocoded location with match codes of Good and Ambiguous means that more than one geocode location was found for the location information and that the geocode service did not have search up-hierarchy to find a match.

Similarly, a geocoded location with match codes of Ambiguous and UpHierarchy implies that a geocode location could not be found that matched all the provided location information, so the geocode service had to search up-hierarchy and found multiple matches at that level. An example of up an Ambiguous and UpHierarchy result is when you provide complete address information, but the geocode service cannot locate a match for the street address and instead returns information for more than one RoadBlock entity type value.

Android

public enum MapLocationMatchCode
{
   UNKNOWN(0),
   GOOD(1),
   AMBIGUOUS(2),
   UP_HIERARCHY(4);
}

iOS

typedef NS_ENUM(NSInteger, MSMapLocationMatchCodes)
{
   MSMapLocationMatchCodeUnknown = 0,
   MSMapLocationMatchCodeGood = 1,
   MSMapLocationMatchCodeAmbiguous = 2,
   MSMapLocationMatchCodeUpHierarchy = 4
};

Values

Unknown

Bing Maps SDK was unable to parse the value in the response.

Good

The location has only one match or all returned matches are considered strong matches. For example, a query for New York returns several Good matches.

Ambiguous

The location is one of a set of possible matches. For example, when you query for the street address 128 Main St., the response may return two locations for 128 North Main St. and 128 South Main St. because there is not enough information to determine which option to choose.

UpHierarchy

The location represents a move up the geographic hierarchy. This occurs when a match for the location request was not found, so a less precise result is returned.

See Also

• MapLocation