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.
422 Building is not in edit mode. Place building in edit mode first before editing
422 The attribute <attribute> which ends with ! can not be changed with the update method.
422 The attribute <attribute> can not be changed with the update method. To change this attribute you must delete the building and start again.
422 Can't update <attribute> because building has no <attribute>.

Examples

(json) PUT {
  "token": "1234TokenGoesHere",
  "building": {
    "block_id": "1",
    "building_name": "Updated Building Name",
    "building_notes": "Built via building upload spreadsheet."
  }
}
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"
    }
  ]
}
Example 1: {
  "token":"1234TokenGoesHere",
  "building": {
     "block_id":1,
     "assessment_type":"Test"
  }
}
Example 2: {
  "token":"1234TokenGoesHere",
  "building": {
    "block_id":1,
    "floor:floor_type":"Slab-on-Grade"
  }
}
Example 3: {
  "token":"1234TokenGoesHere",
  "building": {
    "block_id":1,
    "lighting:{fixture_id}:lamp_type":'LED'
  }
}

Params

Param name Description
token
required

Identifies the user

Validations:

  • Must be a String

building
required

describes the building

Validations:

  • Must be a Hash

building[block_id]
required

Identifies the internal block.

Validations:

  • Must be a String

building[name]
optional

Name of building.

Validations:

  • Must be a String

building[year_of_construction]
optional

Year building was completed.

Validations:

  • Must be a String

building[address]
optional

Street address of building.

Validations:

  • Must be a String

building[city]
optional

City of address.

Validations:

  • Must be a String

building[state]
optional

State of address.

Validations:

  • Must be a String

building[zip_code]
optional

Zipcode of address.

Validations:

  • Must be a String

building[assessment_type]
optional

Test if you are not doing a formal audit or Real if you are.

Validations:

  • Must be a String

building[notes]
optional

Any kind of additional text.

Validations:

  • Must be a String