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 / Basic Account Services / Edit Custom Field

Edit Custom Field

Updated on May 9, 2014

Description

This web service updates a specified custom field. This custom field is used by the data exchange web services during the connection/share process.

Version

25.0

HTTP Method

PUT

Resource URL

/dataExchangeSettings/customField/(customFieldId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
customFieldId Id to the custom field

XML Schemas

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

Example Request

The following example updates a custom field that has an id of 46.

PUT  /dataExchangeSettings/customField/46

<?xml version="1.0" encoding="UTF-8"?>
<customField whenToPrompt="Property" name="FG ID" required="true" validCharacters="Any">
     <minChars>1</minChars>
     <maxChars>12</maxChars>
     <description>Federal ID</description>
     <example>FG 323</example>
     <displayOrder>1</displayOrder>
     <url>http://www.acme.com</url>
</customField>

Example Response

The following example indicates that the custom field was successfully updated. It also returns the new custom field id of 46 and a link to web service to retrieve the custom field.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>46</id>
    <links>
        <link httpMethod="GET" link="/dataExchangeSettings/customField/46" linkDescription="This is the GET url for this custom field."/>
    </links>
</response>
TEST