|
|
APIServer.User.BlockFetchByLogin
| Field | Variable | ...as | Description |
|---|---|---|---|
| LoginName | Position | Input | Login name for a user. Used to position the search for users.
Only users with a login name positioned after than the one
specified will be returned in the output.
A blank login name will return all users. |
| UserSiteKey | Position | Input | The identification of the current site. Restricts the output to users for a specific site. The site must be specified in the input, or no records will be returned. |
| Position | Control | Input | Specifies whether the values specified for LoginName and
SiteKey is to be used, or whether the output should start from the
last record found in the last search.
Values: Yes (Y) or No (N). |
| RowsFetched | Control | Dual | The number of rows fetched in the search. |
| UserFolderListID | Limit | Input | Limits the search. Only records with the exact value specified for the UserFolderListID will be returned. |
| CrtByUserSgt | Limit | Input | Limits the search. Only records with the exact value specified for the CrtByUserSgt will be returned. |
| EmailAddress | Limit | Input | Limits the search. Only records with the exact value specified for the EmailAddress will be returned. |
| UserStatus | Limit | Input | Limits the search. Only records with the exact value specified
for the UserStatus will be returned.
Values: Active (A), Inactive (I), TooManyFialedLogins(F) |
| UserSurrogate | FetchedData(64) | Output | The unique identification of the user. |
| UserSiteKey | FetchedData(64) | Output | The site the user belongs to. |
| LoginName | FetchedData(64) | Output | The login name of the user. |
| UserFolderListID | FetchedData(64) | Output | The folder list assigned to the user. |
| CrtByUserSgt | FetchedData(64) | Output | A reference to the user who created this user. |
| EmailAddress | FetchedData(64) | Output | The e-mail address of the user. |
| FullName | FetchedData(64) | Output | The full name of the user. |
| CreatedTime | FetchedData(64) | Output | Time of user creation. |
| CreatedDate | FetchedData(64) | Output | Date of user creation. |
| UserLanguageCode | FetchedData(64) | Output | For future use |
| Password | FetchedData(64) | Output | Signature of the user password |
| FailedLogins | FetchedData(64) | Output | The number of failed logins. |
| UserStatus | FetchedData(64) | Output | Values: Active (A), Inactive (I), TooManyFailedLogins(F) |
| LastLogin | FetchedData(64) | Output | Time stamp of the last time the user has logged in. |
This is a standard BlockFetch function based on the user entity, with some extra possibilities to limit the search.
The API should be used if you at any time must have a list of users in your application.
To make it easier to use this function, a dummy view (WSYAPI/DataStructures.User.SiteKeyLogin) is provided. Use this view to replace in e.g. grid page functions.
Online documentation - WebsydianExpress v3.0