Module: PortfolioManager::Services::Meter::MeterAggregation::Live

Included in:
All::Live
Defined in:
lib/portfolio_manager/services/meter.rb

Overview

Live Environment

Instance Method Summary collapse

Instance Method Details

#add_individual_meter_to_aggregated_meter(meter_id, individual_meter) ⇒ PortfolioManager::Xml::ResponseType

Add Individual Meter to Aggregated Meter

This web service adds an individual meter to be included in the total for the aggregate meter. The aggregate meter must already be shared with you and you must have write access.

Parameters:

Returns:

Raises:

See Also:



794
795
796
 
# File 'lib/portfolio_manager/services/meter.rb', line 794

def add_individual_meter_to_aggregated_meter(meter_id, individual_meter)
  request(Net::HTTP::Post, path_for("meter", meter_id, "individual"), {}, {}, individual_meter, "individualMeter", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#delete_all_individual_meters_of_an_aggregate_meter(meter_id) ⇒ PortfolioManager::Xml::ResponseType

Delete All Individual Meters of an Aggregate Meter

This web service deletes all information of individual meters that are included in the total for the aggregate meter. The aggregate meter must already be shared with you and you must have write access.

Parameters:

  • meter_id (Integer)

Returns:

Raises:

See Also:



810
811
812
 
# File 'lib/portfolio_manager/services/meter.rb', line 810

def delete_all_individual_meters_of_an_aggregate_meter(meter_id)
  request(Net::HTTP::Delete, path_for("meter", meter_id, "individual"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#delete_individual_meter_of_an_aggregated_meter(individual_meter_id) ⇒ PortfolioManager::Xml::ResponseType

Delete Individual Meter of an Aggregated Meter

This web service deletes information for an individual meter that is included in the total for the aggregate meter. The aggregate meter must already be shared with you and you must have write access.

Parameters:

  • individual_meter_id (Integer)

Returns:

Raises:

See Also:



825
826
827
 
# File 'lib/portfolio_manager/services/meter.rb', line 825

def delete_individual_meter_of_an_aggregated_meter(individual_meter_id)
  request(Net::HTTP::Delete, path_for("meter", "individual", individual_meter_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_individual_meter_of_an_aggregated_meter(individual_meter_id) ⇒ PortfolioManager::Xml::IndividualMeter, PortfolioManager::Xml::ResponseType

Get Individual Meter of an Aggregated Meter

This web service retrieves information for an individual meter that is included in the total for the aggregate meter. The aggregate meter must already be shared with you.

Parameters:

  • individual_meter_id (Integer)

Returns:

Raises:

See Also:



840
841
842
 
# File 'lib/portfolio_manager/services/meter.rb', line 840

def get_individual_meter_of_an_aggregated_meter(individual_meter_id)
  request(Net::HTTP::Get, path_for("meter", "individual", individual_meter_id), {}, {}, nil, nil, PortfolioManager::Xml::IndividualMeter, basic_auth: true)
end

#get_meter_aggregation_indicator(meter_id) ⇒ PortfolioManager::Xml::MeterType, PortfolioManager::Xml::ResponseType

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.

Get Meter Aggregation Indicator

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.

Parameters:

  • meter_id (Integer)

Returns:

Raises:

See Also:



862
863
864
 
# File 'lib/portfolio_manager/services/meter.rb', line 862

def get_meter_aggregation_indicator(meter_id)
  request(Net::HTTP::Get, path_for("meter", meter_id, "aggregateMeter"), {}, {}, nil, nil, PortfolioManager::Xml::MeterType, basic_auth: true)
end

#get_meter_aggregation_list(meter_id) ⇒ PortfolioManager::Xml::ResponseType

Get Meter Aggregation List

This web service retrieves a list of all individual meters that are aggregated into the specified meter. The meter must already be shared with you.

Parameters:

  • meter_id (Integer)

Returns:

Raises:

See Also:



877
878
879
 
# File 'lib/portfolio_manager/services/meter.rb', line 877

def get_meter_aggregation_list(meter_id)
  request(Net::HTTP::Get, path_for("meter", meter_id, "individual", "list"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#update_individual_meter_of_aggregated_meter(individual_meter_id, individual_meter) ⇒ PortfolioManager::Xml::ResponseType

Update Individual Meter of an Aggregated Meter

This web service updates information for an individual meter that is included in the total for the aggregate meter. The aggregate meter must already be shared with you and you must have write access.

Parameters:

Returns:

Raises:

See Also:



893
894
895
 
# File 'lib/portfolio_manager/services/meter.rb', line 893

def update_individual_meter_of_aggregated_meter(individual_meter_id, individual_meter)
  request(Net::HTTP::Put, path_for("meter", "individual", individual_meter_id), {}, {}, individual_meter, "individualMeter", PortfolioManager::Xml::ResponseType, basic_auth: true)
end