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

API: Session.CurrentSessionSetUserAndUpdate

Scoped Name

APIWebServer.Session.CurrentSessionSetUserAndUpdate

Interface

Field Variable ...as Description
UserSurrogate Input Input The unique identification of a user.

Description

This API updates the current session with the specified user, the roles and folder list is updated according to the settings for the user.

This also updates the timeout of the session according to the roles specified for the user.

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.

Events

WSE0017 - Error reading site

WSE0030 - User not found (the user registered as anonymous user does not exist)

WSE0036 - Session not found

WSE0108 - No anonymous user for the session

WSE0103 - No folder list found

WSE0135 - User for session can't be updated (the session already have an assigned user).

Universal events