class SessionWs extends SoapClient (View source)

FinanzOnline session webservice.

This service is used to login and get a session id which is needed for other webservices.

Requirements for this service:

  • A registration for FinanzOnline
  • A user for the web service, which can be created in the user administration of FinanzOnline

Error codes

  • 0 = All fine :)
  • -1 = The session ID is invalid or expired.
  • -2 = The web service is currently not available due to maintenance work.
  • -3 = A technical error has occurred.
  • -4 = The access codes are not valid.
  • -5 = The user is locked because of several incorrect login attempts.
  • -6 = The user is locked.
  • -7 = The user is not a web service user.
  • -8 = The participant is locked for FinanzOnline or not authorized to use the web service

Constants

WSDL

Online WSDL url

WSDL_LOCAL

Local WSDL file

Methods

void
__construct(FonCredential $credential, array $soapOptions = [])

Constructor.

__destruct()

Just be sure to get logged of on class destruction.

login()

Login at session web service.

logout()

Logout from the session web service.

bool
isLoggedIn()

Check if a session is set, otherwise user can't be logged in.

string
getID()

Get the web service session id.

getCredential()

Get the credential object used by this session.

Details

void __construct(FonCredential $credential, array $soapOptions = [])

Constructor.

Initialize soap client with local wsdl if available. Otherwise we will take the online wsdl.

Parameters

FonCredential $credential

credential class used to set some soap params for login/logout

array $soapOptions

https://www.php.net/manual/en/soapclient.soapclient.php options

Return Value

void array

__destruct()

Just be sure to get logged of on class destruction.

SessionWs login()

Login at session web service.

Return Value

SessionWs

Exceptions

Exception
Exception

SessionWs logout()

Logout from the session web service.

Return Value

SessionWs

Exceptions

Exception
Exception

bool isLoggedIn()

Check if a session is set, otherwise user can't be logged in.

Return Value

bool

string getID()

Get the web service session id.

Return Value

string

FonCredential getCredential()

Get the credential object used by this session.

Return Value

FonCredential

The credential object