Web Service Documentation / Categories / Property Services / Edit Design

Edit Design

Updated on February 10, 2014

Description

This web service updates the design characteristics based on the information provided in the XML request for a specified property that already exists. It overwrites all previously existing design characteristics. The property must already be shared with you.

Version

22.0

HTTP Method

PUT

Resource URL

/property/(propertyId)/design

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property that is to be updated

XML Schemas

Request/Response Schema Name
Request design.xsd
Response response.xsd

Example Request

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

PUT  /property/150/design

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

Example Response

The following example indicates that the property was successfully updated. The response also includes a link to the web service to retrieve the metrics. When calling the web service to retrieve the metrics, please make sure you specify the appropriate set of metrics.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>150</id>
    <links>
        <link httpMethod="GET" link="/property/150/design" linkDescription="This is the GET design url for this Property."/>
        <link httpMethod="GET" link="/property/150/design/metrics" linkDescription="This is the GET metrics url for this Property."/>
    </links>
</response>
TEST