ePages 6.11.0 - DE_EPAGES/WebService/API/WebService/BaseAsyncService.pm

Package DE_EPAGES::WebService::API::WebService::BaseAsyncService

Base class for web services with asynchron events.

Functions

deleteSession
getSessionStatus
newSession

deleteSession

deletes the current web service session this method need to call by client after an error or session ended returns a constant soap structure Session.deleted or soap error

Syntax
my $Deleted = $service->deleteSession( $SessionID );
Return
$Deleted (SOAP::Data)
on success returns a SOAP::Data structure for the XML
"<Session>deleted</Session>"
so a client can check if the session is deleted

getSessionStatus

returns soap structure with current session status the status code of a web service session could be: status code <0 should be used for errors status code 0 is used if method finished status code 1 is used if session started status codes >1 should be used for method progress and should be increased

Syntax
my $Status = $service->getSessionStatus( $SessionID );
Input
$SessionID (string)
web service session ID
Return
$Status (SOAP::Data)
SOAP::Data structure with session status
<Session>
<SessionID></SessionID>
<Status></SessionID>
<StatusMessage></StatusMessage>
</Session>

newSession

creates a new web service session and link it to the current soap server

Syntax
my $WSession = $self->newSession();
Return
$WSession (object)
new web service session object