GET /api/v2/buildings/:id
Find building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID of the building.

Validations:

  • Must be a Integer
name
required

The name of the building.

Validations:

  • Must be a String
owner
required

The user that owns the building.

Validations:

  • Must be a Hash
owner[id]
required

The ID of the user that owns the building.

Validations:

  • Must be a Integer
owner[email]
required

The email address of the user that owns the building.

Validations:

  • Must be a String
owner[first_name]
required

The first name of the user that owns the building.

Validations:

  • Must be a String
owner[last_name]
required

The last name of the user that owns the building.

Validations:

  • Must be a String
owner[organization]
optional

The organization to which the user that owns the building is assigned.

Validations:

  • Must be a Hash
owner[organization][id]
required

The ID of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a Integer
owner[organization][name]
required

The name of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a String
owner[site_admin]
required

Set to “true” if the user that owns the building is a site administrator.

Validations:

  • Must be one of: true, false.
owner[type]
required

The type of the user. Always: “User”

Validations:

  • Must be one of: User.
status
required

The status of the building.

Validations:

  • Must be one of: Editing, Running, Rated.
created_at
required

The timestamp for when the building was created.

Validations:

  • Must be a DateTime
updated_at
required

The timestamp for when the building was last modified.

Validations:

  • Must be a DateTime
html_url
required

The URL for the building in the Asset Score tool.

Validations:

  • Must be a String