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 / Meter Services / Add Individual Meter to Aggregated Meter

Add Individual Meter to Aggregated Meter

Updated on March 11, 2021

Description

This web service adds an individual meter to be included in the total for the aggregate meter. The aggregate meter must already be shared with you and you must have write access.

Version

25.0

HTTP Method

POST

Resource URL

/meter/(meterId)/individual

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id to the meter

XML Schemas

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

Example Requests

The following example adds an individual meter to be included in the total for the aggregate meter that has an id of 200.

POST  /meter/200/individual

<?xml version="1.0" encoding="UTF-8"?>
<individualMeter>
     <customId>AE878XS</customId>
     <customIdName>Electric Meter</customIdName>
     <serviceAddress>111 Main St., Arlington, VA 22202</serviceAddress>
     <inUse>true</inUse>
</individualMeter>

The following example adds an individual meter to be included in the total for the aggregate meter that has an id of 200 and is set to inactive.

POST  /meter/200/individual

<?xml version="1.0" encoding="UTF-8"?>
<individualMeter>
     <customId>AE878XS</customId>
     <customIdName>Electric Meter</customIdName>
     <serviceAddress>111 Main St., Arlington, VA 22202</serviceAddress>
     <inUse>false</inUse>
     <inactiveDate>2018-01-25</inactiveDate>
</individualMeter>

Example Response

The following example indicates that the meter aggregation information was successfully created.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>432</id>
     <links>
          <link httpMethod="GET" link="/meter/individual/432" linkDescription="This is the GET url for this individual meter." hint="Electric Main Meter"/>
     </links>
</response>
TEST