Buildings |
---|
A Building is defined as a logical structural unit which may be a single physical structure or multiple structures grouped by a particular criteria. To return a specific fields in the response, a consumer may use the value of fields parameter in a comma-separated list that refers to the names of the fields to be returned. |
Request | Returns |
---|
GET /buildings | All Buildings. |
GET /buildings/{id} | A Building by ID. |
GET /buildings/{id}/equipment | All Equipment related to the Building. |
GET /buildings/{id}/equipmentclasses | All Equipment Class related to the Building. |
GET /buildings/{id}/equipment?classID={id} | Equipment of the given Equipment Class related to the Building. |
GET /buildings/{id}/equipmenttypes | All Equipment Types related to the Building. |
GET /buildings/{id}/equipment?typeID={id} | Equipment of the given Equipment Type related to the Building. |
GET /buildings/{id}/taskrecords | All Tasks related to the Building. |
GET /buildings/{id}/buildingbuildingvariables | Values of all Building Variables assigned to the Building. |
GET /buildings/{id}/equipmentpoints | All Equipment Points related to the building. |
GET /buildings/{id}/points | All Points related to the Building. |
OPTIONS /buildings | This Help table. |
Response Key
| Data Type | Allow Nulls? | Description |
---|
id | Integer | No | Building ID. |
BuildingName | String(100) | No | Building name. |
BuildingTypeID | Integer | No | Building Type ID. |
CID | Integer | No | ID of the Client that this Building is assigned to. |
Address | String(250) | No | Building address. |
BuildingClassDescription | String(1000) | Yes | Description of the categorized Building classification. |
BuildingClassID | Integer | No | ID of the categorized Building classification. |
BuildingClassName | String(50) | No | Name of the categorized Building classification. |
BuildingOwnership | String(50) | Yes | Type of ownership the Buildings is under. |
BuildingTypeDescription | String(1000) | No | Description of the specific type under the Building classification. |
BuildingTypeName | String(100) | No | Name of the specific type under the Building classification. |
BuildingShape | String(50) | Yes | Shape of the Building. |
City | String(100) | No | Building City. |
ClientName | String(100) | No | Client Name. |
Computers | Integer | No | Estimated number of computers in the Building, in range 0-10,000. |
CountryName | String(50) | Yes | Country of the Building. |
CountryAlpha2Code | String(2) | No | Unique ISO Alpha 2 country code. |
DateCreated | ISO Date String | No | Date, in UTC, the Building was created in the system. |
DateModified | ISO Date String | No | Date, in UTC, the Building was last modified in the system. |
Description | String(1000) | Yes | Description of the Building. |
EnvelopeGlassPercentage | Integer | No | Envelope glass percentage of the Building, in range 0-100. |
Floors | Integer | Yes | Number of floors in the Building, in range 1-9999. |
IsActive | Bit | No | True (1) if the Building is actively receiving data and running diagnostics in the system, False (0) otherwise. |
IsVisible | Bit | No | True (1) if the Building is visible to non-administrative users in the system, False (0) otherwise. |
Latitude | Decimal(13,10) | Yes | Latitude of the Building. |
LCID | Integer
| No | Locale identifier for the Building. A locale is a set of information related to the entities language and culture. The locale determines how dates, times, currencies, and numbers are formatted, how items are alphabetically sorted, and how strings are compared. |
Location | String(250) | Yes | Additional location information about the Building. |
Longitude | Decimal(13,10) | Yes | Longitude of the Building. |
MainCoolingSystem | String(50) | Yes | Type of the main cooling system. |
MainHeatingSystem | String(50) | Yes | Type of the main heating system. |
Occupants | Integer | Yes | Estimated number of Building occupants, in range 1-99,999. |
OperatingHours | Integer | No | Building operating hours, in range 0-168. |
Phone | String(10) | Yes | Building phone number (U.S. only). |
RoofConstruction | String(50) | Yes | Type of roof construction. |
SASLink | String(100) | Yes | Space Accounting Software link URL. |
SASReferenceID | String(50) | Yes | Space Accounting Software reference ID. |
StateID | Integer | Yes | The State ID. |
StateName | String(100) | Yes | Building state, province, or equivalent. |
Area | Integer | No | Area of the Building, in range 0-9,999,999,999. |
TimeZone | String(50) | No | Building time zone. |
TimeZoneDisplayName | String(xx) | Yes | The time zone display name. |
UnitSystem | Bit | No | True (1) if the Building data is measured in SI units, False (0) if is measured in IP units. |
WebsiteLink | String(100) | Yes | Building specific website link URL. |
WeatherFileDisplayName | String(150) | Yes | Yes, The weather file display name. |
WeatherFileGFID | Integer | Yes | The building Weather File ID. |
YearBuilt | Integer | Yes | 4-digit year the Building was built. |
Zip | String(10) | Yes | Zip code, or equivalent of the Building. |