Venue Map Data

Article
09/08/2015

The following tables describe the data that is returned in a Venue Maps response. An example response follows the descriptions.

Venue Data

JSON	Description	Example
id	A unique ID for the venue.	`"id": "bingmaps-schoolOfFineArt”`
ypid	The Yellow Pages ID for the venue.	`"ypid": "YN000x000000000"`
name	The culture-specific names for the venue. The empty string ("") refers to the culture identified by the defaultCulture property.	`"name": { "": "School of Fine Art", "es-ES": "Escuela de Bellas Artes", }`
defaultCulture	The culture that is associated with the empty culture string ("") in properties such as name and label. If this value is not specified, en-US is used as the default culture.	`"defaultCulture": "es"`
type	The type of venue. For a list of venue types see the Venue Types table below.	`"type": "University"`
location	The WGS84 coordinates in degrees of a central location for the venue.	`"location": [ 47.623143, -122.332123 ]`
address	The address information for the venue. See the Address Values section below for a description of the address values. Address information will contain as a minimum the adminDistrict and countryRegionCode (3166-1 Alpha-2 country code).	`"address": { "addressLine": "1 Microsoft Way", "suite": "", "locality": "Redmond", "adminDistrict": "WA", "adminDistrict2": "King Co.", "postalCode": "98052", "countryRegionCode": "US", "countryRegion": "United States" }`
phoneNumber	The phone number for the venue.	`"phoneNumber": "(206) 264-1120"`
defaultFloor	The index of the floor to display as the default.	`"defaultFloor": 1`
bbox	A set of WGS84 longitudes and latitudes in degrees (south latitude, west longitude, north latitude, east longitude) that define the geographical area of the venue.	`"bbox": [ 47.6055, -122.3328, 47.6066, -122.3313],`
floors	An array of floor information. For floor property descriptions, see the Floor Properties section below. Floors are indexed as sequential integers starting with zero (0) for the base floor (typically includes the footprint) followed by the venue floors ordered from the bottom floor to the top floor. floors[0]: Base Floor floors[1]: Bottom Floor . . . floors[n]: Top Floor The initial floor or floor[0] is the base floor. The base floor describes the venue and is always displayed as a background for other floors. This floor typically contains Footprint entities, but it can also contain other persistent entities such as outdoor pools and grass.	`"floors": [ <array of floors> ]`

Floor Data

Property Description Example

Property	Description	Example
name	The culture-specific names for the floor. The empty string ("") refers to the culture identified by the defaultCulture property.	`"name": { "": "Level 1", "es-ES": "Nivel 1" }`
entities	An array of entity information for each entity on the floor. For entity property descriptions, see the Entity Data section below.	`"entities": [ <array of venue entities> ]`

name

The culture-specific names for the floor.

The empty string ("") refers to the culture identified by the defaultCulture property.

"name": {
    "": "Level 1",
    "es-ES": "Nivel 1"
}

entities

An array of entity information for each entity on the floor. For entity property descriptions, see the Entity Data section below.

"entities": [
<array of venue entities>
]

Entity Data

Property	Description	Example
id	An integer for a business entity that is unique within the venue. A value of -1 or an integer between 1 and 99999. A value of -1 is used for entities that form the base of the venue, such as Footprint entities.	`"id": 300023`
ypid	The Yellow Pages ID for the venue entity.	`"ypid": "YN000x000000000"`
name	The culture-specific entity names. The empty string ("") refers to the culture identified by the defaultCulture property.	`"name": { "": "Painting", "es-ES": "Pintura", }`
directoryName	The culture-specific names for a non-business entity. These names are listed in the venue directory. For example, if the entity is a section in a stadium with the section number 325, you may want to display the '325' (name) over the section on the map, but then specify 'section 325' (directoryName) in the directory. The empty string ("") refers to the culture identified by the defaultCulture property.	`"directoryName": { "": "Painting Department", "es-ES": "Departamento de pintura", }`
type	The entity type. See the Entity Types section below for a list of possible entity types.	`"type": "Room"`
location	The WGS 84 coordinates in degrees of a central location for the entity.	`"location": [ 47.612342, -122.343242 ]`
address	For businesses only. The entity-specific address information for the entity. If an address value is the same as the venue, it is not returned with the entity address data. For example if the entity address and venue address are the same except for the entity suite number, only the suite number will be included in the entity address. For more information and an example see the Combining Venue and Entity Address Properties. See the Address Data section below for a description of the address values.	`"address": { "addressLine": "1 Microsoft Way", "suite": "", "locality": "Redmond", "adminDistrict": "WA", "adminDistrict2": "King Co.", "postalCode": "98052", "countryRegionCode": "US", "countryRegion": "United States" }`
phoneNumber	The phone number for the entity.	`"phoneNumber": "(206) 264-1120"`
categoryId	The category of the entity.	`"categoryId": "Restaurant"`
categoryName	The culture-specific names for the category. The empty string ("") refers to the culture identified by the defaultCulture property.	`"categoryName": { "": "Department" "es-ES": "Departamento" }`
description	A description of the entity.	`"description": { "": "Painting Department Offices " "es-ES": "Oficinas del Departamento de Pintura " }`
label	The text and placement for the label that identifies the entity. The text can contain new line characters (\n), and contains the name of the entity. The placement is defined as a rectangle with a center point, width, height and angle. The center is specified as WGS84 coordinates in degrees. The angle specifies the rotation of the label off of the axis pointing east. The angle is an integer value in degrees between -180 and 180, where the axis pointing east is the zero (0) degree axis.	`"label": { "": { "text": "Painting\nDepartment", "rect": { "center": [ 47.612434, -122.341234 ], "width": 0.0005, "height": 0.0004, "angle": 45 } }`
geometry	An array of WGS84 coordinates in degrees that define the entity shapes. Each entity shape can have a set inner shapes (specified as an array of "inner" coordinates) that define holes in the shape. Inner shapes do not overlap. If the closed property for a shape is set to true, then the first and last points are connected. To minimize bandwidth, the latitudes and longitudes are provided as separate arrays instead of pairs.	`"geometry": [ { "closed": true, "latitudes": [47.614012,47.622342], "longitudes": [-122.201829,-122.211234], "inner": [ { "latitudes": [47.614111,47.614222], "longitudes": [-122.201900,-122.211111] } ] } ]`

Address Data

Property	Description	Example
addressLine	The official street line of an address relative to the area, as specified by the Locality, or PostalCode, properties. Typical use of this element would be to provide a street address or any official address.	`"addressLine": "1 Microsoft Way"`
suite	The suite number for the address.	`"suite": "101"`
locality	The populated place for the address. This typically refers to a city, but may refer to a suburb or a neighborhood in certain countries.	`"locality": "Redmond"`
adminDistrict	The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it is the second, third, or fourth order subdivision in a country, dependency, or region.	`"adminDistrict": "WA"`
adminDistrict2	The subdivision name in the country or region for an address. This element is used when there is another level of subdivision information for a location, such as the county.	`"adminDistrict2": "King Co.",`
postalCode	The post code, postal code, or ZIP Code of an address.	`"postalCode": "98052"`
countryRegion	The country or region name of an address.	`"countryRegionCode": "US"`
countryRegionCode	The ISO 3166-1 Alpha-2 country code for the address.	`"countryRegion": "United States"`

Combining Venue and Entity Address Properties

Business entity address values that are the same as the venue are not included in the entity address. To get the complete entity address, you must combine the venue and entity address values. The following example shows how this works.

Venue Address Fields

The venue address fields contain the complete address of the venue.

    "address": {
        "addressLine": "1 Microsoft Way",
        "locality": "Redmond",
        "adminDistrict": "WA",
        "adminDistrict2": "King Co.",
        "postalCode": "98052",
        "countryRegionCode": "US",
        "countryRegion": "United States"
    }

Business Entity Address Fields

Because the basic entity address matches the venue address, the only entity-specific address property in the entity address is the suite number.

    "address": {
        "suite": "B"
    }

Complete Business Entity Address

To get the complete entity address, fill in missing entity address properties with venue address values. Combining venue and entity values in this example gives the following entity address.

    "address": {
        "addressLine": "1 Microsoft Way",
        "suite": "B",
        "locality": "Redmond",
        "adminDistrict": "WA",
        "adminDistrict2": "King Co.",
        "postalCode": "98052",
        "countryRegionCode": "US",
        "countryRegion": "United States"
    }

Venue Types

Airport
Building
Casino
Community Center
Convention Center
Hospital
Hotel
Mall
Museum
Resort
Shopping District
Stadium
Store
Train Station
University
Venue
Zoo

Entity Types

Entity types are defined as shapes or points. Shapes are defined by a series of points and can be closed (all the points are connected) or open (two of the points are not connected). Shapes are always displayed with an outline and most shapes are filled. Exceptions include certain shapes like an Elevated train which is displayed as a line.

The following table shows the available entity types and specifies if they are shapes or points and whether the area they contain should be filled.

Entity Type	Usage	Business	Shape	Point	Filled
Accessible Entrance				X
Airport Ground Transportation			X
ATM				X
Baby Changing Facilities			X
Ballroom	To show main ballroom areas for conference and convention centers.		X		X
Ballroom Division	To show small ballroom areas for conference and convention centers.		X		X
Bench				X
Bicycle Rack				X
Concourse	To show concourse areas for airports and transit centers.		X		X
Currency Exchange				X
Customs				X
Display	To show an open area without walls that does not belong to another entity type.		X		X
Elevated Train	To show the path of an elevated train.		X
Elevator				X
Entrance				X
Escalator				X
Female Restroom				X
Floor	To show the floor outline.		X		X
Footprint	To show the footprint outline of the venue.		X		X
Gate				X
Grass	To show outdoor areas with grass.		X		X
Information				X
Light Rail Station				X
London Underground Entrance			X
Luggage Trolleys				X
Male Restroom				X
Object	To show landmarks within a venue, such as an airplane in a flight museum.		X		X
Parking Area	To show enclosed parking garages. Use Parking Structure for parking lots that are not enclosed.		X		X
Parking Structure				X
Play Area				X
Pound Cash Machine				X
Public Area	To show an indoor public area, such as a ticketing counter in an airport.		X		X
Railroad	To show a railroad route within a venue.		X
Restroom				X
Room	To show any entity with walls that is not belong to another entity type.		X		X
Secure Area	To show a secure area, such as a secure area in an airport.		X		X
Security Line			X
Security Point				X
Shop	To show a business that does not serve food.	X
Shop Food	To show a business that serves food, such as a restaurant.	X
Shuttle				X
Special Area	To show an area within a venue that does not have walls, such as a gambling area within a casino.		X		X
Special Room	To show a room that is important for the venue type, such as an attraction in an amusement park.		X		X
Stairs				X
Subway	To show a subway line route.		X
Taxi				X
Telephone				X
Terminal	To show terminals for airports and transit centers.		X		X
Text	To show general-purpose floating text.		X		X
Ticket Vending Machine			X
Transportation			X
Vegetation				X
Vending Machine				X
Venue Patio	To show an outdoor walkable areas, such as the area around a pool or a patio.		X		X

Example

The following JSON example shows a sample response.

{ 
    "id": "my-venue",
    "ypid": "YN000x000000000",
    "name": {
      "": "School of Fine Art",
      "es-ES": "Escuela de Bellas Artes",
    },
    "defaultCulture": "en-us", 
    "type": "University",
    "location": [47.623424,-122.332123],
    "address": {
        "addressLine": "1 Microsoft Way",
        "suite": "",
        "locality": "Redmond",
        "adminDistrict": "WA",
        "adminDistrict2": "King Co.",
        "postalCode": "98052",
        "countryRegionCode": "US",
        "countryRegion": "United States"
    },
    "phoneNumber": "2065550109",
    "defaultFloor": 1, 
    "bbox": [22.291900,-155.842700,-155.840500,22.292830],
    "floors": [{
            "name": {
                "": "Level 1",
                "es-ES": "Nivel 1"
            },
            "entities": [
               {
                    "id":-1,
                    "type":"Footprint",
                    "location":[22.292211,-155.841642],
                    "geometry":[{
                         "closed":true,
                         "latitudes":[22.292847,22.292323,22.291982,22.291574,22.292091,
                                     22.292228,22.292315,22.292482,22.292504,22.292847],
                         "longitudes":[-155.842356,-155.842621,-155.841849,-155.840923,
                                     -155.840781, 155.841159,-155.841351,-155.841536,
                                     -155.841585,-155.842356]
                     }]
                 },
                {
                    "id": 1, 
                    "ypid": "YN000x000000001",
                    "name": {
                         "": "Painting",
                         "es-ES": "Pintura",
                     },
                    "directoryName": {
                         "": "Painting Department",
                         "es-ES": "Departamento de pintura"
                    },
                    "type": "Room", 
                    "location": [22.292822,-155.842356],
                    "address": {
                      "addressLine": "1 Microsoft Way",
                      "suite": "101",
                      "locality": "Redmond",
                      "adminDistrict": "WA",
                      "adminDistrict2": "King Co.",
                      "postalCode": "98052",
                      "countryRegionCode": "US",
                      "countryRegion": "United States"
                    },
                    "phoneNumber": "(206) 555-0102",
                    "categoryId": "12345",
                    "categoryName": {
                        "": "User-defined category"
                    }, 
                    "description": "Entity Description.",  
                    "label": {
                        "": {
                            "text": "Painting",
                            "rect": {
                                "center": [22.612343,-157.343432],
                                "width": 0.0005,
                                "height": 0.0004,
                                "angle": 45
                            }
                        }
                    "label": {
                        "es-ES": {
                            "text": "Pintura",
                            "rect": {
                                "center": [22.612343,-157.343432],
                                "width": 0.0005,
                                "height": 0.0004,
                                "angle": 45
                            }
                        }
                    },
                    "geometry": [
                        {
                            "closed": true,
                            "latitudes": [22.614012,22.623333],
                            "longitudes": [-157.201829,-157.212323]
                            ],
                            "inner": [
                                {
                                    "latitudes": [22.614111, 22.614222],
                                    "longitudes": [-157.201900,-157.211111]
                                }
                            ]
                       }
                    ]
                }
            ]
        }
    ]
}