Module: PortfolioManager::Services::PropertyUse::CustomPropertyUseAndUseDetails::Live

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

Overview

Live Environment

Instance Method Summary collapse

Instance Method Details

#delete_custom_use_detail(details_id) ⇒ PortfolioManager::Xml::ResponseType

Delete Custom Use Detail

This web service deletes a specific custom use detail. The corresponding property must already be shared to you.

Parameters:

  • details_id (Integer)

Returns:

Raises:

See Also:



400
401
402
 
# File 'lib/portfolio_manager/services/property_use.rb', line 400

def delete_custom_use_detail(details_id)
  request(Net::HTTP::Delete, path_for("customUse", "details", detail_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_custom_use_detail_revision(property_id, custom_use_details, elename = nil) ⇒ PortfolioManager::Xml::ResponseType

Edit Custom Use Detail - Revision

This web service updates a specific custom use detail based on the information provided in the XML request. The update is performed by creating a revision history. It returns the unique identifier to the custom use detail and a link to the corresponding web service to retrieve it. The corresponding property must already be shared to you.

A maximum of 2 custom use details can be created for a property. To learn more, please reference this FAQ.

Parameters:

Returns:

Raises:

See Also:



352
353
354
 
# File 'lib/portfolio_manager/services/property_use.rb', line 352

def edit_custom_use_detail_revision(property_id, custom_use_details, elename = nil)
  request(Net::HTTP::Post, path_for("customUse", property_id, "details"), {}, {}, custom_use_details, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_custom_use_details_correction(details_id, custom_use_details, elename = nil) ⇒ PortfolioManager::Xml::ResponseType

Edit Custom Use Details - Correction

This web service updates a specific custom use detail based on the information provided in the XML request. The update is performed as a correction. It returns the unique identifier to the custom use detail and a link to the corresponding web service to retrieve it. The corresponding property must already be shared to you.

Parameters:

Returns:

Raises:

See Also:



386
387
388
 
# File 'lib/portfolio_manager/services/property_use.rb', line 386

def edit_custom_use_details_correction(details_id, custom_use_details, elename = nil)
  request(Net::HTTP::Put, path_for("customUse", "details", details_id), {}, {}, custom_use_details, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_custom_property_use(property_id) ⇒ PortfolioManager::Xml::CustomUseType, PortfolioManager::Xml::ResponseType

Get Custom Property Use

This web service returns the custom use detail information for a given property. If at least one custom use detail has not been defined then a 404 is returned. To create a new custom use detail, please see. The information includes general data about the custom property use itself and its most current custom characteristics information. The corresponding property must already be shared to you.

Parameters:

  • property_id (Integer)

Returns:

Raises:

See Also:



309
310
311
 
# File 'lib/portfolio_manager/services/property_use.rb', line 309

def get_custom_property_use(property_id)
  request(Net::HTTP::Get, path_for("customUse", property_id), {}, {}, nil, nil, PortfolioManager::Xml::CustomUseType, basic_auth: true)
end

#get_custom_use_detail(details_id) ⇒ PortfolioManager::Xml::CustomUseDetailsType, PortfolioManager::Xml::ResponseType

Get Custom Use Detail

This web service retrieves specific use detail information for a given custom use detail. The corresponding property must already be shared with you.

Parameters:

  • details_id (Integer)

Returns:

Raises:

See Also:



367
368
369
 
# File 'lib/portfolio_manager/services/property_use.rb', line 367

def get_custom_use_detail(details_id)
  request(Net::HTTP::Get, path_for("customUse", "details", details_id), {}, {}, nil, nil, PortfolioManager::Xml::CustomUseDetailsType, basic_auth: true)
end

#get_custom_use_details_revision_history(property_id, current_as_of_start, current_as_of_end) ⇒ PortfolioManager::Xml::UseDetails, PortfolioManager::Xml::ResponseType

Get Custom Use Details Revision History

This web service retrieves the custom use details revision history for a specific property. The corresponding property must be already shared to you.

Parameters:

  • property_id (Integer)
  • current_as_of_start (Date)
  • current_as_of_end (Date)

Returns:

Raises:

See Also:



326
327
328
329
330
331
 
# File 'lib/portfolio_manager/services/property_use.rb', line 326

def get_custom_use_details_revision_history(property_id, current_as_of_start, current_as_of_end)
  request(Net::HTTP::Get, path_for("customUse", property_id, "detailRevisions"), {
    "currentAsOfStart" => current_as_of_start.strftime("%Y-%m-%d"),
    "currentAsOfEnd" => current_as_of_end.strftime("%Y-%m-%d"),
  }, {}, nil, nil, PortfolioManager::Xml::UseDetails, basic_auth: true)
end