|
|
APIServer.Session.Update
| 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). |
| RefreshRolesAndFolderList | Data | Input | Set this parameter to Yes (Y) if you want to update the roles
and the folder list for the session based on the updated values.
An example could this could be if you assign a user to the session - and set the parameter to yes, in this case you would get the roles and folder list based on the user settings. |
| 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. |
This API offers the developer the possibility to update a session.
The function starts by calling the Session.UpdateValidation API (for detailed information about the validation see the description of this API).
If the validation is successful, the *Returned status is set to *Successful and the session is updated with the values specified in the input.
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 will contain the number of errors written to ErrorArray.
If a user is already specified for the session, you are only allowed to call this API with the same user (you can't change the user for a session). Call the API with the identification of the existing user id you have either updated the roles of the user and want to make the same update to the session or if you have changed the roles for the session and want to reset the roles to the ones defined for the user.
Online documentation - WebsydianExpress v3.0