ePages 6.10 - DE_EPAGES/FactFinder/API/Object/RemoteFactFinder.pm

Package DE_EPAGES::FactFinder::API::WS::Client

This represents the client part of the functions communicating with with FactFinder WebServices.

Package DE_EPAGES::FactFinder::API::Object::RemoteFactFinder

Functions

createChannel
createUser
deleteChannel
deleteUser
getAllChannels
getAllUsers
suggest
updateUser
uploadProducts

createChannel

Syntax
$Object->createChannel( $Channel );
Input
$Channel (string)
channel name

createUser

creates FACT-Finder user via SOAP

Syntax
$Object->createUser( $Username, $PasswordMD5);
Input
$Username (string)
username
$PasswordMD5 (string)
password | md5-encrypted password

deleteChannel

Removes a FACT-Finder channel

Syntax
$Object->deleteChannel( $Channel, $Input2);
Input
$Channel (string)
channelname

deleteUser

deletes FACT-Finder user

Syntax
deleteUser( $Username );
Input
$Username (string)
user name

getAllChannels

Retrieves Channel list

Syntax
getAllChannels( $Input1 );
Return
$Channels (ref.hash)
channel list

getAllUsers

fetches FACT-Finder user list

Syntax
getAllUsers( );
Return
$Result (ref.hash)
parsed soap document

suggest

calls FACT-Finder suggest service

Syntax
$Object->suggest( $Channel, $Query, $Language);
Input
$Channel (string)
channel name
$Query (string)
query string
Return
$Response (string)
suggest response

updateUser

updates channel rights on user

Syntax
updateUser( $ChannelNames );
Input
$ChannelNames (ref.array)
list of channel names

uploadProducts

upload product export file to fact-finder

Syntax
$Object->uploadProducts( $Channel, $File);
Input
$Channel (string)
channel name
$FileURL (string)
file url