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 Use Services / Edit Custom Use Details - Correction

Edit Custom Use Details - Correction

Updated on August 28, 2023

Description

This web service updates a specific custom use detail based on the information provided in the XML request. The update is performed as a correction. It returns the unique identifier to the custom use detail and a link to the corresponding web service to retrieve it. The corresponding property must already be shared to you.

Version

25.0

HTTP Method

PUT

Resource URL

/customUse/details/(detailsId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
useDetailsId Id of the use details

XML Schemas

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

Example Request

The following example updates the custom use detail that has an id of 130086500. The update is performed as a correction.

PUT  /customUse/details/130086500

<?xml version="1.0" encoding="UTF-8"?>
<customUseDetail1 id="130086500" currentAsOf="2000-01-01" temporary="false" default="No">
     <value>55</value>
     <customName>test detail</customName>
</customUseDetail1>

Example Response

The following example returns the information for the custom use detail.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="130086500" httpMethod="GET" link="/ws/customUse/details/130086500" linkDescription="This is the GET url for this Custom Use Detail."/>
     </links>
</response>
TEST