ePages 6.11.0 - DE_EPAGES/Product/API/WebService/ProductService.pm

Package DE_EPAGES::Product::API::WebService::ProductService

Implements the Product WebService.

Base
DE_EPAGES::Content::API::WebService::BaseContentService

Functions

create
delete
exists
find
getInfo
new
update

create

WebService-Method: create Creates a list of products.

Syntax
$SoapData = $self->create( $aProducts )
Input
$aProducts (ref.array.string)
list of product info (data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given products

delete

WebService-Method: delete Deletes a list of products.

Syntax
$SoapData = $self->delete( $aProducts )
Input
$aProducts (ref.array.string)
list of product paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given products

exists

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

Syntax
$SoapData = $self->exists( $aProducts )
Input
$aProducts (ref.array.string)
list of product paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given products

find

WebService-Method: find Find products by some search parameters.

Syntax
$SoapData = $self->find( $InSearchParameters )
Input
$InSearchParameters (ref.hash)
search arguments (all optional):
  • Text - text in product - string
  • LanguageCode - language for text search - string
  • Alias - product nr - string
  • Class - product class (path) - string
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with a list
of product paths

getInfo

WebService-Method: getInfo Returns information about a list of products (incl. address, assigned users, attributes).

Syntax
$SoapData = $self->getInfo( $aProducts, $aAttributes, $aLanguageCodes )
Input
$aProducts (ref.array.string)
list of product paths
$aAttributes (ref.array.string)
list of AttributeIDs
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
info of all given products

new

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

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

update

WebService-Method: update Updates a list of products.

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