Web Service Documentation / Categories / Meter Services

Meter Services

The Meter Services allow you to manage meters within Portfolio Manager. These services support all meter categories: all fuels, water, Data Center IT energy meters, waste, and water and wastewater plant meters. The ability to define green power is also provided. You must be already connected to your customers to be able to manage their meters.

Meter

Method REST URI * Description
GET /idHierarchy/meter/(meterId) Returns the identifiers to the Property Data Administrator (accountId) and property for a specific meter.
GET /meter/(meterId) Returns information for a specified meter. The meter must already be shared with you.
PUT /meter/(meterId) Updates the information for a specified meter. The meter must already be shared with you and you must have write access to the meter.
DELETE /meter/(meterId) Deletes a specified meter. The meter must already be shared with you.
POST /property/(propertyId)/meter Adds a meter for a specific property. The property must already be shared with you and you must have write access to the property.
GET /property/(propertyId)/meter/list?myAccessOnly=(myAccessOnly) Returns a list of meters for a specified property. The property must already be shared with you.

Property Meter Association

Method REST URI * Description
GET /association/property/(propertyId)/meter Returns the list of meters that are associated to a given property. The corresponding property must be already shared with you.
POST /association/property/(propertyId)/meter Associates a specified list of meters to a given property. The property and meters to associate must be already shared with you.
POST /association/property/(propertyId)/meter/(meterId) Associates a specified (single) meter to a given property. The property and meter must be already shared with you.
DELETE /association/property/(propertyId)/meter/(meterId) Disassociates a specified meter from a given property. The property and meter must be already shared with you.

Property-Use Meter Association

Method REST URI * Description
GET /association/propertyUse/(propertyUseId)/meter Returns the list of meters that are associated to a given property use. The corresponding property must be already shared with you.
POST /association/propertyUse/(propertyUseId)/meter Associates a specified list of meters to a given property use. The corresponding property and meters must be already shared with you.
POST /association/propertyUse/(propertyUseId)/meter/(meterId) Associates a specified (single) meter to a given property use. The property and meter must be already shared with you.
DELETE /association/propertyUse/(propertyUseId)/meter/(meterId) Disassociates a specified meter from a given property use. The property and meter must be already shared with you.

Consumption Data

Method REST URI * Description
PUT /consumptionData/(consumptionDataId) Updates a specific meter consumption data entry. The meter must already be shared with you and you must have write access to the meter.
DELETE /consumptionData/(consumptionDataId) Deletes a specific meter consumption data entry. The meter must already be shared with you and you must have write access to the meter.
GET /idHierarchy/consumptionData/(consumptionDataId) Returns the identifiers to the Property Data Administrator (accountId), property, and meter for a specific consumption data record.
POST /meter/(meterId)/consumptionData Adds consumption data, optional green power, and optional demand data to a specified meter. The property that the meter belongs to must already be shared with you and you must have write access to the meter.
GET /meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Returns the consumption data for a specified meter in sets of 20. The meter must already be shared with you.

Waste Data

Method REST URI * Description
GET /idHierarchy/wasteData/(wasteDataId) Returns the identifiers to the Property Data Administrator (accountId), property, and meter for a specific waste data record.
POST /meter/(meterId)/wasteData Adds waste data to a specified meter. The property that the meter belongs to must already be shared with you and you must have write access to the meter.
GET /meter/(meterId)/wasteData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) Returns the waste data for a specified meter in sets of 20. The meter must already be shared with you.
PUT /wasteData/(wasteDataId) Updates a specific waste data entry. The meter must already be shared with you and you must have write access to the meter.
DELETE /wasteData/(wasteDataId) Deletes a specific waste data entry. The meter must already be shared with you and you must have write access to the meter.

Miscellaneous

Method REST URI * Description
GET /mapping/customer/(espCustID)/property/(espBldgID)/meter/(espMeterID) Returns the unique identifier used within Portfolio Manager for a meter. This service is intended for organizations that use the legacy ABS 2.5 system. The espMeterID is a unique ID for each organization that offers web services. This mapping service returns EPA's corresponding meterID in Portfolio Manager.
GET /meter/(meterId)/customFieldList Returns a list of your custom fields and their values for a specific meter.

* For the LIVE environment, relative to the base URI:  https://portfoliomanager.energystar.gov/ws

LIVE