Web Service Documentation / Categories / Meter Services / Add Meter

Add Meter

Updated on March 11, 2021

Description

This web service creates a meter for a specific property 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 newly created meter and a link to the corresponding web service to retrieve it. The property must already be shared with you and you must have write access to the property.

Version

23.0

HTTP Method

POST

Resource URL

/property/(propertyId)/meter

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property that the meter is to be added to

XML Schemas

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

Example Requests

The following example creates a new electric meter that belongs to an property that has an id of 893.

POST  /property/893/meter

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

The following example creates a new meter that is of an Other type. The meter is created for a property that has an id of 893.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Other (Energy)</type>
    <name>Other</name>
    <otherDescription>Combination Fuel Type</otherDescription>
    <unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
    <metered>true</metered>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

The following example creates an IT energy meter (for Data Centers). The IT meter is created for a property that has an id of 893. Please note that the IT meter needs to be associated to a Data Center.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<meter>
    <type>Power Distribution Unit (PDU) Input Energy</type>
    <name>PDU Meter</name>
    <unitOfMeasure>kWh (thousand Watt-hours)</unitOfMeasure>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</meter>

The following example creates a regularly collected waste meter for beverage containers to a property that has an id of 893.

POST  /property/893/meter

<?xml version="1.0" encoding="UTF-8"?>
<wasteMeter>
    <type>Disposed - Beverage Containers (aluminum, glass, plastic)</type>
    <name>Regular Collection of Beverage Containers</name>
    <unitOfMeasure>tons</unitOfMeasure>
    <dataEntryMethod>regular</dataEntryMethod>
    <firstBillDate>2010-01-01</firstBillDate>
    <inUse>true</inUse>
</wasteMeter>

The following example creates a new electric meter that belongs to a property that has an id of 893 and marks it as an aggregate meter.

POST  /property/893/meter

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

Example Response

The following example indicates that the meter was successfully created. The response also includes the new meter id of 432 and a link to web service to retrieve the property.

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