Module: PortfolioManager::Services::Property::Miscellaneous::Live

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

Overview

Live Environment

Instance Method Summary collapse

Instance Method Details

#add_energy_performance_project(property_id, energy_performance_project) ⇒ PortfolioManager::Xml::ResponseType

Add Energy Performance Project

This web service creates an energy performance project for a specific property based on the information provided in the XML request. The corresponding property must already be shared with you. The service returns the unique identifier to the newly created energy performance project and a link to the corresponding web service to retrieve it.



802
803
804
# File 'lib/portfolio_manager/services/property.rb', line 802

def add_energy_performance_project(property_id, energy_performance_project)
  request(Net::HTTP::Post, path_for("property", property_id, "energyPerformanceProject"), {}, {}, energy_performance_project, "energyPerformanceProject", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#delete_energy_performance_project(energy_performance_project_id) ⇒ PortfolioManager::Xml::ResponseType

Delete Energy Performance Project

This web service deletes a specified energy project project. The corresponding property must already be shared to you.



816
817
818
# File 'lib/portfolio_manager/services/property.rb', line 816

def delete_energy_performance_project(energy_performance_project_id)
  request(Net::HTTP::Delete, path_for("energyPerformanceProject", energy_performance_project_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_billboard_setting_at_property_level_for_account(property_id, billboard_metric_setting) ⇒ PortfolioManager::Xml::ResponseType

Edit Billboard Setting at Property Level for Account

This web service sets a desired “billboard” metric for the authenticated user’s account and a specified property. After set, the front-end application will display the chosen metric in the billboard. The billboard is shown in the upper-right section of each property. You must have at least READ access to the property. Individual property level settings will be cleared if account level billboard setting changes are made.

For more information on account level billboard metric settings, see the PUT /account/(accountId) and PUT /customer/(customerId) documentation sections.



841
842
843
# File 'lib/portfolio_manager/services/property.rb', line 841

def (property_id, billboard_metric_setting)
  request(Net::HTTP::Put, path_for("property", property_id, "billboardMetricSetting"), {}, {}, billboard_metric_setting, "billboardMetricSetting", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_billboard_setting_at_property_level_for_customer(customer_id, property_id, billboard_metric_setting) ⇒ PortfolioManager::Xml::ResponseType

Edit Billboard Setting at Property Level for Customer

This web service sets a desired “billboard” metric for a specified account and property combination. After set, the specified front-end customer user will see the selected metric shown in the billboard. The billboard is displayed in the upper-right section of each property. The customer’s property must be shared with you with at least READ_WRITE permissions. Individual property level settings will be cleared if account level billboard setting changes are made.

For more information on account level billboard metric settings, see the PUT /account/(accountId) and PUT /customer/(customerId) documentation sections.



867
868
869
# File 'lib/portfolio_manager/services/property.rb', line 867

def edit_billboard_setting_at_property_level_for_customer(customer_id, property_id, billboard_metric_setting)
  request(Net::HTTP::Put, path_for("customer", customer_id, "property", property_id, "billboardMetricSetting"), {}, {}, billboard_metric_setting, "billboardMetricSetting", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_energy_performance_project(energy_performance_project_id, energy_performance_project) ⇒ PortfolioManager::Xml::ResponseType

Edit Energy Performance Project

This web service updates an energy performance project based on the information provided in the XML request. The corresponding property must already be shared with you. The service returns the unique identifier to the updated energy performance project and a link to the corresponding web service to retrieve it.



885
886
887
# File 'lib/portfolio_manager/services/property.rb', line 885

def edit_energy_performance_project(energy_performance_project_id, energy_performance_project)
  request(Net::HTTP::Put, path_for("energyPerformanceProject", energy_performance_project_id), {}, {}, energy_performance_project, "energyPerformanceProject", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_property_baseline_and_target(property_id, baseline_and_target) ⇒ PortfolioManager::Xml::ResponseType

Edit Property Baseline and Target

This web service updates the energy and water baseline dates and performance target settings for a specific property based on the information provided in the XML request. The corresponding property must already be shared with you. The service returns a link to the corresponding web service to retrieve the information.



903
904
905
# File 'lib/portfolio_manager/services/property.rb', line 903

def edit_property_baseline_and_target(property_id, baseline_and_target)
  request(Net::HTTP::Put, path_for("property", property_id, "baselineAndTarget"), {}, {}, baseline_and_target, "baselineAndTarget", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_billboard_metric_listPortfolioManager::Xml::BillboardMetricsType, PortfolioManager::Xml::ResponseType

Get Billboard Metric List

This web service returns a list of metrics that can be used for the “billboard” display. For more information on how to set the billboard display, see the “Account” and “Property” documentation sections.



918
919
920
# File 'lib/portfolio_manager/services/property.rb', line 918

def get_billboard_metric_list
  request(Net::HTTP::Get, path_for("billboardMetric", "list"), {}, {}, nil, nil, PortfolioManager::Xml::BillboardMetricsType, basic_auth: true)
end

#get_billboard_setting_at_property_level_for_account(property_id) ⇒ PortfolioManager::Xml::BillboardMetricSetting, PortfolioManager::Xml::ResponseType

Get Billboard Setting at Property Level for Account

This web service returns a desired “billboard” metric for the authenticated user’s account and a specified property. After set, the front-end application will display the chosen metric in the billboard for the authenticated user. The billboard is shown in the upper-right section of each property. You must have at least READ access to the property to view the billboard setting.



936
937
938
# File 'lib/portfolio_manager/services/property.rb', line 936

def (property_id)
  request(Net::HTTP::Get, path_for("property", property_id, "billboardMetricSetting"), {}, {}, nil, nil, PortfolioManager::Xml::BillboardMetricSetting, basic_auth: true)
end

#get_billboard_setting_at_property_level_for_customer(customer_id, property_id) ⇒ PortfolioManager::Xml::BillboardMetricSetting, PortfolioManager::Xml::ResponseType

Get Billboard Setting at Property Level for Customer

This web service returns the set “billboard” metric for a specified account and property combination. The billboard is displayed in the upper-right section of each property. You must be connected with the customer and must have at least READ permission on the property to view the customer’s billboard metric setting.



954
955
956
# File 'lib/portfolio_manager/services/property.rb', line 954

def get_billboard_setting_at_property_level_for_customer(customer_id, property_id)
  request(Net::HTTP::Get, path_for("customer", customer_id, "property", property_id, "billboardMetricSetting"), {}, {}, nil, nil, PortfolioManager::Xml::BillboardMetricSetting, basic_auth: true)
end

#get_egrid_subregion_listPortfolioManager::Xml::EGridSubregionList, PortfolioManager::Xml::ResponseType

Get eGrid Subregion List

This web service retrieves a list of all of the eGrid subregions that a federal property can be associated to.



967
968
969
# File 'lib/portfolio_manager/services/property.rb', line 967

def get_egrid_subregion_list
  request(Net::HTTP::Get, path_for("property", "eGridSubregion", "list"), {}, {}, nil, nil, PortfolioManager::Xml::EGridSubregionList, basic_auth: true)
end

#get_energy_performance_project(energy_performance_project_id) ⇒ PortfolioManager::Xml::EnergyPerformanceProjectType, PortfolioManager::Xml::ResponseType

Get Energy Performance Project

This web service returns information for a specific energy performance project. The corresponding property must already be shared to you. The information returned to you does not include any energy performance indicators. To retrieve energy performance indicators, you can call the Get-Metrics web service for the applicable metrics and evaluation periods.



985
986
987
# File 'lib/portfolio_manager/services/property.rb', line 985

def get_energy_performance_project(energy_performance_project_id)
  request(Net::HTTP::Get, path_for("energyPerformanceProject", energy_performance_project_id), {}, {}, nil, nil, PortfolioManager::Xml::EnergyPerformanceProjectType, basic_auth: true)
end

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

Get Energy Performance Project List

This web service retrieves a list of all the energy performance projects for a specific property. The property must already be shared to you.



1000
1001
1002
# File 'lib/portfolio_manager/services/property.rb', line 1000

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

#get_federal_agency_listPortfolioManager::Xml::FederalAgencies, PortfolioManager::Xml::ResponseType

Get Federal Agency List

This web service retrieves a list of all of the federal agencies that a federal property can be associated to.



1013
1014
1015
# File 'lib/portfolio_manager/services/property.rb', line 1013

def get_federal_agency_list
  request(Net::HTTP::Get, path_for("property", "federalAgency", "list"), {}, {}, nil, nil, PortfolioManager::Xml::FederalAgencies, basic_auth: true)
end

#get_property_baseline_and_target(property_id) ⇒ PortfolioManager::Xml::BaselineAndTargetType, PortfolioManager::Xml::ResponseType

Get Property Baseline and Target

This web service retrieves the energy and water baseline dates and the performance target settings for a specific property.



1027
1028
1029
# File 'lib/portfolio_manager/services/property.rb', line 1027

def get_property_baseline_and_target(property_id)
  request(Net::HTTP::Get, path_for("property", property_id, "baselineAndTarget"), {}, {}, nil, nil, PortfolioManager::Xml::BaselineAndTargetType, basic_auth: true)
end

#get_property_custom_field_values(property_id) ⇒ PortfolioManager::Xml::CustomFieldList, PortfolioManager::Xml::ResponseType

Get Property Custom Field Values

This web service returns a list of custom fields and their values for a specific property.



1041
1042
1043
# File 'lib/portfolio_manager/services/property.rb', line 1041

def get_property_custom_field_values(property_id)
  request(Net::HTTP::Get, path_for("property", property_id, "customFieldList"), {}, {}, nil, nil, PortfolioManager::Xml::CustomFieldList, basic_auth: true)
end