Spatial Data Service Module

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK 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. 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.

Module Name: Microsoft.Maps.SpatialDataService

Namespace: Microsoft.Maps.SpatialDataService

The Bing Spatial Data Services allow you to upload data and have it exposed as a spatial REST service for use in your application. These data sources are initially only accessible through the Query REST API of the service using only your Bing Maps key, however you can make them publicly available which allows any Bing Maps key to access the data. There ar several data sources public data sources available in the Bing Maps, so of these are documented here. In addition to its hosting and spatial REST service capabilities, the Bing Spatial Data services also provides access to administrative boundary data such as state and country/region boundaries through the GeoData REST API.

This module wraps the Query and GeoData REST API’s in the Bing Spatial Data Services and exposes them as an easy to use JavaScript library. It handles all data conversions to and from shapes in Bing Maps to the format required by these services (Well Known Text or Encoded Strings).

Static Classes

The following static classes are exposed through the Microsoft.Maps.SpatialDataService namespace.

Name Description
QueryAPIManager Provides that ability to query data sources that are hosted by the Bing Spatial Data Services using the Query API.
GeoDataAPIManager Provides the ability to request polygons that describe the boundaries of a geographic entities, such as an AdminDivision1 (such as a state or province) or a Postcode1 (such as a zip code) that contain a given point (latitude and longitude) or address. This uses the GeoData API in the Bing Spatial Data Services.

Classes

The following classes are available in the Microsoft.Maps.SpatialDataServices namespace.

Name Description
Filter A class that defines the logic for a filter that can generate a string version of the filter logic that is compatible with the Bing spatial Data Services and can also process the filter logic against a JSON object.
FilterGroup A class that defines the group of filters, and can generate a string version of the filter logic that is compatible with the Bing spatial Data Services and can also process the filter logic against a JSON object.
GetBoundaryRequestOptions Contains options for boundary data.
GeoDataResultSet A set of results returned by the GeoData API.
GeoDataResult A specific result returned by the GeoData API.
Metadata Contains metadata for a boundary returned by the GeoData API.
Name The name for a boundary returned by the GeoData API.
GeoDataPrimitive Describes a primitive for a boundary returned by the GeoData API.
Copyright Information on copyright for a boundary returned by the GeoData API.
CopyrightSource Represents the copyright source for a boundary returned by the GeoData API.

Enumeration

The following enumerations are available in the Microsoft.Maps.SpatialDataServices namespace.

Name Description
FilterCompareOperator Specifies how to compare the filters value against the corresponding property value.
FilterLogicalOperator Specifies how two or more filters are linked together.

Examples

Query API

GeoData API