announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Property Services / Get Design

Get Design

Updated on February 10, 2014

Description

This web service retrieves the design characteristics for a specified property. The property must already be shared with you.

Version

25.0

HTTP Method

GET

Resource URL

/property/(propertyId)/design

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response design.xsd

Example Request

The following example retrieves the design characteristics for a property that has an id of 150.

GET  /property/150/design

Example Response

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>
LIVE