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 / Meter Services / Edit Meter Identifier Value

Edit Meter Identifier Value

Updated on December 10, 2018

Description

This web service updates the meter identifier value for a specific meter based on the information provided in the XML request.

Version

25.0

HTTP Method

PUT

Resource URL

/meter/(meterId)/identifier/(identifierId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id of the meter

XML Schemas

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

Example Request

The following example assigns the value "1645" to the property identifier that has an id of 45678 for the meter with an id of 32423.

PUT  /meter/32423/identifier/45678

<?xml version="1.0" encoding="UTF-8"?>
<additionalIdentifier>
     <additionalIdentifierType id="2"/>
     <description>UTILITY ACCT SUBMETER 12a - MECHANICAL3</description>
     <value>1645</value>
</additionalIdentifier>

Example Response

The following example indicates that the meter identifier value was updated successfully.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>45678</id>
     <links>
          <link httpMethod="GET" link="/meter/32423/identifier/45678" linkDescription="This is the GET url for this Property Additional Identifier."/>
     </links>
</response>
TEST