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

Package DE_EPAGES::ShopConfiguration::API::WebService::FeaturePackService

provides web service for feature packs

Functions

addShopType
applyToAllShops
applyToShop
create
delete
exists
getInfo
removeFromShop
removeShopType
update

addShopType

WebService-Method: addShopType Adds shop types to the list of shop types the feature pack is available for.

Syntax
$SoapData = $self->addShopType($aFeaturePacks);
Input
$aFeaturePacks (ref.array.hash)
list of FeaturePacks
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
status of all given FeaturePacks

applyToAllShops

WebService-Method: applyToAllShops Change feature values of a featurepack and apply these changes to all shops the featurepack has been applied to.

Syntax
$SoapData = $self->applyToAllShops($aFeaturePacks);
Input
$aFeaturePacks (ref.array.hash)
list of FeaturePacks
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
status of all given FeaturePacks

applyToShop

WebService-Method: applyToShop Applies a feature packs to shops.

Syntax
$SoapData = $self->applyToShop($aFeaturePacks);
Input
$aFeaturePacks (ref.array.hash)
list of shop - feature pack assignments
  • Path - object path of the feature pack (e.g. FeaturePacks/MyPack)
  • ShopRef - object path of the ShopRef (e.g. ShopRefs/MyShop)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
status of all given FeaturePacks

create

WebService-Method: create Creates a list of feature packs.

Syntax
$SoapData = $self->create( $aFeaturePacks )
Input
$aFeaturePacks (ref.array.hash)
list of feature pack info (data to create)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given feature packs

delete

WebService-Method: delete Deletes a list of FeaturePacks.

Syntax
$SoapData = $self->delete( $aFeaturePacks )
Input
$aFeaturePacks (ref.array.string)
list of FeaturePack pathes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given FeaturePacks

exists

WebService-Method: exists Returns exists status of a list of FeaturePacks.

Syntax
$SoapData = $self->exists( $aFeaturePacks )
Input
$aFeaturePacks (ref.array.string)
list of FeaturePack pathes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given FeaturePacks

getInfo

WebService-Method: getInfo Returns information about a list of FeaturePacks.

Syntax
$SoapData = $self->getInfo( $aFeaturePacks, $aAttributes, $aLanguages )
Input
$aFeaturePacks (ref.array.string)
list of FeaturePack pathes
$aAttributes (ref.array.string)
list of attribute aliases
$aLanguageCodes (ref.array.string)
list of language codes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
info of all given FeaturePacks

removeFromShop

WebService-Method: removeFromShop Remove a feature pack from a shop.

Syntax
$SoapData = $self->removeFromShop($aFeaturePacks);
Input
$aFeaturePacks (ref.array.hash)
list of FeaturePacks
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
status of all given FeaturePacks

removeShopType

WebService-Method: removeShopType Removes shop types to the list of shop types the feature pack is available for.

Syntax
$SoapData = $self->removeShopType($aFeaturePacks);
Input
$aFeaturePacks (ref.array.hash)
list of FeaturePacks
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
status of all given FeaturePacks

update

WebService-Method: update Updates a list of FeaturePacks.

Syntax
$SoapData = $self->update( $aFeaturePacks )
Input
$aFeaturePacks (ref.array.string)
list of FeaturePack info (FeaturePack path and
data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status of all given FeaturePacks