Web Service Documentation / Categories / Property Services / Get Design
Updated on February 10, 2014
This web service retrieves the design characteristics for a specified property. The property must already be shared with you.
23.0
GET
/property/(propertyId)/design
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
propertyId | Id to the property |
Request/Response | Schema Name |
---|---|
Request | None |
Response | design.xsd |
The following example retrieves the design characteristics for a property that has an id of 150.
GET /property/150/design
The following example returns the design characteristics for a property that has an id of 150.
<?xml version="1.0" encoding="UTF-8"?>
<design>
<propertyUses>
<k12School>
<name>Broadway School update</name>
<useDetails>
<totalGrossFloorArea units="Square Feet">
<value>3</value>
</totalGrossFloorArea>
<openOnWeekends>
<value>Yes</value>
</openOnWeekends>
<percentCooled>
<value>0</value>
</percentCooled>
<percentHeated>
<value>0</value>
</percentHeated>
<numberOfComputers>
<value>3</value>
</numberOfComputers>
<cookingFacilities>
<value>Yes</value>
</cookingFacilities>
<isHighSchool>
<value>Yes</value>
</isHighSchool>
<monthsInUse>
<value>8</value>
</monthsInUse>
<schoolDistrict>
<value>String</value>
</schoolDistrict>
</useDetails>
</k12School>
</propertyUses>
<estimatedEnergyList>
<entries>
<designEntry>
<energyType>Electric</energyType>
<energyUnit>MBtu (million Btu)</energyUnit>
<estimatedAnnualEnergyUsage>10</estimatedAnnualEnergyUsage>
<energyRateCost>100.01</energyRateCost>
<energyRateCostUnit>MBtu (million Btu)</energyRateCostUnit>
</designEntry>
</entries>
</estimatedEnergyList>
<target>
<targetTypeScore>
<value>55</value>
</targetTypeScore>
</target>
</design>