ePages 6.11.0 - DE_EPAGES/ThirdPartyConfig/API/WebService/ThirdPartyConfigService.pm

Package DE_EPAGES::ThirdPartyConfig::API::WebService::ThirdPartyConfigService

Example
use DE_EPAGES::WebService::API::Client;
my $ConfigService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/ThirdPartyConfigService/2009/11')
    ->proxy("http://localhost:80/epages/Store.soap");
$ConfigService->userinfo("/Users/wsadmin:wsadmin");
$ConfigService->setConfigAttributes(...);

Functions

getConfigAttributes
new
setConfigAttributes

getConfigAttributes

Get all attributes to be configured in PBO for the given attributes category. The attributes' names and descriptions will be returned in the specified language. If no name is set, the alias will be returned; if no description is set, the English description is used.

Syntax
my $ahAttributes = $ConfigService->getConfigAttributes({
    'AttributesCategory' => 'Payment',
    'LanguageCode'       => 'en'
})->result;
Input
$hOptions (ref.hash)
hash with following keys:
  • AttributesCategory - one of the constants in <module DE_EPAGES::ThirdPartyConfig::API::Constants> - string
  • LanguageCode - Code2 or Code3 of the language to return the attribute names and descriptions for - string

Return
$ahAttributes (ref.array.hash)
list of attribute sections with following keys:
  • SectionID - id of the attribute section (similat to an alias) - string
  • SectionName - name of the section in the specified language - string
  • Attributes - list of hash references with the attributes - ref.array.hash
    hash keys are:
    • Alias - attribute alias - string
    • Type - attribute type - string
    • ObjectID - id of the object the attribute can be set for - int
    • Name - attribute name in the specified language - string
    • Description - attribute description in the specified language - string
    • Value - current attribute value - string (ref.array.hash for LocalizedString attributes)
    • ObjectName - name of the object (optional) - boolean


new

Creates a new web service object as a blessed hash reference and adds the values from the %Options hash.

Syntax
$Service = DE_EPAGES::ThirdPartyConfig::API::WebService::ThirdPartyConfigService->new( %Options );
Input
%Options (hash)
user-defined values
Return
$Service (object)
web service object

setConfigAttributes

set the configured attributes

Syntax
$ConfigService->setConfigAttributes({
    'AttributesCategory' => 'Payment',
    'Attributes'         => $ahAttributes
});
Input
$hOptions (ref.hash)
hash with following keys:
  • AttributesCategory - one of the constants in <module DE_EPAGES::ThirdPartyConfig::API::Constants> - string
  • Attributes - attributes to set - ref.array.hash
    hash keys are:
    • Alias - attribute alias - string
    • Type - attribute type - string
    • ObjectID - id of the object the attribute will be set for - int
    • Value - attribute value to set - string (ref.array.hash for LocalizedString attributes)