Web Service Documentation / Categories / Property Services / Add Energy Performance Project

Add Energy Performance Project

Updated on July 17, 2013

Description

This web service creates an energy performance project for a specific property based on the information provided in the XML request. The corresponding property must already be shared with you. The service returns the unique identifier to the newly created energy performance project and a link to the corresponding web service to retrieve it.

Version

22.0

HTTP Method

POST

Resource URL

/property/(propertyId)/energyPerformanceProject

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 the energy performance project is to be added to

XML Schemas

Request/Response Schema Name
Request None
Response energyPerformanceProject.xsd

Example Request

The following example creates a new energy performance project that belongs to an property that has an id of 893.

POST  /property/893/energyPerformanceProject

<?xml version="1.0" encoding="UTF-8"?>
<energyPerformanceProject>
         <category>Recommissioning (Stage 1)</category>
         <investmentCost>650000</investmentCost>
         <projectDescription>Recommissioning of Ventalation in building</projectDescription>
         <evaluationPeriod>
            <preImplementationDate>2011-08-01</preImplementationDate>
            <postImplementationDate>2012-08-31</postImplementationDate>
         </evaluationPeriod>
         <projectName>Duct Work</projectName>
         <implementationDate>2011-08-01</implementationDate>
         <estimatedSavingsCost>750000</estimatedSavingsCost>
</energyPerformanceProject>

Example Response

The following example indicates that the energy performance project was successfully added.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>766</id>
     <links>
        <link httpMethod="GET" link="/energyPerformanceProject/766" id="766" hint="Duct Work" linkDescription="This is the GET url for this Energy Performance Project."/>
     </links>
</response>
LIVE