Module: PortfolioManager::Services::Meter::UniqueIdentifiers::Live

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

Overview

Live Environment

Instance Method Summary collapse

Instance Method Details

#add_meter_identifier_value(meter_id, additional_identifier) ⇒ PortfolioManager::Xml::ResponseType

Add Meter Identifier Value

This web service adds a name and value to a specific additional meter identifier for a given meter based on the information provided in the XML request.

Parameters:

Returns:

Raises:

See Also:



678
679
680
 
# File 'lib/portfolio_manager/services/meter.rb', line 678

def add_meter_identifier_value(meter_id, additional_identifier)
  request(Net::HTTP::Post, path_for("meter", meter_id, "identifier"), {}, {}, additional_identifier, "additionalIdentifier", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#delete_meter_identifier_value(meter_id, identifier_id) ⇒ PortfolioManager::Xml::ResponseType

Delete Meter Identifier Value

This web service deletes the meter identifier value for a specific meter and meter identifier.

Parameters:

  • meter_id (Integer)
  • identifier_id (Integer)

Returns:

Raises:

See Also:



693
694
695
 
# File 'lib/portfolio_manager/services/meter.rb', line 693

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

#edit_meter_identifier_value(meter_id, identifier_id, additional_identifier) ⇒ PortfolioManager::Xml::ResponseType

Edit Meter Identifier Value

This web service updates the meter identifier value for a specific meter based on the information provided in the XML request.

Parameters:

Returns:

Raises:

See Also:



709
710
711
 
# File 'lib/portfolio_manager/services/meter.rb', line 709

def edit_meter_identifier_value(meter_id, identifier_id, additional_identifier)
  request(Net::HTTP::Put, path_for("meter", meter_id, "identifier", identifier_id), {}, {}, additional_identifier, "additionalIdentifier", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_all_meter_identifier_list(property_id) ⇒ PortfolioManager::Xml::ResponseType

Get All Meter Identifier List

This web service retrieves a list of all of the unique identifiers for all meters in a specified property. These identifiers are used to provide additional information on a meter. You must have at least read only access on the meter to view the unique identifiers.

Parameters:

  • property_id (Integer)

Returns:

Raises:

See Also:



725
726
727
 
# File 'lib/portfolio_manager/services/meter.rb', line 725

def get_all_meter_identifier_list(property_id)
  request(Net::HTTP::Get, path_for("property", property_id, "meter", "identifier", "list"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_meter_identifier_list ⇒ PortfolioManager::Xml::AdditionalIdentifierTypes, PortfolioManager::Xml::ResponseType

Get Meter Identifier List

This web service retrieves a list of all of the standard and unique identifiers that are currently approved for use by EPA. These identifiers are used to provide additional information on a meter.

Returns:

Raises:

See Also:



739
740
741
 
# File 'lib/portfolio_manager/services/meter.rb', line 739

def get_meter_identifier_list
  request(Net::HTTP::Get, path_for("meter", "identifier", "list"), {}, {}, nil, nil, PortfolioManager::Xml::AdditionalIdentifierTypes, basic_auth: true)
end

#get_meter_identifier_value(meter_id, identifier_id) ⇒ PortfolioManager::Xml::AdditionalIdentifier, PortfolioManager::Xml::ResponseType

Get Meter Identifier Value

This web service retrieves the meter identifier value for a specific meter and meter identifier.

Parameters:

  • meter_id (Integer)
  • identifier_id (Integer)

Returns:

Raises:

See Also:



754
755
756
 
# File 'lib/portfolio_manager/services/meter.rb', line 754

def get_meter_identifier_value(meter_id, identifier_id)
  request(Net::HTTP::Get, path_for("meter", meter_id, "identifier", identifier_id), {}, {}, nil, nil, PortfolioManager::Xml::AdditionalIdentifier, basic_auth: true)
end

#get_meter_identifier_value_list(meter_id) ⇒ PortfolioManager::Xml::AdditionalIdentifiers, PortfolioManager::Xml::ResponseType

Get Meter Identifier Value List

This web service retrieves a list of meter identifier values for a specific meter specified in the URL.

Parameters:

  • meter_id (Integer)

Returns:

Raises:

See Also:



768
769
770
 
# File 'lib/portfolio_manager/services/meter.rb', line 768

def get_meter_identifier_value_list(meter_id)
  request(Net::HTTP::Get, path_for("meter", meter_id, "identifier", "list"), {}, {}, nil, nil, PortfolioManager::Xml::AdditionalIdentifiers, basic_auth: true)
end