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

API: User.UpdateValidation

Scoped Name

APIServer.User.UpdateValidation

Interface

Field Variable ...as Description
UserSurrogate Data Input The unique identification for a user (mandatory).
UserFolderListID Data Input The identification of the folder list to be assigned to the user (optional).
EmailAddress Data Input The e-mail address to be assigned to the user (mandatory).
LoginName Data Input The identification the user must use when logging in to the site. The login name must be unique for the site (mandatory).
FullName Input Input The name of the user (mandatory).
UserSitekey Input Input The site the user is defined for (mandatory).
UserStatus Input Input The status assigned to the user. Valid values are: Active (A), Inactive (I), TooManyFailedLogins (F)  (Mandatory).
NumberOfErrors Error Output The number of messages in the ErrorArray variable.
ErrrorMessage ErrorArray(20) Output For each error a text describing the error can be written to the output variable ErrorArray (occurs 20).

Description

Performs the validation that is necessary before an update of an existing user can be performed.

If the validation fails a non-successful value is written to *Returned status and a message is written to the ErrorArray output variable. If the validation is successful the *Returned status is set to *Successful and the update is done.

The following validation is performed:

UserSurrogate

The surrogate must identify an existing user to be updated.

UserFolderListID

This field is optional. If specified, the ID must identify an existing folder list.

EmailAddress

Mandatory.

LoginName

This field is mandatory. The combination of login name and site must be unique.

FullName

Mandatory.

UserSitekey

This field is mandatory and must identify an existing site

UserStatus

This field is mandatory and must be one of the valid values defined for the field.

Events

Universal events