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

API: User.StateChangeValidation

Scoped Name

APIServer.User.StateChangeValidation

Interface

Field Variable ...as Description
UserSurrogate Data Input The unique identification for a user.
UserStatus Data Input The new status for the user. Valid values are: Active (A), Inactive (I), TooManyFailedLogins (F).
ErrorMessage Error Output If an error occurs this field can contain a text describing the error.

Description

The API performs the necessary validation for an update of the state of the user.

The UserSurrogate has to identify an existing user and the UserStatus must be one of the valid values for the field.

If an error occurs, a text describing the error is written to the ErrorMessage output field.

Events

Universal events