Online documentation - WebsydianExpress v3.5 |
APIServer.User.Delete
Field | Variable | ...as | Description |
---|---|---|---|
UserSurrogate | Data | Input | The unique identification of the user to delete. |
ErrorMessage | Error | Output | Text describing the reason if an error has occurred. |
The API deletes the specified user from the database (physically removes the record). Before deleting the record, the API User.DeleteValidation is called. If the validation fails the *Returned status is set to a non-successful value and a text describing the error is returned in the ErrorMessage field.
If the validation is successful, the user specified by the surrogate is deleted.