Module: PortfolioManager::Services::BasicAccount::AdvancedSettingsForOrganizationsExchangingData::Live

Included in:
PortfolioManager::Services::BasicAccount::All::Live
Defined in:
lib/portfolio_manager/services/basic_account.rb

Overview

Live Environment

Instance Method Summary collapse

Instance Method Details

#create_custom_field(custom_field) ⇒ PortfolioManager::Xml::ResponseType

Create Custom Field

This web service adds a custom field. This custom field is used by the data exchange web services during the connection/share process. Note that there is no validation performed on the specified display order.

Parameters:

Returns:

Raises:

See Also:



189
190
191
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 189

def create_custom_field(custom_field)
  request(Net::HTTP::Post, path_for("dataExchangeSettings", "customField"), {}, {}, custom_field, "customField", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#delete_custom_field(custom_field_id) ⇒ PortfolioManager::Xml::ResponseType

Delete Custom Field

This web service deletes a custom field and all data stored associated with it.

Parameters:

  • custom_field_id (Integer)

Returns:

Raises:

See Also:



203
204
205
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 203

def delete_custom_field(custom_field_id)
  request(Net::HTTP::Delete, path_for("dataExchangeSettings", "customField", custom_field_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_custom_field(custom_field_id, custom_field) ⇒ PortfolioManager::Xml::ResponseType

Edit Custom Field

This web service updates a specified custom field. This custom field is used by the data exchange web services during the connection/share process.

Parameters:

Returns:

Raises:

See Also:



219
220
221
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 219

def edit_custom_field(custom_field_id, custom_field)
  request(Net::HTTP::Put, path_for("dataExchangeSettings", "customField", custom_field_id), {}, {}, custom_field, "customField", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#edit_data_exchange_settings(data_exchange_settings) ⇒ PortfolioManager::Xml::ResponseType

Edit Data Exchange Settings

This web service updates the various settings that describes your data exchange service offerings such as terms and conditions, supported fuel types, etc.

Parameters:

Returns:

Raises:

See Also:



234
235
236
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 234

def edit_data_exchange_settings(data_exchange_settings)
  request(Net::HTTP::Put, path_for("dataExchangeSettings"), {}, {}, data_exchange_settings, "dataExchangeSettings", PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_custom_field(custom_field_id) ⇒ PortfolioManager::Xml::CustomField, PortfolioManager::Xml::ResponseType

Get Custom Field

This web service returns information for a specific custom field.

Parameters:

  • custom_field_id (Integer)

Returns:

Raises:

See Also:



247
248
249
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 247

def get_custom_field(custom_field_id)
  request(Net::HTTP::Get, path_for("dataExchangeSettings", "customField", custom_field_id), {}, {}, nil, nil, PortfolioManager::Xml::CustomField, basic_auth: true)
end

#get_custom_field_list ⇒ PortfolioManager::Xml::ResponseType

Get Custom Field List

This web service returns a list of custom fields that are used by your account. These custom fields allow you to gather more data from your customers as they send connection and share requests to you.

Returns:

Raises:

See Also:



261
262
263
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 261

def get_custom_field_list
  request(Net::HTTP::Get, path_for("dataExchangeSettings", "customField", "list"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
end

#get_data_exchange_settings ⇒ PortfolioManager::Xml::DataExchangeSettings, PortfolioManager::Xml::ResponseType

Get Data Exchange Settings

This web service retrieves the various settings that describes your data exchange service offerings such as terms and conditions, supported fuel types, etc.

Returns:

Raises:

See Also:



275
276
277
 
# File 'lib/portfolio_manager/services/basic_account.rb', line 275

def get_data_exchange_settings
  request(Net::HTTP::Get, path_for("dataExchangeSettings"), {}, {}, nil, nil, PortfolioManager::Xml::DataExchangeSettings, basic_auth: true)
end