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 / Delete Custom Field

Delete Custom Field

Updated on July 17, 2013

Description

This web service deletes a custom field and all data stored associated with it.

Version

25.0

HTTP Method

DELETE

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 None
Response response.xsd

Example Request

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

DELETE  /dataExchangeSettings/customField/46

Example Response

The following example indicates that the custom field was successfully deleted.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
TEST