Contents

Bing Maps SOAP Services ............................................................................................................ 14 Bing Maps SOAP Services Overview ........................................................................................ 14 Getting Started with Bing Maps SOAP Services ........................................................................ 16 Bing Maps SOAP Services Requirements ................................................................................. 17 Bing Maps SOAP Services Addresses ...................................................................................... 17 Developing with Bing Maps SOAP Services .............................................................................. 20 Accessing the Bing Maps SOAP Services ............................................................................. 20 Generating Client Proxy Classes ............................................................................................ 24 Bing Maps SOAP Services Transaction Accounting .............................................................. 25 Understanding Tiles ................................................................................................................ 25 Using Search Filters................................................................................................................ 26 Bing Maps SOAP Services API Reference ................................................................................ 35 Geocode Service .................................................................................................................... 36 ConfidenceFilter Class ........................................................................................................ 37 ConfidenceFilter Constructor ........................................................................................... 37 ConfidenceFilter Properties ............................................................................................. 38 ConfidenceFilter.MinimumConfidence Property ........................................................... 38 FilterBase Class .................................................................................................................. 38 FilterBase Constructor ..................................................................................................... 39 GeocodeOptions Class ....................................................................................................... 39 GeocodeOptions Constructor .......................................................................................... 40 GeocodeOptions Properties ............................................................................................. 40 GeocodeOptions.Count Property ................................................................................. 40 GeocodeOptions.Filters Property ................................................................................. 40 GeocodeRequest Class ...................................................................................................... 41 GeocodeRequest Constructor ......................................................................................... 42 GeocodeRequest Properties ............................................................................................ 42 GeocodeRequest.Address Property ............................................................................. 43 GeocodeRequest.Options Property.............................................................................. 43 GeocodeRequest.Query Property ................................................................................ 44 GeocodeResponse Class .................................................................................................... 44 GeocodeResponse Constructor ....................................................................................... 45 GeocodeResponse Properties ......................................................................................... 45 GeocodeResponse.Results Property ........................................................................... 45 GeocodeResult Class .......................................................................................................... 46 GeocodeResult Constructor ............................................................................................. 47 GeocodeResult Properties ............................................................................................... 47 GeocodeResult.Address Property ................................................................................ 48

GeocodeResult.BestView Property .............................................................................. 48 GeocodeResult.Confidence Property ........................................................................... 48 GeocodeResult.DisplayName Property ........................................................................ 48 GeocodeResult.EntityType Property ............................................................................ 48 GeocodeResult.Locations Property .............................................................................. 60 GeocodeResult.MatchCodes Property ......................................................................... 60 GeocodeServiceClient Class ............................................................................................... 61 GeocodeServiceClient Constructor .................................................................................. 61 GeocodeServiceClient Methods ...................................................................................... 63 GeocodeServiceClient.Geocode Method ..................................................................... 63 GeocodeServiceClient.ReverseGeocode Method ........................................................ 64 ReverseGeocodeRequest Class ......................................................................................... 64 ReverseGeocodeRequest Constructor ............................................................................ 65 ReverseGeocodeRequest Properties .............................................................................. 65 ReverseGeocodeRequest.Location Property ............................................................... 66 Imagery Service ...................................................................................................................... 66 CoverageArea Class ........................................................................................................... 68 CoverageArea Constructor .............................................................................................. 69 CoverageArea Properties ................................................................................................ 69 CoverageArea.BoundingRectangle Property ............................................................... 69 CoverageArea.ZoomRange Property ........................................................................... 69 ImageryMetadataBirdseyeResult Class .............................................................................. 70 ImageryMetadataBirdseyeResult Constructor ................................................................. 71 ImageryMetadataBirdseyeResult Properties ................................................................... 71 ImageryMetadataBirdseyeResult.Heading Property .................................................... 72 ImageryMetadataBirdseyeResult.TilesX Property ........................................................ 73 ImageryMetadataBirdseyeResult.TilesY Property ........................................................ 73 ImageryMetadataOptions Class .......................................................................................... 73 ImageryMetadataOptions Constructor ............................................................................. 74 ImageryMetadataOptions Properties ............................................................................... 75 ImageryMetadataOptions.Heading Property ................................................................ 75 ImageryMetadataOptions.Location Property ................................................................ 75 ImageryMetadataOptions.ReturnImageryProviders Property ...................................... 76 ImageryMetadataOptions.UriScheme Property ............................................................ 76 ImageryMetadataOptions.ZoomLevel Property ............................................................ 76 ImageryMetadataRequest Class ......................................................................................... 77 ImageryMetadataRequest Constructor ............................................................................ 78 ImageryMetadataRequest Properties .............................................................................. 78 ImageryMetadataRequest.Options Property ................................................................ 79 ImageryMetadataRequest.Style Property..................................................................... 79 ImageryMetadataResponse Class ...................................................................................... 79 ImageryMetadataResponse Constructor ......................................................................... 80 ImageryMetadataResponse Properties ........................................................................... 80

ImageryMetadataResponse.Results Property .............................................................. 80 ImageryMetadataResult Class ............................................................................................ 81 ImageryMetadataResult Constructor ............................................................................... 82 ImageryMetadataResult Properties ................................................................................. 82 ImageryMetadataResult.ImageryProviders Property ................................................... 82 ImageryMetadataResult.ImageSize Property ............................................................... 83 ImageryMetadataResult.ImageUri Property ................................................................. 83 ImageryMetadataResult.ImageUriSubdomains Property ............................................. 84 ImageryMetadataResult.Vintage Property ................................................................... 85 ImageryMetadataResult.ZoomRange Property ............................................................ 85 ImageryProvider Class ........................................................................................................ 85 ImageryProvider Constructor ........................................................................................... 86 ImageryProvider Properties ............................................................................................. 86 ImageryProvider.Attribution Property ........................................................................... 86 ImageryProvider.CoverageAreas Property .................................................................. 86 ImageryServiceClient Class ................................................................................................ 87 ImageryServiceClient Constructor ................................................................................... 87 ImageryServiceClient Methods ........................................................................................ 89 ImageryServiceClient.GetImageryMetadata Method ................................................... 89 ImageryServiceClient.GetMapUri Method .................................................................... 92 ImageType Enumeration ..................................................................................................... 95 MapStyle Enumeration ........................................................................................................ 96 MapUriOptions Class........................................................................................................... 97 MapUriOptions Constructor ............................................................................................. 99 MapUriOptions Properties ................................................................................................ 99 MapUriOptions.DisplayLayers Property ..................................................................... 100 MapUriOptions.ImageSize Property ........................................................................... 100 MapUriOptions.ImageType Property .......................................................................... 100 MapUriOptions.PreventIconCollision Property ........................................................... 101 MapUriOptions.Style Property .................................................................................... 101 MapUriOptions.UriScheme Property .......................................................................... 102 MapUriOptions.ZoomLevel Property .......................................................................... 102 MapUriRequest Class ....................................................................................................... 102 MapUriRequest Constructor .......................................................................................... 103 MapUriRequest Properties ............................................................................................. 104 MapUriRequest.Center Property ................................................................................ 105 MapUriRequest.MajorRoutesDestination Property .................................................... 105 MapUriRequest.Options Property............................................................................... 105 MapUriRequest.Pushpins Property ............................................................................ 105 MapUriResponse Class ..................................................................................................... 106 MapUriResponse Constructor ........................................................................................ 107 MapUriResponse Properties .......................................................................................... 107 MapUriResponse.Uri Property .................................................................................... 107

UriScheme Enumeration ................................................................................................... 108 Route Service ....................................................................................................................... 109 ItineraryItem Class............................................................................................................. 110 ItineraryItem Constructor ............................................................................................... 111 ItineraryItem Properties .................................................................................................. 112 ItineraryItem.CompassDirection Property................................................................... 112 ItineraryItem.Hints Property ........................................................................................ 112 ItineraryItem.Location Property .................................................................................. 113 ItineraryItem.ManeuverType Property ........................................................................ 113 ItineraryItem.Summary Property ................................................................................. 113 ItineraryItem.Text Property ......................................................................................... 113 ItineraryItem.Warnings Property ................................................................................. 113 ItineraryItemHint Class ...................................................................................................... 113 ItineraryItemHint Constructor ......................................................................................... 114 ItineraryItemHint Properties ........................................................................................... 114 ItineraryItemHint.HintType Property ........................................................................... 115 ItineraryItemHint.Text Property ................................................................................... 115 ItineraryItemHintType Enumeration................................................................................... 115 ItineraryItemWarning Class ............................................................................................... 116 ItineraryItemWarning Constructor .................................................................................. 116 ItineraryItemWarning Properties .................................................................................... 116 ItineraryItemWarning.Severity Property...................................................................... 117 ItineraryItemWarning.Text Property............................................................................ 117 ItineraryItemWarning.WarningType Property ............................................................. 117 ItineraryWarningSeverity Enumeration.............................................................................. 117 ItineraryWarningType Enumeration................................................................................... 118 MajorRoutesOptions Class ................................................................................................ 120 MajorRoutesOptions Constructor ................................................................................... 121 MajorRoutesOptions Properties ..................................................................................... 121 MajorRoutesOptions.ReturnRoutes Property ............................................................. 122 MajorRoutesRequest Class ............................................................................................... 122 MajorRoutesRequest Constructor.................................................................................. 123 MajorRoutesRequest Properties .................................................................................... 123 MajorRoutesRequest.Destination Property ................................................................ 124 MajorRoutesRequest.Options Property ...................................................................... 124 MajorRoutesResponse Class ............................................................................................ 124 MajorRoutesResponse Constructor ............................................................................... 125 MajorRoutesResponse Properties ................................................................................. 125 MajorRoutesResponse.Routes Property .................................................................... 126 MajorRoutesResponse.StartingPoints Property ......................................................... 126 ManeuverType Enumeration ............................................................................................. 127 RouteLeg Class ................................................................................................................. 129 RouteLeg Constructor .................................................................................................... 130

RouteLeg Properties ...................................................................................................... 130 RouteLeg.ActualEnd Property .................................................................................... 131 RouteLeg.ActualStart Property ................................................................................... 131 RouteLeg.Itinerary Property ....................................................................................... 131 RouteLeg.Summary Property ..................................................................................... 131 RouteOptimization Enumeration ....................................................................................... 132 RouteOptions Class........................................................................................................... 133 RouteOptions Constructor ............................................................................................. 134 RouteOptions Properties ................................................................................................ 134 RouteOptions.Mode Property ..................................................................................... 135 RouteOptions.Optimization Property .......................................................................... 135 RouteOptions.RoutePathType Property ..................................................................... 136 RouteOptions.TrafficUsage Property.......................................................................... 136 RoutePath Class................................................................................................................ 137 RoutePath Constructor .................................................................................................. 138 RoutePath Properties ..................................................................................................... 138 RoutePath.Points Property ......................................................................................... 138 RoutePathType Enumeration ............................................................................................ 138 RouteRequest Class.......................................................................................................... 139 RouteRequest Constructor ............................................................................................ 140 RouteRequest Properties ............................................................................................... 140 RouteRequest.Options Property ................................................................................. 141 RouteRequest.Waypoints Property ............................................................................ 141 RouteResponse Class ....................................................................................................... 141 RouteResponse Constructor .......................................................................................... 143 RouteResponse Properties ............................................................................................ 143 RouteResponse.Result Property ................................................................................ 143 RouteResult Class ............................................................................................................. 143 RouteResult Constructor ................................................................................................ 144 RouteResult Properties .................................................................................................. 144 RouteResult.Legs Property ........................................................................................ 145 RouteResult.RoutePath Property ............................................................................... 145 RouteResult.Summary Property ................................................................................. 145 RouteServiceClient Class .................................................................................................. 145 RouteServiceClient Constructor ..................................................................................... 146 RouteServiceClient Methods ......................................................................................... 147 RouteServiceClient.CalculateRoute Method .............................................................. 148 RouteServiceClient.CalculateRoutesFromMajorRoads Method ................................ 148 RouteSummary Class........................................................................................................ 149 RouteSummary Constructor .......................................................................................... 150 RouteSummary Properties ............................................................................................. 150 RouteSummary.BoundingRectangle Property ........................................................... 150 RouteSummary.Distance Property ............................................................................. 151

RouteSummary.TimeInSeconds Property .................................................................. 151 TrafficUsage Enumeration ................................................................................................. 151 TravelMode Enumeration .................................................................................................. 152 Waypoint Class.................................................................................................................. 153 Waypoint Constructor..................................................................................................... 153 Waypoint Properties ....................................................................................................... 154 Waypoint.Description Property ................................................................................... 154 Waypoint.Location Property ....................................................................................... 154 Search Service...................................................................................................................... 154 AvailableFilter Class .......................................................................................................... 157 AvailableFilter Constructor ............................................................................................. 157 AvailableFilter Properties ............................................................................................... 158 AvailableFilter.PropertyId Property ............................................................................. 158 AvailableFilter.PropertyName Property ...................................................................... 158 BusinessSearchResult Class ............................................................................................ 159 BusinessSearchResult Constructor ............................................................................... 160 BusinessSearchResult Properties ................................................................................. 160 BusinessSearchResult.AdditionalProperties Property ............................................... 162 BusinessSearchResult.Address Property .................................................................. 162 BusinessSearchResult.Categories Property .............................................................. 162 BusinessSearchResult.CategorySpecificProperties Property .................................... 163 BusinessSearchResult.Neighborhoods Property ....................................................... 163 BusinessSearchResult.PhoneNumber Property ........................................................ 163 BusinessSearchResult.RatingCount Property ............................................................ 163 BusinessSearchResult.ReviewCount Property .......................................................... 164 BusinessSearchResult.UserRating Property .............................................................. 164 BusinessSearchResult.Website Property ................................................................... 164 CategoryCount Class ........................................................................................................ 164 CategoryCount Constructor ........................................................................................... 165 CategoryCount Properties ............................................................................................. 165 CategoryCount.Category Property ............................................................................. 166 CategoryCount.Count Property .................................................................................. 166 CategoryCount.CountByNeighborhood Property ....................................................... 166 CategorySpecificPropertySet Class .................................................................................. 167 CategorySpecificPropertySet Constructor ..................................................................... 167 CategorySpecificPropertySet Properties ....................................................................... 167 CategorySpecificPropertySet.CategoryName Property ............................................. 168 CategorySpecificPropertySet.Properties Property ..................................................... 168 CommunityContentSearchResult Class ............................................................................ 168 CommunityContentSearchResult Constructor ............................................................... 169 CommunityContentSearchResult Properties ................................................................. 169 CommunityContentSearchResult.AdditionalProperties Property ............................... 170 CommunityContentSearchResult.Description Property ............................................. 171

CompareOperator Enumeration ........................................................................................ 171 FilterValue Class ............................................................................................................... 172 FilterValue Constructor .................................................................................................. 172 FilterValue Properties..................................................................................................... 173 FilterValue.Id Property ................................................................................................ 173 FilterValue.Name Property ......................................................................................... 173 ListingType Enumeration ................................................................................................... 173 LocationData Class ........................................................................................................... 174 LocationData Constructor .............................................................................................. 175 LocationData Properties ................................................................................................ 175 LocationData.Confidence Property............................................................................. 175 LocationData.Locations Property ............................................................................... 176 LocationData.MatchCodes Property........................................................................... 176 Neighborhood Class .......................................................................................................... 176 Neighborhood Constructor ............................................................................................. 177 Neighborhood Properties ............................................................................................... 177 Neighborhood.City Property ....................................................................................... 177 Neighborhood.Id Property .......................................................................................... 178 Neighborhood.Name Property .................................................................................... 178 Parse Class ....................................................................................................................... 178 Parse Constructor .......................................................................................................... 179 Parse Properties ............................................................................................................ 179 Parse.Address Property ............................................................................................. 180 Parse.Keyword Property ............................................................................................. 180 Parse.Landmark Property ........................................................................................... 180 Parse.LocationSeparator Property ............................................................................. 180 PersonSearchResult Class ............................................................................................... 181 PersonSearchResult Constructor .................................................................................. 182 PersonSearchResult Properties ..................................................................................... 182 PersonSearchResult.Address Property ...................................................................... 182 PersonSearchResult.PhoneNumber Property ............................................................ 183 QuerySuggestion Class ..................................................................................................... 183 QuerySuggestion Constructor ........................................................................................ 183 QuerySuggestion Properties .......................................................................................... 184 QuerySuggestion.Query Property .............................................................................. 184 QuerySuggestion.StructuredQuery Property .............................................................. 184 RangeFilter Class .............................................................................................................. 184 RangeFilter Constructor ................................................................................................. 185 RangeFilter Properties ................................................................................................... 186 RangeFilter.MaximumValue Property......................................................................... 186 RangeFilter.MinimumValue Property.......................................................................... 186 SearchOptions Class ......................................................................................................... 187 SearchOptions Constructor ............................................................................................ 188

SearchOptions Properties .............................................................................................. 188 SearchOptions.AutocorrectQuery Property ................................................................ 189 SearchOptions.Count Property ................................................................................... 190 SearchOptions.Filters Property .................................................................................. 190 SearchOptions.ListingType Property .......................................................................... 190 SearchOptions.ParseOnly Property ........................................................................... 190 SearchOptions.Radius Property ................................................................................. 191 SearchOptions.SortOrder Property ............................................................................ 191 SearchOptions.StartingIndex Property ....................................................................... 191 SearchRegion Class .......................................................................................................... 192 SearchRegion Constructor ............................................................................................. 192 SearchRegion Properties ............................................................................................... 193 SearchRegion.BoundingArea Property ...................................................................... 193 SearchRegion.GeocodeLocation Property ................................................................. 193 SearchRegion.Source Property .................................................................................. 194 SearchRequest Class ........................................................................................................ 194 SearchRequest Constructor ........................................................................................... 196 SearchRequest Properties ............................................................................................. 196 SearchRequest.Query Property ................................................................................. 197 SearchRequest.SearchOptions Property ................................................................... 197 SearchRequest.StructuredQuery Property ................................................................. 197 SearchResponse Class ..................................................................................................... 198 SearchResponse Constructor ........................................................................................ 199 SearchResponse Properties .......................................................................................... 199 SearchResponse.QuerySuggestion Property ............................................................ 200 SearchResponse.ResultSets Property ....................................................................... 200 SearchResultBase Class ................................................................................................... 200 SearchResultBase Constructor...................................................................................... 201 SearchResultBase Properties ........................................................................................ 201 SearchResultBase.Distance Property ........................................................................ 202 SearchResultBase.Id Property ................................................................................... 202 SearchResultBase.LocationData Property ................................................................. 202 SearchResultBase.Name Property ............................................................................. 203 SearchResultSet Class ..................................................................................................... 203 SearchResultSet Constructor ........................................................................................ 204 SearchResultSet Properties ........................................................................................... 204 SearchResultSet.AlternateSearchRegions Property .................................................. 205 SearchResultSet.AvailableFilters Property ................................................................ 205 SearchResultSet.CategoryCounts Property ............................................................... 206 SearchResultSet.EstimatedMatches Property ........................................................... 206 SearchResultSet.ListingType Property....................................................................... 206 SearchResultSet.Parse Property................................................................................ 206 SearchResultSet.QueryCategory Property ................................................................ 207

SearchResultSet.QueryCorrected Property ............................................................... 207 SearchResultSet.Results Property ............................................................................. 207 SearchResultSet.SearchRegion Property .................................................................. 207 SearchServiceClient Class ................................................................................................ 207 SearchServiceClient Constructor ................................................................................... 208 SearchServiceClient Methods ........................................................................................ 209 SearchServiceClient.Search Method .......................................................................... 210 SortOrder Enumeration ..................................................................................................... 210 StructuredSearchQuery Class ........................................................................................... 211 StructuredSearchQuery Constructor .............................................................................. 212 StructuredSearchQuery Properties ................................................................................ 212 StructuredSearchQuery.Keyword Property ................................................................ 212 StructuredSearchQuery.Location Property ................................................................ 212 ValueListFilter Class .......................................................................................................... 213 ValueListFilter Constructor ............................................................................................. 214 ValueListFilter Properties ............................................................................................... 214 ValueListFilter.Values Property .................................................................................. 214 Common Classes and Enumerations ................................................................................... 215 Address Class ................................................................................................................... 217 Address Constructor ...................................................................................................... 219 Address Properties......................................................................................................... 220 Address.AddressLine Property ................................................................................... 221 Address.AdminDistrict Property .................................................................................. 221 Address.CountryRegion Property ............................................................................... 221 Address.District Property ............................................................................................ 221 Address.FormattedAddress Property ......................................................................... 221 Address.Locality Property ........................................................................................... 222 Address.PostalCode Property .................................................................................... 222 Address.PostalTown Property .................................................................................... 222 AuthenticationResultCode Enumeration ........................................................................... 222 Category Class .................................................................................................................. 223 Category Constructor ..................................................................................................... 224 Category Properties ....................................................................................................... 224 Category.Id Property................................................................................................... 224 Category.Name Property ............................................................................................ 224 Circle Class ....................................................................................................................... 225 Circle Constructor .......................................................................................................... 225 Circle Properties ............................................................................................................. 225 Circle.Center Property ................................................................................................ 226 Circle.DistanceUnit Property ...................................................................................... 226 Circle.Radius Property ................................................................................................ 226 Confidence Enumeration ................................................................................................... 227 Credentials Class .............................................................................................................. 227

Credentials Constructor ................................................................................................. 228 Credentials Properties ................................................................................................... 228 Credentials.ApplicationId Property ............................................................................. 229 Credentials.Token Property ........................................................................................ 230 DeviceType Enumeration .................................................................................................. 230 DistanceUnit Enumeration ................................................................................................. 231 ExecutionOptions Class .................................................................................................... 231 ExecutionOptions Constructor ....................................................................................... 232 ExecutionOptions Properties ......................................................................................... 232 ExecutionOptions.SuppressFaults Property ............................................................... 232 FilterExpression Class ....................................................................................................... 232 FilterExpression Constructor .......................................................................................... 233 FilterExpression Properties ............................................................................................ 233 FilterExpression.CompareOperator Property ............................................................. 234 FilterExpression.FilterValue Property ......................................................................... 234 FilterExpression.PropertyId Property.......................................................................... 235 FilterExpressionBase Class .............................................................................................. 235 FilterExpressionBase Constructor ................................................................................. 235 FilterExpressionClause Class ........................................................................................... 236 FilterExpressionClause Constructor .............................................................................. 236 FilterExpressionClause Properties ................................................................................. 237 FilterExpressionClause.Expressions Property ........................................................... 237 FilterExpressionClause.LogicalOperator Property ..................................................... 237 GeocodeLocation Class .................................................................................................... 237 GeocodeLocation Constructor ....................................................................................... 238 GeocodeLocation Properties ......................................................................................... 238 GeocodeLocation.CalculationMethod Property .......................................................... 239 Heading Class ................................................................................................................... 239 Heading Constructor ...................................................................................................... 240 Heading Properties ........................................................................................................ 240 Heading.Orientation Property ..................................................................................... 240 Location Class ................................................................................................................... 241 Location Constructor ...................................................................................................... 242 Location Properties ........................................................................................................ 242 Location.Latitude Property .......................................................................................... 242 Location.Longitude Property ....................................................................................... 243 LogicalOperator Enumeration ........................................................................................... 243 Polygon Class .................................................................................................................... 243 Polygon Constructor....................................................................................................... 244 Polygon Properties ......................................................................................................... 244 Polygon.Vertices Property .......................................................................................... 244 Pushpin Class .................................................................................................................... 245 Pushpin Constructor....................................................................................................... 245

Pushpin Properties ......................................................................................................... 246 Pushpin.IconStyle Property ........................................................................................ 246 Pushpin.Label Property .............................................................................................. 252 Pushpin.Location Property ......................................................................................... 252 RangeOfdateTime Class ................................................................................................... 252 RangeOfdateTime Constructor ...................................................................................... 253 RangeOfdateTime Properties ........................................................................................ 253 RangeOfdateTime.From Property .............................................................................. 253 RangeOfdateTime.To Property .................................................................................. 254 RangeOfint Class .............................................................................................................. 254 RangeOfint Constructor ................................................................................................. 254 RangeOfint Properties ................................................................................................... 255 RangeOfint.From Property ......................................................................................... 255 RangeOfint.To Property .............................................................................................. 255 Rectangle Class ................................................................................................................ 255 Rectangle Constructor ................................................................................................... 256 Rectangle Properties...................................................................................................... 256 Rectangle.Northeast Property .................................................................................... 257 Rectangle.Southwest Property ................................................................................... 257 RequestBase Class ........................................................................................................... 257 RequestBase Constructor .............................................................................................. 258 RequestBase Properties ................................................................................................ 258 RequestBase.Credentials Property ............................................................................ 259 RequestBase.Culture Property ................................................................................... 259 RequestBase.ExecutionOptions Property .................................................................. 261 RequestBase.UserProfile Property ............................................................................. 261 ResponseBase Class ........................................................................................................ 261 ResponseBase Constructor ........................................................................................... 263 ResponseBase Properties ............................................................................................. 263 ResponseBase.BrandLogoUri Property ..................................................................... 263 ResponseBase.ResponseSummary Property ............................................................ 263 ResponseStatusCode Enumeration .................................................................................. 264 ResponseSummary Class ................................................................................................. 264 ResponseSummary Constructor .................................................................................... 265 ResponseSummary Properties ...................................................................................... 265 ResponseSummary.AuthenticationResultCode Property........................................... 266 ResponseSummary.Copyright Property ..................................................................... 266 ResponseSummary.FaultReason Property ................................................................ 266 ResponseSummary.StatusCode Property.................................................................. 266 ResponseSummary.TraceId Property ........................................................................ 267 ShapeBase Class .............................................................................................................. 267 ShapeBase Constructor ................................................................................................. 267 SizeOfint Class .................................................................................................................. 268

SizeOfint Constructor ..................................................................................................... 268 SizeOfint Properties ....................................................................................................... 268 SizeOfint.Height Property ........................................................................................... 269 SizeOfint.Width Property ............................................................................................ 269 UserLocation Class ........................................................................................................... 269 UserLocation Constructor .............................................................................................. 270 UserLocation Properties ................................................................................................ 270 UserLocation.Confidence Property............................................................................. 271 UserProfile Class ............................................................................................................... 271 UserProfile Constructor .................................................................................................. 272 UserProfile Properties .................................................................................................... 272 UserProfile.CurrentHeading Property ......................................................................... 273 UserProfile.CurrentLocation Property......................................................................... 273 UserProfile.DeviceType Property ............................................................................... 273 UserProfile.DistanceUnit Property .............................................................................. 274 UserProfile.IPAddress Property.................................................................................. 274 UserProfile.MapView Property ................................................................................... 274 UserProfile.ScreenSize Property ................................................................................ 274 Reference Tables ..................................................................................................................... 275 Geocode Match Code and Match Method Tables ................................................................ 275 Search Filter Property Table ................................................................................................. 276 Category Property Value Table ......................................................................................... 277 Arts & Entertainment Categories ................................................................................... 278 Automotive & Vehicles Categories ................................................................................. 279 Business to Business Categories .................................................................................. 279 Computers & Technology Categories ............................................................................ 280 Education Categories ..................................................................................................... 281 Food & Dining Categories .............................................................................................. 282 Government & Community Categories .......................................................................... 282 Health & Beauty Categories ........................................................................................... 283 Home & Family Categories ............................................................................................ 285 Legal & Finance Categories ........................................................................................... 286 Professionals & Services Categories ............................................................................. 287 Real Estate & Construction Categories ......................................................................... 287 Sports & Recreation Categories .................................................................................... 288 Shopping Categories...................................................................................................... 289 Travel Categories ........................................................................................................... 290 Amenities Property Value Table ........................................................................................ 291 Atmosphere Property Value Table .................................................................................... 293 Cuisine Property Value Table ............................................................................................ 295 HotelRate Property Value Table ........................................................................................ 299 ParkingOptions Property Value Table ............................................................................... 299 PaymentMethod Property Value Table ............................................................................. 300

Price Property Value Table ............................................................................................... 301 Reservation Property Value Table .................................................................................... 301 Bing Maps SOAP Services Resources and Support ............................................................... 301

Bing Maps SOAP Services

Microsoft Bing Maps SOAP Services is a set of programmable SOAP services that allow you to match addresses to the map, search for points of interest, integrate maps and imagery, return driving directions, and incorporate other location intelligence into your Web application. The Bing Maps SOAP Services software development kit (SDK), Version 1.0 consists of a complete set of reference topics that cover the Bing Maps SOAP Services programming interface (API), Version 1.0. If you are reading this SDK online, you can download the Bing Maps SOAP Services SDK CHM file or PDF file for offline viewing. The Bing Maps AJAX Control and the Bing Maps Silverlight Control are also available for users looking to insert location and search features into their Web application. The interactive SDKs for the Bing Maps AJAX Control and the Bing Maps Silverlight Control are found at http://www.microsoft.com/maps/isdk/ajax and http://www.microsoft.com/maps/isdk/silverlight respectively.

In This Section
Bing Maps SOAP Services Overview Getting Started with Bing Maps SOAP Services Bing Maps SOAP Services Requirements Bing Maps SOAP Services Addresses Developing with Bing Maps SOAP Services Bing Maps SOAP Services API Reference Reference Tables Bing Maps SOAP Services Resources and Support

See Also
Terms and Conditions

Bing Maps SOAP Services Overview

The Bing Maps SOAP Services is a set of Web services that allow you to add mapping and search functionality to your application, including location finding, map imagery, and routing capabilities. The web services are built using Windows Communication Foundation (WCF). There are four Bing Maps SOAP Services: Geocode Service, Imagery Service, Route Service, and Search Service. This topic provides an overview of each of these services and their methods.

14

Geocode Service
You can use the Geocode Service to match addresses, places, and geographic entities to latitude and longitude coordinates on the map, as well as return location information for a specified latitude and longitude coordinate. The Geocode Service methods are: Geocode Finds a geographic location based on a request that may include the address, place, or entity type names to find. ReverseGeocode Finds geographic entities and addresses for a specified map location.

Imagery Service
You can use the Imagery Service to retrieve information about imagery data as well as getting URIs for maps. For example, you can get a link to a map with a pushpin at a specific location or provide a road map or bird's eye imagery to your users. Note Bing Maps draws maps by using an orthographic projection centered on the center point of any given map and based on WGS84 datum. The Imagery Service methods are: GetImageryMetadata Returns information about the requested imagery, including imagery date stamps, vendor attribution, and imagery tile URIs. GetMapUri Returns a URI to a static map that may contain traffic data, routes to a destination from major roads, and pushpins.

Route Service
You can use the Route Service to generate routes and driving directions based on locations or waypoints. For example, you can get directions that include traffic warnings and route hints between multiple locations. You can also get directions from all major roads to a destination (1click directions, also referred to as a "party map") and then use the Imagery Service to map those routes. The Route Service methods are: CalculateRoute Calculates a route between specified stops and returns route directions as well as other route data. CalculateRoutesFromMajorRoads Calculates starting points or route directions to a specified location from nearby major roads.

Search Service
You can use the Search Service to parse a search query that contains a location or keyword (or both) and return search result. The Search Service methods are: Search Returns a parsed query or search results for a given search input string.

15

Note For information about how to reference the Bing Maps SOAP Services, see the Bing Maps SOAP Services Addresses topic.

See Also
Bing Maps SOAP Services API Reference Common Classes and Enumerations

Getting Started with Bing Maps SOAP Services

This topic contains steps for getting started with the Bing Maps SOAP Services.

Learn about the Bing Maps SOAP Services

The Bing Maps SOAP Services is a set of Windows Communication Foundation (WCF) SOAP services. Read the Bing Maps SOAP Services Overview to learn about the Bing Maps SOAP Services and the functionality that these services provide.

Verify the requirements

Verify that your development environment meets the Bing Maps SOAP Services Requirements.

Get a Bing Maps Key

In order to use the Bing Maps SOAP Services with your application, you must get a Bing Maps key. For information about getting a Bing Maps Key, see Getting a Bing Maps Key. For information about how to reference a key in your application, see Accessing the Bing Maps SOAP Services.

Start Developing with Bing Maps SOAP Services

For a step-by-step tutorial for setting up a Visual Studio 2008 project that uses the Bing Maps SOAP Services, see Developing a .NET Application Using Bing Maps SOAP Services in Bing Maps SOAP Services Articles. For information about setting up your Visual Studio application to reference the Bing Maps SOAP Services, see Generating Client Proxy Classes. For information about accessing the Bing Maps SOAP Services by using PHP, see Accessing the Bing Maps SOAP Services Using PHP in Bing Maps SOAP Services Articles.

Transaction Reporting
For information on transaction reporting for the Bing Maps SOAP Services, see Viewing Bing Maps Usage Reports.

16

If you are an existing customer using tokens retrieved from the Bing Maps Token Service in your Bing Maps SOAP Services application, transaction definitions can be found in the Viewing Bing Maps Transaction Reports topic. However, note that Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys.

See Also
Bing Maps SOAP Services API Reference

Bing Maps SOAP Services Requirements

In order to use Bing Maps SOAP Services, certain requirements must be met.

Requirements
Bing Maps SOAP Services is a set of Windows Communication Foundation (WCF) SOAP services. To make requests to the Bing Maps SOAP Services, you must have: The ability to send requests and receive responses using Basic Security Profile Version 1.1 (SOAP 1.1 and WSDL 1.1 protocols). A Bing Maps Platform developer account. For more information see Getting a Bing Maps Key.

Notes
Bing Maps SOAP Services is built on XML and WCF technologies. It has been highly tested for environments using the .NET platform and Visual Studio .NET tools for Web service development. Other environments and toolkits have not been fully tested, but may work with the Bing Maps SOAP Services.

See Also
Bing Maps SOAP Services Overview

Bing Maps SOAP Services Addresses

The Bing Maps SOAP Services are built using Windows Communication Foundation (WCF). The Bing Maps SOAP Services conform to WS-Basic Profile 1.1. The four services are Geocode Service, Imagery Service, Route Service, and Search Service. 17

To use one of the Bing Maps SOAP Services, you need to generate a proxy class on your client. This is described in detail in the Generating Client Proxy Classes topic.

Bing Maps SOAP Services Addresses

The following table lists the service addresses for each of the Bing Maps SOAP Services.

If you an existing customer using tokens, information about staging and production environments can be found in the Requesting a Bing Maps Token topic. However, note that Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys.
Service Name Production Service Metadata URL

Geocode Service Imagery Service Route Service Search Service

http://dev.virtualearth.net/webservices/v1/geocodeservice/geocodeservice.svc http://dev.virtualearth.net/webservices/v1/imageryservice/imageryservice.svc http://dev.virtualearth.net/webservices/v1/routeservice/routeservice.svc http://dev.virtualearth.net/webservices/v1/searchservice/searchservice.svc

Using HTTPS Secure Socket Layer (SSL) Protocol

You can also use the HTTPS Secure Sockets Layer (SSL) protocol to call the Bing Maps SOAP Services. Note that using the SSL protocol adds latency for each call to the Bing Maps SOAP Services. The latency duration depends on how the SSL infrastructure is implemented on your servers; the minimum additional latency is five milliseconds. If you want to send and receive Bing Maps SOAP Services requests using Secure Socket Layer (SSL), follow the steps below. 1. Generate proxy classes using the service addresses listed above by adding a service reference using the Visual Studio User Interface or by using the svcutil.exe tool. More information about this is found in the Generating Client Proxy Classes topic. 2. Edit the service endpoint address URLs found in your Visual Studio configuration file to begin with "https" instead of "http". 3. If you are using Visual Studio 2008 and the .NET Framework 3.0, you also need to change the BasicHttpSecurityMode to Transport. To do this, either set the mode of the security tag in your Visual Studio 2008 configuration file to Transport or set the mode when you initialize the service client. Examples of both methods are provided below.

18

The following example shows how to set the mode of the security tag to Transport in your Visual Studio configuration file.
<!-- Visual Studio 2008 configuration settings for SSL --> <system.serviceModel> <bindings> <basicHttpBinding> <binding name="BasicHttpBinding_IImageryService" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true"> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <security mode="Transport"> <transport clientCredentialType="None" proxyCredentialType="None" realm="" /> <message clientCredentialType="UserName" algorithmSuite="Default" /> </security> </binding> </basicHttpBinding> </bindings> <client> <endpoint address="https://dev.virtualearth.net/WebServices/v1/ImageryService/ImageryService.svc" binding="basicHttpBinding" bindingConfiguration="BasicHttpBinding_IImageryService" contract="IImageryService" name="BasicHttpBinding_IImageryService" /> </client> </system.serviceModel>

The following example shows how to set the security mode to Transport when you initialize the service client.
// Initialize the service client variable with the Transport

19

//

security mode.

SearchServiceClient client = new SearchServiceClient(new BasicHttpBinding(BasicHttpSecurityMode.Transport), new EndpointAddress("https://dev.virtualearth.net/webservices/v1/searchservice/searchservice. svc");

See Also
Generating Client Proxy Classes

Developing with Bing Maps SOAP Services

This section includes topics to help you develop applications using the Bing Maps SOAP Services.

Whenever you use or display results returned from the Bing Maps SOAP Services, you need to also display the logo returned in the ResponseBase.BrandLogoUri Property and copyright notices returned in the ResponseSummary.Copyright Property.

In This Section
Accessing the Bing Maps SOAP Services Generating Client Proxy Classes Bing Maps SOAP Services Transaction Accounting Understanding Tiles Using Search Filters

See Also
Getting Started with Bing Maps SOAP Services Bing Maps SOAP Services API Reference

Accessing the Bing Maps SOAP Services

The topic describes how to access the Bing Maps SOAP Services using a Bing Maps Key or a token.

Using a
You create and access Bing Maps Keys at the Bing Maps Developer Account For information about how to get a Bing Maps Developer Account and Bing Maps Keys, see Getting a Bing Maps Key.

20

To use the Bing Maps Key for your application, set the ApplicationId property of a Credentials object to your Bing Maps Key string. Then, use this object to set the Credentials property of the RequestBase Class. The following example shows how to set Bing Maps Key as part of a request to the Imagery service.

Whenever you use or display results returned from the Bing Maps SOAP Services, you need to also display the logo returned in the ResponseBase.BrandLogoUri Property and copyright notices returned in the ResponseSummary.Copyright Property.
private void RequestImage() { string Results=""; try { // Set a Bing Maps key before making a request string key = "Bing Maps Key";

ImageryService.MapUriRequest mapUriRequest = new ImageryService.MapUriRequest();

// Set credentials using a valid Bing Maps Key mapUriRequest.Credentials = new ImageryService.Credentials(); mapUriRequest.Credentials.ApplicationId = key;

// Set the location of the requested image mapUriRequest.Center = new ImageryService.Location(); mapUriRequest.Center.Latitude = 47.65; mapUriRequest.Center.Longitude = -122.24;

// Set the map style and zoom level ImageryService.MapUriOptions mapUriOptions = new ImageryService.MapUriOptions(); mapUriOptions.Style = ImageryService.MapStyle.AerialWithLabels_v1; mapUriOptions.ZoomLevel = 10;

// Set the size of the requested image to match the size of the image control mapUriOptions.ImageSize = new ImageryService.SizeOfint(); mapUriOptions.ImageSize.Height = 400;

21

mapUriOptions.ImageSize.Width = 600;

mapUriRequest.Options = mapUriOptions;

ImageryService.ImageryServiceClient imageryService = new ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService");

// Make the image request ImageryService.MapUriResponse mapUriResponse = imageryService.GetMapUri(mapUriRequest); string mapUri = mapUriResponse.Uri;

// Set the image control URL to the returned image URI Results = mapUri;

} catch (Exception ex) { Results = "An exception occurred: " + ex.Message;

Private Sub RequestImage() Dim Results As String Try ' Set a Bing Maps key before making a request

Dim key = "Bing Maps Key"

Dim mapUriRequest As New ImageryService.MapUriRequest()

22

' Set credentials using a valid Bing Maps Key mapUriRequest.Credentials = _ New ImageryService.Credentials() With {.ApplicationId = key}

' Set the location of the requested image mapUriRequest.Center = _ New ImageryService.Location() With {.Latitude = 47.65, .Longitude = -122.24}

' Set the map style and zoom level Dim mapUriOptions As New ImageryService.MapUriOptions() _ With {.Style = imageryService.MapStyle.AerialWithLabels_v1, .ZoomLevel = 10}

' Set the size of the requested image to match the size of the image control mapUriOptions.ImageSize = New ImageryService.SizeOfint() _ With {.Height = 400, .Width = 600}

mapUriRequest.Options = mapUriOptions

Dim ImageryServiceInstance As New ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService")

' Make the image request Dim mapUriResponse = ImageryServiceInstance.GetMapUri(mapUriRequest) Dim mapUri = mapUriResponse.Uri

' Set the image control URL to the returned image URI Results = mapUri

Catch ex As Exception Results = "An exception occurred: " &amp; ex.Message End Try

End Sub

23

Using a Bing Maps Token

Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys. If you are using the Bing Maps Token Service, set the Credentials.Token Property to a retrieved token before using a service method to make a request. Note that tokens expire and so new tokens need to be retrieved on a regular basis.

Generating Client Proxy Classes

The Bing Maps SOAP Services metadata define the format of messages that Bing Maps SOAP Services send and receive. The service metadata URLs are outlined in the Bing Maps SOAP Services Addresses topic. To make requests to the Bing Maps SOAP Services, you need to generate proxy classes on your client so that requests can be constructed that are understood by Bing Maps.

Using the ServiceModel Metadata Utility Tool

Bing Maps SOAP Services are a set of web services built using Windows Communication Foundation (WCF) (http://msdn.microsoft.com/en-us/library/ms735119.aspx). The Bing Maps SOAP Services conform to WS-Basic Profile 1.1 (http://www.ws-i.org/Profiles/BasicProfile1.1.html). It is highly recommended that you use the Service Model Metadata Utility Tool (svcutil.exe) or Visual Studio 2008 to generate the service proxy classes for the Bing Maps SOAP Services. Svcutil.exe can be downloaded from http://msdn.microsoft.com/enus/library/aa347733.aspx or from the main menu in the Visual Studio 2008 user interface, select Project, then Add Service Reference. The Bing Maps SOAP Services metadata URLs are listed in the Bing Maps SOAP Services Addresses topic. If you are planning on using more than one of the services (for example, if you want to geocode an address and then retrieve a static map showing that address), use svcutil.exe to generate a single source file that contains service proxy classes for all of the Bing Maps SOAP Services as shown below.
svcutil.exe /target:code /language:csharp /out:VirtualEarthWebServices http://dev.virtualearth.net/webservices/v1/searchservice/searchservice.svc?wsdl http://dev.virtualearth.net/webservices/v1/geocodeservice/geocodeservice.svc?wsdl http://dev.virtualearth.net/webservices/v1/imageryservice/imageryservice.svc?wsdl http://dev.virtualearth.net/webservices/v1/routeservice/routeservice.svc?wsdl

24

rem

The VirtualEarthWebServices.cs file contains the proxy classes that have been

generated. Add this file to your Visual Studio project. The App.config file contains configuration settings.

Other Tools
If you are developing your application in Visual Studio and want to instead use the wsdl.exe command-line utility or the Add Web Reference menu item in the user interface, you need to set the corresponding xxxSpecified member to true for each member that is being set to enable the serialization of those members. More information about this can be found at http://blogs.msdn.com/eugeneos/archive/2007/02/05/solving-the-disappearing-data-issue-whenusing-add-web-reference-or-wsdl-exe-with-wcf-services.aspx

Bing Maps SOAP Services Transaction Accounting

Transactions are counted for each Bing Maps SOAP Services request sent with a valid Bing Maps Key. For information about transactions for the Bing Maps SOAP Services and how to view them, see Viewing Bing Maps Usage Reports.

If you are using tokens retrieved from the Bing Maps Token Service in your Bing Maps SOAP Services application, transaction definitions can be found in the Viewing Bing Maps Token Transaction Reports topic. However, note that Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys.

Understanding Tiles
Bing Maps provides map imagery that users can integrate into their application. To allow clients to load and navigate the imagery as fast as possible, each map view is cut into individual map tiles. This topic contains information about the numbering system used to identify individual tiles.

Tile Numbering System

A map view is comprised of a grid of tiles, numbered from left to right for each row. The table below shows the tile IDs for a map view that contains 5 tiles across and 4 tiles down. 0 5 10 1 6 11 2 7 12 3 8 13 4 9 14 25

15

16

17

18

19

The number of tiles in a map view varies depending on the zoom level of the map. If the zoom level is high (close to the ground), fewer tiles make up the map view. If the zoom level is low (farther away from the ground), more tiles are required to make up a map view. Tile IDs are needed to construct URIs used to request map tiles from Bing Maps. The ImageryServiceClient.GetImageryMetadata Method returns tile URIs in the ImageryMetadataResult.ImageUri Property. If you want to retrieve a URL to a complete static map, use the ImageryServiceClient.GetMapUri Method instead.

Tile IDs should not be confused with "quadkeys", which uniquely identify single tiles at particular levels of detail, and can be used as keys in common database B-tree indexes. For information about generating quadkeys, see the Bing Maps Tile System in the Bing Maps Articles.

See Also
ImageryServiceClient.GetMapUri Method

Using Search Filters

When making requests to the Bing Maps Search Service, you can refine your searches using search filters. Search filters allow you to limit your results to those that meet certain criteria. With search filters, you can write complex searches such as: Search for any businesses that match the keyword cafe with a rating of 4/10 or greater in New York City. Search for all Polynesian restaurants in Honolulu with a romantic atmosphere. Search for all businesses categorized as Malls & Shopping Centers, Museums or Movie Theaters in Chicago.

Filters are only supported for English-United States business searches.

Search Filters
Supported search filters are listed below. Additionally, a table of these filter properties and their associated property values are found in the Search Filter Property Table topic. General Filters The following filters are applicable to all business listings: Category Neighborhood User Rating 26

Payment Method Parking Options

Category-specific Filters Additionally, certain business listing categories have additional properties that can be used for filtering: Restaurants Price Cuisine Atmosphere Reservation Rate Amenities

Hotels

Applying Filters to a Search

Search filters are applied to a search by setting the SearchOptions.Filters Property to one of the types derived from the FilterExpressionBase Class. The derived types are: FilterExpression Class Use this type to specify the property to filter on as well as the property value and an operator to use when comparing this property value against a listing's property value. The Search Filter Property Table contains filter property values and allowable operators for each filter property. FilterExpressionClause Class Use this type to specify multiple filter expressions (FilterExpression Class) to apply to a search. By specifying the appropriate LogicalOperator, results returned can be limited to those that match all criteria (AND) or those that match any criteria (OR). The FilterExpressionClause.Expressions Property can contain 2 to 5 instances of the FilterExpression Class.

Applying a Single Filter The following example demonstrates a search with a single filter. The code below searches for all business listings for the query "cafe in new york" that have a user-rating greater than or equal to 4.
public void SingleFilterExample() { // 1) Create the SearchRequest

// 1a) Set the required SearchRequest parameters SearchService.SearchRequest searchRequest = new SearchService.SearchRequest(); searchRequest.Culture = "en-US";

27

searchRequest.Query = "cafe in new york";

//Identify your Bing Maps Key key = Bing Maps Key; searchRequest.Credentials = new SearchService.Credentials(); // A Bing Maps Key is required for all calls to Bing Maps SOAP Services searchRequest.Credentials.ApplicationId = key; // 1b) Set the User Category Filter SearchService.FilterExpression userRatingFilterExpression = new SearchService.FilterExpression(); userRatingFilterExpression.PropertyId = 3; // User Rating Property ID is 3

userRatingFilterExpression.FilterValue = 4; // User rating scale is between 0 and 10 userRatingFilterExpression.CompareOperator = SearchService.CompareOperator.GreaterThanOrEquals;

// Filters are specified by setting the SearchOptions.Filters property searchRequest.SearchOptions = new SearchService.SearchOptions(); searchRequest.SearchOptions.Filters = userRatingFilterExpression;

// 2) Execute the search by calling the Bing Maps Search Service SearchService.SearchServiceClient client = null; try { // 2a) Create the service client proxy and open the connection. client = new SearchService.SearchServiceClient("BasicHttpBinding_ISearchService"); client.Open();

// 2b) Call Search() SearchService.SearchResponse response = client.Search(searchRequest);

// 2c) Print out the matching results. if (response.ResultSets != null && response.ResultSets.Length > 0) { Console.WriteLine("Cafes in NYC with rating of 4.0 or greater:");

28

foreach (SearchService.SearchResultBase searchResult in response.ResultSets[0].Results) { Console.WriteLine(searchResult.Name); } } } catch (Exception ex) { // If an exception has occurred for any reason, Console.WriteLine("An exception occurred :{0}", ex.ToString()); throw; } finally { // 2d) Close service client proxy. if (client != null) { client.Close(); } } }

Applying Multiple Filters The following example demonstrates a search with multiple filters. The code below searches for all business listings for the query "restaurants in honolulu" that serve Polynesian food and have a romantic atmosphere.
public void MultipleFiltersAndExample() { // 1) Create the SearchRequest

// 1a) Set the required SearchRequest parameters SearchService.SearchRequest searchRequest = new searchRequest.Culture = "en-US"; SearchService.SearchRequest();

29

searchRequest.Query = "restaurants in honolulu";

//Identify your Bing Maps Key string key = "Bing Maps Key"; searchRequest.Credentials = new SearchService.Credentials(); // A Bing Maps Key is required for all calls to the Bing Maps SOAP Services searchRequest.Credentials.ApplicationId = key;

// 1b) Set the filters

// Cuisine Property Filter SearchService.FilterExpression cuisineFilterExpression = new SearchService.FilterExpression(); cuisineFilterExpression.PropertyId = 22; // Cuisine Property ID is 3

cuisineFilterExpression.FilterValue = 62; // 62 = Polynesian cuisineFilterExpression.CompareOperator = SearchService.CompareOperator.Equals;

// Atmosphere Property Filter SearchService.FilterExpression atmosphereFilterExpression = new SearchService.FilterExpression(); atmosphereFilterExpression.PropertyId = 23; // Atmosphere Property ID is 23 atmosphereFilterExpression.FilterValue = 10; // 10 = Romantic atmosphereFilterExpression.CompareOperator = SearchService.CompareOperator.Equals;

// Combine the Cuisine and Atmosphere property filters SearchService.FilterExpressionClause combinedFilterExpressionClause = new SearchService.FilterExpressionClause(); combinedFilterExpressionClause.Expressions = new SearchService.FilterExpressionBase[] { cuisineFilterExpression, atmosphereFilterExpression }; combinedFilterExpressionClause.LogicalOperator = SearchService.LogicalOperator.And;

30

// Filters are specified by setting the SearchOptions.Filters property searchRequest.SearchOptions = new SearchService.SearchOptions(); searchRequest.SearchOptions.Filters = combinedFilterExpressionClause;

// 2) Execute the search by calling the Bing Maps Search Service SearchService.SearchServiceClient client = null; try { // 2a) Create the service client proxy and open the connection. client = new SearchService.SearchServiceClient("BasicHttpBinding_ISearchService"); client.Open();

// 2b) Call Search() SearchService.SearchResponse response = client.Search(searchRequest);

// 2c) Print out the matching results. if (response.ResultSets != null && response.ResultSets.Length > 0) { Console.WriteLine("Restaurants in Honolulu that serve Pacific Rim food and are also on the waterfront:"); foreach (SearchService.SearchResultBase searchResult in response.ResultSets[0].Results) { Console.WriteLine(searchResult.Name); } } } catch (Exception ex) { // If an exception has occurred for any reason, Console.WriteLine("An exception occurred :{0}", ex.ToString()); throw;

31

} finally { // 2d) Close service client proxy. if (client != null) { client.Close(); } } }

Applying a Category Filter The following example demonstrates a search with a category filter. The code below searches for all business listings in Chicago that are categorized as Malls & Shopping Centers, Museums or Movie Theaters.
public void MultipleCategoryFiltersOrExample() { // 1) Create the SearchRequest

// 1a) Set the required SearchRequest parameters SearchService.SearchRequest searchRequest = new SearchService.SearchRequest(); searchRequest.Culture = "en-US"; searchRequest.StructuredQuery = new SearchService.StructuredSearchQuery(); searchRequest.StructuredQuery.Location = "chicago";

string key = "Bing Maps Key"; searchRequest.Credentials = new SearchService.Credentials(); // A Bing Maps Key is required for all calls to the Bing Maps SOAP Services searchRequest.Credentials.ApplicationId = key;

// 1b) Set the filters

// Malls and Shopping Centers

32

SearchService.FilterExpression mallsAndShoppingCentersFilterExpression = new SearchService.FilterExpression(); mallsAndShoppingCentersFilterExpression.PropertyId = 1; ID is 1 mallsAndShoppingCentersFilterExpression.FilterValue = 1614; // 62 = Malls and Shopping Centers mallsAndShoppingCentersFilterExpression.CompareOperator = SearchService.CompareOperator.Equals; // Category Property

// Movie Theaters SearchService.FilterExpression movieTheatersFilterExpression = new SearchService.FilterExpression(); movieTheatersFilterExpression.PropertyId = 1; // Category Property ID is 1 movieTheatersFilterExpression.FilterValue = 1777; // 1777 = Movie Theaters movieTheatersFilterExpression.CompareOperator = SearchService.CompareOperator.Equals;

// Museums SearchService.FilterExpression museumsFilterExpression = new SearchService.FilterExpression(); museumsFilterExpression.PropertyId = 1; // Category Property ID is 1 museumsFilterExpression.FilterValue = 1785; // 1785 = Museums museumsFilterExpression.CompareOperator = SearchService.CompareOperator.Equals;

// Combine all of these filters into a single "OR" expression SearchService.FilterExpressionClause combinedFilterExpressionClause = new SearchService.FilterExpressionClause(); combinedFilterExpressionClause.Expressions = new SearchService.FilterExpressionBase[] { mallsAndShoppingCentersFilterExpression, movieTheatersFilterExpression, museumsFilterExpression };

33

combinedFilterExpressionClause.LogicalOperator = SearchService.LogicalOperator.Or;

// Filters are specified by setting the SearchOptions.Filters property searchRequest.SearchOptions = new SearchService.SearchOptions(); searchRequest.SearchOptions.Filters = combinedFilterExpressionClause; searchRequest.SearchOptions.ListingType = SearchService.ListingType.Business; // Filters only work for businesses

// 2) Execute the search by calling the Bing Maps Search Service SearchService.SearchServiceClient client = null; try { // 2a) Create the service client proxy and open the connection. client = new SearchService.SearchServiceClient("BasicHttpBinding_ISearchService"); client.Open();

// 2b) Call Search() SearchService.SearchResponse response = client.Search(searchRequest);

// 2c) Print out the matching results. if (response.ResultSets != null && response.ResultSets.Length > 0) { Console.WriteLine("Malls & Shopping Centers, Museums and Movie Theaters in Chicago:"); foreach (SearchService.SearchResultBase searchResult in response.ResultSets[0].Results) { Console.WriteLine(searchResult.Name); } } } catch (Exception ex) {

34

// If an exception has occurred for any reason, Console.WriteLine("An exception occurred :{0}", ex.ToString()); throw; } finally { // 2d) Close service client proxy. if (client != null) { client.Close(); } } }

Relevant Search Filters

The SearchResultSet.AvailableFilters Property can be used to further refine the search by providing relevant filters. This property contains any filters that are considered relevant to a business search that returns one or more results. By default, the Bing Maps Search Service returns filters that are applicable to all business searches. Additionally, the Bing Maps Search Service may recommend additional category-specific properties for filtering if it determines that they are relevant to the search. This is useful when developing applications that integrate interactive search. Users of your application can use these filters to narrow down a set of results to those most relevant to them.

See Also
SearchServiceClient.Search Method

Bing Maps SOAP Services API Reference

This section contains reference documentation for the following Bing Maps SOAP Services: Geocode Service Imagery Service Route Service Search Service Common Classes and Enumerations

35

See Also
Bing Maps SOAP Services Overview

Geocode Service
The Bing Maps Geocode Service is comprised of classes and enumerations that allow you to match an address or place to a map location (geocoding) or return geographic entities or addresses found at a given location (reverse geocoding).

In This Section
The Bing Maps Geocode Service contains the following classes and enumerations. Web Service Class
Class or Enumeration Description

GeocodeServiceClient Class

Contains the methods used to make requests to the Geocode Service.

Note The web service class name may be different depending on the tool you use to generate the client proxy classes. Classes and Enumerations
Class or Enumeration Description

ConfidenceFilter Class

Represents a filter that uses a specified minimum confidence level to filter results. Inherits from the FilterBase Class Provides the abstract base class for a result filter. Contains options used to refine a geocode service request. Contains the properties needed to make a GeocodeServiceClient.Geocode Method service request. This class inherits from the RequestBase Class. Contains the results returned by the Geocode Service. This class inherits from the ResponseBase Class. Contains geocoding, location, and entity 36

FilterBase Class GeocodeOptions Class GeocodeRequest Class

GeocodeResponse Class

GeocodeResult Class

Class or Enumeration

Description

properties for a result returned by the Geocode Service. ReverseGeocodeRequest Class Contains the properties needed to make a GeocodeServiceClient.ReverseGeocode Method service request. This class inherits from the RequestBase Class.

See Also
Common Classes and Enumerations

ConfidenceFilter Class
Represents a filter that uses a specified minimum confidence level to filter results. Inherits from the FilterBase Class. Syntax public class ConfidenceFilter : FilterBase Public Class ConfidenceFilter Inherits FilterBase Constructor
Name Description

ConfidenceFilter

Initializes a new instance of a ConfidenceFilter object.

Public Properties
Name Description

MinimumConfidence

A Confidence Enumeration value specifying the minimum level of confidence required for a result to be returned. Required.

See Also GeocodeOptions.Filters Property ConfidenceFilter Constructor Initializes a new instance of the ConfidenceFilter Class. Syntax 37

public ConfidenceFilter() Public Sub New See Also GeocodeOptions.Filters Property ConfidenceFilter Properties The properties of the ConfidenceFilter class are listed here. For a complete list of ConfidenceFilter class members, see the ConfidenceFilter Class topic. Public Properties
Name Description

MinimumConfidence

A Confidence Enumeration value specifying the minimum level of confidence required for a result to be returned. Required.

See Also GeocodeOptions.Filters Property ConfidenceFilter.MinimumConfidence Property A Confidence Enumeration value specifying the minimum level of confidence required for a result to be returned. Required. Set this property before making a service request. Syntax public Confidence MinimumConfidence { set; get; } Public Property MinimumConfidence As Confidence See Also GeocodeOptions.Filters Property

FilterBase Class
Provides the abstract base class for a result filter. Syntax public class FilterBase Public Class FilterBase Constructor
Name Description

FilterBase

Initializes a new instance of a FilterBase object. 38

Remarks The following classes are derived from the FilterBase class. ConfidenceFilter Class

See Also GeocodeOptions.Filters Property FilterBase Constructor Initializes a new instance of the FilterBase Class. Syntax public FilterBase() Public Sub New See Also GeocodeOptions.Filters Property

GeocodeOptions Class
Contains options used to refine a geocode service request. Syntax public class GeocodeOptions Public Class GeocodeOptions Constructor
Name Description

GeocodeOptions

Initializes a new instance of a GeocodeOptions object.

Public Properties
Name Description

Count

An int specifying the number of geocoded results to return. Optional. The default value is 5. A FilterBase Class array specifying the filters used to refine the results returned. Optional.

Filters

39

See Also GeocodeRequest.Options Property GeocodeOptions Constructor Initializes a new instance of the GeocodeOptions Class. Syntax public GeocodeOptions() Public Sub New See Also GeocodeRequest.Options Property GeocodeOptions Properties The properties of the GeocodeOptions class are listed here. For a complete list of GeocodeOptions class members, see the GeocodeOptions Class topic. Public Properties
Name Description

Count

An int specifying the number of geocoded results to return. Optional. The default value is 5. A FilterBase Class array specifying the filters used to refine the results returned. Optional.

Filters

GeocodeOptions.Count Property An int specifying the number of geocoded results to return. Optional. The default value is 5. Set this property before making a service request. Syntax public int Count { set; get; } Public Property Count As Integer Remarks The Count property value must be greater than 0 and no more than 20. GeocodeOptions.Filters Property A FilterBase Class array specifying the filters used to refine the results returned. Optional. Set this property before making a service request. Syntax

40

public FilterBase[] Filters { set; get; } Public Property Filters As FilterBase() Remarks The Filters property can include one ConfidenceFilter Class object, so the maximum length of the array is 1.

GeocodeRequest Class
Contains the properties needed to make a Geocode service request. This class inherits from the RequestBase Class. Syntax public class GeocodeRequest : RequestBase Public Class GeocodeRequest Inherits RequestBase Constructor
Name Description

GeocodeRequest

Initializes a new instance of a GeocodeRequest object.

Public Properties
Name Description

Address

An Address Class object specifying the address to match to a coordinate on the map. Optional. Either the Address or Query property must be set. A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying 41

Credentials

Culture

ExecutionOptions

Name

Description

calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) Options Query A GeocodeOptions Class object used to refine the geocode request. Optional. A string containing the query to parse and match to a coordinate on the map. Optional. Either the Address or Query property must be set. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

UserProfile

See Also GeocodeServiceClient.Geocode Method GeocodeRequest Constructor Initializes a new instance of the GeocodeRequest Class. Syntax public GeocodeRequest() Public Sub New See Also GeocodeServiceClient.Geocode Method GeocodeRequest Properties The properties of the GeocodeRequest class are listed here. For a complete list of GeocodeRequest class members, see the GeocodeRequest Class topic. Public Properties
Name Description

Address

An Address Class object specifying the address to match to a coordinate on the map. Optional. Either the Address or Query property must be set. 42

Name

Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A GeocodeOptions Class object used to refine the geocode request. Optional. A string containing the query to parse and match to a coordinate on the map. Optional. Either the Address or Query property must be set. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Culture

ExecutionOptions

Options Query

UserProfile

GeocodeRequest.Address Property An Address Class object specifying the address to match to a coordinate on the map. Optional. Either the Address or Query property must be set. Set this property before making a service request. Syntax public Address Address { set; get; } Public Property Address As Address Remarks For an Address object to be valid, at least one Address Class property must be set. See Also GeocodeRequest.Query Property GeocodeRequest.Options Property 43

A GeocodeOptions Class object used to refine the geocode request. Optional. Set this property before making a service request. Syntax public GeocodeOptions Options { set; get; } Public Property Options As GeocodeOptions GeocodeRequest.Query Property A string containing the query to parse and match to a coordinate on the map. Optional. Either the Address or Query property must be set. Set this property before making a service request. Syntax public string Query { set; get; } Public Property Query As String Remarks The maximum length of the Query property string is 256. See Also GeocodeRequest.Address Property

GeocodeResponse Class
Contains the results returned by the Geocode Service. This class inherits from the ResponseBase Class. Syntax public class GeocodeResponse : ResponseBase Public Class GeocodeResponse Inherits ResponseBase Constructor
Name Description

GeocodeResponse

Initializes a new instance of a GeocodeResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.)

44

Name

Description

ResponseSummary

A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A GeocodeResult Class array, where each element is a possible match returned by the Geocode Service.

Results

See Also GeocodeServiceClient.Geocode Method GeocodeResponse Constructor Initializes a new instance of the GeocodeResponse Class. Syntax public GeocodeResponse() Public Sub New GeocodeResponse Properties The properties of the GeocodeResponse class are listed here. For a complete list of GeocodeResponse class members, see the GeocodeResponse Class topic. Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A GeocodeResult Class array, where each element is a possible match returned by the Geocode Service.

ResponseSummary

Results

GeocodeResponse.Results Property A GeocodeResult Class array, where each element is a possible match returned by the Geocode Service. Get this property from the service response. 45

Syntax public GeocodeResult[] Results { set; get; } Public Property Results As GeocodeResult() Remarks The length of the Results array will be less than or equal to the value specified in the GeocodeOptions.Count Property. Geocode results returned in the Results property are ordered by relevance, from most to least relevant.

GeocodeResult Class
Contains geocoding, location, and entity properties for a result returned by the Geocode Service. Syntax public class GeocodeResult Public Class GeocodeResult Constructor
Name Description

GeocodeResult

Initializes a new instance of a GeocodeResult object.

Public Properties
Name Description

Address BestView Confidence DisplayName EntityType Locations

An Address Class that specifies address properties for the result. A Rectangle Class that defines the best map view for the result. A Confidence Enumeration value indicating how confident the service is about the result. A string containing a display name for the result. A string containing the entity type name of the result. A GeocodeLocation Class array containing 46

Name

Description

location matches based on the geocoding calculation method. MatchCodes A string array containing the type of matches used to geocode the locations found in the Locations property.

See Also GeocodeResponse.Results Property GeocodeResult Constructor Initializes a new instance of the GeocodeResult Class. Syntax public GeocodeResult() Public Sub New GeocodeResult Properties The properties of the GeocodeResult class are listed here. For a complete list of GeocodeResult class members, see the GeocodeResult Class topic. Public Properties
Name Description

Address BestView Confidence DisplayName EntityType Locations

An Address Class that specifies address properties for the result. A Rectangle Class that defines the best map view for the result. A Confidence Enumeration value indicating how confident the service is about the result. A string containing a display name for the result. A string containing the entity type name of the result. A GeocodeLocation Class array containing location matches based on the geocoding calculation method. 47

Name

Description

MatchCodes

A string array containing the type of matches used to geocode the locations found in the Locations property.

GeocodeResult.Address Property An Address Class that specifies address properties for the result. Get this property from the service response. Syntax public Address Address { set; get; } Public Property Address As Address GeocodeResult.BestView Property A Rectangle Class that defines the best map view for the result. Get this property from the service response. Syntax public Rectangle BestView { set; get; } Public Property BestView As Rectangle GeocodeResult.Confidence Property A Confidence Enumeration value indicating how confident the service is about the result. Get this property from the service response. Syntax public Confidence Confidence { set; get; } Public Property Confidence As Confidence GeocodeResult.DisplayName Property A string containing a display name for the result. Get this property from the service response. Syntax public string DisplayName { set; get; } Public Property DisplayName As String GeocodeResult.EntityType Property A string containing the entity type name of the result. Get this property from the service response. Syntax 48

public string EntityType { set; get; } Public Property EntityType as String Remarks The EntityType property can be used to further refine the geocode results that have been returned. For example, the geocode result "JFK Airport [John F. Kennedy International Airport] (airport), United States" has an entity type name "Airport". If this result was found in a set of ambiguous results, "Airport" entities could be displayed to the user. The following table contains entity types that may be returned:
EntityType Description

Address AdminDivision1 A first-order, initial political subdivision of a [Sovereign], such as a state, province, department, region, or prefecture A second-order political subdivision of a [CountryRegion], a division of an [AdminDivision1] or [Dependent] A third-order political subdivision of a [CountryRegion], a division of an [AdminDivision2] A building housing governmental offices or facilities An administrative division of a [CountryRegion], undifferentiated as to administrative level A [Structure] used for agricultural purposes A place where aircraft regularly land and take off, with runways, navigational aids, and facilities for handling passengers and/or cargo An improved surface suitable for landing airplanes A facility containing rides and other attractions, such as a theme park A place where archeological remains, old structures, or cultural artifacts are located 49

AdminDivision2

AdminDivision3

AdministrativeBuilding AdministrativeDivision AgriculturalStructure Airport

AirportRunway AmusementPark AncientSite

EntityType

Description

Aquarium Archipelago Autorail Basin Battlefield Bay Beach BorderPost

A place where marine life is displayed to the public A logical grouping of [Island]s A [Railway] that carries automobiles A low-lying area mostly or wholly surrounded by higher ground A site of a land battle of historical importance An area of water partially enclosed by an indentation of shoreline A [Coast] with a surface of sand or fine rock A post or station at an international boundary for regulating of movement of people and goods A structure erected across an obstacle such as a stream or road used by vehicles and pedestrians A category that identifies a kind of business A place where a number of businesses are located A name that identifies a business A [Structure] used for commercial purposes A place where buses pick up and discharge passengers A site occupied by tents, huts, or other shelters for temporary use An artificially constructed watercourse An underground passageway or chamber, or cavity on the side of a cliff A spherical body in space A burial place or ground One of the set of most granular, lowest level [CensusDistrict]s 50

Bridge

BusinessCategory BusinessCenter BusinessName BusinessStructure BusStation Camp Canal Cave CelestialFeature Cemetery Census1

EntityType

Description

Census2

One of the set of second-order [CensusDistrict]s composed by aggregating [Census1]s A district defined by a national census bureau and used for statistical data collection A body of water between two landmasses A building for public Christian worship A building housing the administrative offices of a municipal government A high, steep to perpendicular slope overlooking a lower area or water body An area of homogenous climactic conditions, as defined by modified Koeppen classes An area of land adjacent to a [WaterFeature] A facility for community recreation and meetings A very large landmass, surrounded by water and larger than an [Island], that forms one of the primary divisions of land on a [CelestialFeature] A large meeting hall for conventions and other meetings and shows A primary [PoliticalUnit] A building in which courts of law are held A generally circular saucer or bowl-shaped depression caused by volcanic or meteorite explosive action An area of land with strong local identity but no political existence A large area of ocean where surface water flows in a certain constant general direction A barrier constructed across a stream to impound water 51

CensusDistrict Channel Church CityHall Cliff ClimateRegion Coast CommunityCenter Continent

ConventionCenter CountryRegion Courthouse Crater

CulturalRegion Current Dam

EntityType

Description

Delta

An area where a [River] divides into many separate water channels as it enters a [Sea] or [Lake] A [PoliticalUnit] that is politically controlled by a [Sovereign], but separate geographically and to some degree politically, such as a territory, colony, or dependency A large area with low rainfall and little or no vegetation An area in political dispute that is not considered part of any [CountryRegion] A land region where all surface water drains into one specific [WaterFeature] A wave form, ridge, or star shaped feature composed of sand A place where the destructive energy of a specific earthquake is centered A region with a homogeneous ecosystem, flora, and/or fauna A place for providing instruction An area where the surface elevation of all land is within a defined range A building or set of buildings where goods are manufactured, processed or fabricated A route used by a boat or other floating conveyance regularly used to transport people and vehicles across a [WaterFeature] A structure and associated facilities where a ferry boat docks and takes on passengers, automobiles, and/or cargo A place for hatching fish eggs or raising fish A large area of trees An [AdministrativeDivision] that no longer exists

Dependent

Desert DisputedArea DrainageBasin Dune EarthquakeEpicenter Ecoregion EducationalStructure ElevationZone Factory FerryRoute

FerryTerminal

FishHatchery Forest FormerAdministrativeDivision

52

EntityType

Description

FormerPoliticalUnit FormerSovereign Fort Garden GeodeticFeature

A [PoliticalUnit] that no longer exists A [Sovereign] that no longer exists A defensive structure or earthwork An enclosure for displaying selected plant life An invisible point, line, or area on the surface of a [CelestialFeature] used for geographic reference A single thing that has spatial extent and location One of the two points of intersection of the surface of a [CelestialFeature] and its axis of rotation A [HotSpring] that intermittently shoots water into the air A mass of ice, usually at high latitudes or high elevations, with sufficient thickness to flow away from the source area A recreational field where golf is played A [Structure] typically owned and operated by a governmental entity A place where helicopters land and take off A half the surface of a [Celestial Feature], usually northern, southern, eastern, or western A place where students receive advanced or specialized education, such as a college or university A place of historical importance A building in which the sick or injured, especially those confined to bed, are medically treated A place where hot water emerges from the ground A large area covered with frozen water 53

GeoEntity GeographicPole

Geyser Glacier

GolfCourse GovernmentStructure Heliport Hemisphere HigherEducationFacility

HistoricalSite Hospital

HotSpring Ice

EntityType

Description

IndigenousPeoplesReserve IndustrialStructure InformationCenter InternationalDateline

An area of land set aside for aboriginal, tribal, or native populations A [Structure] used for industrial or extractive purposes A place where tourists and citizens can obtain information The line running between geographic poles designated as the point where a calendar day begins An area of land composed of the member [PoliticalUnit]s of an official governmental organization made up of two or more [Sovereign]s An area of land completely surrounded by water and smaller than a [Continent] A narrow strip of land connecting two larger landmasses and bordered by water on two sides A place where two or more roads join An inland water body, usually fresh water A relatively small area of land exhibiting a common characteristic that distinguishes it from surrounding land A natural geographic feature on dry land A [Structure] that is a well-known point of reference An imaginary line of constant latitude that circles a [CelestialFeature], in which every point on the line is equidistant from a geographic pole A place where books and other media are stored and loaned out to the public or others A tall structure with a major navigation light An area of land where most of the population 54

InternationalOrganization

Island Isthmus

Junction Lake LandArea

Landform LandmarkBuilding LatitudeLine

Library Lighthouse LinguisticRegion

EntityType

Description

speaks the same language or languages in the same linguistic family LongitudeLine An imaginary line of constant longitude on a [CelestialFeature] running from one geographic pole to the other A point on the surface of a [CelestialFeature] that is the origin for lines of magnetic force A harbor facility for small boats A place where goods are bought and sold A [Structure] in which the sick or injured are medically treated A place where urban rapid transit trains pick up and drop off passengers, often underground or elevated A place used by an armed service for storing arms and supplies, for accommodating and training troops, and as a base from which operations can be initiated A place where mineral ores are extracted from the ground by excavating surface pits and subterranean passages A place characterized by dwellings, school, church, hospital and other facilities operated by a religious group for the purpose of providing charitable services and to propagate religion A commemorative structure or statue A building for public Islamic worship An elevated landform that rises, often steeply, above surrounding land on most sides A group of connected [Mountain]s A building where objects of permanent interest in one or more of the arts and sciences are preserved and exhibited A [Structure] used for nautical purposes 55

MagneticPole Marina Market MedicalStructure MetroStation

MilitaryBase

Mine

Mission

Monument Mosque Mountain MountainRange Museum

NauticalStructure

EntityType

Description

NavigationalStructure Neighborhood

A [Structure] used for navigational purposes A section of a [PopulatedPlace], usually homogenous and/or well-known but often with indistinct boundaries An area in a [Desert] made productive by the availability of water A wildlife or scenic observation point A vast expanse of salt water, one of the major [Sea]s covering part of the earth A building housing offices An area maintained as a place of beauty, or for recreation A parking lot reserved for mass transit commuters A break in a [MountainRange] used for transportation from one side to the other An elongated area of land projecting into a body of water and surrounded by water on three sides An extensive area of comparatively level to gently undulating land, lacking surface irregularities A [CelestialFeature] that orbits a star A section of a planetary crust that is in motion relative to other plates An elevated plain with steep slopes on one or more sides A tract of land used for playing team sports and/or other athletic events A point on the surface of a [CelestialFeature] that marks an important geographical or astronomical location A building in which police are stationed or 56

Oasis ObservationPoint Ocean OfficeBuilding Park ParkAndRide Pass Peninsula

Plain

Planet Plate Plateau PlayingField Pole

PoliceStation

EntityType

Description

posted PoliticalUnit PopulatedPlace Postcode An area of land with well-defined borders that is subject to a specific political administration A concentrated area of human settlement, such as a city, town, or village A district used by a postal service as an aid in postal distribution and having a unique identifying code One of the set of lowest-level, most granular, and detailed set of [PostCode]s in a [Sovereign] One of the set of second-order (one level up from the lowest level) [Postcode]s in a [Sovereign], composed by aggregating [Postcode1]s One of the set of third-order [Postcode]s in a [Sovereign], composed by aggregating [Postcode2]s One of the set of fourth-order [Postcode]s in a [Sovereign], composed by aggregating [Postcode3]s A public building in which mail is received, sorted and distributed A facility for generating electric power A facility for confining persons convicted or accused of crimes A small, usually pointed [Peninsula] that often marks the terminus of a landmass A track where races are held A permanent twin steel-rail track on which trains move A place comprised of ticket offices, platforms, and other facilities for loading and unloading train passengers and freight A [Structure] used for watching or participating 57

Postcode1 Postcode2

Postcode3

Postcode4

PostOffice PowerStation Prison Promontory RaceTrack Railway RailwayStation

RecreationalStructure

EntityType

Description

in sports or other athletic activity Reef A partly submerged feature, usually of coral, that projects upward near the water's surface and can be a navigational hazard A large area of land where a specific characteristic of the land or its people is relatively homogenous An area of land where the population holds relatively homogenous religious practices A structure where organized, public religious services are held A [Structure] used for scientific purposes A tract of public land set aside for restricted use or reserved for future use A house, hut, apartment building, or other structure where people reside A designated area, usually along a major highway, where motorists can pause to relax A stream of running water An open way with improved surface for efficient transportation of vehicles A temporary installation set up to control or block traffic along a road A junction where two or more roads meet or cross at grade A destroyed or decayed structure that is no longer functional A [CelestialFeature] that orbits a [Planet] A place where people, usually children, receive a basic education A scientific facility used as a base from which research is carried out or monitored A large area of salt water 58

Region

ReligiousRegion ReligiousStructure ResearchStructure Reserve ResidentialStructure RestArea River Road RoadBlock RoadIntersection Ruin Satellite School ScientificResearchBase Sea

EntityType

Description

SeaplaneLandingArea ShipWreck ShoppingCenter Shrine Site SkiArea Sovereign SpotElevation Spring Stadium StatisticalDistrict Structure TectonicBoundary TectonicFeature Temple TimeZone TouristStructure Trail TransportationStructure Tunnel

A place on a water body where floatplanes land and take off A site of the remains of a wrecked vessel A collection of linked retail establishments A structure or place memorializing a person or religious concept A place most notable because of an event that occurred in that location A place developed for recreational alpine or nordic skiing An independent nation-state, the highest level of political authority in that location A point on a [CelestialFeature]'s surface with a known elevation A place where water emerges from the ground A structure with an enclosure for athletic games with tiers of seats for spectators An area of land defined as a district to be used for statistical collection or service provision A building, facility, or group of buildings and/or facilities used for a certain common purpose A line forming the border between two [Plate]s A [Landform] related to [Plate]s and their movement An edifice dedicated to religious worship A large area within which the same time standard is used A [Structure] typically used by tourists A path, track, or route used by pedestrians, animals, or off-road vehicles A [Structure] used for transportation purposes A subterranean passageway for transportation 59

EntityType

Description

UnderwaterFeature UrbanRegion Valley Volcano Wall Waterfall WaterFeature Well

A feature on the floor of a [WaterFeature] An area of land with high population density and extensive urban development A low area surrounded by higher ground on two or more sides A [Mountain] formed by volcanic action and composed of volcanic rock An upright structure that encloses, divides, or protects an area A vertical or very steep section of a [River] A geographic feature that has water on its surface A cylindrical hole, pit, or tunnel drilled or dug down to a depth from which water, oil, or gas can be pumped or brought to the surface An area of high soil moisture, partially or intermittently covered with shallow water A zoological garden or park where wild animals are kept for exhibition

Wetland Zoo

GeocodeResult.Locations Property A GeocodeLocation Class array containing location matches based on the geocoding calculation method. Get this property from the service response. Syntax public CalculatedLocation[] Locations { set; get; } Public Property Locations as CalculatedLocation() GeocodeResult.MatchCodes Property A string array containing the type of matches used to geocode the locations found in the Locations property. Get this property from the service response. Syntax public string[] MatchCodes { set; get; } Public Property MatchCodes As String() 60

Remarks The return values for the MatchCodes property are listed in the Geocode Match Code and Match Method Tables topic.

GeocodeServiceClient Class
Contains the methods used to make requests to the Geocode Service. Note The name of this class and its constructor may be different depending on the tool you use to generate the client proxy classes. Syntax public class GeocodeServiceClient : System.ServiceModel.ClientBase<IGeocodeService> Public Class GeocodeServiceClient Inherits System.ServiceModel.ClientBase(Of IGeocodeService) Constructor
Name Description

GeocodeServiceClient

Initializes a new instance of a GeocodeServiceClient object.

Methods
Name Description

Geocode

Finds a geographic location based on a request that may include the address, place, or entity type names to find. Finds geographic entities and addresses for a specified map location (known as reverse geocoding).

ReverseGeocode

GeocodeServiceClient Constructor Initializes a new instance of the GeocodeServiceClient Class. Syntax public GeocodeServiceClient()

61

Public Sub New Syntax public GeocodeServiceClient(string endpointConfigurationName) Public Sub New(ByVal endpointConfigurationName As String) Syntax public GeocodeServiceClient(string endpointConfigurationName, string remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String) Syntax public GeocodeServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Syntax public GeocodeServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Parameters endpointConfigurationName binding remoteAddress Remarks The Geocode service provides endpoints for Basic HTTP and Binary over HTTP configurations. When you create a proxy for your application, references to both endpoints are added to your application. Therefore, you must specify the endpoint you want to use. To specify the endpoint, use the following endpoint configuration names.
Endpoint Configuration Type Endpoint Configuration Name

The endpoint for a service that allows clients to find and communicate with the service. The binding with which to make calls to the service. The address of the service endpoint.

Basic HTTP Binary over HTTP Example

BasicHttpBinding_IGeocodeService CustomBinding_IGeocodeService

Create a GeocodeServiceClient object that uses the binary over HTTP endpoint. 62

GeocodeService.GeocodeServiceClient geocodeService = new GeocodeService.GeocodeServiceClient("CustomBinding_IGeocodeService"); Dim geocodeServiceInstance As New GeocodeService.GeocodeServiceClient("BasicHttpBinding_IGeocodeService")

See Also System.ServiceModel.ClientBase.ClientBase(TChannel) Constructor GeocodeServiceClient Methods The methods of the GeocodeServiceClient class are listed here. For a complete list of GeocodeServiceClient class members, see the GeocodeServiceClient Class topic. Public Methods
Name Description

Geocode

Finds a geographic location based on a request that may include the address, place, or entity type names to find. Finds geographic entities and addresses for a specified map location (known as reverse geocoding).

ReverseGeocode

GeocodeServiceClient.Geocode Method Finds a geographic location based on a request that may include the address, place, or entity type names to find. Syntax public GeocodeResponse Geocode(GeocodeRequest request) Public Function Geocode(ByVal request As GeocodeRequest) As GeocodeResponse Parameters request A GeocodeRequest object that contains the header and parameter information for the service operation.

Return Value Returns a GeocodeResponse Class, which contains a GeocodeResult Class array. Example VirtualEarthServices#4 See Also 63

GeocodeServiceClient.ReverseGeocode Method GeocodeServiceClient.ReverseGeocode Method Finds geographic entities and addresses for a specified map location (known as reverse geocoding). Syntax public GeocodeResponse ReverseGeocode(ReverseGeocodeRequest request) Public Function ReverseGeocode(ByVal request As ReverseGeocodeRequest) As GeocodeResponse Parameters request A ReverseGeocodeRequest object that contains the header and parameter information for the service operation.

Return Value Returns a GeocodeResponse Class, which contains a GeocodeResult Class array. Example VirtualEarthServices#5 See Also GeocodeServiceClient.Geocode Method

ReverseGeocodeRequest Class
Contains the properties needed to make a ReverseGeocode service request. This class inherits from the RequestBase Class. Syntax public class ReverseGeocodeRequest : RequestBase Public Class ReverseGeocodeRequest Constructor
Name Description

ReverseGeocodeRequest

Initializes a new instance of a ReverseGeocodeRequest object.

Public Properties 64

Name

Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A Location Class object specifying the map location to match to known geographic entities. Required. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Culture

ExecutionOptions

Location

UserProfile

See Also GeocodeServiceClient.ReverseGeocode Method ReverseGeocodeRequest Constructor Initializes a new instance of the ReverseGeocodeRequest Class. Syntax public ReverseGeocodeRequest() Public Sub New

ReverseGeocodeRequest Properties The properties of the ReverseGeocodeRequest class are listed here. For a complete list of ReverseGeocodeRequest class members, see the ReverseGeocodeRequest Class topic. Public Properties

65

Name

Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A Location Class object specifying the map location to match to known geographic entities. Required. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Culture

ExecutionOptions

Location

UserProfile

ReverseGeocodeRequest.Location Property A Location Class object specifying the map location to match to known geographic entities. Required. Set this property before making a service request. Syntax public Location Location { set; get; } Public Property Location As Location

Imagery Service
The Bing Maps Imagery Service is comprised of classes and enumerations that allow you to retrieve map imagery information, including imagery URIs.

Bing Maps has introduced a new "road" map style for all Bing Maps APIs that is designed for improved readability and improved interaction between imagery with data overlays. This map style is in use on http://www.bing.com/maps and starting November 2010, you can opt-in to the new map style when you use the Bing Maps APIs. This opt-in period will end on April 30, 2011. On May 1, 2011, the new map style will become the only style available. 66

An enumeration of all possible map styles is provide by the MapStyle Enumeration.

In this Section
The Bing Maps Imagery Service contains the following classes and enumerations. Web Service Class
Class or Enumeration Description

ImageryServiceClient Class

Contains the methods used to make requests to the Imagery Service.

Note The web service class name may be different depending on the tool you use to generate the client proxy classes. Classes and Enumerations
Class or Enumeration Description

CoverageArea Class ImageryMetadataBirdseyeResult Class

Contains bounding box and zoom level properties specifying a coverage area. Contains detailed information about a specific bird's eye image, including vintage data, URIs, image orientation, and bird's eye tile details. This class inherits from the ImageryMetadataResult Class. Contains options for refining the imagery metadata request. Contains the properties needed to make a ImageryServiceClient.GetImageryMetadata Method service request. This class inherits from the RequestBase Class. Contains the results returned by the ImageryServiceClient.GetImageryMetadata Method. This class inherits from the ResponseBase Class. Contains detailed information about a specific image, including vintage data and URIs. Represents a vendor that provides imagery data.

ImageryMetadataOptions Class ImageryMetadataRequest Class

ImageryMetadataResponse Class

ImageryMetadataResult Class ImageryProvider Class

67

Class or Enumeration

Description

ImageType Enumeration MapStyle Enumeration MapUriOptions Class MapUriRequest Class

Contains image format types. Contains map styles. Contains the options for refining the map URI request. Contains the properties needed to make a ImageryServiceClient.GetMapUri Method service request. This class inherits from the RequestBase Class. Contains the URI returned by the ImageryServiceClient.GetMapUri Method. This class inherits from the ResponseBase Class. Contains values that specify URI scheme.

MapUriResponse Class

UriScheme Enumeration

See Also
Common Classes and Enumerations

CoverageArea Class
Contains bounding box and zoom level properties specifying a coverage area. Syntax public class CoverageArea Public Class CoverageArea Constructor
Name Description

CoverageArea

Initializes a new instance of a CoverageArea object.

Public Properties
Name Description

BoundingRectangle

A Rectangle Class object that defines the 68

Name

Description

borders of the area on the map. ZoomRange A RangeOfint Class object indicating the zoom levels that are covered.

See Also ImageryProvider.CoverageAreas Property CoverageArea Constructor Initializes a new instance of the CoverageArea Class. Syntax public CoverageArea() Public Sub New CoverageArea Properties The properties of the CoverageArea class are listed here. For a complete list of CoverageArea class members, see the CoverageArea Class topic. Public Properties
Name Description

BoundingRectangle ZoomRange

A Rectangle Class object that defines the borders of the area on the map. A RangeOfint Class object indicating the zoom levels that are covered.

See Also ImageryProvider.CoverageAreas Property CoverageArea.BoundingRectangle Property A Rectangle Class object that defines the borders of the area on the map. Get this property from the service response. Syntax public Rectangle BoundingRectangle { set; get; } Public Property BoundingRectangle As Rectangle CoverageArea.ZoomRange Property A RangeOfint Class object indicating the zoom levels that are covered. Get this property from the service response. 69

Syntax public RangeOfint ZoomRange { set; get; } Public Property ZoomRange As RangeOfInt

ImageryMetadataBirdseyeResult Class
Contains detailed information about a specific bird's eye image, including vintage data, URIs, image orientation, and bird's eye tile details. This class inherits from the ImageryMetadataResult Class. Syntax public class ImageryMetadataBirdseyeResult : ImageryMetadataResult Public Class ImageryMetadataBirdseyeResult Inherits ImageryMetadataResult Constructor
Name Description

ImageryMetadataBirdseyeResult

Initializes a new instance of an ImageryMetadataBirdseyeResult object.

Public Properties
Name Description

Heading ImageryProviders

A Heading Class object containing the orientation of the bird's eye scene, in degrees. An ImageryProvider Class array that specifies the vendors that provided the imagery data. (Inherited from the ImageryMetadataResult Class.) A SizeOfint Class object specifying the height and width of the image. (Inherited from the ImageryMetadataResult Class.) A string specifying the URI for the image. (Inherited from the ImageryMetadataResult Class.) A string array, where each element specifies a 70

ImageSize

ImageUri

ImageUriSubdomains

Name

Description

sub-domain that can be used to construct a URI for the image. (Inherited from the ImageryMetadataResult Class.) TilesX An int specifying the number of horizontal tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. An int specifying the number of vertical tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. A RangeOfdateTime Class object specifying a time frame when the image was created. (Inherited from the ImageryMetadataResult Class.) A RangeOfint Class object specifying a zoom range that the image supports. (Inherited from the ImageryMetadataResult Class.)

TilesY

Vintage

ZoomRange

See Also ImageryMetadataResponse.Results Property ImageryMetadataBirdseyeResult Constructor Initializes a new instance of the ImageryMetadataBirdseyeResult Class. Syntax public ImageryMetadataBirdseyeResult() Public Sub New ImageryMetadataBirdseyeResult Properties The properties of the ImageryMetadataBirdseyeResult class are listed here. For a complete list of ImageryMetadataBirdseyeResult class members, see the ImageryMetadataBirdseyeResult Class topic. Public Properties
Name Description

Heading

A Heading Class object containing the orientation of the bird's eye scene, in degrees. 71

Name

Description

ImageryProviders

An ImageryProvider Class array that specifies the vendors that provided the imagery data. (Inherited from the ImageryMetadataResult Class.) A SizeOfint Class object specifying the height and width of the image. (Inherited from the ImageryMetadataResult Class.) A string specifying the URI for the image. (Inherited from the ImageryMetadataResult Class.) A string array, where each element specifies a sub-domain that can be used to construct a URI for the image. (Inherited from the ImageryMetadataResult Class.) An int specifying the number of horizontal tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. An int specifying the number of vertical tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. A RangeOfdateTime Class object specifying a time frame when the image was created. (Inherited from the ImageryMetadataResult Class.) A RangeOfint Class object specifying a zoom range that the image supports. (Inherited from the ImageryMetadataResult Class.)

ImageSize

ImageUri

ImageUriSubdomains

TilesX

TilesY

Vintage

ZoomRange

ImageryMetadataBirdseyeResult.Heading Property A Heading Class object containing the orientation of the bird's eye scene, in degrees. Get this property from the service response. Syntax public Heading Heading { set; get; } Public Property Heading As Heading 72

ImageryMetadataBirdseyeResult.TilesX Property An int specifying the number of horizontal tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. Get this property from the service response. Syntax public int TilesX { set; get; } Public Property TilesX As Integer Remarks Bird's eye images consist of a grid of tiles. The TilesX and TilesY properties are needed to compute tile IDs, which are used to retrieve the bird's eye tiles found in a bird's eye image. For example, let's say the TilesX property is 2 and the TilesY property is 3. In this scenario, the first bird's eye image tile in the upper left-hand corner has a tile ID of 0. The last tile in the lower righthand corner has a tile ID of 5 (TilesX * TilesY - 1). The first row of tile IDs are 0, 1, and 2. The second row of tiles IDs are 3, 4, and 5. More information about tile IDs is found in the Understanding Tiles topic. See Also ImageryMetadataBirdseyeResult.TilesY Property ImageryMetadataBirdseyeResult.TilesY Property An int specifying the number of vertical tiles in the bird's eye scene at the highest zoom level for the bird's eye scene. Get this property from the service response. Syntax public int TilesY { set; get; } Public Property TilesY As Integer Remarks Bird's eye images consist of a grid of tiles. The TilesX and TilesY properties are needed to compute tile IDs, which are used to retrieve the bird's eye tiles found in a bird's eye image. For example, let's say the TilesX property is 2 and the TilesY property is 3. In this scenario, the first bird's eye image tile in the upper left-hand corner has a tile ID of 0. The last tile in the lower righthand corner has a tile ID of 5 (TilesX * TilesY - 1). The first row of tile IDs are 0, 1, and 2. The second row of tiles IDs are 3, 4, and 5. More information about tile IDs is found in the Understanding Tiles topic. See Also ImageryMetadataBirdseyeResult.TilesX Property

ImageryMetadataOptions Class
Contains options for refining the imagery metadata request.

73

Syntax public class ImageryMetadataOptions Public Class ImageryMetadataOptions Constructor

Name Description

ImageryMetadataOptions

Initializes a new instance of a ImageryMetadataOptions object.

Public Properties
Name Description

Heading

A Heading Class object representing the direction the map is turned. Optional. The default value is null. A Location Class object specifying the location of the tile image. Optional. The default value is null. A bool specifying if provider information should be returned in the ImageryMetadataResult.ImageryProviders Property. Optional. The default value is false. A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. An int representing the zoom level of the map view. Optional.

Location

ReturnImageryProviders

UriScheme

ZoomLevel

Remarks If the ImageryMetadataRequest.Style Property specifies Birdseye or BirdseyeWithLabels imagery, then both the Location property and the ZoomLevel property must be specified. ImageryMetadataOptions Constructor Initializes a new instance of the ImageryMetadataOptions Class. Syntax 74

public ImageryMetadataOptions() Public Sub New ImageryMetadataOptions Properties The properties of the ImageryMetadataOptions class are listed here. For a complete list of ImageryMetadataOptions class members, see the ImageryMetadataOptions Class topic. Public Properties
Name Description

Heading

A Heading Class object representing the direction the map is turned. Optional. The default value is null. A Location Class object specifying the location of the tile image. Optional. The default value is null. A bool specifying if provider information should be returned in the ImageryMetadataResult.ImageryProviders Property. Optional. The default value is false. A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. An int representing the zoom level of the map view. Optional.

Location

ReturnImageryProviders

UriScheme

ZoomLevel

ImageryMetadataOptions.Heading Property A Heading object representing the direction the map is turned. Optional. The default value is null. Set this property before making a service request. Syntax public Heading Heading { set; get; } Public Property Heading As Heading Remarks The Heading property is ignored if the ImageryMetadataRequest.Style Property is not set to Birdseye or BirdseyeWithLabels. ImageryMetadataOptions.Location Property

75

A Location object specifying the location of the tile image. Optional. The default value is null. Set this property before making a service request. Syntax public Location Location { set; get; } Public Property Location As Location Remarks The minimum latitude value for the Location property is -85. The maximum latitude value is 85. ImageryMetadataOptions.ReturnImageryProviders Property A bool specifying if provider information should be returned in the ImageryMetadataResult.ImageryProviders Property. Optional. The default value is false. Set this property before making a service request. Syntax public bool ReturnImageryProviders { set; get; } Public Property ReturnImageryProviders As Boolean ImageryMetadataOptions.UriScheme Property A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. Set this property before making a service request. Syntax public UriScheme UriScheme { set; get; } Public Property UriScheme As UriScheme ImageryMetadataOptions.ZoomLevel Property An int representing the zoom level of the map. Optional. Set this property before making a service request. Syntax public int ZoomLevel { set; get; } Public Property ZoomLevel As Integer Remarks Valid values for the ZoomLevel property range from 1 to 21. If the ZoomLevel property is not specified, Bing Maps sets the zoom level to the best level for the imagery requested.

76

ImageryMetadataRequest Class
Contains the properties needed to make a GetImageryMetadata service request. This class inherits from the RequestBase Class. Syntax public class ImageryMetadataRequest : RequestBase Public Class ImageryMetadataRequest Inherits RequestBase Constructor
Name Description

ImageryMetadataRequest

Initializes a new instance of an ImageryMetadataRequest object.

Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) An ImageryMetadataOptions Class object containing properties for refining the imagery metadata request. Optional. A MapStyle Enumeration value indicating an imagery style. Required. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase 77

Culture

ExecutionOptions

Options

Style UserProfile

Name

Description

Class.)

See Also ImageryServiceClient.GetImageryMetadata Method ImageryMetadataRequest Constructor Initializes a new instance of the ImageryMetadataRequest Class. Syntax public ImageryMetadataRequest() Public Sub New ImageryMetadataRequest Properties The properties of the ImageryMetadataRequest class are listed here. For a complete list of ImageryMetadataRequest class members, see the ImageryMetadataRequest Class topic. Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) An ImageryMetadataOptions Class object containing properties for refining the imagery metadata request. Optional. A MapStyle Enumeration value indicating an imagery style. Required. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase 78

Culture

ExecutionOptions

Options

Style UserProfile

Name

Description

Class.) ImageryMetadataRequest.Options Property An ImageryMetadataOptions Class object containing properties for refining the imagery metadata request. Optional. Set this property before making a service request. Syntax public ImageryMetadataOptions Options { set; get; } Public Property Options As ImageryMetadataOptions ImageryMetadataRequest.Style Property A MapStyle Enumeration value indicating an imagery style. Required. Set this property before making a service request. Syntax public MapStyle Style { set; get; } Public Property Style As MapStyle

ImageryMetadataResponse Class
Contains the results returned by the ImageryServiceClient.GetImageryMetadata Method. This class inherits from the ResponseBase Class. Syntax public class ImageryMetadataResponse : ResponseBase Public Class ImageryMetadataResponse Inherits ResponseBase Constructor
Name Description

ImageryMetadataResponse

Initializes a new instance of an ImageryMetadataResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) 79

Name

Description

ResponseSummary

A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) An ImageryMetadataResult Class array, where each element contains imagery metadata information returned by the Imagery Service.

Results

See Also ImageryServiceClient.GetImageryMetadata Method ImageryMetadataResponse Constructor Initializes a new instance of the ImageryMetadataResponse Class. Syntax public ImageryMetadataResponse() Public Sub New ImageryMetadataResponse Properties The properties of the ImageryMetadataResponse class are listed here. For a complete list of ImageryMetadataResponse class members, see the ImageryMetadataResponse Class topic. Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) An ImageryMetadataResult Class array, where each element contains imagery metadata information returned by the Imagery Service.

ResponseSummary

Results

ImageryMetadataResponse.Results Property An ImageryMetadataResult Class array, where each element contains imagery metadata information returned by the Imagery Service. Get this property from the service response. Syntax public ImageryMetadataResult[] Results { set; get; } 80

Public Property Results As ImageryMetadataResult() Remarks If there are no results to return, the Results property will be an empty array. If the service request is invalid, the Results property will be null.

ImageryMetadataResult Class
Contains detailed information about a specific image, including vintage data and URIs. Syntax public class ImageryMetadataResult Public Class ImageryMetadataResult Constructor
Name Description

ImageryMetadataResult

Initializes a new instance of an ImageryMetadataResult object.

Public Properties
Name Description

ImageryProviders ImageSize ImageUri ImageUriSubdomains

An ImageryProvider Class array that specifies the vendors that provided the imagery data. A SizeOfint Class object specifying the height and width of the image. A string specifying the URI for the image. A string array, where each element specifies a sub-domain that can be used to construct a URI for the image. A RangeOfdateTime Class object specifying a time frame when the image was created. A RangeOfint Class object specifying a zoom range that the image supports.

Vintage ZoomRange

81

See Also ImageryMetadataResponse.Results Property ImageryMetadataResult Constructor Initializes a new instance of the ImageryMetadataResult Class. Syntax public ImageryMetadataResult() Public Sub New ImageryMetadataResult Properties The properties of the ImageryMetadataResult class are listed here. For a complete list of ImageryMetadataResult class members, see the ImageryMetadataResult Class topic. Public Properties
Name Description

ImageryProviders ImageSize ImageUri ImageUriSubdomains

An ImageryProvider Class array that specifies the vendors that provided the imagery data. A SizeOfint Class object specifying the height and width of the image. A string specifying the URI for the image. A string array, where each element specifies a sub-domain that can be used to construct a URI for the image. A RangeOfdateTime Class object specifying a time frame when the image was created. A RangeOfint Class object specifying a zoom range that the image supports.

Vintage ZoomRange

ImageryMetadataResult.ImageryProviders Property An ImageryProvider Class array that specifies the vendors that provided the imagery data. Get this property from the service response. Syntax public ImageryProvider[] ImageryProviders { set; get; } Public Property ImageryProviders As ImageryProvider() Remarks The ImageryProviders property contains the imagery data providers for the map style specified in the ImageryMetadataRequest.Style Property. If imagery metadata is needed for two different map styles, two GetImageryMetadata requests need to be made. 82

ImageryMetadataResult.ImageSize Property A SizeOfint Class object specifying the height and width of the image. Get this property from the service response. Syntax public SizeOfint ImageSize { set; get; } Public Property ImageSize As SizeOfint ImageryMetadataResult.ImageUri Property A string specifying the URI for the image. Get this property from the service response. Syntax public string ImageUri { set; get; } Public Property ImageUri As String Remarks The URI returned in the ImageUri property may contain placeholders that must be supplied before the URI is used. The table below lists the possible placeholders.

83

URI Placeholder

Description

{culture}

The culture of the map. A list of supported culture strings is in the RequestBase.Culture Property topic. The quadkey of the tile. For information about quadkeys, see the Bing Maps Tile System article in the Bing Maps Articles. The sub-domain to use to retrieve tiles to allow maximum performance for network calls. The valid values are t0, t1, t2, or t3. The ID of the tile. Information about tile IDs is found in the Understanding Tiles topic.

{quadkey}

{subdomain}

{tileId} {token}

If you are using Bing Maps Keys, you can ignore the {token} string because this is a legacy item and is not processed as part of the URI. This item will be removed in future versions of the Bing Maps SOAP Services. The client token of the requestor, if one exists. {zoom} The zoom level of the map.

If the UserProfile.DeviceType Property specified is Mobile, then the ImageUri property contains a URI for a map designed for mobile devices. This only applies to the AerialWithLabels and Road map styles.

See Also ImageryServiceClient.GetMapUri Method Understanding Tiles ImageryMetadataResult.ImageUriSubdomains Property A string array, where each element specifies a sub-domain that can be used to construct a URI for the image. Get this property from the service response. Syntax public string[] ImageUriSubdomains { set; get; } Public Property ImageUriSubdomains As String() See Also 84

ImageryServiceClient.GetMapUri Method ImageryMetadataResult.Vintage Property A RangeOfdateTime Class object specifying a time frame when the image was created. Get this property from the service response. Syntax public RangeOfdateTime Vintage { set; get; } Public Property Vintage As RangeOfdateTime ImageryMetadataResult.ZoomRange Property A RangeOfint Class object specifying a zoom range that the image supports. Get this property from the service response. Syntax public RangeOfint ZoomRange { set; get; } Public Property ZoomRange As RangeOfint Remarks The range specified in the ZoomRange property is inclusive, meaning the zoom levels specified in the From and To properties of the ZoomRange are supported for the image.

ImageryProvider Class
Represents a vendor that provides imagery data. Syntax public class ImageryProvider Public Class ImageryProvider Constructor
Name Description

ImageryProvider

Initializes a new instance of an ImageryProvider object.

Public Properties
Name Description

Attribution

A string containing copyright and credit 85

Name

Description

information for the imagery data. CoverageAreas A CoverageArea Class array containing the geographical areas and zoom levels covered by the imagery provider.

See Also ImageryMetadataResult.ImageryProviders Property ImageryProvider Constructor Initializes a new instance of the ImageryProvider Class. Syntax public ImageryProvider() Public Sub New ImageryProvider Properties The properties of the ImageryProvider class are listed here. For a complete list of ImageryProvider class members, see the ImageryProvider Class topic. Public Properties
Name Description

Attribution CoverageAreas

A string containing copyright and credit information for the imagery data. A CoverageArea Class array containing the geographical areas and zoom levels covered by the imagery provider.

See Also ImageryMetadataResult.ImageryProviders Property ImageryProvider.Attribution Property A string containing copyright and credit information for the imagery data. Get this property from the service response. Syntax public string Attribution { set; get; } Public Property Attribution As String ImageryProvider.CoverageAreas Property 86

A CoverageArea Class array containing the geographical areas covered by the imagery provider. Get this property from the service response. Syntax public CoverageArea[] CoverageAreas { set; get; } Public Property CoverageAreas As CoverageArea()

ImageryServiceClient Class
Contains the methods used to make requests to the Imagery Service. Note The name of this class and its constructor may be different depending on the tool you use to generate the client proxy classes. Syntax public class ImageryServiceClient : System.ServiceModel.ClientBase<IImageryService> Public Class ImageryServiceClient Inherits System.ServiceModel.ClientBase(Of IImageryService) Constructor
Name Description

ImageryServiceClient

Initializes a new instance of an ImageryServiceClient object.

Public Methods
Name Description

GetImageryMetadata GetMapUri

Retrieves metadata for imagery hosted by Bing Maps. Retrieves a URI that can be used to access a static map image.

ImageryServiceClient Constructor Initializes a new instance of the ImageryServiceClient Class. Syntax public ImageryServiceClient()

87

Public Sub New Syntax public ImageryServiceClient(string endpointConfigurationName) Public Sub New(ByVal endpointConfigurationName As String) Syntax public ImageryServiceClient(string endpointConfigurationName, string remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String) Syntax public ImageryServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Syntax public ImageryServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Parameters endpointConfigurationName binding remoteAddress Remarks The Imagery service provides endpoints for Basic HTTP and Binary over HTTP configurations. When you create a proxy for your application, references to both endpoints are added to your application. Therefore, you must specify the endpoint you want to use. To specify the endpoint, use the following endpoint configuration names.
Endpoint Configuration Type Endpoint Configuration Name

The endpoint for a service that allows clients to find and communicate with the service. The binding with which to make calls to the service. The address of the service endpoint.

Basic HTTP Binary over HTTP Example

BasicHttpBinding_IImageryService CustomBinding_IImageryService

Create an ImageryServiceClient object that uses the binary over HTTP endpoint. 88

ImageryService.ImageryServiceClient ImageryService = new ImageryService.ImageryServiceClient("CustomBinding_IImageryService"); Dim ImageryServiceInstance As New ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService")

See Also System.ServiceModel.ClientBase.ClientBase(TChannel) Constructor ImageryServiceClient Methods The methods of the ImageryServiceClient class are listed here. For a complete list of ImageryServiceClient class members, see the ImageryServiceClient Class topic. Public Methods
Name Description

GetImageryMetadata GetMapUri

Retrieves metadata for imagery hosted by Bing Maps. Retrieves a URI that can be used to access a static map image.

ImageryServiceClient.GetImageryMetadata Method Retrieves metadata for imagery hosted by Bing Maps. Syntax public ImageryMetadataResponse GetImageryMetadata(ImageryMetadataRequest request) Public Function GetImageryMetadata(ByVal request As ImageryMetadataRequest) As ImageryMetadataResponse Parameters request An ImageryMetadataRequest object that contains the header and parameter information for the service operation.

Return Value Returns an ImageryMetadataResponse Class, which contains an ImageryMetadataResult Class array. Remarks

89

The ImageryProviders property contains the imagery data providers for the map style specified in the VEImageryMetadataOptions.MapStyle Property. If imagery metadata is needed for two different map styles, two GetImageryMetadata requests need to be made. Example Code
private void RequestImageryMetadata() { string Results = ""; try { // Set a Bing Maps key before making a request string key = "Bing Maps Key";

ImageryService.ImageryMetadataRequest metadataRequest = new ImageryService.ImageryMetadataRequest();

// Set credentials using a valid Bing Maps Key metadataRequest.Credentials = new ImageryService.Credentials(); metadataRequest.Credentials.ApplicationId = key;

// Set the imagery metadata request options ImageryService.Location centerLocation = new ImageryService.Location(); centerLocation.Latitude = 47.65; centerLocation.Longitude = -122.24;

metadataRequest.Options = new ImageryService.ImageryMetadataOptions(); metadataRequest.Options.Location = centerLocation; metadataRequest.Options.ZoomLevel = 10;

metadataRequest.Style = ImageryService.MapStyle.AerialWithLabels_v1;

// Make the imagery metadata request ImageryService.ImageryServiceClient imageryService = new ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService");

90

ImageryService.ImageryMetadataResponse metadataResponse = imageryService.GetImageryMetadata(metadataRequest);

Results = "The image requested was created between " + metadataResponse.Results[0].Vintage.From.ToString() + " and " + metadataResponse.Results[0].Vintage.To.ToString();

} catch (Exception ex) { Results = "An exception occurred: " + ex.Message;

} }

Code
Private Sub RequestImageryMetadata() Dim Results As String Try ' Set a Bing Maps key before making a request Dim key = "Bing Maps Key"

Dim metadataRequest As New ImageryService.ImageryMetadataRequest()

' Set credentials using a valid Bing Maps Key metadataRequest.Credentials = _ New ImageryService.Credentials() With {.ApplicationId = key}

' Set the imagery metadata request options Dim centerLocation As New ImageryService.Location() _ With {.Latitude = 47.65, .Longitude = -122.24}

metadataRequest.Options = New ImageryService.ImageryMetadataOptions() _ With {.Location = centerLocation, .ZoomLevel = 10}

91

metadataRequest.Style = ImageryService.MapStyle.AerialWithLabels_v1

' Make the imagery metadata request Dim ImageryServiceInstance As New ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService") Dim metadataResponse = ImageryServiceInstance.GetImageryMetadata(metadataRequest)

Results = "The image requested was created between " &amp; _ metadataResponse.Results(0).Vintage.From &amp; " and " &amp; _ metadataResponse.Results(0).Vintage.To

Catch ex As Exception Results = "An exception occurred: " &amp; ex.Message End Try End Sub

See Also ImageryServiceClient.GetMapUri Method Understanding Tiles ImageryServiceClient.GetMapUri Method Retrieves a URI that can be used to access a static map image. Syntax public MapUriResponse GetMapUri(MapUriRequest request) Public Function GetMapUri(ByVal request As MapUriRequest) As MapUriResponse Parameters request A MapUriRequest object that contains the header and parameter information for the service operation.

Return Value Returns a MapUriResponse Class, which contains a URI to a static map image. Examples
private void RequestImage() { string Results="";

92

try { // Set a Bing Maps key before making a request string key = "Bing Maps Key";

ImageryService.MapUriRequest mapUriRequest = new ImageryService.MapUriRequest();

// Set credentials using a valid Bing Maps Key mapUriRequest.Credentials = new ImageryService.Credentials(); mapUriRequest.Credentials.ApplicationId = key;

// Set the location of the requested image mapUriRequest.Center = new ImageryService.Location(); mapUriRequest.Center.Latitude = 47.65; mapUriRequest.Center.Longitude = -122.24;

// Set the map style and zoom level ImageryService.MapUriOptions mapUriOptions = new ImageryService.MapUriOptions(); mapUriOptions.Style = ImageryService.MapStyle.AerialWithLabels_v1; mapUriOptions.ZoomLevel = 10;

// Set the size of the requested image to match the size of the image control mapUriOptions.ImageSize = new ImageryService.SizeOfint(); mapUriOptions.ImageSize.Height = 400; mapUriOptions.ImageSize.Width = 600;

mapUriRequest.Options = mapUriOptions;

ImageryService.ImageryServiceClient imageryService = new ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService");

// Make the image request ImageryService.MapUriResponse mapUriResponse = imageryService.GetMapUri(mapUriRequest);

93

string mapUri = mapUriResponse.Uri;

// Set the image control URL to the returned image URI Results = mapUri;

} catch (Exception ex) { Results = "An exception occurred: " + ex.Message;

Private Sub RequestImage() Dim Results As String Try ' Set a Bing Maps key before making a request

Dim key = "Bing Maps Key"

Dim mapUriRequest As New ImageryService.MapUriRequest()

' Set credentials using a valid Bing Maps Key mapUriRequest.Credentials = _ New ImageryService.Credentials() With {.ApplicationId = key}

' Set the location of the requested image mapUriRequest.Center = _ New ImageryService.Location() With {.Latitude = 47.65, .Longitude = -122.24}

' Set the map style and zoom level

94

Dim mapUriOptions As New ImageryService.MapUriOptions() _ With {.Style = imageryService.MapStyle.AerialWithLabels_v1, .ZoomLevel = 10}

' Set the size of the requested image to match the size of the image control mapUriOptions.ImageSize = New ImageryService.SizeOfint() _ With {.Height = 400, .Width = 600}

mapUriRequest.Options = mapUriOptions

Dim ImageryServiceInstance As New ImageryService.ImageryServiceClient("BasicHttpBinding_IImageryService")

' Make the image request Dim mapUriResponse = ImageryServiceInstance.GetMapUri(mapUriRequest) Dim mapUri = mapUriResponse.Uri

' Set the image control URL to the returned image URI Results = mapUri

Catch ex As Exception Results = "An exception occurred: " &amp; ex.Message End Try

End Sub

See Also ImageryServiceClient.GetImageryMetadata Method Understanding Tiles

ImageType Enumeration
Contains image format types. Syntax public enum ImageType Public Enum ImageType 95

Members
Member Description

Default Gif Jpeg Png

The default format type. The image format is GIF. The image format is JPEG. The image format is PNG.

See Also MapUriOptions.ImageType Property

MapStyle Enumeration
Contains map styles. Syntax public enum MapStyle Public Enum MapStyle Members

Bing Maps has introduced a new "road" map style for all Bing Maps APIs that is designed for improved readability and improved interaction between imagery with data overlays. This map style is in use on http://www.bing.com/maps and starting November 2010, you can opt-in to the new map style when you use the Bing Maps APIs. This opt-in period will end on April 30, 2011. On May 1, 2011, the new map style will become the only style available. To opt-in and use the new map style, use the enumeration values that have a "_v1" extension. The enumeration values without the "_v0" or "_v1" extension provide the same map style as the _v0 extension. When the opt-in period ends, all enumeration values will use the new map style.
Member Description

Aerial Aerial_v0 Aerial_v1

The aerial imagery map style. The aerial imagery map style. The aerial imagery that is part of the new map 96

Member

Description

style. AerialWithLabels AerialWithLabels_v0 AerialWithLabels_v1 Birdseye Birdseye_v0 Birdseye_v1 BirdseyeWithLabels BirdseyeWithLabels_v0 BirdseyeWithLabels_v1 Road Road_v0 Road_v1 The aerial imagery map style with a road overlay. The aerial imagery map style with a road overlay. The aerial imagery map style with a road overlay that is part of the new map style. The bird's eye (oblique-angle) imagery map style The bird's eye (oblique-angle) imagery map style The bird's eye (oblique-angle) imagery that is part of the new map style. The bird's eye imagery map style with a road overlay. The bird's eye imagery map style with a road overlay. The bird's eye imagery map style with a road overlay that is part of the new map style. The road map style. The road map style. The road map style that is part of the new map style.

See Also ImageryMetadataRequest.Style Property MapUriOptions.Style Property

MapUriOptions Class
Contains the options for refining the map URI request. Syntax public class MapUriOptions 97

Public Class MapUriOptions Constructor

Name Description

MapUriOptions

Initializes a new instance of a MapUriOptions object.

Public Properties
Name Description

DisplayLayers

A string array indicating the layer data to display on the map. Optional. The default value is null. A SizeOfint Class object specifying the height and width of the image to return. Optional. The default width is 350 and the default height is 350. An ImageType Enumeration value specifying the format of the image to return. Optional. The default value is ImageType.Default, which means the default changes depending on the map style specified. A bool indicating whether or not to separate pushpin icons that are close to each other on the map so that they are more visible. Optional. The default value is false. A MapStyle Enumeration value specifying the map style of the image to return. Optional. The default value is MapStyle.Road. A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. An int indicating the zoom level of the map to return. Optional.

ImageSize

ImageType

PreventIconCollision

Style

UriScheme

ZoomLevel

98

See Also MapUriRequest.Options Property MapUriOptions Constructor Initializes a new instance of the MapUriOptions Class. Syntax public MapUriOptions() Public Sub New MapUriOptions Properties The properties of the MapUriOptions class are listed here. For a complete list of MapUriOptions class members, see the MapUriOptions Class topic. Public Properties
Name Description

DisplayLayers

A string array indicating the layer data to display on the map. Optional. The default value is null. A SizeOfint Class object specifying the height and width of the image to return. Optional. The default width is 350 and the default height is 350. An ImageType Enumeration value specifying the format of the image to return. Optional. The default value is ImageType.Default, which means the default changes depending on the map style specified. A bool indicating whether or not to separate pushpin icons that are close to each other on the map so that they are more visible. Optional. The default value is false. A MapStyle Enumeration value specifying the map style of the image to return. Optional. The default value is MapStyle.Road. A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. 99

ImageSize

ImageType

PreventIconCollision

Style

UriScheme

Name

Description

ZoomLevel

An int indicating the zoom level of the map to return. Optional.

MapUriOptions.DisplayLayers Property A string array indicating the layer data to display on the map. Optional. The default value is null. Set this property before making a service request. Syntax public string[] DisplayLayers { set; get; } Public Property DisplayLayers As String() Remarks The following table lists strings that can be specified in the DisplayLayers property.
DisplayLayer Description

"TrafficFlow" MapUriOptions.ImageSize Property

Displays traffic information for major roads.

A SizeOfint Class object specifying the height and width of the image to return. Optional. The default width is 350 and the default height is 350. Set this property before making a service request. Syntax public SizeOfint ImageSize { set; get; } Public Property ImageSize As SizeOfint Remarks The Height property value of the SizeOfint object specified in the ImageSize property can range from 80 to 834. The Width property value of the SizeOfint object specified in the ImageSize property can range from 80 to 900. MapUriOptions.ImageType Property An ImageType Enumeration value specifying the format of the image to return. Optional. The default value is ImageType.Default, which means the default changes depending on the map style specified. Set this property before making a service request. Syntax public ImageType ImageType { set; get; } 100

Public Property ImageType As ImageType Remarks The default value of the ImageType property is ImageType.Default. This means that if the MapUriOptions.Style Property specifies: Road imagery, then the ImageType property will default to Png. Aerial imagery, then the ImageType property will default to Jpeg. AerialWithLabels imagery, then the ImageType property will default to Jpeg.

See Also MapStyle Enumeration MapUriOptions.PreventIconCollision Property A bool indicating whether or not to separate pushpin icons that are close to each other on the map so that they are more visible. Optional. The default value is false. Set this property before making a service request. Syntax public bool PreventIconCollision { set; get; } Public Property PreventIconCollision As Boolean Remarks If the PreventIconCollision property is set to true, then overlapping pushpin icons are separated and each pushpin is drawn on the map where there is more space. Additionally, a line is drawn from the new pushpin to the location on the map where the pushpin would have originally been placed. This pushpin display style is referred to as "icon on a stick." If the PreventIconCollision property is set to true, then only pushpin icons with the following Pushpin.IconStyle Property values are affected: 13, 14, 15, and 16. See Also MapUriRequest.Pushpins Property MapUriOptions.Style Property A MapStyle Enumeration value specifying the map style of the image to return. Optional. The default value is MapStyle.Road. Set this property before making a service request. Syntax public MapStyle Style { set; get; } Public Property Style As MapStyle Remarks The default image type returned depends on the map style specified in the MapStyle property. See the MapUriOptions.ImageType Property topic for more information. The Birdseye and BirdseyeWithLabels map styles are not supported. 101

MapUriOptions.UriScheme Property A UriScheme Enumeration value specifying the URI scheme to return. Optional. The default value is UriScheme.Http. Set this property before making a service request. Syntax public UriScheme UriScheme { set; get; } Public Property UriScheme As UriScheme MapUriOptions.ZoomLevel Property An int indicating the zoom level of the map to return. Optional. Set this property before making a service request. Syntax public int ZoomLevel { set; get; } Public Property ZoomLevel As Integer Remarks The valid range of values for the ZoomLevel property is 1 to 21. If the ZoomLevel property is not specified, Bing Maps sets the zoom level to the best level for the image requested.

MapUriRequest Class
Contains the properties needed to make a GetMapUri service request. This class inherits from the RequestBase Class. Syntax public class MapUriRequest : RequestBase Public Class MapUriRequest Inherits RequestBase Constructor
Name Description

MapUriRequest

Initializes a new instance of a MapUriRequest object.

Public Properties

102

Name

Description

Center

A Location Class object specifying the coordinates of the center of the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A Location Class object specifying the location that should be used if four major routes to that location should be displayed on the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A MapUriOptions Class object containing properties for refining the map URI request. Optional. A Pushpin Class array containing the pushpins to display on the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Credentials

Culture

ExecutionOptions

MajorRoutesDestination

Options

Pushpins

UserProfile

MapUriRequest Constructor Initializes a new instance of the MapUriRequest Class. Syntax public MapUriRequest() 103

Public Sub New MapUriRequest Properties The properties of the MapUriRequest class are listed here. For a complete list of MapUriRequest class members, see the MapUriRequest Class topic. Public Properties
Name Description

Center

A Location Class object specifying the coordinates of the center of the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A Location Class object specifying the location that should be used if four major routes to that location should be displayed on the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A MapUriOptions Class object containing properties for refining the map URI request. Optional. A Pushpin Class array containing the pushpins to display on the map. Optional. The Center, MajorRoutesDestination, or Pushpins property must be defined. A UserProfile Class object containing user information helpful in service calculations. 104

Credentials

Culture

ExecutionOptions

MajorRoutesDestination

Options

Pushpins

UserProfile

Name

Description

Optional. (Inherited from the RequestBase Class.) See Also ImageryServiceClient.GetMapUri Method MapUriRequest.Center Property A Location Class object specifying the coordinates of the center of the map. Optional. Set this property before making a service request. Syntax public Location Center { set; get; } Public Property Center As Location Remarks The Center, MajorRoutesDestination, or Pushpins property must be defined for the MapUriRequest to be valid. The minimum latitude value for the Center property is -85. The maximum latitude value is 85. MapUriRequest.MajorRoutesDestination Property A Location Class object specifying the location that should be used if four major routes to that location should be displayed on the map. Optional. Set this property before making a service request. Syntax public Location MajorRoutesDestination { set; get; } Public Property MajorRoutesDestination As Location Remarks The Center, MajorRoutesDestination, or Pushpins property must be defined for the MapUriRequest to be valid. If the MajorRoutesDestination property is not specified, major routes will not be displayed on the map. The minimum latitude value for the MajorRoutesDestination property is -85. The maximum latitude value is 85. MapUriRequest.Options Property A MapUriOptions Class object containing properties for refining the map URI request. Optional. Set this property before making a service request. Syntax public MapUriOptions Options { set; get; } Public Property Options As MapUriOptions MapUriRequest.Pushpins Property 105

A Pushpin Class array containing the pushpins to display on the map. Optional. Set this property before making a service request. Syntax public Pushpin[] Pushpins { set; get; } Public Property Pushpins As Pushpin() Remarks The Center, MajorRoutesDestination, or Pushpins property must be defined for the MapUriRequest to be valid. If the Pushpins property is not specified, pushpins will not be displayed on the map. The maximum number of pushpins that can be displayed on the map is 18. The minimum latitude value for the Pushpin.Location Property of each pushpin in the Pushpins property is -85. The maximum latitude value is 85.

MapUriResponse Class
Contains the URI returned by the ImageryServiceClient.GetMapUri Method. This class inherits from the ResponseBase Class. Syntax public class MapUriResponse : ResponseBase Public Class MapUriResponse Inherits ResponseBase Constructor
Name Description

MapUriResponse

Initializes a new instance of a MapUriResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. 106

ResponseSummary

Name

Description

(Inherited from the ResponseBase Class.) Uri A string that is the URI of the requested map.

See Also ImageryServiceClient.GetMapUri Method MapUriResponse Constructor Initializes a new instance of the MapUriResponse Class. Syntax public MapUriResponse() Public Sub New MapUriResponse Properties The properties of the MapUriResponse class are listed here. For a complete list of MapUriResponse class members, see the MapUriResponse Class topic. Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A string that is the URI of the requested map.

ResponseSummary

Uri MapUriResponse.Uri Property

A string that is the URI of the requested map. Get this property from the service response. Syntax public string Uri { set; get; } Public Property Uri As String Remarks The URI returned in the ImageUri property may contain placeholders that must be supplied before the URI is used. The table below lists the possible placeholders.

107

URI Placeholder

Description

{culture} {token}

The culture you want to use to display labels and other text.

If you are using Bing Maps Keys, you can ignore the &token={token} string in the ImageUrl field because this is a legacy item and is not processed as part of the HTTP request. This item will be removed in future versions of the Bing Maps SOAP Services. The client token of the requestor, if one exists The URI returned in the Uri property is a link to a static image. The Uri property is null if the service request was invalid.

See Also ImageryMetadataResult.ImageUri Property Understanding Tiles

UriScheme Enumeration
Contains values that specify URI scheme. Syntax public enum UriScheme Public Enum UriScheme Members
Member Description

Http Https

The URI begins with "http". The URI begins with "https".

108

Route Service
The Bing Maps Route Service is comprised of classes and enumerations that allow you to calculate route directions to and from multiple locations on a map.

In This Section
The Bing Maps Route Service contains the following classes and enumerations. Web Service Class
Class or Enumeration Description

RouteServiceClient Class

Contains the methods used to make requests to the Route Service.

Note The web service class name may be different depending on the tool you use to generate the client proxy classes. Classes and Enumerations
Class or Enumeration Description

ItineraryItem Class ItineraryItemHint Class ItineraryItemHintType Enumeration

Contains the properties that define one step of a route. Contains properties that provide extra information to help follow the route instruction. Contains route hint types used to determine what type of hint is described in the ItineraryItemHint.Text Property. Contains details about road conditions that may affect the route. Contains levels of impact that the warning has on the route. Contains types of warnings that occur along a route. Contains properties used to refine a CalculateRoutesFromMajorRoads service request. This class inherits from the RouteOptions Class. Contains the properties needed to make a CalculateRoutesFromMajorRoads service 109

ItineraryItemWarning Class ItineraryWarningSeverity Enumeration ItineraryWarningType Enumeration MajorRoutesOptions Class

MajorRoutesRequest Class

Class or Enumeration

Description

request. This class inherits from the RequestBase Class. MajorRoutesResponse Class Contains the results returned from a CalculateRoutesFromMajorRoads service request. This class inherits from the RequestBase Class. Contains values that represent route maneuvers. Represents a leg of a route. A route leg is a portion of a route between two waypoints. Contains values that represent route calculation methods. Contains properties used to refine a route service request. Represents the raw calculated route data. Contains route path types to return. A route path is the set of points that define the exact shape of the route. Contains the properties needed to make a CalculateRoute request. This class inherits from the RequestBase Class. Contains the result returned from CalculateRoute request. This class inherits from the RequestBase Class. Represents a calculated route. Contains route summary information, such as total distance and time. Contains values indicating how to use traffic information in the route calculation. Contains travel modes for a route. Represents a stop in route.

ManeuverType Enumeration RouteLeg Class RouteOptimization Enumeration RouteOptions Class RoutePath Class RoutePathType Enumeration

RouteRequest Class

RouteResponse Class

RouteResult Class RouteSummary Class TrafficUsage Enumeration TravelMode Enumeration Waypoint Class

ItineraryItem Class
Contains the properties that define one step of a route. 110

Syntax public class ItineraryItem : System.Object Public Class ItineraryItem Inherits System.Object Constructor
Name Description

ItineraryItem

Initializes a new instance of an ItineraryItem object.

Public Properties
Name Description

CompassDirection Hints Location ManeuverType

A string indicating the compass direction of travel. An ItineraryItemHint Class array containing the hints with the itinerary item. A Location Class defining the location of the start of the itinerary item. A ManeuverType Enumeration value indicating the type of instruction described in the ItineraryItem.Text Property. A RouteSummary Class object containing summary properties for the itinerary item. A string describing the route instruction. An ItineraryItemWarning Class array containing the warnings associated with the itinerary item.

Summary Text Warnings

See Also RouteLeg.Itinerary Property ItineraryItem Constructor Initializes a new instance of the ItineraryItem Class. Syntax public ItineraryItem() Public Sub New

111

ItineraryItem Properties The properties of the ItineraryItem class are listed here. For a complete list of ItineraryItem class members, see the ItineraryItem Class topic. Public Properties
Name Description

CompassDirection Hints Location ManeuverType

A string indicating the compass direction of travel. An ItineraryItemHint Class array containing the hints with the itinerary item. A Location Class defining the location of the start of the itinerary item. A ManeuverType Enumeration value indicating the type of instruction described in the ItineraryItem.Text Property. A RouteSummary Class object containing summary properties for the itinerary item. A string describing the route instruction. An ItineraryItemWarning Class array containing the warnings associated with the itinerary item.

Summary Text Warnings

ItineraryItem.CompassDirection Property A string indicating the compass direction of travel. Get this property from the service response. Syntax public string CompassDirection { set; get; } Public Property CompassDirection As String Remarks The CompassDirection property is returned in the language specified in the RequestBase.Culture Property. The default Culture is "en-US", and the corresponding CompassDirection values are "North", "Northeast", "East", "Southeast", "South", "Southwest", "West", and "Northwest". ItineraryItem.Hints Property An ItineraryItemHint Class array containing the hints with the itinerary item. Get this property from the service response. Syntax public ItineraryItemHint[] Hints { set; get; } Public Property Hints As ItineraryItemHint() 112

ItineraryItem.Location Property A Location Class defining the location of the start of the itinerary item. Get this property from the service response. Syntax public Location Location { set; get; } Public Property Location As Location ItineraryItem.ManeuverType Property A ManeuverType Enumeration value indicating the type of instruction described in the ItineraryItem.Text Property. Get this property from the service response. Syntax public ManeuverType ManeuverType { set; get; } Public Property ManeuverType As ManeuverType ItineraryItem.Summary Property A RouteSummary Class object containing summary properties for the itinerary item. Get this property from the service response. Syntax public Summary Summary { set; get; } Public Property Summary As Summary ItineraryItem.Text Property A string describing the route instruction. Get this property from the service response. Syntax public string Text { set; get; } Public Property Text As String Remarks For routes within North America and Europe, HTML tags are returned along with the route instructions in the Text property. ItineraryItem.Warnings Property An ItineraryItemWarning Class array containing the warnings associated with the itinerary item. Get this property from the service response. Syntax public ItineraryItemWarning[] Warnings { set; get; } Public Property Warnings As ItineraryItemWarning()

ItineraryItemHint Class
Contains properties that provide extra information to help follow the route instruction.

113

Syntax public class ItineraryItemHint : System.Object Public Class ItineraryItemHint Inherits System.Object Constructor
Name Description

ItineraryItemHint

Initializes a new instance of an ItineraryItemHint object.

Public Properties
Name Description

HintType

An ItineraryItemHintType Enumeration value specifying the type of hint described in the ItineraryItemHint.Text Property. A string describing the hint associated with the route itinerary item.

Text

See Also ItineraryItem.Hints Property ItineraryItemHint Constructor Initializes a new instance of the ItineraryItemHint Class. Syntax public ItineraryItemHint() Public Sub New ItineraryItemHint Properties The properties of the ItineraryItemHint class are listed here. For a complete list of ItineraryItemHint class members, see the ItineraryItemHint Class topic. Public Properties
Name Description

HintType

An ItineraryItemHintType Enumeration value specifying the type of hint described in the ItineraryItemHint.Text Property. A string describing the hint associated with the 114

Text

Name

Description

route itinerary item. ItineraryItemHint.HintType Property An ItineraryItemHintType Enumeration value specifying the type of hint described in the ItineraryItemHint.Text Property. Get this property from the service response. Syntax public ItineraryItemHintType HintType { set; get; } Public Property HintType As ItineraryItemHintType See Also ItineraryItem.Hints Property ItineraryItemHint.Text Property A string describing the hint associated with the route itinerary item. Get this property from the service response. Syntax public string Text { set; get; } Public Property Text As String See Also ItineraryItemHint.HintType Property

ItineraryItemHintType Enumeration
Contains route hint types used to determine what type of hint is described in the ItineraryItemHint.Text Property. Syntax public enum ItineraryItemHintType Public Enum ItineraryItemHintType Members
Name Description

Landmark NextIntersection PreviousIntersection

The hint is a landmark that helps to identify the next maneuver. The hint indicates the next intersection seen if the turn was missed. The hint indicates the intersection seen before a turn. 115

See Also ItineraryItemHint.HintType Property

ItineraryItemWarning Class
Contains details about road conditions that may affect the route. Syntax public class ItineraryItemWarning : System.Object Public Class ItineraryItemWarning Inherits System.Object Constructor
Name Description

ItineraryItemWarning

Initializes a new instance of an ItineraryItemWarning object.

Public Properties
Name Description

Severity

An ItineraryWarningSeverity Enumeration value indicating the level of impact that the warning has on the route. A string describing the warning. An ItineraryWarningType Enumeration value indicating the type of warning described in the ItineraryItemWarning.Text Property.

Text WarningType

See Also ItineraryItem.Warnings Property ItineraryItemWarning Constructor Initializes a new instance of the ItineraryItemWarning Class. Syntax public ItineraryItemWarning() Public Sub New ItineraryItemWarning Properties The properties of the ItineraryItemWarning class are listed here. For a complete list of ItineraryItemWarning class members, see the ItineraryItemWarning Class topic. 116

Public Properties
Name Description

Severity

An ItineraryWarningSeverity Enumeration value indicating the level of impact that the warning has on the route. A string describing the warning. An ItineraryWarningType Enumeration value indicating the type of warning described in the ItineraryItemWarning.Text Property.

Text WarningType

See Also ItineraryItem.Warnings Property ItineraryItemWarning.Severity Property An ItineraryWarningSeverity Enumeration value indicating the level of impact that the warning has on the route. Get this property from the service response. Syntax public ItineraryWarningSeverity Severity { set; get; } Public Property Severity As ItineraryWarningSeverity ItineraryItemWarning.Text Property A string describing the warning. Get this property from the service response. Syntax public string Text { set; get; } Public Property Text As String ItineraryItemWarning.WarningType Property An ItineraryWarningType Enumeration value indicating the type of warning described in the ItineraryItemWarning.Text Property. Get this property from the service response. Syntax public ItineraryWarningType WarningType { set; get; } Public Property WarningType As ItineraryWarningType

ItineraryWarningSeverity Enumeration
Contains levels of impact that the warning has on the route. Syntax public enum ItineraryWarningSeverity Public Enum ItineraryWarningSeverity 117

Members
Member

None LowImpact Minor Moderate Serious

A warning which has no impact on the route A warning which has low impact on the route A minor route warning A moderate route warning A serious route warning

See Also ItineraryWarningType Enumeration

ItineraryWarningType Enumeration
Contains types of warnings that occur along a route. Syntax public enum ItineraryWarningType Public Enum ItineraryWarningType Members
Member Description

Accident AdminDivisionChange BlockedRoad CheckTimetable Congestion CountryChange DisabledVehicle GateAccess GetOffTransit

There is a car accident. The route has left one administrative division and entered another. The road is blocked. Check a time table. This usually refers to a ferry time table. The traffic is slow. The route has left one country and entered another. There is a disabled vehicle. A gate blocks the road and access is required to continue along the route. Get off the transit at this location. 118

Member

Description

GetOnTransit IllegalUTurn MassTransit Miscellaneous NoIncident None Other OtherNews OtherTrafficIncidents PlannedEvents PrivateRoad RestrictedTurn RoadClosures RoadHazard ScheduledConstruction SeasonalClosures Tollbooth TollRoad TrafficFlow UnpavedRoad UnscheduledConstruction Weather

Get on the transit at this location. A U-turn is illegal at this location. Use mass transit at this location. A miscellaneous warning is available for this location. There is no incident at this location. There is no warning at this location. There is a warning at this location that can not be classified as any other type of warning. There is news about this location. There are other traffic incidents at this location. There are scheduled events that may disrupt the route. The road being travelled on is private. The turn is restricted depending on the time of day. There are road closures at this location. There is a road hazard. There is scheduled construction. A seasonal closure occurs at this location. A toll is required at this location to continue along the route. The road being travelled on is a toll road. The warning is a traffic warning. The road being travelled on is unpaved. There is construction at this location. There is significant weather at this location.

119

MajorRoutesOptions Class
Contains properties used to refine a CalculateRoutesFromMajorRoads service request. This class inherits from the RouteOptions Class. Syntax public class MajorRoutesOptions : RouteOptions Public Class MajorRoutesOptions Inherits RouteOptions Constructor
Name Description

MajorRoutesOptions

Initializes a new instance of a MajorRoutesOptions object.

Public Properties
Name Description

Mode

A TravelMode Enumeration value specifying the type of directions to return. Optional. The default value is TravelMode.Driving. (Inherited from the RouteOptions Class.) A RouteOptimization Enumeration value specifying the calculation method to use. Optional. The default value is RouteOptimization.MinimizeTime. (Inherited from the RouteOptions Class.) A bool specifying whether or not to return calculated routes in the MajorRoutesResponse.Routes Property. Optional. The default is false. A RoutePathType Enumeration value specifying the type of route path to return. Optional. The default value is RoutePathType.None. (Inherited from the RouteOptions Class.) A TrafficUsage Enumeration value specifying how traffic information is used in the route calculation. Optional. The default value is TrafficUsage.None. (Inherited from the 120

Optimization

ReturnRoutes

RoutePathType

TrafficUsage

Name

Description

RouteOptions Class.)

See Also MajorRoutesRequest.Options Property MajorRoutesOptions Constructor Initializes a new instance of the MajorRoutesOptions Class. Syntax public MajorRoutesOptions() Public Sub New MajorRoutesOptions Properties The properties of the MajorRoutesOptions class are listed here. For a complete list of MajorRoutesOptions class members, see the MajorRoutesOptions Class topic. Public Properties
Name Description

Mode

A TravelMode Enumeration value specifying the type of directions to return. Optional. The default value is TravelMode.Driving. (Inherited from the RouteOptions Class.) A RouteOptimization Enumeration value specifying the calculation method to use. Optional. The default value is RouteOptimization.MinimizeTime. (Inherited from the RouteOptions Class.) A bool specifying whether or not to return calculated routes in the MajorRoutesResponse.Routes Property. Optional. The default is false. A RoutePathType Enumeration value specifying the type of route path to return. Optional. The default value is RoutePathType.None. (Inherited from the RouteOptions Class.) A TrafficUsage Enumeration value specifying how traffic information is used in the route 121

Optimization

ReturnRoutes

RoutePathType

TrafficUsage

Name

Description

calculation. Optional. The default value is TrafficUsage.None. (Inherited from the RouteOptions Class.) See Also MajorRoutesRequest.Options Property MajorRoutesOptions.ReturnRoutes Property A bool specifying whether or not to return calculated routes in the MajorRoutesResponse.Routes Property. Optional. The default is false. Set this property before making a service request. Syntax public bool ReturnRoutes { set; get; } Public Property ReturnRoutes As Boolean Remarks If the ReturnRoutes property is set to true, then every route returned in the response is counted as one route calculation. See Also MajorRoutesResponse.Routes Property

MajorRoutesRequest Class
Contains the properties needed to make a CalculateRoutesFromMajorRoads service request. This class inherits from the RequestBase Class. Syntax public class MajorRoutesRequest : RequestBase Public Class MajorRoutesRequest Inherits RequestBase Constructor
Name Description

MajorRoutesRequest

Initializes a new instance of a MajorRoutesRequest object.

Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the 122

Name

Description

RequestBase Class.) Culture A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) A Waypoint Class object specifying the location where all of the major routes should end. Required. An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A MajorRoutesOptions Class object used to refine the route request. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Destination

ExecutionOptions

Options UserProfile

See Also RouteServiceClient.CalculateRoutesFromMajorRoads Method MajorRoutesRequest Constructor Initializes a new instance of the MajorRoutesRequest Class. Syntax public MajorRoutesRequest() Public Sub New MajorRoutesRequest Properties The properties of the MajorRoutesRequest class are listed here. For a complete list of MajorRoutesRequest class members, see the MajorRoutesRequest Class topic. Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) 123

Name

Description

Culture

A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) A Waypoint Class object specifying the location where all of the major routes should end. Required. An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A MajorRoutesOptions Class object used to refine the route request. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Destination

ExecutionOptions

Options UserProfile

See Also RouteServiceClient.CalculateRoutesFromMajorRoads Method MajorRoutesRequest.Destination Property A Waypoint Class object specifying the location where all of the major routes should end. Required. Set this property before making a service request. Syntax public Waypoint Destination { set; get; } Public Property Destination As Waypoint MajorRoutesRequest.Options Property A MajorRoutesOptions Class object used to refine the route request. Optional. Set this property before making a service request. Syntax public MajorRoutesOptions Options { set; get; } Public Property Options As MajorRoutesOptions

MajorRoutesResponse Class
Contains the results returned from a CalculateRoutesFromMajorRoads service request. This class inherits from the ResponseBase Class. 124

Syntax public class MajorRoutesResponse : ResponseBase Public Class MajorRoutesResponse Inherits ResponseBase Constructor
Name Description

MajorRoutesResponse

Initializes a new instance of a MajorRoutesResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A RouteResult Class array containing the calculated routes from all nearby major roads to the requested destination. A Waypoint Class array containing the calculated start locations from all nearby major roads to the requested destination.

ResponseSummary

Routes

StartingPoints

See Also RouteServiceClient.CalculateRoutesFromMajorRoads Method MajorRoutesResponse Constructor Initializes a new instance of the MajorRoutesResponse Class. Syntax public MajorRoutesResponse() Public Sub New MajorRoutesResponse Properties The properties of the MajorRoutesResponse class are listed here. For a complete list of MajorRoutesResponse class members, see the MajorRoutesResponse Class topic. 125

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A RouteResult Class array containing the calculated routes from all nearby major roads to the requested destination. A Waypoint Class array containing the calculated start locations from all nearby major roads to the requested destination.

ResponseSummary

Routes

StartingPoints

See Also RouteServiceClient.CalculateRoutesFromMajorRoads Method MajorRoutesResponse.Routes Property A RouteResult Class array containing the calculated routes from all nearby major roads to the requested destination. Get this property from the service response. Syntax public RouteResult[] Routes { set; get; } Public Property Routes As RouteResult() Remarks If you would like calculated routes returned in the MajorRoutesResponse.Routes Property, set the MajorRoutesOptions.ReturnRoutes Property to true when making the service request. Note that the service must perform one route calculation for every route returned in the Routes property. If no major roads are found near the specified MajorRoutesRequest.Destination Property, then the MajorRoutesResponse.StartingPoints Property is returned empty and no routes are calculated. MajorRoutesResponse.StartingPoints Property A Waypoint Class array containing the calculated start locations from all nearby major roads to the requested destination. Get this property from the service response. Syntax public Waypoint[] StartingPoints { set; get; } Public Property StartingPoints As Waypoint() Remarks 126

The StartingPoints property only defines the start locations to a destination from all nearby major roads. If you would like calculated routes returned in the MajorRoutesResponse.Routes Property as well, set the MajorRoutesOptions.ReturnRoutes Property to true when making the service request. Note that the service must perform one route calculation for every route returned in the Routes property. If no major roads are found near the specified MajorRoutesRequest.Destination Property, then the StartingPoints property is returned empty.

ManeuverType Enumeration
Contains values that represent route maneuvers. Syntax public enum ManeuverType Public Enum ManeuverType Members
Member Description

ArriveFinish ArriveIntermediateStop BearLeft BearLeftThenBearLeft BearLeftThenBearRight BearLeftThenTurnLeft BearLeftThenTurnRight BearRight BearRightThenBearLeft BearRightThenBearRight BearRightThenTurnLeft BearRightThenTurnRight BearThenKeep BearThenMerge Continue DepartIntermediateStop

Arrive at the last stop in the route. Arrive at an intermediate stop in the route. Bear left. Bear left then bear left. Bear left then bear right. Bear left then turn left. Bear left then turn right. Bear right. Bear right then bear left. Bear right then bear right. Bear right then turn left. Bear right then turn right. Bear then keep on the current road. Bear then merge onto another road. Continue along the current road. Depart an intermediate stop in the route.

127

Member

Description

DepartIntermediateStopReturning DepartStart EnterRoundabout EnterThenExitRoundabout ExitRoundabout KeepLeft KeepOnrampLeft KeepOnrampRight KeepOnrampStraight KeepRight KeepStraight KeepToStayLeft KeepToStayRight KeepToStayStraight Merge None RampThenHighwayLeft RampThenHighwayRight RampToHighwayStraight RoadNameChange Take TakeRampLeft TakeRampRight TakeRampStraight TakeTransit Transfer TurnBack TurnLeft

Return to an intermediate stop in the route. Depart the first stop in the route. Enter a roundabout. Enter then exit a roundabout. Exit a roundabout. Keep left. Keep on the left side of the ramp. Keep on the right side of the ramp. Keep straight ahead on the ramp. Keep right. Keep straight. Keep on the current road then stay left. Keep on the current road then stay right. Keep on the current road then go straight. Merge onto another road. No maneuver. Take a ramp to the highway on the left. Take a ramp to the highway on the right. Take a ramp to the highway straight ahead. The road name changed. Take a new road. Take a ramp left. Take a ramp right. Take a ramp straight ahead. Take transit. Transfer from one transit to another. Turn around. Turn left. 128

Member

Description

TurnLeftThenBearLeft TurnLeftThenBearRight TurnLeftThenTurnLeft TurnLeftThenTurnRight TurnRight TurnRightThenBearLeft TurnRightThenBearRight TurnRightThenTurnLeft TurnRightThenTurnRight TurnThenMerge TurnToStayLeft TurnToStayRight Unknown UTurn Wait Walk

Turn left then bear left. Turn left then bear right. Turn left then turn left. Turn left then turn right. Turn right. Turn right then bear left. Turn right then bear right. Turn right then turn left. Turn right then turn right. Turn then merge onto another road. Turn then stay left. Turn then stay right. Unknown maneuver. Take a U-turn. Wait. Walk.

See Also ItineraryItem.ManeuverType Property

RouteLeg Class
Represents a leg of a route. A route leg is a portion of a route between two waypoints. Syntax public class RouteLeg Public Class RouteLeg Constructor
Name Description

RouteLeg

Initializes a new instance of a RouteLeg object.

129

Public Properties
Name Description

ActualEnd

A Location Class object representing the end location that the route service used for the route leg. A Location Class object representing the start location that the route service used for the route leg. An ItineraryItem Class array containing each step of the route leg. A RouteSummary Class object containing total distance and time information for the route leg.

ActualStart

Itinerary Summary

See Also RouteResult.Legs Property RouteLeg Constructor Initializes a new instance of the RouteLeg Class. Syntax public RouteLeg() Public Sub New RouteLeg Properties The properties of the RouteLeg class are listed here. For a complete list of RouteLeg class members, see the RouteLeg Class topic. Public Properties
Name Description

ActualEnd

A Location Class object representing the end location that the route service used for the route leg. A Location Class object representing the start location that the route service used for the route leg. An ItineraryItem Class array containing each step of the route leg.

ActualStart

Itinerary

130

Name

Description

Summary

A RouteSummary Class object containing total distance and time information for the route leg.

See Also RouteResult.Legs Property RouteLeg.ActualEnd Property A Location Class object representing the end location that the route service used for the route leg. Get this property from the service response. Syntax public Location ActualEnd { set; get; } Public Property ActualEnd As Location Remarks In most cases the ActualEnd property value is identical to the requested route point location. However, if a route point is not close to a road, the route service chooses a location on the nearest road and uses this new location to calculate the route. The ActualEnd property contains this new location. RouteLeg.ActualStart Property A Location Class object representing the start location that the route service used for the route leg. Get this property from the service response. Syntax public Location ActualStart { set; get; } Public Property ActualStart As Location Remarks In most cases the ActualStart property value is identical to the requested route point location. However, if a route point is not close to a road, the route service chooses a location on the nearest road and uses this new location to calculate the route. The ActualStart property contains this new location. RouteLeg.Itinerary Property An ItineraryItem Class array containing each step of the route leg. Get this property from the service response. Syntax public ItineraryItem[] Itinerary { set; get; } Public Property Itinerary As ItineraryItem() RouteLeg.Summary Property A RouteSummary Class object containing total distance and time information for the route leg. Get this property from the service response. 131

Syntax public RouteSummary Summary { set; get; } Public Property Summary As RouteSummary

RouteOptimization Enumeration
Contains values that represent route calculation methods. Syntax public enum RouteOptimization Public Enum RouteOptimization Members
Member Description

MinimizeDistance

The route is calculated to minimize the total distance between pairs of waypoints and does not optimize the total distance for the route. The route is calculated to minimize the total time.

MinimizeTime

Remarks The following table shows the route calculation that is performed for different values of the RouteOptions.Optimization Property and the RouteOptions.TrafficUsage Property.
Optimization TrafficUsage Route calculation

MinimizeTime

None

The route is calculated to minimize time. Traffic information is not used. The route is calculated using traffic information to minimize the time. The route is calculated to minimize time, but traffic is only used to calculate the total route time. The route is calculated to minimize the distance between waypoints. Traffic 132

MinimizeTime

TrafficBasedRouteAndTime

MinimizeTime

TrafficBasedTime

MinimizeDistance

None

Optimization

TrafficUsage

Route calculation

information is not used. MinimizeDistance MinimizeDistance TrafficBasedRouteAndTime TrafficBasedTime A fault is thrown. The route is calculated to minimize the distance between waypoints, but traffic information is only used to calculate the total route time.

See Also RouteOptions.Optimization Property

RouteOptions Class
Contains properties used to refine a route service request. Syntax public class RouteOptions Public Class RouteOptions Constructor
Name Description

RouteOptions

Initializes a new instance of a RouteOptions object.

Public Properties
Name Description

Mode

A TravelMode Enumeration value specifying the type of directions to return. Optional. The default value is TravelMode.Driving. A RouteOptimization Enumeration value specifying the calculation method to use. Optional. The default value is RouteOptimization.MinimizeTime. A RoutePathType Enumeration value specifying the type of route path to return. 133

Optimization

RoutePathType

Name

Description

Optional. The default value is RoutePathType.None. TrafficUsage A TrafficUsage Enumeration value specifying how traffic information is used in the route calculation. Optional. The default value is TrafficUsage.None.

See Also RouteRequest.Options Property MajorRoutesRequest.Options Property RouteOptions Constructor Initializes a new instance of the RouteOptions Class. Syntax public RouteOptions() Public Sub New RouteOptions Properties The properties of the RouteOptions class are listed here. For a complete list of RouteOptions class members, see the RouteOptions Class topic. Public Properties
Name Description

Mode

A TravelMode Enumeration value specifying the type of directions to return. Optional. The default value is TravelMode.Driving. A RouteOptimization Enumeration value specifying the calculation method to use. Optional. The default value is RouteOptimization.MinimizeTime. A RoutePathType Enumeration value specifying the type of route path to return. Optional. The default value is RoutePathType.None. A TrafficUsage Enumeration value specifying how traffic information is used in the route calculation. Optional. The default value is 134

Optimization

RoutePathType

TrafficUsage

Name

Description

TrafficUsage.None. See Also RouteRequest.Options Property MajorRoutesRequest.Options Property RouteOptions.Mode Property A TravelMode Enumeration value specifying the type of directions to return. Optional. The default value is TravelMode.Driving. Set this property before making a service request. Syntax public TravelMode Mode { set; get; } Public Property Mode As TravelMode Remarks If the travel mode for a CalculateRoute Method request is Walking and the as the crow flies distance between the start and end locations is more than 250 kilometers, then an error is returned. RouteOptions.Optimization Property A RouteOptimization Enumeration value specifying the calculation method to use. Optional. The default value is RouteOptimization.MinimizeTime. Set this property before making a service request. Syntax public RouteOptimization Optimization { set; get; } Public Property Optimization As RouteOptimization Remarks The following table shows the route calculation that is performed for different values of the RouteOptions.Optimization Property and the RouteOptions.TrafficUsage Property.
Optimization TrafficUsage Route calculation

MinimizeTime

None

The route is calculated to minimize time. Traffic information is not used. The route is calculated using traffic information to minimize the time. The route is calculated to minimize time, but traffic is only used to calculate the 135

MinimizeTime

TrafficBasedRouteAndTime

MinimizeTime

TrafficBasedTime

Optimization

TrafficUsage

Route calculation

total route time. MinimizeDistance None The route is calculated to minimize distance. Traffic information is not used. A fault is thrown. The route is calculated to minimize distance, but traffic information is only used to calculate the total route time.

MinimizeDistance MinimizeDistance

TrafficBasedRouteAndTime TrafficBasedTime

RouteOptions.RoutePathType Property A RoutePathType Enumeration value specifying the type of route path to return. Optional. The default value is RoutePathType.None. Set this property before making a service request. Syntax public RoutePathType RoutePathType { set; get; } Public Property RoutePathType As RoutePathType Remarks If the RoutePathType property is set to a value other than RoutePathType.None, a route path is returned in the RouteResult.RoutePath Property. RouteOptions.TrafficUsage Property A TrafficUsage Enumeration value specifying how traffic information is used in the route calculation. Optional. The default value is TrafficUsage.None. Set this property before making a service request. Syntax public TrafficUsage TrafficUsage { set; get; } Public Property TrafficUsage As TrafficUsage Remarks The following table shows the route calculation that is performed for different values of the RouteOptions.Optimization Property and the RouteOptions.TrafficUsage Property.
Optimization TrafficUsage Route calculation

MinimizeTime

None

The route is calculated to minimize time. Traffic information is not used. The route is calculated 136

MinimizeTime

TrafficBasedRouteAndTime

Optimization

TrafficUsage

Route calculation

using traffic information to minimize the time. MinimizeTime TrafficBasedTime The route is calculated to minimize time, but traffic is only used to calculate the total route time. The route is calculated to minimize distance. Traffic information is not used. A fault is thrown. The route is calculated to minimize distance, but traffic information is only used to calculate the total route time.

MinimizeDistance

None

MinimizeDistance MinimizeDistance

TrafficBasedRouteAndTime TrafficBasedTime

RoutePath Class
Represents the raw calculated route data. Syntax public class RoutePath Public Class RoutePath Constructor
Name Description

RoutePath

Initializes a new instance of a RoutePath object.

Public Properties
Name Description

Points

A Location Class array representing the shape of the route.

137

See Also RouteResult.RoutePath Property RouteOptions.RoutePathType Property RoutePath Constructor Initializes a new instance of the RoutePath Class. Syntax public RoutePath() Public Sub New RoutePath Properties The properties of the RoutePath class are listed here. For a complete list of RoutePath class members, see the RoutePath Class topic. Public Properties
Name Description

Points

A Location Class array representing the shape of the route.

See Also RouteResult.RoutePath Property RoutePath.Points Property A Location Class array representing the shape of the route. Get this property from the service response. Syntax public Location[] Points { set; get; } Public Property Points As Location() Remarks The Points property is returned if the RouteOptions.RoutePathType Property is set to RoutePathType.Points.

RoutePathType Enumeration
Contains route path types to return. A route path is the set of points that define the exact shape of the route. Syntax public enum RoutePathType Public Enum RoutePathType

138

Members
Member Description

None Points

No route path is returned. A set of points that define the shape of the route is returned.

See Also RouteOptions.RoutePathType Property

RouteRequest Class
Contains the properties needed to make a CalculateRoute request. This class inherits from the RequestBase Class. Syntax public class RouteRequest : RequestBase Public Class RouteRequest Inherits RequestBase Constructor
Name Description

RouteRequest

Initializes a new instance of a RouteRequest object.

Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) 139

Culture

ExecutionOptions

Name

Description

Options UserProfile

A RouteOptions Class object used to refine the route request. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.) A Waypoint Class array where each element represents a stop in the route. Required.

Waypoints

See Also RouteServiceClient.CalculateRoute Method RouteServiceClient.CalculateRoutesFromMajorRoads Method RouteRequest Constructor Initializes a new instance of the RouteRequest Class. Syntax public RouteRequest() Public Sub New RouteRequest Properties The properties of the RouteRequest class are listed here. For a complete list of RouteRequest class members, see the RouteRequest Class topic. Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.)

Culture

ExecutionOptions

140

Name

Description

Options UserProfile

A RouteOptions Class object used to refine the route request. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.) A Waypoint Class array where each element represents a stop in the route. Required.

Waypoints

See Also RouteServiceClient.CalculateRoute Method RouteRequest.Options Property A RouteOptions Class object used to refine the route request. Optional. Set this property before making a service request. Syntax public RouteOptions Options { set; get; } Public Property Options As RouteOptions RouteRequest.Waypoints Property A Waypoint Class array where each element represents a stop in the route. Required. Set this property before making a service request. Syntax public Waypoint[] Waypoints { set; get; } Public Property Waypoints As Waypoint() Remarks The Waypoints property must contain at least 2 waypoints and no more than 25 waypoints.

RouteResponse Class
Contains the result returned from a CalculateRoute service request. This class inherits from the ResponseBase Class. Syntax public class RouteResponse : ResponseBase Public Class RouteResponse Inherits ResponseBase Constructor

141

Name

Description

RouteResponse

Initializes a new instance of a RouteResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A RouteResult Class object returned by the Route Service.

ResponseSummary

Result

Remarks If you are using the Visual Studio user interface or the svcutil.exe utility from the command line to create your proxy classes, the size of the web service response is restricted by the following two Windows Communication Foundation (WCF) properties. MaxReceivedMessageSize Property MaxItemsInObjectGraph Property

The Bing Maps SOAP Services may return responses larger than the default values for these properties. To ensure responses are successfully received, set these properties to the recommended values in the table below.
Service

MaxReceivedMessageSize 65536 (default) 65536 (default) 9000000 800000

MaxItemsInObjectGraph 65536 (default) 65536 (default) 7000000 65536 (default)

Geocode Service Imagery Service Route Service Search Service

See Also RouteServiceClient.CalculateRoute Method

142

RouteResponse Constructor Initializes a new instance of the RouteResponse Class. Syntax public RouteResponse() Public Sub New RouteResponse Properties The properties of the RouteResponse class are listed here. For a complete list of RouteResponse class members, see the RouteResponse Class topic. Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A RouteResult Class object returned by the Route Service.

ResponseSummary

Result

See Also RouteServiceClient.CalculateRoute Method RouteResponse.Result Property A RouteResult Class object returned by the Route Service. Get this property from the service response. Syntax public RouteResult Result { set; get; } Public Property Result As RouteResult

RouteResult Class
Represents a calculated route. Syntax public class RouteResult Public Class RouteResult Constructor

143

Name

Description

RouteResult

Initializes a new instance of a RouteResult object.

Public Properties
Name Description

Legs

A RouteLeg Class array, where each element represents a portion of the route between waypoints. A RoutePath Class object containing the raw calculated route data. A RouteSummary Class object containing route summary information, such as total distance and time.

RoutePath Summary

See Also RouteResponse.Result Property MajorRoutesResponse.Routes Property RouteResult Constructor Initializes a new instance of the RouteResult Class. Syntax public RouteResult() Public Sub New RouteResult Properties The properties of the RouteResult class are listed here. For a complete list of RouteResult class members, see the RouteResult Class topic. Public Properties
Name Description

Legs

A RouteLeg Class array, where each element represents a portion of the route between waypoints. A RoutePath Class object containing the raw calculated route data. 144

RoutePath

Name

Description

Summary

A RouteSummary Class object containing route summary information, such as total distance and time.

See Also RouteResponse.Result Property MajorRoutesResponse.Routes Property RouteResult.Legs Property A RouteLeg Class array, where each element represents a portion of the route between waypoints. Get this property from the service response. Syntax public RouteLeg[] Legs { set; get; } Public Property Legs As RouteLeg() RouteResult.RoutePath Property A RoutePath Class object containing the raw calculated route data. Get this property from the service response. Syntax public RoutePath RoutePath { set; get; } Public Property RoutePath As RoutePath RouteResult.Summary Property A RouteSummary Class object containing route summary information, such as total distance and time. Get this property from the service response. Syntax public RouteSummary Summary { set; get; } Public Property Summary As RouteSummary

RouteServiceClient Class
Contains the methods used to make requests to the Route Service. Note The name of this class and its constructor may be different depending on the tool you use to generate the client proxy classes. Syntax public class RouteServiceClient : System.ServiceModel.ClientBase<IRouteService> Public Class RouteServiceClient Inherits System.ServiceModel.ClientBase(Of IRouteService) Constructor

145

Name

Description

RouteServiceClient

Initializes a new instance of a RouteServiceClient object.

Public Methods
Name Description

CalculateRoute

Calculates a route between specified stops and returns route directions as well as other route data. Calculates starting points or route directions to a specified location from nearby major roads.

CalculateRoutesFromMajorRoads

See Also RouteRequest Class RouteResponse Class MajorRoutesRequest Class MajorRoutesResponse Class RouteServiceClient Constructor Initializes a new instance of the RouteServiceClient Class. Syntax public RouteServiceClient() Public Sub New Syntax public RouteServiceClient(string endpointConfigurationName) Public Sub New(ByVal endpointConfigurationName As String) Syntax public RouteServiceClient(string endpointConfigurationName, string remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String) Syntax public RouteServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)

146

Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Syntax public RouteServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Parameters endpointConfigurationName binding remoteAddress Remarks The Route service provides endpoints for Basic HTTP and Binary over HTTP configurations. When you create a proxy for your application, references to both endpoints are added to your application. Therefore, you must specify the endpoint you want to use. To specify the endpoint, use the following endpoint configuration names.
Endpoint Configuration Type Endpoint Configuration Name

The endpoint for a service that allows clients to find and communicate with the service. The binding with which to make calls to the service. The address of the service endpoint.

Basic HTTP Binary over HTTP Example

BasicHttpBinding_IRouteService CustomBinding_IRouteService

Create a RouteServiceClient object that uses the binary over HTTP endpoint.
RouteService.RouteServiceClient RouteService = new RouteService.RouteServiceClient("CustomBinding_IRouteService"); Dim RouteServiceInstance As New RouteService.RouteServiceClient("BasicHttpBinding_IRouteService")

See Also System.ServiceModel.ClientBase.ClientBase(TChannel) Constructor RouteServiceClient Methods The methods of the RouteServiceClient class are listed here. For a complete list of RouteServiceClient class members, see the RouteServiceClient Class topic. 147

Public Methods
Name Description

CalculateRoute

Calculates a route between specified stops and returns route directions as well as other route data. Calculates starting points or route directions to a specified location from nearby major roads.

CalculateRoutesFromMajorRoads

See Also RouteRequest Class RouteResponse Class MajorRoutesRequest Class MajorRoutesResponse Class RouteServiceClient.CalculateRoute Method Calculates a route between specified stops and returns route directions as well as other route data. Syntax public RouteResponse CalculateRoute(RouteRequest request) Public Function CalculateRoute(ByVal request As RouteRequest) As RouteResponse Parameters request A RouteRequest object that contains the header and parameter information for the service operation.

Return Value Returns a RouteResponse Class, which contains a RouteResult Class. Example VirtualEarthServices#6 See Also RouteServiceClient.CalculateRoutesFromMajorRoads Method RouteServiceClient.CalculateRoutesFromMajorRoads Method Calculates starting points or route directions to a specified location from nearby major roads. Syntax public MajorRoutesResponse CalculateRoutesFromMajorRoads(MajorRoutesRequest request);

148

Public Function CalculateRoutesFromMajorRoads(ByVal request As MajorRoutesRequest) As MajorRoutesResponse Parameters request A MajorRoutesRequest object that contains the header and parameter information for the service operation.

Return Value Returns a MajorRoutesResponse Class. Remarks If no major roads are found near the specified MajorRoutesRequest.Destination Property, then the MajorRoutesResponse.StartingPoints Property is returned empty and no routes are calculated. Example VirtualEarthServices#7 See Also RouteServiceClient.CalculateRoute Method

RouteSummary Class
Contains route summary information, such as total distance and time. Syntax public class RouteSummary Public Class RouteSummary Constructor
Name Description

RouteSummary

Initializes a new instance of a RouteSummary object.

Public Properties
Name Description

BoundingRectangle Distance

A Rectangle Class object defining the map view that contains the route portion. A double representing the total distance of the 149

Name

Description

route portion. TimeInSeconds A long representing the total time, in seconds, of the route portion.

See Also RouteLeg.Summary Property RouteResult.Summary Property RouteSummary Constructor Initializes a new instance of the RouteSummary Class. Syntax public RouteSummary() Public Sub New RouteSummary Properties The properties of the RouteSummary class are listed here. For a complete list of RouteSummary class members, see the RouteSummary Class topic. Public Properties
Name Description

BoundingRectangle Distance TimeInSeconds

A Rectangle Class object defining the map view that contains the route portion. A double representing the total distance of the route portion. A long representing the total time, in seconds, of the route portion.

See Also RouteLeg.Summary Property RouteResult.Summary Property RouteSummary.BoundingRectangle Property A Rectangle Class object defining the map view that contains the route portion. Get this property from the service response. Syntax public Rectangle BoundingRectangle { set; get; } Public Property BoundingRectangle As Rectangle 150

RouteSummary.Distance Property A double representing the total distance of the route portion. Get this property from the service response. Syntax public double Distance { set; get; } Public Property Distance As Double Remarks The Distance property is returned in the units specified in the UserProfile.DistanceUnit Property, sent as part of the service request. RouteSummary.TimeInSeconds Property A long representing the total time, in seconds, of the route portion. Get this property from the service response. Syntax public long TimeInSeconds { set; get; } Public Property TimeInSeconds As Long

TrafficUsage Enumeration
Contains values indicating how to use traffic information in the route calculation. Syntax public enum TrafficUsage Public Enum TrafficUsage Members
Member Description

None TrafficBasedRouteAndTime TrafficBasedTime

Traffic information is not used in the route calculation. Traffic information is used to change the route to minimize time. Traffic information is used to recalculate the total travel time. The route is not changed.

Remarks The following table shows the route calculation that is performed for different values of the RouteOptions.Optimization Property and the RouteOptions.TrafficUsage Property.

151

Optimization

TrafficUsage

Route calculation

MinimizeTime

None

The route is calculated to minimize time. Traffic information is not used. The route is calculated using traffic information to minimize the time. The route is calculated to minimize time, but traffic is only used to calculate the total route time. The route is calculated to minimize distance. Traffic information is not used. A fault is thrown. The route is calculated to minimize distance, but traffic information is only used to calculate the total route time.

MinimizeTime

TrafficBasedRouteAndTime

MinimizeTime

TrafficBasedTime

MinimizeDistance

None

MinimizeDistance MinimizeDistance

TrafficBasedRouteAndTime TrafficBasedTime

See Also RouteOptions.TrafficUsage Property

TravelMode Enumeration
Contains travel modes for a route. Syntax public enum TravelMode Public Enum TravelMode Members
Member Description

Driving Walking

The returned route contains driving directions. The returned route contains walking directions.

152

Remarks If the travel mode for a CalculateRoute Method request is Walking and the as the crow flies distance between the start and end locations is more than 250 kilometers, then an error is returned. See Also RouteOptions.Mode Property

Waypoint Class
Represents a stop in route. Syntax public class Waypoint Public Class Waypoint Constructor
Name Description

Waypoint

Initializes a new instance of a Waypoint object.

Public Properties
Name Description

Description Location

A string describing the route stop. Optional. The default is null. A Location Class object indicating the location of the route stop. Required.

See Also RouteRequest.Waypoints Property Waypoint Constructor Initializes a new instance of the Waypoint Class. Syntax public Waypoint() Public Sub New

153

Waypoint Properties The properties of the Waypoint class are listed here. For a complete list of Waypoint class members, see the Waypoint Class topic. Public Properties
Name Description

Description Location

A string describing the route stop. Optional. The default is null. A Location Class object indicating the location of the route stop. Required.

See Also RouteRequest.Waypoints Property Waypoint.Description Property A string describing the route stop. Optional. The default is null. Set this property before making a service request. Syntax public string Description { set; get; } Public Property Description As String Remarks If the Description property is set, it is used in the ItineraryItem.Text Property for the stop in the returned route. The Description property can be a maximum of 256 characters. See Also ItineraryItem Class Waypoint.Location Property A Location Class object indicating the location of the route stop. Required. Set this property before making a service request. Syntax public Location Location { set; get; } Public Property Location As Location

Search Service
The Bing Maps Search Service is comprised of classes and enumerations that allow you to parse a search query as well as return search results.

154

In This Section
The Bing Maps Search Service contains the following classes and enumerations. Web Service Class

Class or Enumeration

Description

SearchServiceClient Class

Contains the methods used to make requests to the Search Service.

Note The web service class name may be different depending on the tool you use to generate the client proxy classes. Classes and Enumerations

AvailableFilter Class BusinessSearchResult Class

Contains properties identifying filters available for the search result. Represents a search result from business listings. This class inherits from the SearchResultBase Class. Contains properties that indicate the number of items in a specified category and the number of items in a specified category in specific neighborhoods. Contains a point of interest category name and properties specific to that category. Represents a search result from community content listings. This class inherits from the SearchResultBase Class. Contains operators that compare two values. Represents a filter value ID and name. Contains search result listing types, which specify the search source. Contains geocoded locations as well as properties indicating the match code and match confidence of these locations.

CategoryCount Class

CategorySpecificPropertySet Class CommunityContentSearchResult Class

CompareOperator Enumeration FilterValue Class ListingType Enumeration LocationData Class

155

Neighborhood Class Parse Class PersonSearchResult Class

Represents a city neighborhood. Contains a parsed search query. Represents a search result from people listings. This class inherits from the SearchResultBase Class. Contains a corrected query and a corrected separated query derived from a search request. Contains properties that specify a number range of allowable filter property values. This class inherits from the AvailableFilter Class. Contains properties used to refine a search service request. Contains a location or area that matches the 'where' component of the search query. Contains the properties needed to make a SearchServiceClient.Search Method service request. This class inherits from the RequestBase Class. Contains the results returned by the Search Service. This class inherits from the ResponseBase Class. Contains properties that define a search result returned by the Search Service. Contains a set of search results as well as other properties that describe the search that was performed. Contains values that specify how to order items. Contains properties that represent the 'what' and 'where' components of a search query. Represents a search filter with a fixed set of valid values. This class inherits from the AvailableFilter Class.

QuerySuggestion Class RangeFilter Class

SearchOptions Class SearchRegion Class SearchRequest Class

SearchResponse Class

SearchResultBase Class SearchResultSet Class

SortOrder Enumeration StructuredSearchQuery Class ValueListFilter Class

156

See Also
Common Classes and Enumerations

AvailableFilter Class
Contains properties identifying filters available for the search result.

Filters are only supported for English - United States business searches. Syntax public class AvailableFilter Public Class AvailableFilter Constructor
Name Description

AvailableFilter

Initializes a new instance of an AvailableFilter object.

Public Properties
Name Description

PropertyId PropertyName

An int indicating the ID of the property used to filter the search results. A string indicating the name of the property used to filter the search results.

Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic. The following classes inherit from the AvailableFilter class: RangeFilter Class ValueListFilter Class

See Also SearchResultSet.AvailableFilters Property AvailableFilter Constructor Initializes a new instance of the AvailableFilter Class. 157

Syntax public AvailableFilter() Public Sub New AvailableFilter Properties The properties of the AvailableFilter class are listed here. For a complete list of AvailableFilter class members, see the AvailableFilter Class topic. Public Properties
Name Description

PropertyId PropertyName

An int indicating the ID of the property used to filter the search results. A string indicating the name of the property used to filter the search results.

See Also SearchResultSet.AvailableFilters Property AvailableFilter.PropertyId Property An int indicating the ID of the property used to filter the search results. Get this property from the service response. Syntax public int PropertyId { set; get; } Public Property PropertyId As Integer Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic. See Also AvailableFilter.PropertyName Property AvailableFilter.PropertyName Property A string indicating the name of the property used to filter the search results. Get this property from the service response. Syntax public string PropertyName { set; get; } Public Property PropertyName As String 158

Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic.

BusinessSearchResult Class
Represents a search result from business listings. This class inherits from the SearchResultBase Class. Syntax public class BusinessSearchResult : SearchResultBase Public Class BusinessSearchResult Inherits SearchResultBase Constructor
Name Description

BusinessSearchResult

Initializes a new instance of a BusinessSearchResult object.

Public Properties
Name Description

AdditionalProperties

A System.Collections.Generic.Dictionary <string,object> object containing additional information about the business. An Address Class object indicating the address of the business. A Category Class array indicating the business type. A CategorySpecificPropertySet Class array containing properties specific to the business type. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase 159

Address Categories CategorySpecificProperties

Distance

Id

Name

Description

Class.) LocationData A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.) A Neighborhood Class array indicating the neighborhoods where the business is found. A string containing the phone number of the business. An int indicating the number of users that rated the business. An int indicating the number of reviews written about the business. A double indicating the average user rating given to the business. A System.Uri representing the business's web site.

Name

Neighborhoods PhoneNumber RatingCount ReviewCount UserRating Website

See Also SearchResultSet.Results Property BusinessSearchResult Constructor Initializes a new instance of the BusinessSearchResult Class. Syntax public BusinessSearchResult() Public Sub New BusinessSearchResult Properties The properties of the BusinessSearchResult class are listed here. For a complete list of BusinessSearchResult class members, see the BusinessSearchResult Class topic. Public Properties

160

Name

Description

AdditionalProperties

A System.Collections.Generic.Dictionary <string,object> object containing additional information about the business. An Address Class object indicating the address of the business. A Category Class array indicating the business type. A CategorySpecificPropertySet Class array containing properties specific to the business type. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase Class.) A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.) A Neighborhood Class array indicating the neighborhoods where the business is found. A string containing the phone number of the business. An int indicating the number of users that rated the business. An int indicating the number of reviews written about the business. A double indicating the average user rating given to the business. A System.Uri representing the business's web site. 161

Address Categories CategorySpecificProperties

Distance

Id

LocationData

Name

Neighborhoods PhoneNumber RatingCount ReviewCount UserRating Website

BusinessSearchResult.AdditionalProperties Property A System.Collections.Generic.Dictionary<string,object> object containing additional information (property name and property value) about the business. Get this property from the service response. Syntax public System.Collections.Generic.Dictionary AdditionalProperties { set; get; } Public Property AdditionalProperties As System.Collections.Generic.Dictionary Remarks The following table lists filter properties that are returned in the AdditionalProperties property.
Name

EmailAddress HoursOfOperation Coupons BirdsEyeSceneId ParkingOptions PhotoUrl BusinessSearchResult.Address Property An Address Class object indicating the address of the business. Get this property from the service response. Syntax public Address Address { set; get; } Public Property Address As Address BusinessSearchResult.Categories Property A Category Class array indicating the business type. Get this property from the service response. Syntax public Category[] Categories { set; get; } Public Property Categories As Category() Remarks The Categories property contains the top five categories most common to business search results. 162

BusinessSearchResult.CategorySpecificProperties Property A CategorySpecificPropertySet Class array containing properties specific to the business type. Get this property from the service response. Syntax public CategorySpecificPropertySet[] CategorySpecificProperties { set; get; } Public Property CategorySpecificProperties CategorySpecificPropertySet() Remarks The following table lists category specific filter properties returned in the CategorySpecificProperties property.
Category Category Specific Property Name

Restaurant Restaurant Restaurant Hotel Hotel Hotel Hotel

Price Cuisine MenuUrl HotelClass HotelRate Amenities ReservationUrl

BusinessSearchResult.Neighborhoods Property A Neighborhood Class array indicating the neighborhoods where the business is found. Get this property from the service response. Syntax public Neighborhood[] Neighborhoods { set; get; } Public Property Neighborhoods As Neighborhood() BusinessSearchResult.PhoneNumber Property A string containing the phone number of the business. Get this property from the service response. Syntax public string PhoneNumber { set; get; } Public Property PhoneNumber As String BusinessSearchResult.RatingCount Property 163

An int indicating the number of users that rated the business. Get this property from the service response. Syntax public int RatingCount { set; get; } Public Property RatingCount As Integer BusinessSearchResult.ReviewCount Property An int indicating the number of reviews written about the business. Get this property from the service response. Syntax public int ReviewCount { set; get; } Public Property ReviewCount As Integer BusinessSearchResult.UserRating Property A double indicating the average user rating given to the business. Get this property from the service response. Syntax public double UserRating { set; get; } Public Property UserRating As Double Remarks The UserRating property value ranges from a lowest rating of 0 to a highest rating of 10. BusinessSearchResult.Website Property A System.Uri containing the business's web site. Get this property from the service response. Syntax public System.Uri Website { set; get; } Public Property Website As System.Uri

CategoryCount Class
Contains properties that indicate the number of items in a specified category and the number of items in a specified category in specific neighborhoods. Syntax public class CategoryCount Public Class CategoryCount 164

Constructor
Name Description

CategoryCount

Initializes a new instance of a CategoryCount object.

Public Properties
Name Description

Category Count CountByNeighborhood

A Category Class object specifying the category of the counted items. An int representing the number of items in the category specified in the Category property. A System.Collections.Generic.Dictionary <Neighborhood,int> object representing the number of items in the specified neighborhoods and in the category specified by the Category property.

See Also SearchResultSet.CategoryCounts Property CategoryCount Constructor Initializes a new instance of the CategoryCount Class. Syntax public CategoryCount() Public Sub New CategoryCount Properties The properties of the CategoryCount class are listed here. For a complete list of CategoryCount class members, see the CategoryCount Class topic. Public Properties
Name Description

Category

A Category Class object specifying the category of the counted items.

165

Name

Description

Count CountByNeighborhood

An int representing the number of items in the category specified in the Category property. A System.Collections.Generic.Dictionary <Neighborhood,int> object representing the number of items in the specified neighborhoods and in the category specified by the Category property.

See Also SearchResultSet.CategoryCounts Property CategoryCount.Category Property A Category Class object specifying the category of the counted items. Get this property from the service response. Syntax public Category Category { set; get; } Public Property Category As Category CategoryCount.Count Property An int representing the number of items in the category specified in the Category property. Get this property from the service response. Syntax public int Count { set; get; } Public Property Count As Integer CategoryCount.CountByNeighborhood Property A System.Collections.Generic.Dictionary<Neighborhood,int> object representing the number of items in the specified neighborhoods and in the category specified by the Category property. Get this property from the service response. Syntax public System.Collections.Generic.Dictionary<Neighborhood,int> CountByNeighborhood { set; get; } Public Property CountByNeighborhood As System.Collections.Generic.Dictionary(Of Neighborhood, Integer) See Also Neighborhood Class 166

CategorySpecificPropertySet Class
Contains a point of interest category name and properties specific to that category. Syntax public class CategorySpecificPropertySet Public Class CategorySpecificPropertySet Constructor
Name Description

CategorySpecificPropertySet

Initializes a new instance of a CategorySpecificPropertySet object.

Public Properties
Name Description

CategoryName Properties

A string indicating the name of the category. A System.Collections.Generic.Dictionary <string,object> object indicating the properties only applicable to the category specified in the CategoryName property.

CategorySpecificPropertySet Constructor Initializes a new instance of the CategorySpecificPropertySet Class. Syntax public CategorySpecificPropertySet() Public Sub New CategorySpecificPropertySet Properties The properties of the CategorySpecificPropertySet class are listed here. For a complete list of CategorySpecificPropertySet class members, see the CategorySpecificPropertySet Class topic. Public Properties
Name Description

CategoryName

A string indicating the name of the category. 167

Name

Description

Properties

A System.Collections.Generic.Dictionary <string,object> object indicating the properties only applicable to the category specified in the CategoryName property.

See Also BusinessSearchResult.CategorySpecificProperties Property CategorySpecificPropertySet.CategoryName Property A string indicating the name of the category. Get this property from the service response. Syntax public string CategoryName { set; get; } Public Property CategoryName As String CategorySpecificPropertySet.Properties Property A System.Collections.Generic.Dictionary <string,object> object indicating the properties only applicable to the category specified in the CategoryName property. Get this property from the service response. Syntax public System.Collections.Generic.Dictionary<string,object> Properties { set; get; } Public Property Properties As System.Collections.Generic.Dictionary(Of String, Object)

CommunityContentSearchResult Class
Represents a search result from community content listings. This class inherits from the SearchResultBase Class. Syntax public class CommunityContentSearchResult : SearchResultBase Public Class CommunityContentSearchResult Inherits SearchResultBase Constructor
Name Description

CommunityContentSearchResult

Initializes a new instance of a CommunityContentSearchResult object.

168

Public Properties
Name Description

AdditionalProperties

A System.Collections.Generic.Dictionary <string,object> object containing additional information about the community content. A string containing the description of the community content. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase Class.) A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.)

Description Distance

Id

LocationData

Name

See Also SearchResultSet.Results Property CommunityContentSearchResult Constructor Initializes a new instance of the CommunityContentSearchResult Class. Syntax public CommunityContentSearchResult() Public Sub New CommunityContentSearchResult Properties The properties of the CommunityContentSearchResult class are listed here. For a complete list of CommunityContentSearchResult class members, see the CommunityContentSearchResult Class topic. Public Properties

169

Name

Description

AdditionalProperties

A System.Collections.Generic.Dictionary <string,object> object containing additional information about the community content. A string containing the description of the community content. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase Class.) A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.)

Description Distance

Id

LocationData

Name

See Also SearchResultSet.Results Property CommunityContentSearchResult.AdditionalProperties Property A System.Collections.Generic.Dictionary<string,object> object containing additional information about the community content. Get this property from the service response. Syntax public System.Collections.Generic.Dictionary<string,object> AdditionalProperties { set; get; } Public Property AdditionalProperties As System.Collections.Generic.Dictionary(Of String, Object) Remarks The following table lists filter properties that are returned in the AdditionalProperties property.
Name

SourceUrl ParentCollectionId SourceFormat 170

Name

ParentCollectionTitle Tags PhotoUrl AnnotationType CommunityContentSearchResult.Description Property A string containing the description of the community content. Get this property from the service response. Syntax public string Description { set; get; } Public Property Description As String

CompareOperator Enumeration
Contains operators that compare two values. Syntax public enum CompareOperator Public Enum CompareOperator Members
Member Description

Equals GreaterThan GreaterThanOrEquals LessThan LessThanOrEquals

Determines if two values are equal Determines if a first value is greater than a second value Determines if a first value is greater than or equal to a second value Determines if a first value is less than a second value Determines if a first value is less than or equal to a second value

171

Remarks If the filter property name is UserRating, then all members of the CompareOperator enumeration are valid operators. For all other filter properties, only the Equals member of the CompareOperator enumeration is valid. See the Search Filter Property Table for available filter properties. See Also FilterExpression.CompareOperator Property

FilterValue Class
Represents a filter value ID and name. Syntax public class FilterValue Public Class FilterValue Constructor
Name Description

FilterValue

Initializes a new instance of a FilterValue object.

Public Properties
Name Description

Id Name

An int specifying the filter value ID. A string specifying the filter value name.

Remarks A table of filter property IDs, names, and values can be found in the Search Filter Property Table topic. See Also ValueListFilter.Values Property FilterExpression.FilterValue Property FilterValue Constructor Initializes a new instance of the FilterValue Class. 172

Syntax public FilterValue() Public Sub New FilterValue Properties The properties of the FilterValue class are listed here. For a complete list of FilterValue class members, see the FilterValue Class topic. Public Properties
Name Description

Id Name FilterValue.Id Property

An int specifying the filter value ID. A string specifying the filter value name.

An int specifying the filter value ID. Get this property from the service response. Syntax public int Id { set; get; } Public Property Id As Integer FilterValue.Name Property A string specifying the filter value name. Get this property from the service response. Syntax public string Name { set; get; } Public Property Name As String Remarks The Name property is localized.

ListingType Enumeration
Contains search result listing types, which specify the search source. Syntax public enum ListingType Public Enum ListingType

173

Members
Member Description

Business Community Content Person Unknown

The search result is from business listings. The search result is from community content listings. The search result is from people listings. The search result source is unknown.

See Also SearchOptions.ListingType Property SearchResultSet.ListingType Property

LocationData Class
Contains geocoded locations as well as properties indicating the match code and match confidence of these locations. Syntax public class LocationData Public Class LocationData Constructor
Name Description

LocationData

Initializes a new instance of a LocationData object.

Public Properties
Name Description

Confidence

A Confidence Enumeration value representing how confident the Geocode Service is in the matches found in the Locations property. A GeocodeLocation Class array containing the matched locations.

Locations

174

Name

Description

MatchCodes

A string array containing the type of matches used to geocode the locations found in the Locations property.

See Also SearchResultBase.LocationData Property Geocode Match Code and Match Method Tables LocationData Constructor Initializes a new instance of the LocationData Class. Syntax public LocationData() Public Sub New LocationData Properties The properties of the LocationData class are listed here. For a complete list of LocationData class members, see the LocationData Class topic. Public Properties
Name Description

Confidence

A Confidence Enumeration value representing how confident the Geocode Service is in the matches found in the Locations property. A GeocodeLocation Class array containing the matched locations. A string array containing the type of matches used to geocode the locations found in the Locations property.

Locations MatchCodes

See Also SearchResultBase.LocationData Property LocationData.Confidence Property A Confidence Enumeration value representing how confident the Geocode Service is in the matches found in the Locations property. Get this property from the service response. Syntax 175

public Confidence Confidence { set; get; } Public Property Confidence As Confidence LocationData.Locations Property A GeocodeLocation Class array containing the matched locations. Get this property from the service response. Syntax public GeocodeLocation[] Locations { set; get; } Public Property Locations As GeocodeLocation() LocationData.MatchCodes Property A string array containing the type of matches used to geocode the locations found in the Locations property. Get this property from the service response. Syntax public string[] MatchCodes { set; get; } Public Property MatchCodes As String() Remarks The return values for the MatchCodes property are listed in the Geocode Match Code and Match Method Tables topic.

Neighborhood Class
Represents a city neighborhood. Syntax public class Neighborhood Public Class Neighborhood Constructor
Name Description

Neighborhood

Initializes a new instance of a Neighborhood object.

Public Properties

176

Name

Description

City Id Name

A string containing the name of the city where the neighborhood is located. An int indicating the ID of the neighborhood. A string containing the name of the neighborhood.

See Also BusinessSearchResult.Neighborhoods Property Neighborhood Constructor Initializes a new instance of the Neighborhood Class. Syntax public Neighborhood() Public Sub New Neighborhood Properties The properties of the Neighborhood class are listed here. For a complete list of Neighborhood class members, see the Neighborhood Class topic. Public Properties
Name Description

City Id Name

A string containing the name of the city where the neighborhood is located. An int indicating the ID of the neighborhood. A string containing the name of the neighborhood.

See Also BusinessSearchResult.Neighborhoods Property Neighborhood.City Property A string containing the name of the city where the neighborhood is located. Get this property from the service response. Syntax public string City { set; get; } 177

Public Property City As String Neighborhood.Id Property An int indicating the ID of the neighborhood. Get this property from the service response. Syntax public int Id { set; get; } Public Property Id As Integer Neighborhood.Name Property A string containing the name of the neighborhood. Get this property from the service response. Syntax public string Name { set; get; } Public Property Name As String

Parse Class
Contains a parsed search query. Syntax public class Parse Public Class Parse Constructor
Name Description

Parse

Initializes a new instance of a Parse object.

Public Properties
Name Description

Address Keyword Landmark

An Address Class containing the parsed 'where' component of the search query. A string representing the 'what' component of the search query. A string representing the display name of the landmark, if one exists.

178

Name

Description

LocationSeparator

A string containing the separator used to connect the 'what' and 'where' components of the search query.

Remarks If the search query is "pizza in Seattle, WA", then the Keyword property contains "pizza", the LocationSeparator property contains "in", and the Address property contains "Seattle" in the Address.Locality Property and "WA" in the Address.AdminDistrict Property. See Also SearchResultSet.Parse Property Parse Constructor Initializes a new instance of the Parse Class. Syntax public Parse() Public Sub New Parse Properties The properties of the Parse class are listed here. For a complete list of Parse class members, see the Parse Class topic. Public Properties
Name Description

Address Keyword Landmark LocationSeparator

An Address Class containing the parsed 'where' component of the search query. A string representing the 'what' component of the search query. A string representing the display name of the landmark, if one exists. A string containing the separator used to connect the 'what' and 'where' components of the search query.

See Also SearchResultSet.Parse Property 179

Parse.Address Property An Address Class containing the parsed 'where' component of the search query. Get this property from the service response. Syntax public Address Address { set; get; } Public Property Address As Address Remarks If the search query is "pizza in Seattle, WA", then the Address property contains "Seattle" in the Address.Locality Property and "WA" in the Address.AdminDistrict Property. Parse.Keyword Property A string representing the 'what' component of the search query. Get this property from the service response. Syntax public string Keyword { set; get; } Public Property Keyword As String Remarks If the search query is "pizza in Seattle, WA", then the Keyword property contains "pizza". Parse.Landmark Property A string representing the display name of the landmark, if one exists. Get this property from the service response. Syntax public string Landmark { set; get; } Public Property Landmark As String Parse.LocationSeparator Property A string containing the separator used to connect the 'what' and 'where' components of the search query. Get this property from the service response. Syntax public string LocationSeparator { set; get; } Public Property LocationSeparator As String Remarks If the search query is "pizza in Seattle, WA", then the LocationSeparator property contains "in".

180

PersonSearchResult Class
Represents a search result from people listings. This class inherits from the SearchResultBase Class. Syntax public class PersonSearchResult : SearchResultBase Public Class PersonSearchResult Inherits SearchResultBase Constructor
Name Description

PersonSearchResult

Initializes a new instance of a PersonSearchResult object.

Public Properties
Name Description

Address Distance

An Address Class object representing the address of the person. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase Class.) A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.) A string containing the phone number of the person.

Id

LocationData

Name

PhoneNumber

See Also SearchResultSet.Results Property 181

PersonSearchResult Constructor Initializes a new instance of the PersonSearchResult Class. Syntax public PersonSearchResult() Public Sub New PersonSearchResult Properties The properties of the PersonSearchResult class are listed here. For a complete list of PersonSearchResult class members, see the PersonSearchResult Class topic. Public Properties
Name Description

Address Distance

An Address Class object representing the address of the person. A double indicating the distance between the search result and the 'where' component of the search query. (Inherited from the SearchResultBase Class.) A string representing the ID of the search result. (Inherited from the SearchResultBase Class.) A LocationData Class object containing information about the location of the result. (Inherited from the SearchResultBase Class.) A string containing the listing title of the search result. (Inherited from the SearchResultBase Class.) A string containing the phone number of the person.

Id

LocationData

Name

PhoneNumber

See Also SearchResultSet.Results Property PersonSearchResult.Address Property An Address Class object representing the address of the person. Get this property from the service response. Syntax

182

public Address Address { set; get; } Public Property Address As Address PersonSearchResult.PhoneNumber Property A string containing the phone number of the person. Get this property from the service response. Syntax public string PhoneNumber { set; get; } Public Property PhoneNumber As String

QuerySuggestion Class
Contains a corrected query and a corrected separated query derived from a search request. Syntax public class QuerySuggestion Public Class QuerySuggestion Constructor
Name Description

QuerySuggestion

Initializes a new instance of a QuerySuggestion object.

Public Properties
Name Description

Query StructuredQuery

A string containing a corrected version of the original search query. A StructuredSearchQuery Class containing a separated and corrected version of the original search query.

See Also SearchResponse.QuerySuggestion Property QuerySuggestion Constructor Initializes a new instance of the QuerySuggestion Class. Syntax

183

public QuerySuggestion() Public Sub New QuerySuggestion Properties The properties of the QuerySuggestion class are listed here. For a complete list of QuerySuggestion class members, see the QuerySuggestion Class topic. Public Properties
Name Description

Query StructuredQuery

A string containing a corrected version of the original search query. A StructuredSearchQuery Class containing a separated and corrected version of the original search query.

See Also SearchResponse.QuerySuggestion Property QuerySuggestion.Query Property A string containing a corrected version of the original search query. Get this property from the service response. Syntax public string Query { set; get; } Public Property Query As String QuerySuggestion.StructuredQuery Property A StructuredSearchQuery Class containing a separated and corrected version of the original search query. Get this property from the service response. Syntax public StructuredSearchQuery StructuredQuery { set; get; } Public Property StructuredQuery As StructuredSearchQuery

RangeFilter Class
Contains properties that specify a number range of allowable filter property values. This class inherits from the AvailableFilter Class. Syntax

184

public class RangeFilter : AvailableFilter Public Class RangeFilter Inherits AvailableFilter Constructor
Name Description

RangeFilter

Initializes a new instance of a RangeFilter object.

Public Properties
Name Description

MaximumValue

An object indicating the end of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. An object indicating the start of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. An int indicating the ID of the property used to filter the search results. (Inherited from the AvailableFilter Class.) A string indicating the name of the property used to filter the search results. (Inherited from the AvailableFilter Class.)

MinimumValue

PropertyId

PropertyName

Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic. RangeFilter Constructor Initializes a new instance of the RangeFilter Class. Syntax public RangeFilter() Public Sub New

185

RangeFilter Properties The properties of the RangeFilter class are listed here. For a complete list of RangeFilter class members, see the RangeFilter Class topic. Public Properties
Name Description

MaximumValue

An object indicating the end of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. An object indicating the start of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. An int indicating the ID of the property used to filter the search results. (Inherited from the AvailableFilter Class.) A string indicating the name of the property used to filter the search results. (Inherited from the AvailableFilter Class.)

MinimumValue

PropertyId

PropertyName

See Also SearchResultSet.AvailableFilters Property RangeFilter.MaximumValue Property An object indicating the end of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. Get this property from the service response. Syntax public object MaximumValue { set; get; } Public Property MaximumValue As Object Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic. RangeFilter.MinimumValue Property An object indicating the start of the range of allowable values for the filter property identified by the PropertyId and PropertyName properties. Get this property from the service response. Syntax

186

public object MinimumValue { set; get; } Public Property MinimumValue As Object Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic.

SearchOptions Class
Contains properties used to refine a search service request. Syntax public class SearchOptions Public Class SearchOptions Constructor
Name Description

SearchOptions

Initializes a new instance of a SearchOptions object.

Public Properties
Name Description

AutocorrectQuery

A bool indicating if the spelling of words in the search query should be corrected. Optional. The default value is true. An int specifying the number of search results to return. Optional. The default value is 10. A FilterExpressionBase Class array specifying how to filter the search results that are returned. Optional. A ListingType Enumeration value identifying the listing type to search. Optional. The default value is ListingType.Business. A bool indicating if the search query should only be parsed. Optional. The default is false, in which case search results are returned as well. 187

Count Filters

ListingType

ParseOnly

Name

Description

Radius

A double specifying the radius in DistanceUnits of the circle in which to search. The radius is measured from the center point of the search region returned. Optional. The default value may vary depending on the size of the search region. A SortOrder Enumeration value specifying how to sort the search results. Optional. The default value is SortOrder.Relevance. An int specifying the zero-based array index of the first result to return. Optional. The default value is 0.

SortOrder

StartingIndex

See Also SearchRequest.SearchOptions Property SearchOptions Constructor Initializes a new instance of the SearchOptions Class. Syntax public SearchOptions() Public Sub New SearchOptions Properties The properties of the SearchOptions class are listed here. For a complete list of SearchOptions class members, see the SearchOptions Class topic. Public Properties
Name Description

AutocorrectQuery

A bool indicating if the spelling of words in the search query should be corrected. Optional. The default value is true. An int specifying the number of search results to return. Optional. The default value is 10. A FilterExpressionBase Class array specifying how to filter the search results that are returned. Optional. A ListingType Enumeration value identifying the 188

Count Filters

ListingType

Name

Description

listing type to search. Optional. The default value is ListingType.Business. ParseOnly A bool indicating if the search query should only be parsed. Optional. The default is false, in which case search results are returned as well. A double specifying the radius in DistanceUnits of the circle in which to search. The radius is measured from the center point of the search region returned. Optional. The default value may vary depending on the size of the search region. A SortOrder Enumeration value specifying how to sort the search results. Optional. The default value is SortOrder.Relevance. An int specifying the zero-based array index of the first result to return. Optional. The default value is 0.

Radius

SortOrder

StartingIndex

See Also SearchRequest.SearchOptions Property SearchOptions.AutocorrectQuery Property A bool indicating if the spelling of words in the search query should be corrected. Optional. The default value is true. Set this property before making a service request. Syntax public bool AutocorrectQuery { set; get; } Public Property AutocorrectQuery As Boolean Remarks If AutocorrectQuery property is true, then any misspelled words in the search query are corrected before performing the search. If the search service finds that a search query needs to be corrected, the corrected query is returned in the SearchResponse.QuerySuggestion Property. However, the corrected query is only used to search for results if AutocorrectQuery property is set to true. If a corrected query was used to search for results, the returned SearchResultSet.QueryCorrected Property is true. See Also 189

QuerySuggestion Class SearchOptions.Count Property An int specifying the number of search results to return. Optional. The default value is 10. Set this property before making a service request. Syntax public int Count { set; get; } Public Property Count As Integer Remarks The Count property minimum value is 1 and the maximum value is 25. Use the Count property and the SearchOptions.StartingIndex Property to return search results in batches. SearchOptions.Filters Property A FilterExpressionBase Class array specifying how to filter the search results that are returned. Optional. Set this property before making a service request. Syntax public FilterExpressionBase Filters { set; get; } Public Property Filters As FilterExpressionBase Remarks The Filters property takes a FilterExpression Class object or a FilterExpressionClause Class object. Use the FilterExpressionClause Class if you want to use more than one filter. See Also Search Filter Property Table SearchOptions.ListingType Property A ListingType Enumeration value identifying the listing type to search. Optional. The default value is ListingType.Business. Set this property before making a service request. Syntax public ListingType ListingType { set; get; } Public Property ListingType As ListingType SearchOptions.ParseOnly Property A bool indicating if the search query should only be parsed. Optional. The default is false, in which case search results are returned as well. Set this property before making a service request. Syntax public bool ParseOnly { set; get; } 190

Public Property ParseOnly As Boolean Remarks If the ParseOnly property is true, then the following request properties are not used: SearchOptions.Count Property SearchOptions.Filters Property SearchOptions.StartingIndex Property SearchOptions.StartingIndex Property SearchResultSet.AvailableFilters Property SearchResultSet.EstimatedMatches Property SearchResultSet.Results Property

Additionally, the following properties in the SearchResponse.ResultSets Property are not set:

SearchOptions.Radius Property A double specifying the radius in DistanceUnits of the circle in which to search. The radius is measured from the center point of the search region returned. Optional. The default value may vary depending on the size of the search region. Syntax public double Radius { set; get; } Public Property Radius As Double Remarks The maximum allowable value for the Radius property is 250. SearchOptions.SortOrder Property A SortOrder Enumeration value specifying how to sort the search results. Optional. The default value is SortOrder.Relevance. Set this property before making a service request. Syntax public SortOrder SortOrder { set; get; } Public Property SortOrder As SortOrder SearchOptions.StartingIndex Property An int specifying the zero-based array index of the first result to return. Optional. The default value is 0. Set this property before making a service request. Syntax public int StartingIndex { set; get; } Public Property StartingIndex As Integer Remarks The StartingIndex property minimum value is 0 and the maximum value is 249.

191

Use the StartingIndex property and the SearchOptions.Count Property to return search results in batches.

SearchRegion Class
Contains a location or area that matches the 'where' component of the search query. Syntax public class SearchRegion Public Class SearchRegion Constructor
Name Description

SearchRegion

Initializes a new instance of a SearchRegion object.

Public Properties
Name Description

BoundingArea

A ShapeBase Class object that defines an area of the map that matches the 'where' component of the search query. A GeocodeResult Class object containing a geocode match for the 'where' component of the search query. A string indicating the source of the match for the 'where' component of the search query.

GeocodeLocation

Source

See Also SearchResultSet.SearchRegion Property SearchResultSet.AlternateSearchRegions Property SearchRegion Constructor Initializes a new instance of the SearchRegion Class. Syntax public SearchRegion() 192

Public Sub New SearchRegion Properties The properties of the SearchRegion class are listed here. For a complete list of SearchRegion class members, see the SearchRegion Class topic. Public Properties
Name Description

BoundingArea

A ShapeBase Class object that defines an area of the map that matches the 'where' component of the search query. A GeocodeResult Class object containing a geocode match for the 'where' component of the search query. A string indicating the source of the match for the 'where' component of the search query.

GeocodeLocation

Source

See Also SearchResultSet.AlternateSearchRegions Property SearchResultSet.SearchRegion Property SearchRegion.BoundingArea Property A ShapeBase Class object that defines an area of the map that matches the 'where' component of the search query. Get this property from the service response. Syntax public ShapeBase BoundingArea { set; get; } Public Property BoundingArea As ShapeBase Remarks The BoundingArea property is populated when the SearchRegion.Source Property is "CurrentLocation", "MapView", or "Query". SearchRegion.GeocodeLocation Property A GeocodeResult Class object containing a geocode match for the 'where' component of the search query. Get this property from the service response. Syntax public GeocodeResult GeocodeLocation { set; get; } Public Property GeocodeLocation As GeocodeResult Remarks 193

The GeocodeLocation property is populated when the SearchRegion.Source Property is "CurrentLocation" or "Query" and the 'where' component of the search query was matched to a geocode result. SearchRegion.Source Property A string indicating the source of the match for the 'where' component of the search query. Get this property from the service response. Syntax public string Source { set; get; } Public Property Source As String Remarks The following table lists the possible values for the Source property.
Source Description

"CurrentLocation"

The search query was performed using information about the user's current location, which is either provided directly in the UserProfile.CurrentLocation Property or calculated based on the IP address found in the UserProfile.IPAddress Property. In this case, both the SearchRegion.BoundingArea Property and the SearchRegion.GeocodeLocation Property may be populated. The 'where' component of the search query was matched to an area of the map, which is returned in the SearchRegion.BoundingArea Property. The 'where' component of the search query was matched to a geocode result. The SearchRegion.GeocodeLocation Property is populated with results of the geocode and the SearchRegion.BoundingArea Property contains the best map view of the geocoded result.

"MapView"

"Query"

SearchRequest Class
Contains the properties needed to make a Search service request. This class inherits from the RequestBase Class.

194

Syntax public class SearchRequest : RequestBase Public Class SearchRequest Inherits RequestBase Constructor
Name Description

SearchRequest

Initializes a new instance of a SearchRequest object.

Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A string containing the query to parse and match to a search result. Optional. A SearchOptions Class object used to refine the search request. Optional. A StructuredSearchQuery Class object containing the query to match to a search result. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Culture

ExecutionOptions

Query SearchOptions StructuredQuery

UserProfile

195

Remarks The Query, StructuredQuery, and SearchOptions properties are optional, but at least one of the following must be set: Query, StructuredQuery, or SearchOptions.Filters Property. The Query and StructuredQuery properties cannot both be specified. If the Query and StructuredQuery properties are not specified, then the SearchOptions.Filters property can only contain filters with a property ID of 1 (category filter). See Also SearchServiceClient.Search Method SearchResponse Class Search Filter Property Table SearchRequest Constructor Initializes a new instance of the SearchRequest Class. Syntax public SearchRequest() Public Sub New SearchRequest Properties The properties of the SearchRequest class are listed here. For a complete list of SearchRequest class members, see the SearchRequest Class topic. Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.) A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.) An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.) A string containing the query to parse and match to a search result. Optional. A SearchOptions Class object used to refine 196

Culture

ExecutionOptions

Query SearchOptions

Name

Description

the search request. Optional. StructuredQuery A StructuredSearchQuery Class object containing the query to match to a search result. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

UserProfile

See Also SearchServiceClient.Search Method SearchResponse Class SearchRequest.Query Property A string containing the query to parse and match to a search result. Optional. Set this property before making a service request. Syntax public string Query { set; get; } Public Property Query As String Remarks The Query property contains both the 'what' and 'where' components of a search request. The Query property string has a maximum length of 256. SearchRequest.SearchOptions Property A SearchOptions Class object used to refine the search request. Optional. Set this property before making a service request. Syntax public SearchOptions SearchOptions { set; get; } Public Property SearchOptions As SearchOptions SearchRequest.StructuredQuery Property A StructuredSearchQuery Class object containing a query to search. Optional. Set this property before making a service request. Syntax public StructuredSearchQuery StructuredQuery { set; get; } Public Property StucturedQuery As StructuredSearchQuery 197

Remarks The StructuredSearchQuery property separates the 'what' and 'where' components of a search request.

SearchResponse Class
Contains the results returned by the Search Service. This class inherits from the ResponseBase Class. Syntax public class SearchResponse : ResponseBase Public Class SearchResponse Inherits ResponseBase Constructor
Name Description

SearchResponse

Initializes a new instance of a SearchResponse object.

Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A QuerySuggestion Class object containing a corrected query and a corrected separated query derived from the search request. A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A SearchResultSet Class array, where each element contains search results from a specific listing type.

QuerySuggestion

ResponseSummary

ResultSets

198

Remarks If you are using the Visual Studio user interface or the svcutil.exe utility from the command line to create your proxy classes, the size of the web service response is restricted by the following two Windows Communication Foundation (WCF) properties. MaxReceivedMessageSize Property MaxItemsInObjectGraph Property

The Bing Maps SOAP Services may return responses larger than the default values for these properties. To ensure responses are successfully received, set these properties to the recommended values in the table below.
Service

MaxReceivedMessageSize 65536 (default) 65536 (default) 9000000 800000

MaxItemsInObjectGraph 65536 (default) 65536 (default) 7000000 65536 (default)

Geocode Service Imagery Service Route Service Search Service

See Also SearchServiceClient.Search Method SearchResponse Constructor Initializes a new instance of the SearchResponse Class. Syntax public SearchResponse() Public Sub New SearchResponse Properties The properties of the SearchResponse class are listed here. For a complete list of SearchResponse class members, see the SearchResponse Class topic. Public Properties
Name Description

BrandLogoUri

The System.Uri of the Bing Maps brand logo image. (Inherited from the ResponseBase Class.) A QuerySuggestion Class object containing a corrected query and a corrected separated 199

QuerySuggestion

Name

Description

query derived from the search request. ResponseSummary A ResponseSummary Class object describing the response that was returned by the service. (Inherited from the ResponseBase Class.) A SearchResultSet Class array, where each element contains search results from a specific listing type.

ResultSets

See Also SearchServiceClient.Search Method SearchResponse.QuerySuggestion Property A QuerySuggestion Class object containing a corrected query and a corrected separated query derived from the search request. Get this property from the service response. Syntax public QuerySuggestion QuerySuggestion { set; get; } Public Property QuerySuggestion As QuerySuggestion Remarks The QuerySuggestion property is null if there are no suggestions available. SearchResponse.ResultSets Property A SearchResultSet Class array, where each element contains search results from a specific listing type. Get this property from the service response. Syntax public SearchResultSet[] ResultSets { set; get; } Public Property ResultSets As SearchResultSet() See Also ListingType Enumeration

SearchResultBase Class
Contains properties that define a search result returned by the Search Service. Syntax public class SearchResultBase Public Class SearchResultBase 200

Constructor
Name Description

SearchResultBase

Initializes a new instance of a SearchResultBase object.

Public Properties
Name Description

Distance

A double indicating the distance between the search result and the 'where' component of the search query. A string representing the ID of the search result. A LocationData Class object containing information about the location of the result. A string containing the listing title of the search result.

Id LocationData Name

Remarks The following classes inherit from the SearchResultBase class: BusinessSearchResult Class CommunityContentSearchResult Class PersonSearchResult Class

See Also SearchResultSet.Results Property SearchResultBase Constructor Initializes a new instance of the SearchResultBase Class. Syntax public SearchResultBase() Public Sub New SearchResultBase Properties The properties of the SearchResultBase class are listed here. For a complete list of SearchResultBase class members, see the SearchResultBase Class topic. 201

Public Properties
Name Description

Distance

A double indicating the distance between the search result and the 'where' component of the search query. A string representing the ID of the search result. A LocationData Class object containing information about the location of the result. A string containing the listing title of the search result.

Id LocationData Name

See Also SearchResultSet.Results Property SearchResultBase.Distance Property A double indicating the distance between the search result and the 'where' component of the search query. Get this property from the service response. Syntax public double Distance { set; get; } Public Property Distance As Double Remarks The Distance property is returned in the units specified in the UserProfile.DistanceUnit Property. SearchResultBase.Id Property A string representing the ID of the search result. Get this property from the service response. Syntax public string Id { set; get; } Public Property Id As String SearchResultBase.LocationData Property A LocationData Class object containing information about the location of the result. Get this property from the service response. Syntax public LocationData LocationData { set; get; } Public Property LocationData As LocationData 202

SearchResultBase.Name Property A string containing the listing title of the search result. Get this property from the service response. Syntax public string Name { set; get; } Public Property Name As String Remarks If the search result is a BusinessSearchResult Class or a CommunityContentSearchResult Class, then the Name property is the point of interest title. If the search result is a PersonSearchResult Class, then the Name property is the person's full name.

SearchResultSet Class
Contains a set of search results as well as other properties that describe the search that was performed. Syntax public class SearchResultSet Public Class SearchResultSet Constructor
Name Description

SearchResultSet

Initializes a new instance of a SearchResultSet object.

Public Properties
Name Description

AlternateSearchRegions

A SearchRegion Class array containing other possible matches for the 'where' component of the search. An AvailableFilter Class array containing filters that can be used to filter the results in the Results property. A CategoryCount Class array, where each 203

AvailableFilters

CategoryCounts

Name

Description

element contains the number of results in the Results property that belong to a specified category. EstimatedMatches ListingType Parse QueryCategory QueryCorrected SearchResultSet.Results Property SearchRegion An int indicating an estimated number of matches found from the search. A string indicating the listing type of the results in the Results property. A Parse Class object containing the parsed search query. Reserved for future use. A bool indicating if a suggested query was used. A SearchResultBase Class array containing the search results. A SearchRegion Class object containing a location or area that matches the 'where' component of the search query.

See Also SearchResponse.ResultSets Property SearchResultSet Constructor Initializes a new instance of the SearchResultSet Class. Syntax public SearchResultSet() Public Sub New SearchResultSet Properties The properties of the SearchResultSet class are listed here. For a complete list of SearchResultSet class members, see the SearchResultSet Class topic. Public Properties
Name Description

AlternateSearchRegions

A SearchRegion Class array containing other possible matches for the 'where' component of 204

Name

Description

the search. AvailableFilters An AvailableFilter Class array containing filters that can be used to filter the results in the Results property. A CategoryCount Class array, where each element contains the number of results in the Results property that belong to a specified category. An int indicating an estimated number of matches found from the search. A string indicating the listing type of the results in the Results property. A Parse Class object containing the parsed search query. Reserved for future use. A bool indicating if a suggested query was used. A SearchResultBase Class array containing the search results. A SearchRegion Class object containing a location or area that matches the 'where' component of the search query.

CategoryCounts

EstimatedMatches ListingType Parse QueryCategory QueryCorrected SearchResultSet.Results Property SearchRegion

SearchResultSet.AlternateSearchRegions Property A SearchRegion Class array containing other possible matches for the 'where' component of the search. Get this property from the service response. Syntax public SearchRegion[] AlternateSearchRegions { set; get; } Public Property AlternateSearchRegions As SearchRegion() SearchResultSet.AvailableFilters Property An AvailableFilter Class array containing filters that can be used to filter the results in the Results property. Get this property from the service response. Syntax

205

public AvailableFilter[] AvailableFilters { set; get; } Public Property AvailableFilters As AvailableFilter() SearchResultSet.CategoryCounts Property A CategoryCount Class array, where each element contains the number of results in the Results property that belong to a specified category. Get this property from the service response. Syntax public CategoryCount[] CategoryCounts { set; get; } Public Property CategoryCounts As CategoryCount() SearchResultSet.EstimatedMatches Property An int indicating an estimated number of matches found from the search. Get this property from the service response. Syntax public int EstimatedMatches { set; get; } Public Property EstimatedMatches As Integer Remarks The EstimatedMatches property does not represent the number of search results returned. To get the number of returned results, use the Length property of the SearchResultSet.Results Property array. SearchResultSet.ListingType Property A string indicating the listing type of the results in the Results property. Get this property from the service response. Syntax public string ListingType { set; get; } Public Property ListingType As String Remarks The ListingType property contains one of the following values: "business", "collections", or "people". SearchResultSet.Parse Property A Parse Class object containing the parsed search query. Get this property from the service response. Syntax public Parse Parse { set; get; } Public Property Parse As Parse 206

SearchResultSet.QueryCategory Property Reserved for future use. Syntax public Category QueryCategory { set; get; } Public Property QueryCategory As Category See Also Category Class SearchResultSet.QueryCorrected Property A bool indicating if a suggested query was used. Get this property from the service response. Syntax public bool QueryCorrected { set; get; } Public Property QueryCorrected As Boolean See Also QuerySuggestion Class SearchOptions.AutocorrectQuery Property SearchResultSet.Results Property A SearchResultBase Class array containing the search results. Get this property from the service response. Syntax public SearchResultBase[] Results { set; get; } Public Property Results As SearchResultBase() SearchResultSet.SearchRegion Property A SearchRegion Class object containing a location or area that matches the 'where' component of the search query. Get this property from the service response. Syntax public SearchRegion SearchRegion { set; get; } Public Property SearchRegion As SearchRegion

SearchServiceClient Class
Contains the methods used to make requests to the Search Service. Note The name of this class and its constructor may be different depending on the tool you use to generate the client proxy classes.

207

Syntax public class SearchServiceClient : System.ServiceModel.ClientBase<ISearchService> Public Class SearchServiceClient Inherits System.ServiceModel.ClientBase(Of ISearchService) Constructor
Name Description

SearchServiceClient

Initializes a new instance of a SearchServiceClient object.

Public Methods
Name Description

Search

Performs a search based on a given query and options.

See Also SearchRequest Class SearchResponse Class SearchServiceClient Constructor Initializes a new instance of the SearchServiceClient Class. Syntax public SearchServiceClient() Public Sub New Syntax public SearchServiceClient(string endpointConfigurationName) Public Sub New(ByVal endpointConfigurationName As String) Syntax public SearchServiceClient(string endpointConfigurationName, string remoteAddress) Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String) Syntax public SearchServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) 208

Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Syntax public SearchServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, ByVal remoteAddress As System.ServiceModel.EndpointAddress) Parameters endpointConfigurationName binding remoteAddress Remarks The Search service provides endpoints for Basic HTTP and Binary over HTTP configurations. When you create a proxy for your application, references to both endpoints are added to your application. Therefore, you must specify the endpoint you want to use. To specify the endpoint, use the following endpoint configuration names.
Endpoint Configuration Type Endpoint Configuration Name

The endpoint for a service that allows clients to find and communicate with the service. The binding with which to make calls to the service. The address of the service endpoint.

Basic HTTP Binary over HTTP Example

BasicHttpBinding_ISearchService CustomBinding_ISearchService

Create a SearchServiceClient object that uses the binary over HTTP endpoint.
SearchService.SearchServiceClient SearchService = new SearchService.SearchServiceClient("CustomBinding_ISearchService"); Dim SearchServiceInstance As New SearchService.SearchServiceClient("BasicHttpBinding_ISearchService")

See Also System.ServiceModel.ClientBase.ClientBase(TChannel) Constructor SearchServiceClient Methods The methods of the SearchServiceClient class are listed here. For a complete list of SearchServiceClient class members, see the SearchServiceClient Class topic. 209

Public Methods
Name Description

Search

Performs a search based on a given query and options.

SearchServiceClient.Search Method Performs a search based on a given query and options. Syntax public SearchResponse Search(SearchRequest request) Public Function Search(ByVal request As SearchRequest) As SearchResponse Parameters request A SearchRequest object that contains the header and parameter information for the service operation. Required.

Return Value Returns a SearchResponse Class, which contains a SearchResultSet Class array. Example VirtualEarthServices#8 See Also GeocodeServiceClient.Geocode Method Search Filter Property Table

SortOrder Enumeration
Contains values that specify how to order items. Syntax public enum SortOrder Public Enum SortOrder Members
Member Description

Distance

Order the items from closest to a location to 210

Member

Description

farthest from a location. Popularity Rating Relevance Order the items from most popular to least popular. Order the items from highest rating to lowest rating. Order the items from most relevant to least relevant.

See Also SearchOptions.SortOrder Property

StructuredSearchQuery Class
Contains properties that represent the 'what' and 'where' components of a search query. Syntax public class StructuredSearchQuery Public Class StructuredSearchQuery Constructor
Name Description

StructuredSearchQuery

Initializes a new instance of a StructuredSearchQuery object.

Public Properties
Name Description

Keyword

A string specifying the 'what' component of a search query. Optional. Either the Keyword property or the Location property must be specified. A string specifying the 'where' component of a search query. Optional. Either the Keyword property or the Location property must be specified. 211

Location

See Also QuerySuggestion.StructuredQuery Property StructuredSearchQuery Constructor Initializes a new instance of the StructuredSearchQuery Class. Syntax public StructuredSearchQuery() Public Sub New StructuredSearchQuery Properties The properties of the StructuredSearchQuery class are listed here. For a complete list of StructureSearchQuery class members, see the StructuredSearchQuery Class topic. Public Properties
Name Description

Keyword

A string specifying the 'what' component of a search query. Optional. Either the Keyword property or the Location property must be specified. A string specifying the 'where' component of a search query. Optional. Either the Keyword property or the Location property must be specified.

Location

StructuredSearchQuery.Keyword Property A string specifying the 'what' component of a search query. Optional. Either the Keyword property or the Location property must be specified. Set this property before making a service request. Syntax public string Keyword { set; get; } Public Property Keyword As String Remarks The Keyword property string has a maximum length of 75. StructuredSearchQuery.Location Property

212

A string specifying the 'where' component of a search query. Optional. Either the Keyword property or the Location property must be specified. Set this property before making a service request. Syntax public string Location { set; get; } Public Property Location As String Remarks The Location property string has a maximum length of 75.

ValueListFilter Class
Represents a search filter with a fixed set of valid values. This class inherits from the AvailableFilter Class. Syntax public class ValueListFilter : AvailableFilter Public Class ValueListFilter Inherits AvailableFilter Constructor
Name Description

ValueListFilter

Initializes a new instance of a ValueListFilter object.

Public Properties
Name Description

PropertyId

An int indicating the ID of the property used to filter the search results. (Inherited from the AvailableFilter Class.) A string indicating the name of the property used to filter the search results. (Inherited from the AvailableFilter Class.) An object array specifying the valid filter property values to use to filter results.

PropertyName

Values

213

Remarks A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic. See Also SearchResultSet.AvailableFilters Property ValueListFilter Constructor Initializes a new instance of the ValueListFilter Class. Syntax public ValueListFilter() Public Sub New ValueListFilter Properties The properties of the ValueListFilter class are listed here. For a complete list of ValueListFilter class members, see the ValueListFilter Class topic. Public Properties
Name Description

PropertyId

An int indicating the ID of the property used to filter the search results. (Inherited from the AvailableFilter Class.) A string indicating the name of the property used to filter the search results. (Inherited from the AvailableFilter Class.) An object array specifying the valid filter property values to use to filter results.

PropertyName

Values

See Also SearchResultSet.AvailableFilters Property ValueListFilter.Values Property An object array specifying the valid filter property values to use to filter results. Get this property from the service response. Syntax public object[] Values { set; get; } Public Property Values As Object() Remarks 214

The Values property can be an array of one of the following types: Category Class FilterValue Class Neighborhood Class

A table of filter property IDs, property names, and values is found in the Search Filter Property Table topic.

Common Classes and Enumerations

The Bing Maps SOAP Services Common classes and enumerations are shared by all of the services.

In This Section
The following classes and enumerations are commonly used by the Bing Maps SOAP Services. Bing Maps Common Classes and Enumerations
Class or Enumeration Description

Address Class AuthenticationResultCode Enumeration Category Class Circle Class Confidence Enumeration Credentials Class DeviceType Enumeration DistanceUnit Enumeration ExecutionOptions Class FilterExpression Class

Contains parts of an address and the complete address. Contains values that indicate if service request was authenticated. Represents a point of interest category, such as 'restaurant', 'hotel', or 'gas station'. Represents a circle on the map. This class inherits from the ShapeBase Class. Contains confidence levels for geocode calculations. Contains the credentials used to authenticate the service request. Contains device types. Contains units used to measure distance. Contains properties to refine the request calculation. Represents a filter property and filter value pair used to filter search results. This class inherits from the FilterExpressionBase Class. 215

Class or Enumeration

Description

FilterExpressionBase Class FilterExpressionClause Class GeocodeLocation Class

Provides the abstract base class for a result filter. Contains two or more combined filters or filter expressions. Contains a location and a property that indicates what method was used to match the location to the map. This class inherits from the Location Class. Contains the direction an object is facing. Contains the altitude and coordinate values of a location on the map. Represents a polygon on the map. This class inherits from the ShapeBase Class. Contains the properties of a pushpin on the map. Contains properties that define a date range. Contains properties that define a number range. Represents a rectangle on the map. This class inherits from the ShapeBase Class. Contains the base properties for making a service request. The request classes of all of the services derive from the RequestBase class. Contains the base summary property for the service response. The response classes of all of the services derive from the ResponseBase class. Contains values that indicate if the service request was successful. Contains information about the response returned by the service. Provides the abstract base class for a shape on a map. 216

Heading Class Location Class Polygon Class Pushpin Class RangeOfdateTime Class RangeOfint Class Rectangle Class RequestBase Class

ResponseBase Class

ResponseStatusCode Enumeration ResponseSummary Class ShapeBase Class

Class or Enumeration

Description

SizeOfint Class UserLocation Class

Contains height and width properties to indicate size of a rectangle. Represents a location with an associated confidence level. This class inherits from the Location Class. Contains optional settings that define the end user.

UserProfile Class

See Also
Geocode Service Imagery Service Route Service Search Service

Address Class
Contains parts of an address and the complete address. Syntax public class Address Public Class Address Constructor
Name Description

Address

Initializes a new instance of an Address object.

Public Properties
Name Description

AddressLine

A string specifying the street line of an address. The AddressLine property is the most precise, official line for an address relative to the postal agency servicing the area specified by the Locality, PostalTown, or PostalCode properties. Typical use of this 217

Name

Description

element would be to enclose a street address, private bag, or any other similar official address. Optional. AdminDistrict A string specifying the subdivision name within the country or region for an address. This element is also commonly treated as the first order administrative subdivision, but in some cases it is the second, third, or fourth order subdivision within a country, dependency, or region. Optional. A string specifying the country or region name of an address. Optional. A string specifying the higher level administrative subdivision used in some countries or regions. Optional. A string containing the complete address. A string specifying the populated place for the address. This commonly refers to a city, but may refer to a suburb or neighborhood in certain countries. Optional. A string specifying the post code, postal code, or ZIP Code of an address. Optional. A string specifying the postal city of an address. Optional.

CountryRegion District

FormattedAddress Locality

PostalCode PostalTown

Remarks For an Address object to be valid, it must contain at least one context element such as PostalTown, PostalCode, AdminDistrict, District, Locality, or CountryRegion. The following table shows how parts of an address in specific countries map to the properties of the Address class.

218

Property

Austria, Belgium, Denmark, Finland, France, Germany, Greece, Luxembou rg, Norway, Sweden, Switzerlan d, Taiwan, and The Netherland s

Austral ia and Brazil

Canad a

Italy, Portuga l, and Spain

Hong Kong

Puerto Rico

Singapo re and New Zealand

United Kingdo m

United States

AddressLi ne Locality PostalTow n AdminDist rict District PostalCod e

Street address City

Street addres s City

Street addres s City

Street addres s City

Street Street addres addre s ss City City

Street Addres address s line 1 City Addres s line 2 Postal city

Street addre ss City City State

State

Provin ce

Provinc Territo e ry District

Postcode

Postal code

Postal code

Postco de

Postal code

Postcod Postco e de

Zip code

See Also GeocodeRequest.Address Property GeocodeResult.Address Property Address Constructor Initializes a new instance of the Address Class. Syntax public Address() 219

Public Sub New Address Properties The properties of the Address class are listed here. For a complete list of Address class members, see the Address Class topic. Public Properties
Name Description

AddressLine

A string specifying the street line of an address. The AddressLine property is the most precise, official line for an address relative to the postal agency servicing the area specified by the Locality, PostalTown, or PostalCode properties. Typical use of this element would be to enclose a street address, private bag, or any other similar official address. Optional. A string specifying the subdivision name within the country or region for an address. This element is also commonly treated as the first order administrative subdivision, but in some cases it is the second, third, or fourth order subdivision within a country, dependency, or region. Optional. A string specifying the country or region name of an address. Optional. A string specifying the higher level administrative subdivision used in some countries or regions. Optional. A string containing the complete address. A string specifying the populated place for the address. This commonly refers to a city, but may refer to a suburb or neighborhood in certain countries. Optional. A string specifying the post code, postal code, or ZIP Code of an address. Optional. A string specifying the postal city of an address. Optional.

AdminDistrict

CountryRegion District

FormattedAddress Locality

PostalCode PostalTown

220

See Also GeocodeRequest.Address Property Address.AddressLine Property A string specifying the street line of an address. The AddressLine property is the most precise, official line for an address relative to the postal agency servicing the area specified by the Locality, PostalTown, or PostalCode properties. Typical use of this element would be to enclose a street address, private bag, or any other similar official address. Optional. Set this property before making a service request. Syntax public string AddressLine { set; get; } Public Property AddressLine As String Address.AdminDistrict Property A string specifying the subdivision name within the country or region for an address. This element is also commonly treated as the first order administrative subdivision, but in some cases it is the second, third, or fourth order subdivision within a country, dependency, or region. Optional. Set this property before making a service request. Syntax public string AdminDistrict { set; get; } Public Property AdminDistrict As String Address.CountryRegion Property A string specifying the country or region name of an address. Optional. Set this property before making a service request. Syntax public string CountryRegion { set; get; } Public Property CountryRegion As String Address.District Property A string specifying the higher level administrative subdivision used in some countries or regions. Optional. Set this property before making a service request. Syntax public string District { set; get; } Public Property District As String Address.FormattedAddress Property A string containing the complete address. Get this property from the service response. 221

Syntax public string FormattedAddress { set; get; } Public Property FormattedAddress As String Remarks The FormattedAddress property can not be specified when making a geocode request. This property is only returned in the GeocodeResult.Address Property. If you want to geocode an address string, use the GeocodeRequest.Query Property. See Also GeocodeRequest Class Address.Locality Property A string specifying the populated place for the address. This commonly refers to a city, but may refer to a suburb or neighborhood in certain countries. Optional. Set this property before making a service request. Syntax public string Locality { set; get; } Public Property Locality As String Address.PostalCode Property A string specifying the post code, postal code, or ZIP Code of an address. Optional. Set this property before making a service request. Syntax public string PostalCode { set; get; } Public Property PostalCode As String Address.PostalTown Property A string specifying the postal city of an address. Optional. Set this property before making a service request. Syntax public string PostalTown { set; get; } Public Property PostalTown As String

AuthenticationResultCode Enumeration
Contains values that indicate if service request was authenticated.

222

Syntax public enum AuthenticationResultCode Public Enum AuthenticationResultCode Members

Member Description

CredentialsExpired InvalidCredentials NoCredentials None NotAuthorized ValidCredentials

The credentials in the service request are expired. The credentials in the service request are not valid. No credentials were included in the service request. No authentication information is available. The user identified by the credentials is not authorized to use the requested feature. The credentials in the service request are valid.

See Also ResponseSummary.AuthenticationResultCode Property

Category Class
Represents a point of interest category, such as 'restaurant', 'hotel', or 'gas station'. Syntax public class Category Public Class Category Constructor
Name Description

Category

Initializes a new instance of a Category object.

Public Properties

223

Name

Description

Id Name

An int specifying the category ID. A string specifying the category name.

See Also BusinessSearchResult.Categories Property Category Constructor Initializes a new instance of the Category Class. Syntax public Category() Public Sub New Category Properties The properties of the Category class are listed here. For a complete list of Category class members, see the Category Class topic. Public Properties
Name Description

Id Name See Also BusinessSearchResult.Categories Property Category.Id Property

An int specifying the category ID. A string specifying the category name.

An int specifying the category ID. Get this property from the service response. Syntax public int Id { set; get; } Public Property Id As Integer Category.Name Property A string specifying the category name. Get this property from the service response. Syntax public string Name { set; get; } 224

Public Property Name As String

Circle Class
Represents a circle on the map. This class inherits from the ShapeBase Class. Syntax public class Circle : ShapeBase Public Class Circle Inherits ShapeBase Constructor
Name Description

Circle

Initializes a new instance of a Circle object.

Public Properties
Name Description

Center DistanceUnit

A Location Class object specifying the center of the circle. A DistanceUnit Enumeration indicating the unit of measurement of the value in the Radius property. A double specifying the radius of the circle.

Radius

See Also SearchRegion.BoundingArea Property Circle Constructor Initializes a new instance of the Circle Class. Syntax public Circle() Public Sub New Circle Properties The properties of the Circle class are listed here. For a complete list of Circle class members, see the Circle Class topic. 225

Public Properties
Name Description

Center DistanceUnit

A Location Class object specifying the center of the circle. A DistanceUnit Enumeration indicating the unit of measurement of the value in the Radius property. A double specifying the radius of the circle.

Radius See Also SearchRegion.BoundingArea Property Circle.Center Property

A Location Class object specifying the center of the circle. Get this property from the service response. Syntax public Location Center { set; get; } Public Property Center As Location Circle.DistanceUnit Property A DistanceUnit Enumeration indicating the unit of measurement of the value in the Radius property. Get this property from the service response. Syntax public DistanceUnit DistanceUnit { set; get; } Public Property DistanceUnit As DistanceUnit Remarks The DistanceUnit property value is the same as the value specified in the UserProfile.DistanceUnit Property in the service request. Circle.Radius Property A double specifying the radius of the circle. Get this property from the service response. Syntax public double Radius { set; get; } Public Property Radius As Double

226

Confidence Enumeration
Contains confidence levels for geocode calculations. Syntax public enum Confidence Public Enum Confidence Members
Member Description

High Low Medium

The geocode service has high confidence in the match. The geocode service has low confidence in the match. The geocode service has medium confidence in the match.

See Also GeocodeResult.Confidence Property

Credentials Class
Contains the credentials used to authenticate the service request. Syntax public class Credentials Public Class Credentials Constructor
Name Description

Credentials

Initializes a new instance of a Credentials object.

Public Properties

227

Name

Description

ApplicationId

A string representing the application ID, or Bing Maps Key, obtained from the Bing Maps Account Center. Optional. Either the ApplicationId property or the Token property must be specified.

Token Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys. A string representing the client token obtained from the Virtual Earth Token Service. Optional. Either the ApplicationId property or the Token property must be specified.

See Also Accessing the Bing Maps SOAP Services RequestBase.Credentials Property Credentials Constructor Initializes a new instance of the Credentials Class. Syntax public Credentials() Public Sub New Credentials Properties The properties of the Credentials class are listed here. For a complete list of Credentials class members, see the Credentials Class topic. 228

Public Properties
Name Description

ApplicationId

A string representing the application ID, or Bing Maps Key, obtained from the Bing Maps Account Center. Optional. Either the ApplicationId property or the Token property must be specified.

Token Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys. A string representing the client token obtained from the Virtual Earth Token Service. Optional. Either the ApplicationId property or the Token property must be specified. See Also Accessing the Bing Maps SOAP Services RequestBase.Credentials Property Credentials.ApplicationId Property A string representing the application ID, or Bing Maps Key, obtained from the Bing Maps Account Center. Optional. Either the ApplicationId property or the Token property must be specified. Syntax public string ApplicationId { set; get; } Public Property ApplicationId As String See Also Accessing the Bing Maps SOAP Services 229

Credentials.Token Property

Bing Maps Keys are the recommended authentication method for the Bing Maps AJAX Control, the Bing Maps Silverlight Control, the Bing Maps SOAP Services, the Bing Maps REST Services, and the Bing Spatial Data Services as described in Getting a Bing Maps Key. Information about transaction accounting provided by Bing Maps Keys is in Viewing Bing Maps Usage Reports. If you are an existing customer using tokens, consider updating your application to use Bing Maps Keys. A string representing the client token obtained from the Bing Maps Token Service. Optional. Either the ApplicationId property or the Token property must be specified. Syntax public string Token { set; get; } Public Property Token As String See Also Accessing the Bing Maps SOAP Services Credentials.ApplicationId Property

DeviceType Enumeration
Contains device types. Syntax public enum DeviceType Public Enum DeviceTypE Members
Member Description

Desktop Mobile

The device is a desktop computer. The device is a mobile device.

Remarks If the UserProfile.DeviceType Property specified is Mobile, then the ImageryMetadataResult.ImageUri Property contains a URI for a map designed for mobile devices. This only applies to the AerialWithLabels and Road map styles. See Also UserProfile.DeviceType Property 230

DistanceUnit Enumeration
Contains units used to measure distance. Syntax public enum DistanceUnit Public Enum DistanceUniT Members
Member Description

Kilometer Mile

Distances are given in kilometers. Distances are given in miles.

See Also UserProfile.DistanceUnit Property

ExecutionOptions Class
Contains properties to refine the request calculation. Syntax public class ExecutionOptions Public Class ExecutionOptions Constructor
Name Description

ExecutionOptions

Initializes a new instance of an ExecutionOptions object.

Public Properties
Name Description

SuppressFaults

A bool indicating if the service should suppress Bing Maps faults. Optional. The default value is false, which means Bing Maps faults are returned. 231

See Also RequestBase.ExecutionOptions Property ExecutionOptions Constructor Initializes a new instance of the ExecutionOptions Class. Syntax public ExecutionOptions() Public Sub New ExecutionOptions Properties The properties of the ExecutionOptions class are listed here. For a complete list of ExecutionOptions class members, see the ExecutionOptions Class topic. Public Properties
Name Description

SuppressFaults

A bool indicating if the service should suppress Bing Maps faults. Optional. The default value is false, which means Bing Maps faults are returned.

See Also RequestBase.ExecutionOptions Property ExecutionOptions.SuppressFaults Property A bool indicating if the service should suppress Bing Maps faults. Optional. The default value is false, which means Bing Maps faults are returned. Set this property before making a service request. Syntax public bool SuppressFaults { set; get; } Public Property SuppressFaults As Boolean Remarks The SuppressFaults property setting is only applicable to Bing Maps faults. Other faults, including Windows Communication Foundation faults, are not affected by this property setting.

FilterExpression Class
Represents a filter property and filter value pair used to filter search results. This class inherits from the FilterExpressionBase Class.

232

Syntax public class FilterExpression : FilterExpressionBase Public Class FilterExpression Inherits FilterExpressionBase Constructor
Name Description

FilterExpression

Initializes a new instance of a FilterExpression object.

Public Properties
Name Description

CompareOperator

A CompareOperator Enumeration value specifying how to compare the FilterValue against the corresponding property value of a search result. Required. An object specifying the filter property value. Required. An int specifying the filter property ID. Required.

FilterValue PropertyId

Remarks Filter property IDs, names, and values are listed in the Search Filter Property Table. See Also SearchOptions.Filters Property FilterExpression Constructor Initializes a new instance of the FilterExpression Class. Syntax public FilterExpression() Public Sub New FilterExpression Properties The properties of the FilterExpression class are listed here. For a complete list of FilterExpression class members, see the FilterExpression Class topic. 233

Public Properties
Name Description

CompareOperator

A CompareOperator Enumeration value specifying how to compare the FilterValue against the corresponding property value of a search result. Required. An object specifying the filter property value. Required. An int specifying the filter property ID. Required.

FilterValue PropertyId

FilterExpression.CompareOperator Property A CompareOperator Enumeration value specifying how to compare the FilterValue against the corresponding property value of a search result. Required. Set this property before making a service request. Syntax public CompareOperator CompareOperator{ set; get; } Public Property CompareOperator As CompareOperator Remarks If the filter property name is UserRating, then all members of the CompareOperator Enumeration are valid operators. For all other filter properties, only the Equals member of the CompareOperator enumeration is valid. See the Search Filter Property Table for available filter properties. See Also Search Filter Property Table FilterExpression.FilterValue Property An object specifying the filter property value. Required. Set this property before making a service request. Syntax public object FilterValue { set; get; } Public Property FilterValue As Object Remarks The FilterValue property can be one of the following types: int or double. See Also Search Filter Property Table 234

FilterExpression.PropertyId Property An int specifying the filter property ID. Required. Set this property before making a service request. Syntax public int PropertyId { set; get; } Public Property PropertyId As Integer See Also Search Filter Property Table

FilterExpressionBase Class
Provides the abstract base class for a result filter. Syntax public class FilterExpressionBase Public Class FilterExpressionBase Constructor
Name Description

FilterExpressionBase

Initializes a new instance of a FilterExpressionBase object.

Remarks The FilterExpression Class and the FilterExpressionClause Class inherit from FilterExpressionBase. See Also SearchOptions.Filters Property FilterExpressionClause.Expressions Property FilterExpressionBase Constructor Initializes a new instance of the FilterExpressionBase Class. Syntax public FilterExpressionBase() Public Sub New

235

FilterExpressionClause Class
Contains two or more combined filters or filter expressions. Syntax public class FilterExpressionClause : FilterExpressionBase Public Class FilterExpressionClause Inherits FilterExpressionBase Constructor
Name Description

FilterExpressionClause

Initializes a new instance of a FilterExpressionClause object.

Public Properties
Name Description

Expressions

A FilterExpressionBase Class array containing the filters or filter clauses to combine using the LogicalOperator property. Required. A LogicalOperator Enumeration value specifying how to combine the filters in the Expressions property. Required.

LogicalOperator

Remarks Filter property IDs, names, and values are found in the Search Filter Property Table. See Also SearchOptions.Filters Property FilterExpressionClause Constructor Initializes a new instance of the FilterExpressionClause Class. Syntax public FilterExpressionClause() Public Sub New

236

FilterExpressionClause Properties The properties of the FilterExpressionClause class are listed here. For a complete list of FilterExpressionClause class members, see the FilterExpressionClause Class topic. Public Properties
Name Description

Expressions

A FilterExpressionBase Class array containing the filters or filter clauses to combine using the LogicalOperator property. Required. A LogicalOperator Enumeration value specifying how to combine the filters in the Expressions property. Required.

LogicalOperator

FilterExpressionClause.Expressions Property A FilterExpressionBase Class array containing the filters or filter clauses to combine using the LogicalOperator property. Required. Set this property before making a service request. Syntax public FilterExpressionBase[] Expressions { set; get; } Public Property Expressions As FilterExpressionBase() Remarks The Expressions property array must contain at least 2 elements and no more than 5. The Expressions property cannot have more than 5 levels of nested clauses. FilterExpressionClause.LogicalOperator Property A LogicalOperator Enumeration value specifying how to combine the filters in the Expressions property. Required. Set this property before making a service request. Syntax public LogicalOperator LogicalOperator { set; get; } Public Property LogicalOperator As LogicalOperator Remarks If more than one logical operator is required, specify a FilterExpressionClause Class object in the Expressions property.

GeocodeLocation Class
Contains a location and a property that indicates what method was used to match the location to the map. This class inherits from the Location Class. 237

Syntax public class GeocodeLocation : Location Public Class GeocodeLocation Inherits Location Constructor
Name Description

GeocodeLocation

Initializes a new instance of a GeocodeLocation object.

Public Properties
Name Description

Altitude CalculationMethod Latitude

Reserved for future use. A string indicating the geocode method that was used to match the location to the map. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.) A double specifying the longitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.)

Longitude

See Also GeocodeResult.Locations Property GeocodeLocation Constructor Initializes a new instance of the GeocodeLocation Constructor. Syntax public GeocodeLocation() Public Sub New GeocodeLocation Properties The properties of the GeocodeLocation class are listed here. For a complete list of GeocodeLocation class members, see the GeocodeLocation Class topic. Public Properties 238

Name

Description

Altitude CalculationMethod Latitude

Reserved for future use. A string indicating the geocode method that was used to match the location to the map. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.) A double specifying the longitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.)

Longitude

See Also GeocodeResult.Locations Property GeocodeLocation.CalculationMethod Property A string indicating the geocode method that was used to match the location to the map. Get this property from the service response. Syntax public string CalculationMethod { set; get; } Public Property CalculationMethod As String Remarks The values for the CalculationMethod property are found in the Geocode Match Code and Match Method Tables topic.

Heading Class
Contains the direction an object is facing. Syntax public class Heading Public Class Heading Constructor
Name Description

Heading

Initializes a new instance of a Heading object.

239

Public Properties
Name Description

Orientation

A double specifying the direction, in degrees. Optional. The default value is 0.

See Also ImageryMetadataOptions.Heading Property ImageryMetadataBirdseyeResult.Heading Property Heading Constructor Initializes a new instance of the Heading Class. Syntax public Heading() Public Sub New Heading Properties The properties of the Heading class are listed here. For a complete list of Heading class members, see the Heading Class topic. Public Properties
Name Description

Orientation

A double specifying the direction, in degrees. Optional. The default value is 0.

See Also ImageryMetadataOptions.Heading Property ImageryMetadataBirdseyeResult.Heading Property Heading.Orientation Property A double specifying the direction, in degrees. Optional. The default value is 0. Syntax public double Orientation { set; get; } Public Property Orientation As Double Remarks The valid range of values for the Orientation property is 0 to 360. 240

The compass directions North, East, South, and West are specified using the values 0, 90, 180, and 270, respectively. If imagery is not available for the orientation specified, imagery with the orientation closest to the specified value is returned.

Location Class
Contains the altitude and coordinate values of a location on the map. Syntax public class Location Public Class Location Constructor
Name Description

Location

Initializes a new instance of a Location object.

Public Properties
Name Description

Altitude Latitude

Reserved for future use. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. A double specifying the longitude of a single point on the globe. Optional. The default value is 0.

Longitude

Remarks The GeocodeLocation Class and the UserLocation Class inherit from the Location class. See Also Circle.Center Property ImageryMetadataOptions.Location Property ItineraryItem.Location Property MapUriRequest.Center Property Polygon.Vertices Property 241

Pushpin.Location Property Rectangle Class ReverseGeocodeRequest.Location Property RouteLeg Class RoutePath.Points Property Waypoint.Location Property Location Constructor Initializes a new instance of the Location Class. Syntax public Location() Public Sub New Location Properties The properties of the Location class are listed here. For a complete list of Location class members, see the Location Class topic. Public Properties
Name Description

Altitude Latitude

Reserved for future use. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. A double specifying the longitude of a single point on the globe. Optional. The default value is 0.

Longitude

Location.Latitude Property A double specifying the latitude of a single point on the globe. Optional. The default value is 0. Syntax public double Latitude { set; get; } Public Property Latitude As Double Remarks This property is a floating-point value in decimal degrees representing a WGS 84 datum. Valid values range from -90 to 90. See Also 242

Location.Longitude Property Location.Longitude Property A double specifying the longitude of a single point on the globe. Optional. The default value is 0. Syntax public double Longitude { set; get; } Public Property Longitude As Double Remarks This property is a floating-point value in decimal degrees representing a WGS 84 datum. Valid values range from -180 to 180. See Also Location.Latitude Property

LogicalOperator Enumeration
Contains values that link two expressions. Syntax public enum LogicalOperator Public Enum LogicalOperator Members
Member Description

And Or

Connects two expressions that both must be true Connects two expressions where either one or both must be true

See Also FilterExpressionClause.LogicalOperator Property

Polygon Class
Represents a polygon on the map. This class inherits from the ShapeBase Class. Syntax public class Polygon : ShapeBase 243

Public Class Polygon Inherits ShapeBase Constructor

Name Description

Polygon

Initializes a new instance of a Polygon object.

Public Properties
Name Description

Vertices

A Location Class array specifying the vertices of the polygon. Required.

Polygon Constructor Initializes a new instance of the Polygon Class. Syntax public Polygon() Public Sub New Polygon Properties The properties of the Polygon class are listed here. For a complete list of Polygon class members, see the Polygon Class topic. Public Properties
Name Description

Vertices

A Location Class array specifying the vertices of the polygon. Required.

Polygon.Vertices Property A Location Class array specifying the vertices of the polygon. Required. Set this property before making a service request. Syntax public Location[] Vertices { set; get; } Public Property Vertices As Location()

244

Pushpin Class
Contains the properties of a pushpin on the map. Syntax public class Pushpin Public Class Pushpin Constructor
Name Description

Pushpin

Initializes a new instance of a Pushpin object.

Public Properties
Name Description

IconStyle

A string indicating the pushpin style to use. Optional. The default value is pushpin style "1", unless the PreventIconCollision property is set to true, in which case the default pushpin style is "15". A string containing the text to show on the pushpin. Optional. The default value is the empty string, which means there is no label. A Location Class object specifying where the pushpin is located on the map. Required.

Label

Location

See Also MapUriRequest.Pushpins Property Pushpin Constructor Initializes a new instance of a Pushpin Class. Syntax public Pushpin() Public Sub New

245

Pushpin Properties The properties of the Pushpin class are listed here. For a complete list of Pushpin class members, see the Pushpin Class topic. Public Properties
Name Description

IconStyle

A string indicating the pushpin style to use. Optional. The default value is pushpin style "1", unless the PreventIconCollision property is set to true, in which case the default pushpin style is "15". A string containing the text to show on the pushpin. Optional. The default value is the empty string, which means there is no label. A Location Class object specifying where the pushpin is located on the map. Required.

Label

Location

See Also MapUriRequest.Pushpins Property Pushpin.IconStyle Property A string indicating the pushpin style to use. Optional. The default value is pushpin style "1", unless the PreventIconCollision property is set to true, in which case the default pushpin style is "15". Set this property before making a service request. Syntax public string IconStyle { set; get; } Public Property IconStyle As String Remarks The following table shows the available pushpin icon styles.
IconStyle Icon

246

IconStyle

Icon

247

IconStyle

Icon

10

11

12

13

14

248

IconStyle

Icon

15

16

17

18

19

20

21

249

IconStyle

Icon

22

23

24

25

26

27

28

250

IconStyle

Icon

29

30

31

32

33

34

35

251

IconStyle

Icon

36

Pushpin.Label Property A string containing the text to show on the pushpin. Optional. The default value is the empty string, which means there is no label. Set this property before making a service request. Syntax public string Label { set; get; } Public Property Label As String Remarks The Label property has a maximum length of 2 characters. Pushpin.Location Property A Location Class object specifying where the pushpin is located on the map. Required. Set this property before making a service request. Syntax public Location Location { set; get; } Public Property Location As Location

RangeOfdateTime Class
Contains properties that define a date range. Syntax public class RangeOfdateTime Public Class RangeOfdateTime Constructor
Name Description

RangeOfdateTime

Initializes a new instance of a RangeOfdateTime object.

252

Public Properties
Name Description

From To

A System.DateTime class object representing the beginning of the date range. A System.DateTime class object representing the end of the date range.

See Also ImageryMetadataResult.Vintage Property RangeOfdateTime Constructor Initializes a new instance of the RangeOfdateTime Class. Syntax public RangeOfdateTime() Public Sub New RangeOfdateTime Properties The properties of the RangeOfdateTime class are listed here. For a complete list of RangeOfdateTime class members, see the RangeOfdateTime Class topic. Public Properties
Name Description

From To

A System.DateTime class object representing the beginning of the date range. A System.DateTime class object representing the end of the date range.

See Also ImageryMetadataResult.Vintage Property RangeOfdateTime.From Property A System.DateTime class object representing the beginning of the date range. Get this property from the service response. Syntax public System.DateTime From { set; get; } Public Property From As System.DateTime 253

RangeOfdateTime.To Property A System.DateTime class object representing the end of the date range. Get this property from the service response. Syntax public System.DateTime To { set; get; } Public Property To As System.DateTime

RangeOfint Class
Contains properties that define a number range. Syntax public class RangeOfint Public Class RangeOfint Constructor
Name Description

RangeOfint

Initializes a new instance of a RangeOfint object.

Public Properties
Name Description

From To

An int representing the beginning of the number range. An int representing the end of the number range.

See Also ImageryMetadataResult.ZoomRange Property RangeOfint Constructor Initializes a new instance of the RangeOfint Class. Syntax public RangeOfint() 254

Public Sub New RangeOfint Properties The properties of the RangeOfint class are listed here. For a complete list of RangeOfint class members, see the RangeOfint Class topic. Public Properties
Name Description

From To

An int representing the beginning of the number range. An int representing the end of the number range.

See Also ImageryMetadataResult.ZoomRange Property RangeOfint.From Property An int representing the beginning of the number range. Get this property from the service response. Syntax public int From { set; get; } Public Property From As Integer RangeOfint.To Property An int representing the end of the number range. Get this property from the service response. Syntax public int To { set; get; } Public Property To As Integer

Rectangle Class
Represents a rectangle on the map. This class inherits from the ShapeBase Class. Syntax public class Rectangle : ShapeBase Public Class Rectangle Inherits ShapeBase Constructor 255

Name

Description

Rectangle

Initializes a new instance of a Rectangle object.

Public Properties
Name Description

Northeast Southwest

A Location Class object specifying the upperright corner of the rectangle. Required. A Location Class object specifying the lowerleft corner of the rectangle. Required.

See Also UserProfile.MapView Property GeocodeResult.BestView Property RouteSummary.BoundingRectangle Property Rectangle Constructor Initializes a new instance of the Rectangle Class. Syntax public Rectangle() Public Sub New Rectangle Properties The properties of the Rectangle class are listed here. For a complete list of Rectangle class members, see the Rectangle Class topic. Public Properties
Name Description

Northeast Southwest

A Location Class object specifying the upperright corner of the rectangle. Required. A Location Class object specifying the lowerleft corner of the rectangle. Required.

See Also UserProfile.MapView Property 256

GeocodeResult.BestView Property RouteSummary.BoundingRectangle Property Rectangle.Northeast Property A Location Class object specifying the upper-right corner of the rectangle. Required. Set this property before making a service request. Syntax public Location Northeast { set; get; } Public Property Northeast As Location Rectangle.Southwest Property A Location Class object specifying the lower-left corner of the rectangle. Required. Set this property before making a service request. Syntax public Location Southwest { set; get; } Public Property Southwest As Location

RequestBase Class
Contains the base properties for making a service request. The request classes of all of the services derive from the RequestBase class. Syntax public class RequestBase Public Class RequestBase Constructor
Name Description

RequestBase

Initializes a new instance of a RequestBase object.

Public Properties
Name Description

Credentials

A Credentials Class object that identifies the requestor. Required.

257

Name

Description

Culture

A string specifying the culture in which to return results. Optional. The default value is "en-US". An ExecutionOptions Class object specifying calculation and return options of the request. Optional. A UserProfile Class object containing user information helpful in service calculations. Optional.

ExecutionOptions

UserProfile

See Also ResponseBase Class RequestBase Constructor Initializes a new instance of the RequestBase Class. Syntax public RequestBase() Public Sub New See Also ResponseBase Class RequestBase Properties The properties of the RequestBase class are listed here. For a complete list of RequestBase class members, see the RequestBase Class topic. Public Properties
Name Description

Credentials Culture

A Credentials Class object that identifies the requestor. Required. A string specifying the culture in which to return results. Optional. The default value is "en-US". An ExecutionOptions Class object specifying calculation and return options of the request. Optional. 258

ExecutionOptions

Name

Description

UserProfile

A UserProfile Class object containing user information helpful in service calculations. Optional.

RequestBase.Credentials Property A Credentials Class object that identifies the requestor. Required. Set this property before making a service request. Syntax public Credentials Credentials { set; get; } Public Property Credentials As Credentials See Also Accessing the Bing Maps SOAP Services RequestBase.Culture Property A string specifying the culture in which to return results. Optional. The default value is "en-US". Set this property before making a service request. Syntax public string Culture { set; get; } Public Property Culture As String Remarks Depending on the culture string specified, the following items will be returned in the language of the culture: Geographic entities and place names returned from the Geocode Service. Map labels on the images returned by the Imagery Service or Bing Maps tile servers. Route directions text returned by the Route Service. Place name search results returned by the Search Service. Business names are not localized.

Some cultures return business data through the Bing Maps SOAP Search Service. These cultures are Germany (de-DE), Canada (en-CA, fr-CA), the United Kingdom (en-GB), India (enIN), The United States (en-US), France (fr-FR), and Italy (it-IT) The following table lists the supported culture strings for each service. If you set the culture string to a valid culture not found in this table, the default culture ("en-US") is used. If you set the culture string to an invalid culture, a fault is returned.

259

Language - Country/Region

Culture String

Service Support

Czech - Czech Republic** Danish - Denmark** Dutch - Netherlands** English - Australia English - Canada* English - India*** English - United Kingdom** English - United States

cs-CZ da-DK nl-NL en-AU en-CA en-IN en-GB en-US

Geocode Service, Route Service Geocode Service, Route Service Geocode Service, Route Service Route Service Geocode Service, Route Service, Search Service Search Service Geocode Service, Route Service, Search Service Geocode Service, Route Service, Search Service, Imagery Service This is the default culture.

Finnish -Finland** French - Canada* French - France**

fi-FI fr-CA fr-FR

Geocode Service, Route Service Geocode Service, Route Service, Search Service Geocode Service, Route Service, Search Service, Imagery Service Geocode Service, Route Service, Search Service, Imagery Service Geocode Service, Route Service, Search Service, Imagery Service Geocode Service, Route Service, Search Service Geocode Service, Route Service Geocode Service, Route 260

German - Germany**

de-DE

Italian - Italy**

it-IT

Japanese - Japan Norwegian (Bokmal) - Norway** Portuguese - Brazil**

ja-JP nb-NO Pt-BR

Language - Country/Region

Culture String

Service Support

Service Portuguese - Portugal** Spanish - Spain** Spanish - United States* Swedish - Sweden** pt-PT es-ES es-US sv-SE Geocode Service, Route Service Geocode Service, Route Service, Imagery Service Route Service, Search Service Geocode Service, Route Service

* Support for this culture is limited to the United States and Canada. ** Support for this culture is limited to Europe. *** Information about a fully supported set of web services for India users is found at http://dev.mapindia.live.com/sdk. RequestBase.ExecutionOptions Property An ExecutionOptions Class object specifying calculation and return options of the request. Optional. Set this property before making a service request. Syntax public ExecutionOptions ExecutionOptions { set; get; } Public Property ExecutionOptions As ExecutionOptions RequestBase.UserProfile Property A UserProfile Class object containing user information helpful in service calculations. Optional. Set this property before making a service request. Syntax public UserProfile UserProfile { set; get; } Public Property UserProfile As UserProfile

ResponseBase Class
Contains the base summary property for the service response. The response classes of all of the services derive from the ResponseBase class.

261

Whenever you use or display results returned from the Bing Maps SOAP Services, you need to also display the logo returned in the ResponseBase.BrandLogoUri Property and copyright notices returned in the ResponseSummary.Copyright Property. Syntax public class ResponseBase Public Class ResponseBase Constructor
Name Description

ResponseBase

Initializes a new instance of a ResponseBase object.

Public Properties
Name Description

BrandLogoUri ResponseSummary

The System.Uri of the Bing Maps brand logo image. A ResponseSummary Class object describing the response that was returned by the service.

Remarks If you are using the Visual Studio user interface or the svcutil.exe utility from the command line to create your proxy classes, the size of the web service response is restricted by the following two Windows Communication Foundation (WCF) properties. MaxReceivedMessageSize Property MaxItemsInObjectGraph Property

The Bing Maps SOAP Services may return responses larger than the default values for these properties. To ensure responses are successfully received, set these properties to the recommended values in the table below.
Service

MaxReceivedMessageSize 65536 (default) 65536 (default) 9000000

MaxItemsInObjectGraph 65536 (default) 65536 (default) 7000000 262

Geocode Service Imagery Service Route Service

Service

MaxReceivedMessageSize 800000

MaxItemsInObjectGraph 65536 (default)

Search Service

See Also RequestBase Class ResponseBase Constructor Initializes a new instance of the ResponseBase Class. Syntax public ResponseBase() Public Sub New ResponseBase Properties The properties of the ResponseBase class are listed here. For a complete list of ResponseBase class members, see the ResponseBase Class topic. Public Properties
Name Description

BrandLogoUri ResponseSummary

The System.Uri of the Bing Maps brand logo image. A ResponseSummary Class object describing the response that was returned by the service.

ResponseBase.BrandLogoUri Property The System.Uri of the Bing Maps brand logo image. Syntax public System.Uri BrandLogoUri { set; get; } Public Property BrandLogoUri As System.Uri Remarks Whenever you use or display results returned from the Bing Maps SOAP Services, you need to also display the logo returned in the BrandLogoUri property and copyright notices returned in the ResponseSummary.Copyright Property. ResponseBase.ResponseSummary Property A ResponseSummary Class object describing the response that was returned by the service. Get this property from the service response. Syntax 263

public ResponseSummary ResponseSummary { set; get; } Public Property ResponseSummary As ResponseSummary

ResponseStatusCode Enumeration
Contains values that indicate if the service request was successful. Syntax public enum ResponseStatusCode Public Enum ResponseStatusCode Members
Member Description

BadRequest ServerError Success

The service request was malformed and results could not be returned. An error occurred while the request was being processed. The service request was successful and results were returned.

See Also ResponseSummary.StatusCode Property

ResponseSummary Class
Contains information about the response returned by the service. Syntax public class ResponseSummary Public Class ResponseSummary Constructor
Name Description

ResponseSummary

Initializes a new instance of a ResponseSummary object. 264

Public Properties
Name Description

AuthenticationResultCode

An AuthenticationResultCode Enumeration value indicating whether or not the Credentials passed were valid. The Bing Maps SOAP Services copyright string. A string describing the fault, if one occurred. A ResponseStatusCode Enumeration value indicating whether or not the request was fulfilled. A unique string that identifies the request.

Copyright FaultReason StatusCode

TraceId

See Also ResponseBase Class ResponseSummary Constructor Initializes a new instance of the ResponseSummary Class. Syntax public ResponseSummary() Public Sub New ResponseSummary Properties The properties of the ResponseSummary class are listed here. For a complete list of ResponseSummary class members, see the ResponseSummary Class topic. Public Properties
Name Description

AuthenticationResultCode

An AuthenticationResultCode Enumeration value indicating whether or not the Credentials passed were valid. The Bing Maps SOAP Services copyright string. A string describing the fault, if one occurred. A ResponseStatusCode Enumeration value 265

Copyright FaultReason StatusCode

Name

Description

indicating whether or not the request was fulfilled. TraceId See Also ResponseBase Class ResponseSummary.AuthenticationResultCode Property An AuthenticationResultCode Enumeration value indicating whether or not the Credentials passed were valid. Get this property from the service response. Syntax public AuthenticationResultCode AuthenticationResultCode { set; get; } Public Property AuthenticationResultCode As AuthenticationResultCode ResponseSummary.Copyright Property The Bing Maps copyright string. Get this property from the service response. Syntax public string Copyright { set; get; } Public Property Copyright As String Remarks Whenever you use or display results returned from the Bing Maps SOAP Services, you need to also display the logo returned in the ResponseBase.BrandLogoUri Property and copyright notices returned in the Copyright property. ResponseSummary.FaultReason Property A string describing the fault, if one occurred. Get this property from the service response. Syntax public string FaultReason { set; get; } Public Property FaultReason As String Remarks The FaultReason property is empty if the ResponseSummary.StatusCode Property has a value of StatusCode.Success. ResponseSummary.StatusCode Property A ResponseStatusCode Enumeration value indicating whether or not the request was fulfilled. Get this property from the service response. 266 A unique string that identifies the request.

Syntax public StatusCode StatusCode { set; get; } Public Property StatusCode As StatusCode Remarks If the StatusCode property value is BadRequest or ServerError, then the corresponding fault message is in the ResponseSummary.FaultReason Property. ResponseSummary.TraceId Property A unique string that identifies the request. Get this property from the service response. Syntax public string TraceId { set; get; } Public Property TraceId As String

ShapeBase Class
Provides the abstract base class for a shape on a map. Syntax public class ShapeBase Public Class ShapeBase Constructor
Name Description

ShapeBase

Initializes a new instance of a ShapeBase object.

Remarks The Circle Class, the Polygon Class and the Rectangle Class inherit from the ShapeBase class. ShapeBase Constructor Initializes a new instance of the ShapeBase Class. Syntax public ShapeBase() Public Sub New

267

SizeOfint Class
Contains height and width properties to indicate size of a rectangle. Syntax public class SizeOfint Public Class SizeOfint Constructor
Name Description

SizeOfint

Initializes a new instance of a SizeOfint object.

Public Properties
Name Description

Height Width

An int specifying height in pixels. An int specifying width in pixels.

See Also ImageryMetadataResult.ImageSize Property MapUriOptions.ImageSize Property SizeOfint Constructor Initializes a new instance of the SizeOfint Class. Syntax public SizeOfint() Public Sub New SizeOfint Properties The properties of the SizeOfint class are listed here. For a complete list of SizeOfint class members, see the SizeOfint Class topic. Public Properties
Name Description

Height

An int specifying height in pixels.

268

Name

Description

Width See Also ImageryMetadataResult.ImageSize Property MapUriOptions.ImageSize Property SizeOfint.Height Property

An int specifying width in pixels.

An int specifying height in pixels. Get this property from the service response. Syntax public int Height { set; get; } Public Property Height As Integer SizeOfint.Width Property An int specifying width in pixels. Get this property from the service response. Syntax public int Width { set; get; } Public Property Width As Integer

UserLocation Class
Represents a location with an associated confidence level. This class inherits from the Location Class. Syntax public class UserLocation : Location Public Class UserLocation Inherits Location Constructor
Name Description

UserLocation

Initializes a new instance of a UserLocation object.

Public Properties

269

Name

Description

Altitude Confidence

Reserved for future use. A Confidence Enumeration value indicating the level of confidence that the user is at the current location. Optional. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.) A double specifying the longitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.)

Latitude

Longitude

See Also UserProfile.CurrentLocation Property UserLocation Constructor Initializes a new instance of the UserLocation Class. Syntax public UserLocation() Public Sub New UserLocation Properties The properties of the UserLocation class are listed here. For a complete list of UserLocation class members, see the UserLocation Class topic. Public Properties
Name Description

Altitude Confidence

Reserved for future use. A Confidence Enumeration value indicating the level of confidence that the user is at the current location. Optional. A double specifying the latitude of a single point on the globe. Optional. The default value is 0. (Inherited from the Location Class.) A double specifying the longitude of a single point on the globe. Optional. The default value 270

Latitude

Longitude

Name

Description

is 0. (Inherited from the Location Class.) See Also UserProfile.CurrentLocation Property UserLocation.Confidence Property A Confidence Enumeration value indicating the level of confidence that the user is at the current location. Optional. Set this property before making a service request. Syntax public Confidence Confidence { set; get; } Public Property Confidence As Confidence

UserProfile Class
Contains optional settings that define the end user. Syntax public class UserProfile Public Class UserProfile Constructor
Name Description

UserProfile

Initializes a new instance of a UserProfile object.

Public Properties
Name Description

CurrentHeading

A Heading Class object specifying the direction that the user is currently heading. Optional. The default Heading.Orientation Property value is 0, which is north. A UserLocation Class object specifying the current location of the user. Optional. A DeviceType Enumeration value specifying 271

CurrentLocation DeviceType

Name

Description

the device type of the end user. Optional. The default value is Desktop. DistanceUnit A DistanceUnit Enumeration value specifying the units to use when measuring distances. Optional. The default value is Kilometer. A string specifying the IP address of the end user. Optional. A ShapeBase Class object specifying the bounds of the map view. Optional. A SizeOfint Class object specifying the size of the available screen space, in pixels. Optional.

IPAddress MapView ScreenSize

See Also RequestBase.UserProfile Property UserProfile Constructor Initializes a new instance of the UserProfile Class. Syntax public UserProfile() Public Sub New UserProfile Properties The properties of the UserProfile class are listed here. For a complete list of UserProfile class members, see the UserProfile Class topic. Public Properties
Name Description

CurrentHeading

A Heading Class object specifying the direction that the user is currently heading. Optional. The default Heading.Orientation Property value is 0, which is north. A UserLocation Class object specifying the current location of the user. Optional. A DeviceType Enumeration value specifying the device type of the end user. Optional. The 272

CurrentLocation DeviceType

Name

Description

default value is Desktop. DistanceUnit A DistanceUnit Enumeration value specifying the units to use when measuring distances. Optional. The default value is Kilometer. A string specifying the IP address of the end user. Optional. A ShapeBase Class object specifying the bounds of the map view. Optional. A SizeOfint Class object specifying the size of the available screen space, in pixels. Optional.

IPAddress MapView ScreenSize

See Also RequestBase.UserProfile Property UserProfile.CurrentHeading Property A Heading Class object specifying the direction that the user is currently heading. Optional. The default Heading.Orientation Property value is 0, which is north. Set this property before making a service request. Syntax public Heading CurrentHeading { set; get; } Public Property CurrentHeading As Heading UserProfile.CurrentLocation Property A UserLocation Class object specifying the current location of the user. Optional. Set this property before making a service request. Syntax public UserLocation CurrentLocation { set; get; } Public Property CurrentLocation As UserLocation UserProfile.DeviceType Property A DeviceType Enumeration value specifying the device type of the end user. Optional. The default value is Desktop. Set this property before making a service request. Syntax public DeviceType DeviceType { set; get; } Public Property DeviceType As DeviceType 273

Remarks If the DeviceType specified is Mobile, then the ImageryMetadataResult.ImageUri Property contains a URI for a map designed for mobile devices. This only applies to the AerialWithLabels and Road map styles. UserProfile.DistanceUnit Property A DistanceUnit Enumeration value specifying the units to use when measuring distances. Optional. The default value is Kilometer. Set this property before making a service request. Syntax public DistanceUnit DistanceUnit { set; get; } Public Property DistanceUnit As DistanceUnit UserProfile.IPAddress Property A string specifying the IP address of the end user. Optional. Set this property before making a service request. Syntax public string IPAddress { set; get; } Public Property IPAddress As String Remarks The maximum length of the IPAddress property is 256 characters. The IPAddress property must be in either IPv4 or IPv6 form. UserProfile.MapView Property A ShapeBase Class object specifying the bounds of the map view. Optional. Set this property before making a service request. Syntax public ShapeBase MapView { set; get; } Public Property MapView As ShapeBase Remarks For Bing Maps SOAP Services, Version 1.0, the MapView property must be a Rectangle object. UserProfile.ScreenSize Property A SizeOfint Class object specifying the size of the available screen space, in pixels. Optional. Set this property before making a service request. Syntax public SizeOfint ScreenSize { set; get; } Public Property ScreenSize As SizeOfint 274

Reference Tables
This section includes tables of reference that support the Bing Maps SOAP Services API.

In This Section
Geocode Match Code and Match Method Tables Search Filter Property Table

See Also Geocode Match Code and Match Method Tables

The following tables list match code and match method values returned by the Bing Maps Geocode Service.

Match Codes
The GeocodeResult.MatchCodes Property and the LocationData.MatchCodes Property contain values that indicate the geocoding level of the location match. The table below lists possible values for these properties.
Value Description

None Good Ambiguous

No match was found by the Bing Maps Geocode Service. The Bing Maps Geocode Service found a single match. The Bing Maps Geocode Service returned more than one possible match. For example, the street address for the entity is 128 Main St. and the Bing Maps Geocode Service returns matches for 128 North Main St. and 128 South Main St. because there is no way to determine which is desired. The Bing Maps Geocode Service was unable to match all of the information and had to move up the geographic hierarchy to find a less precise result. For example, a match code of UpHierarchy is returned if the Bing Maps Geocode Service cannot match the address fields for the entity and returns a match at the postal code level. 275

UpHierarchy

Value

Description

Modified

The Bing Maps Geocode Service found a match, but only if the match is modified.

Match Methods
The GeocodeLocation.CalculationMethod Property contains values that indicate the geocode method used to match the location to the map. The following table lists possible values for this property.
Value Description

Interpolation InterpolationOffset

The Bing Maps Geocode Service matched the location to a point on a road using interpolation. The Bing Maps Geocode Service matched the location to a point on a road using interpolation with an additional offset to shift the point to the side of the street. The Bing Maps Geocode Service matched the location to the center of a parcel. The Bing Maps Geocode Service matched the location to the rooftop of a building.

Parcel Rooftop

Search Filter Property Table

The following table lists the property ID, property name, and possible values for properties associated with points of interest on the map. Use this table to identify filters returned in the AvailableFilter Class, as well as values to specify in the FilterExpression Class properties.

Filters are only supported for English-United States business searches.

Property ID Name Possible Values

1 2 3 4

Category Neighborhood UserRating PaymentMethod

Category Property Value Table A Neighborhood.Id Property value. A double between 0 and 10. PaymentMethod Property Value 276

Property ID

Name

Possible Values

Table 5 21 ParkingOptions Price This property is only applicable to entities in the restaurant category (category ID = 11168). 22 Cuisine This property is only applicable to entities in the restaurant category (category ID = 11168). 23 Atmosphere This property is only applicable to entities in the restaurant category (category ID = 11168). 24 Reservation This property is only applicable to entities in the restaurant category (category ID = 11168). 31 HotelRate This property is only applicable to entities in the hotel category (category ID = 13344). 32 Amenities This property is only applicable to entities in the hotel category (category ID = 13344). Amenities Property Value Table Atmosphere Property Value Table Cuisine Property Value Table ParkingOptions Property Value Table Price Property Value Table

Reservation Property Value Table

HotelRate Property Value Table

Category Property Value Table

The following table lists top-level values for the Category search filter property. Click on the toplevel category values to see subcategory values.

The top-level categories in this table cannot be used for filtering. Click a top-level category to view the subcategories that are available for filtering.

277

Value

Arts & Entertainment Automotive & Vehicles Business to Business Computers & Technology Education Food & Dining Government & Community Health & Beauty Home & Family Legal & Finance Professionals & Services Real Estate & Construction Sports & Recreation Shopping Travel

Arts & Entertainment Categories The following table lists sub-categories of the Arts & Entertainment category. These are values for the Category search filter property.
Value Value ID

Entertainment Agencies & Bureaus Museums Trade Shows, Expositions & Fairs Adult Entertainment Amusement Art Clubs Costumes

984 1785 2699 10002 10004 10012 10028 10033 278

Value

Value ID

Dance Escort Services Gambling General Entertainers Movies Music Party & Event Planning Theater Ticket Sales

10036 10046 10051 10056 10064 10073 10100 10122 10129

Automotive & Vehicles Categories The following table lists sub-categories of the Automotive & Vehicles category. These are values for the Category search filter property.
Value Value ID

Auto Wreckers Aircraft Auto Parts & Repair Auto Care & Accessories General Auto Services Boats Car & Truck Sales Motorcycles & Motor Scooters Recreational Vehicles & Campers Trailers

2917 10133 10142 10194 10215 10254 10282 10299 10312 10328

Business to Business Categories The following table lists sub-categories of the Business to Business category. These are values for the Category search filter property.

279

Value

Value ID

Environmental & Ecological Services Agriculture & Food B2B Health & Beauty B2B Office Supplies & Equipment Business Services Manufacturing & Supplies Energy & Mining Storage & Transportation B2B Communications & Advertising Security & Facilities B2B Science & Technology B2B Computers & Electronics B2B Entertainment & Recreation

987 10362 10678 10925 12001 13436 13449 13455 13480 13482 13483 13484 13485

Computers & Technology Categories The following table lists sub-categories of the Computers & Technology category. These are values for the Category search filter property.
Value Value ID

Computer Service & Repair Computer Dealers Radio Communication Equipment Electronic Equipment & Service Internet Products & Services Sound Systems & Equipment Cable Television & Satellite Cellular & Wireless Computer & Web Publishing Computer Consulting & System Design

26 48 234 297 1442 2483 10832 10840 10852 10855 280

Value

Value ID

Computer Networking & Cabling Computer Software Services Computer Training Electronic Data Services Telecommunications & Telephone Services Televisions & Radios Video Equipment & Supplies Video Games

10869 10879 10886 10906 10957 10984 10994 11010

Education Categories The following table lists sub-categories of the Education category. These are values for the Category search filter property.
Value Value ID

Special Education Schools General Interest Schools Adult Education Colleges & Universities Educational Organizations Education & Teacher Services Elementary Schools Preschool through Kindergarten Schools Parochial & Private Schools Religious & Spiritual Instruction Specialty Instruction Tutoring Vocational & Training Schools Medical Education Schools Alternative Schools & Home Schooling

2354 2360 11015 11017 11020 11023 11033 11035 11040 11043 11051 11062 11065 11593 13632 281

Value

Value ID

Community & Junior Colleges Junior High & Middle Schools Senior High & Preparatory Schools Charter Schools Public Schools

13636 13637 13638 83163 83164

Food & Dining Categories The following table lists sub-categories of the Food & Dining category. These are values for the Category search filter property.
Value Value ID

Bakeries Banquet Facilities Beverages Catering Cooking & Barbecue Grocery & Food Stores Restaurants Taverns, Bars & Cocktail Lounges

11073 11076 11078 11096 11099 11151 11168 11199

Government & Community Categories The following table lists sub-categories of the Government & Community category. These are values for the Category search filter property.
Value Value ID

Notaries Public Services Animal Shelters & Humane Societies Associations Parks & Recreation Cemeteries & Memorial Parks

1816 11207 11210 11215 11220

282

Value

Value ID

Charitable Organizations Citizenship Electric Companies Natural Gas Services Government Services Historical Sites Libraries News Parking Facilities Recycling Centers Religious Services & Organizations Sewer Services Social Service Organizations Television & Radio Stations Waste Management Water Services & Equipment Fire Protection Police & Sheriff Chambers of Commerce

11224 11229 11233 11242 11243 11262 11265 11268 11274 11277 11280 11344 11347 11371 11374 11381 13547 13548 13550

Health & Beauty Categories The following table lists sub-categories of the Health & Beauty category. These are values for the Category search filter property.
Value Value ID

Color Consultants Cosmetics & Perfumes Hospice Medical Equipment & Supplies

660 752 1358 1670 283

Value

Value ID

Abuse & Addiction Treatment Assisted Living & Care Services Alternative Medicine Day Spas Dental care Disabilities Doctors & Clinics Eye Care First Aid Hair & Beauty Health Clubs & Fitness Hearing Home Health Services Hospitals & Medical Centers Massage Medical Information & Referral Mental Health Services Nail Salons Nurses & Nursing Care Physical Therapy & Rehabilitation Skin care Tanning Salons Tattoos & Piercings Women's Health & Reproduction Pharmacies Beauty Supplies

11385 11397 11408 11429 11432 11450 11460 11518 11529 11532 11550 11567 11575 11579 11588 11637 11649 11669 11672 11683 11696 11702 11705 11714 13070 13505

284

Home & Family Categories The following table lists sub-categories of the Home & Family category. These are values for the Category search filter property.
Value Value ID

Home Improvement Appliances Bathrooms Closets & Closet Accessories Decks & Patios Family Services Fireplaces & Heating Stoves Flooring Heating, Plumbing & Air Systems Furniture Gutters & Downspouts Home Repairs & Maintenance House Cleaning Interior Designers & Decorators Kitchens Laundries & Laundromats Lawn & Garden Lighting Fixtures Movers & Storage Pest Control Pets & Pet Supplies Pools, Spas & Saunas Window Treatments & Coverings Safety Doors & Windows

1329 11736 11750 11759 11764 11772 11801 11805 11816 11819 11830 11833 11844 11852 11858 11863 11866 11888 11894 11907 11915 11949 11957 12828 12860

285

Value

Value ID

Homeowners Association

13572

Legal & Finance Categories The following table lists sub-categories of the Legal & Finance category. These are values for the Category search filter property.
Value Value ID

Appraisers Tax Return Preparation & Filing Accounting & Bookkeeping Auctions Bail Bonds Bankruptcy Assistance Banks & Credit Unions Check Cashing & Money Transfers Coin Dealers Credit & Debt Counseling Currency Exchanges Economy Escrow Services Financial Planning & Investment Advice Insurance Legal Services & Assistants Loans Pawnbrokers Detectives & Forensics Commercial Banking & Financial Services Check Printing

102 2596 11974 11981 11983 11985 11987 12039 12042 12046 12051 12053 12056 12058 12087 12101 12146 12152 12225 13479 13526

286

Professionals & Services Categories The following table lists sub-categories of the Professionals & Services category. These are values for the Category search filter property.
Value Value ID

Apparel Services Audio-Visual Equipment Services Copying Services Delivery Services Graphic Services Mailing & Freight Services Paranormal Services Photography Services Publishers & Printers Restoration & Repair Services Telephone Answering Services Employment Inventors Personalization Services

12185 12201 12212 12219 12246 12261 12289 12295 12307 12324 12348 12350 13120 13129

Real Estate & Construction Categories The following table lists sub-categories of the Real Estate & Construction category. These are values for the Category search filter property.
Value Value ID

Building & Construction Services Property Management & Maintenance Tile Materials & Experts Utilities Construction Specialty Rooms & Structures Construction Site Services Wrecking & Excavating

1718 2175 2662 2773 12361 12431 12459 287

Value

Value ID

Contractor Equipment & Supplies Inspection Services Surveyors Real Estate Services Buildings HVAC & Energy Conservation Drilling & Pumping Doors & Windows Construction Grading, Foundations & Paving Interior Walls, Ceilings & Floors Construction Landscape & Water Construction Metal Materials & Experts Roofing & Siding Construction Stone & Masonry Wood Materials & Experts Security & Safety

12467 12513 12529 12549 12572 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497

Sports & Recreation Categories The following table lists sub-categories of the Sports & Recreation category. These are values for the Category search filter property.
Value Value ID

Hot Air Balloons Skateboards & Equipment Archery & Shooting Bicycles Bowling Crafts & Hobbies Equestrian

262 2451 12640 12645 12650 12653 12654 288

Value

Value ID

General Sports Golf Gymnastics Horseshoes Hunting & Fishing Martial Arts & Self Defense Outdoor Recreation Paintball Parachuting & Parasailing Pool & Billiards Racing Recreation Centers Skating Snow Sports Sporting Goods Swimming & Watersports Team Sports Tennis & Racquet Sports Country Clubs

12670 12676 12690 12695 12698 12706 12713 12719 12722 12726 12731 12733 12737 12742 12750 12755 12767 12781 13571

Shopping Categories The following table lists sub-categories of the Shopping category. These are values for the Category search filter property.
Value Value ID

Cigar, Cigarette & Tobacco Dealers Jewelry Stationary Antiques

600 1471 2515 12874 289

Value

Value ID

Apparel Books Cultural Goods Floral & Dcor Hardware & Tools Housewares Stores & Services Toys & Games Stores

12876 12912 12916 12922 12949 12961 12987 13018

Travel Categories The following table lists sub-categories of the Travel category. These are values for the Category search filter property.
Value Value ID

Airports, Flying Fields & Services Car Rentals Limousine Service Taxicab Service Public Transit Transportation Providers Aircraft Charter & Rental Companies Airlines & Airline Ticket Agencies Boat Charter & Rental Companies Bus Lines & Charters Campgrounds & RV Parks Cruises Guides & Sightseeing Hotels & Accommodations Resorts

58 216 1556 2597 2717 2722 13311 13316 13324 13327 13331 13333 13336 13344 13354 290

Value

Value ID

Specialty Transportation Trains Travel Accessories Travel Agencies & Bureaus

13357 13360 13364 13635

Amenities Property Value Table

The following table lists values and associated value IDs for the Amenities search filter property.
Value Value ID

Air conditioning Airport transportation Arcade/game room ATM/banking Ballroom(s) Banquet facilities Bar/lounge Beachfront Bicycles Billiards and darts Business center Car rental Casino/gambling Childcare Coffee maker, hair dryer, iron, etc. Coffee shop or caf Complimentary newspapers Concierge desk Conference room(s)

59 0 1 2 5 6 7 60 61 62 9 63 10 4 64 12 13 15 16

291

Value

Value ID

Continental breakfast Currency exchange Dancing Disabled access Dry cleaning/laundry Elevator/lift Event catering Executive suite Express check-in/check-out Family friendly Fitness center Gift shop or newsstand Golf course Golf course Internet access available Kids' activities Kitchen or kitchenette Live entertainment Meeting rooms (small groups) Minibar/fridge Non-smoking rooms Patio Pets allowed Phone/voicemail Picnic tables/barbecue grills Porter/bellhop Private party rooms Restaurant on site

65 17 66 67 18 19 20 68 21 69 24 26 27 29 31 33 34 36 38 71 77 39 40 79 80 41 81 42 292

Value

Value ID

Room service Safe deposit Security Shopping nearby Spa Swimming pool Television Tennis court(s) Translation Services Wake up service Wedding services Whirlpool Wi-fi

43 44 46 48 49 52 82 54 55 83 57 58 84

See Also Search Filter Property Table

Atmosphere Property Value Table

The following table lists values and associated value IDs for the Atmosphere search filter property.
Value Value ID

Authentic Dcor Bar Scene Beer Garden Brewpub Bright Lighting Business Casual Casual Comfortable

17 18 20 24 25 0 1 31 293

Value

Value ID

Country Club Country Style Dim Lighting Dressy Drive-In Elegant Ethnic Dcor European Atmosphere Family Friendly Family Style Dining Festive Fine Dining Food Court Formal Gay Friendly Jacket/Tie Required Jacket/Tie Suggested Live Entertainment Live Music Lounge Modern Neighborhood Eatery No Dress Code No Jeans No Sports Attire Ocean View Outdoor Dining People Watching

33 2 3 36 37 4 38 39 5 40 6 41 43 7 46 53 54 56 57 59 61 62 63 64 65 66 68 69 294

Value

Value ID

Pet-Friendly Piano Quiet Retro Dcor Romantic Rustic Scenic View Singles Scene Smoking Sports Bar Sunset View Takeout Victorian Garden Waterfront

70 71 9 75 10 77 79 11 80 81 83 85 89 92

See Also Search Filter Property Table

Cuisine Property Value Table

The following table lists values and associated value IDs for the Cuisine search filter property.
Value Value ID

African American American Regional Asian Bagel Bakery Barbecue Bar

1 2 81 4 82 5 6 106 295

Value

Value ID

Bistro Brazilian Breakfast British Brunch Buffet Burger Caf Cafeteria Cajun Californian Caribbean Cheese Steak Chicken Chinese Coffee & Espresso Contemporary/Nouveau Continental Creole Cuban Deli Dessert Dim Sum Diner Dinner Theater Donut Eastern European Eclectic

7 8 83 10 84 85 11 86 87 12 88 14 89 90 15 16 91 18 19 92 20 21 22 93 94 95 25 96 296

Value

Value ID

Ethiopian Family Style Fast Food Fish & Chips Fondue French Fusion German Gourmet Greek Grill Halal Health Food Homestyle Hot Dog Ice Cream Indian International Irish Italian Jamaican Japanese Juice Korean Kosher Latin American Lebanese Mediterranean

24 26 27 97 28 29 30 31 98 32 33 34 36 99 37 100 39 40 101 41 102 42 103 43 44 45 46 49 297

Value

Value ID

Mexican Middle Eastern Moroccan Noodle Shop Oceana Pacific Rim Pizza Polynesian Pub Ribs Salad Sandwiches Scandinavian Seafood Smoothies Soul Food Soup South American Southern (US) Southwestern Spanish Sports Bar Steak Sushi Tapas Tea Room Tex-Mex Thai

50 51 52 54 105 58 61 62 9 107 108 63 109 64 110 65 111 66 68 69 70 112 71 72 74 113 114 75 298

Value

Value ID

Traditional Turkish Vegetarian Vietnamese Wine Wrap

115 76 79 80 116 117

See Also Search Filter Property Table

HotelRate Property Value Table

The following table lists values and associated value IDs for the HotelRate search filter property.
Value Value ID

$ $$ $$$ $$$$ $$$$$

0 1 2 3 4

See Also Search Filter Property Table

ParkingOptions Property Value Table

The following table lists values and associated value IDs for the ParkingOptions search filter property.
Value Value ID

Free parking on site Merchant-validated parking Metered street parking

2 6 7

299

Value

Value ID

Off site parking nearby Paid parking on site Parking on site Street parking Valet parking

10 11 12 13 14

See Also Search Filter Property Table

PaymentMethod Property Value Table

The following table lists values and associated value IDs for the PaymentMethod search filter property.
Value Value ID

American Express ATM Cash Check Debit Cards Diner's Club Discover Eurocard Financing JBC Mastercard Paypal online Traveler's Check Visa

0 11 1 2 4 10 3 14 5 17 7 25 8 9

300

See Also Search Filter Property Table

Price Property Value Table

The following table lists values and associated value IDs for the Price search filter property.
Value Value ID

$ $$ $$$ $$$$ $$$$$

0 1 2 3 4

See Also Search Filter Property Table

Reservation Property Value Table

The following table lists values and associated value IDs for the Reservation search filter property.
Value Value ID

Not accepted Reservations accepted Reservations required

3 0 2

See Also Search Filter Property Table

Bing Maps SOAP Services Resources and Support

This topic contains resources for getting support.

301

Getting Help
Developer Resources
If you have questions about using the Bing Maps SOAP Services, the following resources may help. Connect with other Bing Maps developers at the Bing Maps Forum. Read the Bing Maps Developer blog.

Account Access Issues

If you are experiencing issues with your Bing Maps Developer Account, contact the Bing Maps Account Administrator.

Note Support for Bing Maps account access issues is available only through e-mail. Email messages are answered within two business days.

Licensing Questions
If you are interested in finding out more about Bing Maps or have questions about licensing Bing Maps, email [email protected] or go to http://www.microsoft.com/maps/contact.aspx. From North, Central, and South America, you can also contact Bing Maps by calling (800) 426-9400, ext. 11315.

302