Supported Formats

json, xml

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

{"name":"Test Building","total_floor_area":"1000","year_of_construction":"2013","zip_code":"99352","city":"Richland","state":"WA"}
<building>
  <name>Test Building</name>
  <year-of-construction>2013</year-of-construction>
  <address>1234 Somewhere Ave.</address>
  <city>Richland</city>
  <state>WA</state>
  <zip-code>99352</zip-code>
  <total-floor-area>1000</total-floor-area>
  <notes>Some notes about my building.</notes>
</building>

Params

Param name Description
name
required

Name of building.

Validations:

  • Must be a String

year_of_construction
required

Year building was completed.

Validations:

  • Must be a Integer

address
required

Street address of building.

Validations:

  • Must be a String

city
required

City of address.

Validations:

  • Must be a String

state
required

State of address.

Validations:

  • Must be a String

zip_code
required

Zipcode of address.

Validations:

  • Must be a String

total_floor_area
required

Gross floor area in square feet.

Validations:

  • Must be a Integer

notes
optional

Optional notes about building.

Validations:

  • Must be a String