Skip to content

Latest commit

 

History

History
204 lines (171 loc) · 3.58 KB

building_acronym.md

File metadata and controls

204 lines (171 loc) · 3.58 KB

Building Details

GET /buildings/{building_code}.{format}

Description

This method returns the official building name, its unique number, and its lat/long coordinates given a building code.

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1217 Enabled Yes
Service Name buildings Service ID 257
Information Steward Institution of Analysis & Planning (IAP) Data Type CSV
Update Frequency When updated by the steward/via github pull request Cache Time 0 seconds

Notes

  • Usage won't increase if there is no data returned
  • This data is community curated on github.
  • Any value can be null

Sources

Parameters

GET /buildings/{building_code}.{format}
Parameter Type Required Description
key filter yes Your API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /buildings/{building_code}.{format}

Response

Field Name Type Value Description
building_id string Unique building number
building_code string Official building name
alternate_names array Alternate building names
latitude float Latitude of building location
longitude float Longitude of building location
building_sections array List of building sections
section_name array Name of section
latitude float Latitude of building section location
longitude float Longitude of building section location

Any value can be null

Output

JSON

{
  "meta":{
    "requests":121,
    "timestamp":1381957030,
    "status":200,
    "message":"Request successful",
    "method_id":2,
    "version":2.07,
    "method":{
      
    }
  },
  "data":{
    "building_id":23,
    "building_code":"MHR",
    "building_name":"Minota Hagey Residence",
    "alternate_names":[
      "Velocity"
    ],
    "latitude":43.46579535,
    "longitude":-80.54275113,
    "building_sections":[
      
    ],
    "building_outline":[
      
    ]
  }
}