SessionWs

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
 

Methods summary

Method Return Description
__construct void Constructor.
__destruct Just be sure to get logged of on class destruction.
login self Login at session web service.
logout self Logout from the session web service.
isLoggedIn bool Check if a session is set, otherwise user can't be logged in.
getID string Get the web service session id.
getCredential FonCredential Undocumented function.

Details

public function __construct(FonCredential $credential, array<string,mixed> $soapOptions=[]): void

Constructor.

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

Parameters

Parameter Type Default Description
$credential FonCredential credential class used to set some soap params for login/logout
$soapOptions array [] https://www.php.net/manual/en/soapclient.soapclient.php options

Return value

void array
 
public function __destruct():

Just be sure to get logged of on class destruction.

 
public function login(): self

Login at session web service.

Return value

self
 
public function logout(): self

Logout from the session web service.

Return value

self
 
public function isLoggedIn(): bool

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

Return value

bool
 
public function getID(): string

Get the web service session id.

Return value

string
 
public function getCredential(): FonCredential

Undocumented function.

Return value

FonCredential
 
On this page
 
Generated by Dog, a slim source code documentation generator. Printed with Dog-HtmlPrinter.
PHP Fon Webservices

SessionWs

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
 

Methods summary

Method Return Description
__construct void Constructor.
__destruct Just be sure to get logged of on class destruction.
login self Login at session web service.
logout self Logout from the session web service.
isLoggedIn bool Check if a session is set, otherwise user can't be logged in.
getID string Get the web service session id.
getCredential FonCredential Undocumented function.

Details

public function __construct(FonCredential $credential, array<string,mixed> $soapOptions=[]): void

Constructor.

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

Parameters

Parameter Type Default Description
$credential FonCredential credential class used to set some soap params for login/logout
$soapOptions array [] https://www.php.net/manual/en/soapclient.soapclient.php options

Return value

void array
 
public function __destruct():

Just be sure to get logged of on class destruction.

 
public function login(): self

Login at session web service.

Return value

self
 
public function logout(): self

Logout from the session web service.

Return value

self
 
public function isLoggedIn(): bool

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

Return value

bool
 
public function getID(): string

Get the web service session id.

Return value

string
 
public function getCredential(): FonCredential

Undocumented function.

Return value

FonCredential
 
On this page
 
Generated by Dog, a slim source code documentation generator. Printed with Dog-HtmlPrinter.