Online documentation - WebsydianExpress v3.5 |
APIServer.User.SingleFetchSiteLogin
Field | Variable | ...as | Description |
---|---|---|---|
LoginName | FetchKey | Input | The login name defined for the user |
UserSitekey | FetchKey | Input | The site the user belongs to. The combination of the login name and the site is unique. |
UserAuthLevel | FetchedData | Output | Not used. |
UserFolderListID | FetchedData | Output | If the user has assigned a specific folder list the identification is returned in this field. |
CrtByUserSgt | FetchedData | Output | The unique identification of the user who has created the current user. Use the API UserSingleFetch to obtain more information about the creating user. |
EmailAddress | FetchedData | Output | The email address registered for the user. |
LoginName | FetchedData | Output | The login name used by the user (same as input). |
FullName | FetchedData | Output | The name registered for the user. |
ErpCustomerKey | FetchedData | Output | For future use. |
ErpAccountKey | FetchedData | Output | For future use. |
CreatedTime | FetchedData | Output | User creation time. |
CreatedDate | FetchedData | Output | User creation date. |
UserLanguageCode | FetchedData | Output | For future use. |
UserSiteKey | FetchedData | Output | Identifies the site, which the user is registered for (same as input). |
UserSurrogate | FetchedData | Output | The unique identification of the user (same as input). |
Password | FetchedData | Output | The signed value of the user password. Can be used to compare the password with a signature of a user entered value. |
FailedLogins | FetchedData | Output | Shows the number of failed logins performed by the user. |
UserStatus | FetchedData | Output | The status of the user. Valid values are: Active (A), Inactive (I), TooManyFailedLogins(F). |
LastLogin | FetchedData | Output | Timestamp for last login by user. |
The API can be used to find information about a user, when the user surrogate is not known. This API finds the user based on the login name and the site the user belongs to.
The API behaves as a standard SingleFetch function.