ePages 6.10 - DE_EPAGES/ShopConfiguration/API/WebService/ShopCountService.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::ShopCountService

Provides web service access for counting shops by shop type, database and shop status flags.

Example
use DE_EPAGES::WebService::API::Client;
my $ShopCountService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/ShopCountService/2006/08')
    ->proxy("http://localhost:80/epages/Site.soap");
$ShopCountService->userinfo( "/Providers/$ProviderAlias/Users/$Login:$Password" );
print $ShopCountService->getCount({
    ShopType => 'Demo'
})->result;

Functions

getAllCounts
getCount

getAllCounts

Returns the number of shops of a provider from all databases. Deleted shops and internal test shops are not included.

Syntax
$ahCounters = $ShopCountService->getAllCounts()->result;
Return
$ahCounters (ref.array.hash)
list of shop counters. Each list element is a hsh with
following keys:
  • Database - database alias - string
  • ShopType - shop type alias - string
  • Trial_Closed - shop count (IsTrialShop && IsClosed && !IsPreCreated) - integer
  • Trial_NotClosed - shop count (IsTrialShop && !IsClosed && !IsPreCreated) - integer
  • NotTrial_Closed - shop count (!IsTrialShop && IsClosed && !IsPreCreated) - integer
  • NotTrial_NotClosed - shop count (!IsTrialShop && !IsClosed && !IsPreCreated) - integer
  • PreCreated - shop count (IsPreCreated) - integer

getCount

Returns the number of shops of a provider, filtered by shop type, database and flags.

Syntax
$Count = $ShopCountService->getCount({
    ShopType => $ShopType,
    Database => $Database,
    IsClosed => $IsClosed,
    IsDeleted => $IsDeleted,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    IsPreCreated => $IsPreCreated,
})->result;
Input
$ShopType (string)
shop type alias
$Database (string)
database identifier (store alias)
$IsClosed (integer)
0 - do not count closed shops; 1 - count only closed shops; else - count both (optional)
$IsDeleted (integer)
0 - do not count deleted shops; 1 - count only deleted shops; 2 - count both (optional)
$IsTrialShop (integer)
0 - do not count shops in trial period; 1 - count only shops in trial period; else - count both (optional)
$IsInternalTestShop (integer)
0 - do not count internal test shops; 1 - count only internal test shops; else - count both (optional)
$IsPreCreated (integer)
0 - do not count pre-created shops; 1 - count only pre-created shops; 2 - count both (optional)
Return
$Count (integer)
number of matching shops