Get Venue Map

Use the following URL template to get information about a venue map. When you make a request by using the following URL template, the response returns a description of the venue formatted using the Venue Map Data schema. The default response returns only a subset of the venue entities. If you want to return the full set of venue entities, you must set the view parameter to *. If you want to further filter results by language and country codes, use the culture parameter. See the template parameter descriptions and examples below for more information.

URL Template

Get a venue data that includes the venue layout and business information.

https://dev.virtualearth.net/REST/v1/JSONFilter/VenueMaps/Data/venue?view=view&culture=culture&indent=indent&key=BingMapsKey

Template Parameters

Culture-Specific Venue Data

Some venue map data can be defined by culture. You can set the culture parameter in the URL to specify which culture-specific data to return. Note that the culture parameter is not the same as the defaultCulture property that is returned with the venue data. The defaultCulture value specifies culture associated with the empty culture string "". In the following example, the defaultCulture is en (English) and the name string associated with the empty culture string "" is in English. If the culture parameter was set to es or es-ES, the Spanish phrase is returned. Otherwise, the English phrase is returned.

"defaultCulture": "en"

"name": {
  "": "School of Fine Art",
  "es-ES": "Escuela de Bellas Artes",
}

                 

As suggested by the previous example, if an exact match is not found for the culture parameter value, an up-hierarchy match is made. The hierarchy from lowest to highest is:

• language_code-country_code (Example: "en-gb")

• language_code (Example: "en")

• default culture ("")

The following examples show this hierarchy works.

Match Example:

• URL parameter: culture=fr-ca

• Venue schema definition: "schema element":{"":"Value 0", "fr-ca":"Value 1"}

• Result: Value 1 is returned because an exact match is found.

Match Example:

• URL parameter: culture=fr-fr

• Venue schema definition: "schema element":{"":"Value 0", "fr-ca":"Value 1"}

• Result: Value 0 is returned because no exact match or up hierarchy language match is found.

Match Example:

• URL parameter: culture=fr-fr

• Venue schema definition: "schema element":{"":"Value 0", "fr":"Value 1", "fr-ca":"Value 2"}

• Result: Value 1 is returned because an exact match is not found, but an up hierarchy language match is found.

Match Example:

• URL parameter: culture=it

• Venue schema definition: "schema element":{ "fr-fr":"Value 1", "fr-ca":"Value 2"}

• Result: No value is returned because no exact match or up hierarchy match is found. Notice that a value for the default culture ("") is not defined. If a default culture ("") value was defined, it would have been returned.

Match Example:

• URL parameter: No culture is specified, so the default value for the culture parameter en-us is used.

• Venue schema definition: "schema element":{"":"Value 0", "en":"Value 1", "fr-ca":"Value 2"}

• Result: Value 1 is returned because an exact match is not found, but an up hierarchy language match is found.

Response

A JSON response that contains the venue map data. See Venue Map Data for a description of the data in the response. XML format is not supported.

Examples

Get venue map data.

This example gets the default subset of venue map data for a venue map.

https://dev.virtualearth.net/REST/v1/VenueMap/JSONFilter/Data/MyVenueMap?key=BingMapsKey

Get formatted venue map data.

This example gets the default subset of venue map data and is formatted for readability.

https://dev.virtualearth.net/REST/v1/VenueMap/JSONFilter/Data/MyVenueMap?indent=1&key=BingMapsKey

Get the complete venue map data.

This example gets the complete set of venue map data.

https://dev.virtualearth.net/REST/v1/VenueMap/JSONFilter/Data/MyVenueMap?view=*&key=BingMapsKey

Get venue map data and use en-gb as the filter for culture-specific data.

This example gets the default subset of venue map data and returns the best match for all culture-specific data by first checking for "en-gb" data, then "en" data, and finally "" data.

https://dev.virtualearth.net/REST/v1/VenueMap/JSONFilter/Data/MyVenueMap?culture=en-gb&key=BingMapsKey

Get venue map data and specify a JSON callback object and function.

This example gets the default subset of venue map data and specifies a JSON callback function (jsonp) and a name for the JSON object (jsono) that is returned. When the jsonp parameter is specified the response is contained within the JSON function call. For this example, the response is formatted as venueMapData(<response data>).

https://dev.virtualearth.net/REST/v1/VenueMap/JSONFilter/Data/MyVenueMap?jsono=venueMapData&jsonp=ProcessVenueMap&key=BingMapsKey

HTTP Status Codes

When the request is successful, the following HTTP status code is returned.

• 200

When the request is not successful, the response returns one of the following errors.

• 400

• 401

• 500

• 503