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

Invalid building example:
  {
  "valid": false,
  "errors": [
    "building_without_block"
    ]
  }
Invalid block example:
{
  "valid": false,
  "errors": [
    {
      "blocks_without_primary_hvac": [
        {
          "building_id": 2,
          "building_use_type_id": 2,
          "color": "c8dcdc",
          "created_at": "2013-09-24T18:58:09Z",
          "dimension_1": 100,
          "dimension_10": null,
          "dimension_2": 100,
          "dimension_3": null,
          "dimension_4": null,
          "dimension_5": null,
          "dimension_6": null,
          "dimension_7": null,
          "dimension_8": null,
          "dimension_9": null,
          "floor_id": 2,
          "floor_to_ceiling_height": 9,
          "floor_to_floor_height": 12,
          "has_drop_ceiling": null,
          "has_timer_controls": null,
          "id": 2,
          "is_above_ground": true,
          "name": "b1",
          "number_of_bg_floors": 0,
          "number_of_floors": 1,
          "operating_season_id": null,
          "operation_id": null,
          "orientation": 0,
          "percent_footprint": null,
          "perimeter_zone_depth": null,
          "position": "{"x":0,"z":0,"y":6}",
          "roof_id": 2,
          "selected": null,
          "shape_id": 1,
          "sides": null,
          "skylight_id": 2,
          "skylight_layout_id": null,
          "ui_id": "",
          "updated_at": "2013-09-24T18:58:10Z",
          "uses_percent_served": false,
          "vertices": "[[{"x":50,"z":50,"y":0},{"x":50,"z":-50,"y":0},{"x":-50,"z":-50,"y":0},{"x":-50,"z":50,"y":0}],[{"x":50,"z":50,"y":12},{"x":50,"z":-50,"y":12},{"x":-50,"z":-50,"y":12},{"x":-50,"z":50,"y":12}]]",
          "zone_layout_id": null
        }
      ]
    }
  ]
}
Valid example (json):
  {
    "valid": true,
    "errors": []
  }
Example with errors (xml):
<hash>
<valid type="boolean">false</valid>
<errors type="array">
<error>
<blocks-without-hvac-systems type="array"></blocks-without-hvac-systems>
</error>
</errors>
</hash>