Building Type API

The Building Type API provides Green Building Studio client developers a facility for discovering what building types are currently recognized by Green Building Studio. Examples of building types are office building, hospital, place of worship, etc.

Making The Request

To access the Building Types API, use:

https://gbs.autodesk.com/gbs/api/v1/project/buildingTypeList/responseFormat

where responseFormat may be either of the following values:

json indicates output in JavaScript Object Notation (JSON)
xml indicates output as XML

Note: If responseFormat is omitted, the output will default to XML.

Building Types API Responses

Building Types API responses are returned in the format indicated in the responseFormat within the request URL.

JSON Output Example

[{ "BuildingTypeId": 1, "BuildingTypeName": "AutomotiveFacility"}, { "BuildingTypeId": 2, "BuildingTypeName": "ConventionCenter"}, { "BuildingTypeId": 3, "BuildingTypeName": "Courthouse"}, { "BuildingTypeId": 4, "BuildingTypeName": "DiningBarLoungeOrLeisure"}, { "BuildingTypeId": 5, "BuildingTypeName": "DiningCafeteriaFastFood"}, { "BuildingTypeId": 6, "BuildingTypeName": "DiningFamily"}, { "BuildingTypeId": 7, "BuildingTypeName": "Dormitory"}, { "BuildingTypeId": 8, "BuildingTypeName": "ExerciseCenter"}, { "BuildingTypeId": 9, "BuildingTypeName": "FireStation"}, { "BuildingTypeId": 10, "BuildingTypeName": "Gymnasium"}, { "BuildingTypeId": 11, "BuildingTypeName": "HospitalOrHealthcare"}, { "BuildingTypeId": 12, "BuildingTypeName": "Hotel"}, { "BuildingTypeId": 13, "BuildingTypeName": "Library"}, { "BuildingTypeId": 14, "BuildingTypeName": "Manufacturing"}, { "BuildingTypeId": 15, "BuildingTypeName": "Motel"}, { "BuildingTypeId": 16, "BuildingTypeName": "MotionPictureTheatre"}, { "BuildingTypeId": 17, "BuildingTypeName": "MultiFamily"}, { "BuildingTypeId": 18, "BuildingTypeName": "Museum"}, { "BuildingTypeId": 19, "BuildingTypeName": "Office"}, { "BuildingTypeId": 20, "BuildingTypeName": "ParkingGarage"}, { "BuildingTypeId": 21, "BuildingTypeName": "Penitentiary"}, { "BuildingTypeId": 22, "BuildingTypeName": "PerformingArtsTheater"}, { "BuildingTypeId": 23, "BuildingTypeName": "PoliceStation"}, { "BuildingTypeId": 24, "BuildingTypeName": "PostOffice"}, { "BuildingTypeId": 25, "BuildingTypeName": "ReligiousBuilding"}, { "BuildingTypeId": 26, "BuildingTypeName": "Retail"}, { "BuildingTypeId": 27, "BuildingTypeName": "SchoolOrUniversity"}, { "BuildingTypeId": 28, "BuildingTypeName": "SportsArena"}, { "BuildingTypeId": 29, "BuildingTypeName": "TownHall"}, { "BuildingTypeId": 30, "BuildingTypeName": "Transportation"}, { "BuildingTypeId": 31, "BuildingTypeName": "Warehouse"}, { "BuildingTypeId": 32, "BuildingTypeName": "Workshop"}, { "BuildingTypeId": 34, "BuildingTypeName": "SingleFamily"}, { "BuildingTypeId": 35, "BuildingTypeName": "HealthcareClinic"}]

XML Output Example

<?xml version="1.0" ?>
 <ArrayOfBuildingType xmlns="http://gbs.autodesk.com/gbs/api/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <BuildingType>
     <BuildingTypeId> 1 </BuildingTypeId>
     <BuildingTypeName> AutomotiveFacility </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 2 </BuildingTypeId>
     <BuildingTypeName> ConventionCenter </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 3 </BuildingTypeId>
     <BuildingTypeName> Courthouse </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 4 </BuildingTypeId>
     <BuildingTypeName> DiningBarLoungeOrLeisure </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 5 </BuildingTypeId>
     <BuildingTypeName> DiningCafeteriaFastFood </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 6 </BuildingTypeId>
     <BuildingTypeName> DiningFamily </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 7 </BuildingTypeId>
     <BuildingTypeName> Dormitory </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 8 </BuildingTypeId>
     <BuildingTypeName> ExerciseCenter </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 9 </BuildingTypeId>
     <BuildingTypeName> FireStation </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 10 </BuildingTypeId>
     <BuildingTypeName> Gymnasium </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 11 </BuildingTypeId>
     <BuildingTypeName> HospitalOrHealthcare </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 12 </BuildingTypeId>
     <BuildingTypeName> Hotel </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 13 </BuildingTypeId>
     <BuildingTypeName> Library </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 14 </BuildingTypeId>
     <BuildingTypeName> Manufacturing </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 15 </BuildingTypeId>
     <BuildingTypeName> Motel </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 16 </BuildingTypeId>
     <BuildingTypeName> MotionPictureTheatre </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 17 </BuildingTypeId>
     <BuildingTypeName> MultiFamily </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 18 </BuildingTypeId>
     <BuildingTypeName> Museum </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 19 </BuildingTypeId>
     <BuildingTypeName> Office </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 20 </BuildingTypeId>
     <BuildingTypeName> ParkingGarage </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 21 </BuildingTypeId>
     <BuildingTypeName> Penitentiary </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 22 </BuildingTypeId>
     <BuildingTypeName> PerformingArtsTheater </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 23 </BuildingTypeId>
     <BuildingTypeName> PoliceStation </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 24 </BuildingTypeId>
     <BuildingTypeName> PostOffice </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 25 </BuildingTypeId>
     <BuildingTypeName> ReligiousBuilding </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 26 </BuildingTypeId>
     <BuildingTypeName> Retail </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 27 </BuildingTypeId>
     <BuildingTypeName> SchoolOrUniversity </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 28 </BuildingTypeId>
     <BuildingTypeName> SportsArena </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 29 </BuildingTypeId>
     <BuildingTypeName> TownHall </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 30 </BuildingTypeId>
     <BuildingTypeName> Transportation </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 31 </BuildingTypeId>
     <BuildingTypeName> Warehouse </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 32 </BuildingTypeId>
     <BuildingTypeName> Workshop </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 34 </BuildingTypeId>
     <BuildingTypeName> SingleFamily </BuildingTypeName>
   </BuildingType>
   <BuildingType>
     <BuildingTypeId> 35 </BuildingTypeId>
     <BuildingTypeName> HealthcareClinic </BuildingTypeName>
   </BuildingType>
 </ArrayOfBuildingType>