Managing the Session

The following methods control a Web Service session.

Starting a Session

NOTE: We recommend using the Authenticating REST service for this method instead. REST services are more advanced and are the preferred choice over SOAP.

The authenticate method authenticates a user. Once authenticated, the client will receive a session identifier. This identifier will be required as proof of authentication for future requests.

Request Type: authenticate

Element	Type	Description
FFWSHeader Mandatory	FFWSHeader	The header information. See FFWSHeader Type (see FFWSHeader Type ).
username Mandatory	String	The client’s username.
password Mandatory	String	The client’s password in cleartext.

Response Type: authenticateResponse

Element	Type	Description
result Mandatory	Integer	Authentication result. A value of 1 indicates success.
sessionId Mandatory	String	Session identifier.
faSessionId Optional	String	AFA session identifier.
phpSessionId Optional	String	PHP session identifier.
faToken Optional	String	AFA token.

Verifying a Session is Active

NOTE: We recommend using the Check if session is alive REST service for this method instead. REST services are more advanced and are the preferred choice over SOAP.

The isSessionAlive method verifies that the current session is alive.

Request Type: isSessionAlive

Element	Type	Description
FFWSHeader Mandatory	FFWSHeader	The header information. See FFWSHeader Type (see FFWSHeader Type ).
sessionId Mandatory	String	The client’s session identifier.