Syntax
Public Function LoginHistoryReport(ClientID As Long, FromDate As String, ToDate As String, IP As String, API As Integer, Username As String, Status As Integer, WhoType As Integer, WhoID As Integer, OTPEnabled As Boolean, OTPFailed As Boolean) As String
Description
The LoginHistoryReport operation is used to get the login history report for the given login client ID.
Request Parameters
| Name |
Description |
Required |
| ClientID |
- Client identifier to get login history report for
- Type: Long
- Default: None
- Constraints: Must be valid client Id and accessible by logged in dealer
|
Yes |
| FromDate |
- Specify the duration
- Type: String
- Default: None
- Constraints: Must be valid date format (DD/MM/YYYY HH:NN:SS)
- : means from the beginning
|
Yes |
| ToDate |
- Specify the duration
- Type: String
- Default: None
- Constraints: Must be valid date format (DD/MM/YYYY HH:NN:SS)
- : means till now
|
Yes |
| IP |
- The report will show the login history for this IP
- Type: String
- Default: None
- : Means for all IPs
|
Yes |
| API |
- Indicate if the login by API or using terminal
- Type: Integer
- Default: None
- Can be one of the following
-1: means All
1: means API
0: non API
|
Yes |
| Username |
- The username that wants to get the login history for
- Type: String
- Default: none
- : means All usernames
|
Yes |
| Status |
- The succeeded or failed login
- Type: Integer
- Default: None
- Can be one of the following
-1: means ALL
1: means failed login
0: Succeeded
|
Yes |
| WhoType |
- The report will show of Dealer or client
- Type: Integer
- Default: None
- Can be one of the following
0: means for all
1: means for Dealer
2: means for Client
|
Yes |
| WhoID |
- The Id of Dealer or Client
- Type: Integer
- Default: None
- 0: means for all
|
Yes |
| OTPEnabled |
- Type: Boolean
- Default: None
|
Yes |
| OTPFailed |
- Type: Boolean
- Default: None
|
Yes |
Response Elements
| Name |
Description |
| Result |
The operation returns a list of types LoginHisReport, otherwise, an explicit error code is returned if Status is less than 0.
The Following are the LoginHisReportdata member
- Status :
1: Means Failed
0: Means Succeeded
- LoginTime: client login time
- LogoutTime : client logout time
- Type : Client / Dealer
1: means Dealer
2: means the client
- Username: Logged in user name
- Name: Logged in name
- IP: Logged IP address
- ISAPI : False: means Not API
True: means login through API
- OTPEnabled: OTP Enabled
- OTPFailed: OTP Failed
|
See Also
VertexFX Backoffice WCF Service Index