Module: PortfolioManager::Services::Property::InternationalWeatherStation::Live

Included in:

All::Live

Defined in:

lib/portfolio_manager/services/property.rb

Overview

Live Environment

Instance Method Summary

• #edit_property_international_weather_station(property_id, international_weather_station_id) ⇒ PortfolioManager::Xml::ResponseType

  Edit Property International Weather Station.

• #get_international_weather_station_list(page = 1, country = nil) ⇒ PortfolioManager::Xml::InternationalWeatherStationList, PortfolioManager::Xml::ResponseType

  Get International Weather Station List.

Instance Method Details

#edit_property_international_weather_station(property_id, international_weather_station_id) ⇒ PortfolioManager::Xml::ResponseType

Edit Property International Weather Station

This web service sets a specified international weather station for a given property. The property cannot be located in the US or CA to set an international weather station. US and CA weather stations are assigned automatically based on the entered postal code. You must have read/write access to set the international weather station.

Parameters:

• property_id (Integer)
• international_weather_station_id (Integer)

Returns:

• (PortfolioManager::Xml::ResponseType)

Raises:

• (PortfolioManager::HTTPBasicCredentialsNotFoundError)
• (PortfolioManager::HTTPResponseError)

See Also:

• https://portfoliomanager.energystar.gov/webservices/home/api/property/internationalWeatherStation/put

# File 'lib/portfolio_manager/services/property.rb', line 453

def edit_property_international_weather_station(property_id, international_weather_station_id)
  request(Net::HTTP::Put, path_for("property", property_id, "internationalWeatherStation", international_weather_station_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_international_weather_station_list(page = 1, country = nil) ⇒ PortfolioManager::Xml::InternationalWeatherStationList, PortfolioManager::Xml::ResponseType

Get International Weather Station List

This web service returns a list of international weather stations for a specified country code. The country code follows the International Organization for Standardization (ISO 3166).

Parameters:

• page (Integer) (defaults to: 1)
• country (nil, String) (defaults to: nil)

Returns:

• (PortfolioManager::Xml::InternationalWeatherStationList, PortfolioManager::Xml::ResponseType)

Raises:

• (PortfolioManager::HTTPBasicCredentialsNotFoundError)
• (PortfolioManager::HTTPResponseError)

See Also:

• https://portfoliomanager.energystar.gov/webservices/home/api/property/internationalWeatherStationList/get

# File 'lib/portfolio_manager/services/property.rb', line 469

def get_international_weather_station_list(page = 1, country = nil)
  request(Net::HTTP::Get, path_for("property", "internationalWeatherStation", "list"), {
    "page" => page,
    "country" => country,
  }, {}, nil, nil, PortfolioManager::Xml::InternationalWeatherStationList, basic_auth: true)
end