Module: PortfolioManager::REST::Meter

Includes:
Utils
Included in:
API
Defined in:
lib/portfolio_manager/rest/meter.rb

Overview

Meter services

See Also:

Instance Method Summary collapse

Instance Method Details

#meter(meter_id) ⇒ Object

This web service retrieves information for a specific meter. The meter must already be shared with you.

Parameters:

  • meter_id (String, Integer)

See Also:



17
18
19
 
# File 'lib/portfolio_manager/rest/meter.rb', line 17

def meter(meter_id)
  perform_get_request("/meter/#{meter_id}")
end

#meter_list(property_id) ⇒ Object

This web service retrieves a list of all the meters for a specific property. The property must already be shared with you.

See Also:



26
27
28
 
# File 'lib/portfolio_manager/rest/meter.rb', line 26

def meter_list(property_id)
  perform_get_request("/property/#{property_id}/meter/list")
end

#metrics(property_id, year, month, measurement_system, metric) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/portfolio_manager/rest/meter.rb', line 30

def metrics(property_id, year, month, measurement_system, metric)
  perform_get_request(
    "/property/#{property_id}/metrics",
    query: {
      year: year, month: month, measurementSystem: measurement_system
    },
    header: {
      'PM-Metrics' => metric
    }
  )
end