Web Service Documentation / Categories / Meter Services / Get Meter Aggregation Indicator
Updated on March 11, 2021
This web service retrieves information on whether the specified meter represents an aggregation of multiple meters or not. It will also include the information that the existing Get-Meter web service returns. The meter must already be shared with you.
NOTE: This web service is available because the aggregateMeter element cannot be added to the existing Get Meter web service schema until the 17.0 release (summer 2021). Until then, this service allows for backwards compatibility and informs whether the meter is marked as an aggregate or not.
23.0
GET
/meter/(meterId)/aggregateMeter
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
meterId | Id to the meter |
Request/Response | Schema Name |
---|---|
Request | None |
Response | meter.xsd |
The following example retrieves the information of a specific individual meter (with an id of 200) which indicates whether the meter is an aggregate or not.
GET /meter/200/aggregateMeter
The following example returns the information for the meter which includes whether or not the meter is an aggregation of individual meters.
<?xml version="1.0" encoding="UTF-8"?>
<meter>
<id>543</id>
<type>Electric</type>
<name>Electric Main Meter</name>
<unitOfMeasure>kBtu (thousand Btu)</unitOfMeasure>
<metered>true</metered>
<firstBillDate>2010-01-01</firstBillDate>
<inUse>true</inUse>
<accessLevel>Read</accessLevel>
<aggregateMeter>true</aggregateMeter>
<audit>
<createdBy>DUNAYT</createdBy>
<createdByAccountId>-14</createdByAccountId>
<createdDate>2012-08-16T17:04:57-04:00</createdDate>
<lastUpdatedBy>DUNAYT</lastUpdatedBy>
<lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
<lastUpdatedDate>2012-08-16T17:09:35-04:00</lastUpdatedDate>
</audit>
</meter>