announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

Web Service Documentation / Categories / Basic Account Services / Get Custom Field

Get Custom Field

Updated on May 9, 2014

Description

This web service returns information for a specific custom field.

Version

25.0

HTTP Method

GET

Resource URL

/dataExchangeSettings/customField/(customFieldId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customFieldId Id to the custom field

XML Schemas

Request/Response Schema Name
Request None
Response customField.xsd

Example Request

The following example retrieves the custom field with the id of 45.

GET  /dataExchangeSettings/customField/45

Example Response

The following example returns information for the custom field.

<?xml version="1.0" encoding="UTF-8"?>
<customField validCharacters="Any" required="true" name="Lot Number" whenToPrompt="Property">
     <description>Lot Number for the property in ACME Building system.</description>
     <example>FG 323</example>
     <url>http://www.acme.com</url>
     <minChars>1</minChars>
     <maxChars>12</maxChars>
     <displayOrder>1</displayOrder>
 </customField>
TEST