Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: Session.UpdateValidation

Scoped Name

APIServer.Session.UpdateValidation

Interface

Field Variable ...as Description
SessionSurrogate Data Input The unique identification of the session to update (mandatory).
SessionSiteKey Data Input The identification of the site (mandatory).
SessionUserSurrogate Data Input The unique identification of the user owning the session (optional).
IpAddress Data Input The IP address of the machine where the request originates (the machine running the browser) (optional).
SessionStatus Data Input The new status of the session (mandatory).

Valid values: Active (A), TimedOut (T), Ended (E).

NumberOfErrors Error Output The number of errors in ErrorArray.
ErrorMessage ErrorArray(20) Output A description of an error, which has occurred during either validation or update.

Description

This function performs the validation necessary to update a session.

If the validation is successful, the *Returned status is set to *Successful.

If the validation fails the *Returned status is set to a non-successful value and for each error an error message can be written in the ErrorArray output variable. The field NumberOfErrors is set to the number of errors written to ErrorArray.

The following rules are enforced by the validation:

SessionSurrogate

This field is mandatory and must specify a valid session to update. The session must be Active (SessionStatus set to Active).

SessionSiteKey

This field is mandatory and must specify an existing site.

SessionUserSurrogate

This field is optional. If the field is specified, it must specify an existing user for the site specified by the input field SessionSiteKey.

SessionStatus

The status the session is to be changed to. Valid values are "Active", "Ended", "TimedOut".

Events

Universal events