Supported Formats

json

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
401 Access Denied -- Not owner of building and/or the building has not been shared with this user.
404 Unsupported operation
500 Unspecified error on server.

Examples

Response: {
  "building_id": 1,
  "total_floor_area!": 10512.0,
  "orientation!": "North/South",
  "name": "Valid Preview Building Name",
  "year_of_construction": 1902,
  "address": "123 Main Street",
  "city": "Good City Name",
  "state": "MA",
  "zip_code": "12345",
  "notes": "Built via building upload spreadsheet.",
  "status!": "Rated",
  "assessment_type": "Test",
  "blocks": [
    {
      "block_id": 1,
      "lighting": [
        {
          "id": 1,
          "percent_served": 90.0,
          "percent_served_status!": "Do not know",
          "fixture_status!": "Do not know",
          "mounting_type": "Recessed",
          "lamp_type": "Fluorescent T12"
        },
        {
          "id": 2,
          "percent_served": 10.0,
          "percent_served_status!": "Do not know",
          "fixture_status!": "Do not know",
          "mounting_type": "Pendant",
          "lamp_type": "Incandescent/Halogen"
        }
      ],
      "use_type:name!": "Office",
      "roof:roof_type": "Built-up w/ metal deck",
      "roof:roof_type_status!": "Do not know",
      "floor:floor_type": "Slab-on-Grade",
      "floor:floor_type_status!": "Do not know",
      "surfaces:window_wall_ratio": 0.33,
      "surfaces:window_wall_ratio_status!": "Do not know",
      "wall:wall_type": "Brick/Stone on steel frame",
      "wall:wall_type_status!": "Do not know",
      "window:framing_type": "Metal w/ Thermal Breaks",
      "window:framing_type_status!": "Do not know",
      "window:glass_type": "Single Pane",
      "window:glass_type_status!": "Do not know",
      "water_heater:fuel_type": "Natural Gas",
      "water_heater:fuel_type_status!": "Do not know",
      "hvac_system:type": "Packaged Rooftop VAV with Electric Reheat",
      "hvac_system:type_status!": "Do not know",
      "hvac_system:fuel_type": "Electricity",
      "hvac_system:fuel_type_status!": "Do not know"
    }
  ]
}

Params

Param name Description
token
required

Identifies the user

Validations:

  • Must be a String