ePages 7.23.0 - DE_EPAGES/WebService/API/WebService.pm

Package DE_EPAGES::WebService::API::WebService

This package provides helper functions to access the web services.

@EXPORT_OK
LoadWebServiceByURI
TestWebserviceConnection
FormatSimpleArray
FormatString

Functions

FormatSimpleArray
FormatString
IsSimpleStringArray
LoadWebServiceByURI
TestWebserviceConnection

FormatSimpleArray

encodes utf8 simple array which has depth 1

Syntax
FormatSimpleArray($Value);
Input
$Value (any)
attribute value
Return
$Value (any)
encoded utf8 value

FormatString

encodes utf8 string

Syntax
FormatString($Value);
Input
$Value (any)
attribute value
Return
$Value (any)
encoded utf8 value

IsSimpleStringArray

checks if array contains just scalar values

Syntax
IsSimpleStringArray($aValue);
Input
$aElement (ref.array)
array element
Return
$Boolean (boolean)
array contains only primitve datatypes

LoadWebServiceByURI

Loads the web service by URI.

Syntax
$WebService = LoadWebServiceByURI( $URI );
Example
$WebService = LoadWebServiceByURI( 'urn://epages.de/WebService/Test/2004/08' );
Input
$URI (string)
web service URI
Return
$WebService (object)
web service

TestWebserviceConnection

Tests the web service connection from the currect Store to $TargetStoreName (used by script WebService/Scripts/testWebServices.pl)

Syntax
$success = TestWebserviceConnection( $TargetStoreName );
Example
if ( TestWebserviceConnection( 'Store' ) );
Input
$TargetStoreName (string)
the name of the store to connect to
Return
$success (boolean)
0 if failed, 1 if succeeded