Managing the Session

The following methods control a Web Service session.

Starting a Session

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
FFWSHeaderMandatory	FFWSHeader	The header information. See FFWSHeader Type (see FFWSHeader Type ).
usernameMandatory	String	The client’s username.
passwordMandatory	String	The client’s password in cleartext.

 

Response Type: authenticateResponse

Element	Type	Description
resultMandatory	Integer	Authentication result. A value of 1 indicates success.
sessionIdMandatory	String	Session identifier.
faSessionIdOptional	String	AFA session identifier.
phpSessionIdOptional	String	PHP session identifier.
faTokenOptional	String	AFA token.

Verifying a Session is Active

The isSessionAlive method verifies that the current session is alive.

Request Type: isSessionAlive

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

Response Type: isSessionAliveResponse

Element	Type	Description
resultMandatory	Integer	Method result. A value of 1 indicates the session is still active.