Web Service Documentation / Categories / Meter Services / Edit Meter

Edit Meter

Updated on March 11, 2021

Description

This web service updates a specified meter based on the information provided in the XML request and establishes all of the necessary meter sharing permissions between you and the Portfolio Manager user. It returns the unique identifier to the meter and a link to the corresponding web service to retrieve it. The meter must already be shared with you and you must have write access to the meter.

Version

23.0

HTTP Method

PUT

Resource URL

/meter/(meterId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id to the meter to be updated

XML Schemas

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

Example Requests

The following example updates a meter that has an id of 543.

PUT  /meter/543

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Electric</type>
    <name>Electric Main Meter - REVISED</name>
    <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

The following example updates an data center power distribution unit (PDU) input energy meter that has an id of 544.

PUT  /meter/544

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Power Distribution Unit (PDU) Input Energy</type>
    <name>PDU IT Data Center - REVISED</name>
    <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

The following example updates a flow meter that has an id of 545.

PUT  /meter/545

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Average Flow</type>
    <name>Waste water average flow meter - REVISED</name>
    <unitOfMeasure>MGal (US)</unitOfMeasure>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

The following example updates an intermittently collected waste meter of paper that has an id of 546.

PUT  /meter/546

<?xml version="1.0" encoding="UTF-8"?>
<wasteMeter>
    <name>Disposed - Paper (REVISED)</name>
    <type>Disposed - Paper - Books</type>
    <unitOfMeasure>Gallons (US)</unitOfMeasure>
    <dataEntryMethod>intermittent</dataEntryMethod>
    <inUse>true</inUse>
</wasteMeter>

The following example updates a meter to indicate that it is an aggregate meter.

PUT  /meter/543

<?xml version="1.0" encoding="UTF-8"?>
<meter>
     <type>Electric</type>
     <name>Electric Main Meter - REVISED</name>
     <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
     <firstBillDate>2010-01-01</firstBillDate>
     <inUse>true</inUse>
     <aggregateMeter>true</aggregateMeter>
</meter>

Example Response

The following example indicates that the meter was successfully updated. It also returns the unique identifier to the meter and a link to the corresponding web service to retrieve it.

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