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"
}

Params

Param name Description
token
required

Identifies the user

Validations:

  • Must be a String