LoginHistoryReport
Posted by Angham Al-Banawien, Last modified by Diana Alkouni on 16 December 2019 02:47 PM


Syntax

Public Overrides Function LoginHistoryReport( ByRef ClientID As Integer , ByRef FromDate As String, ByRef ToDate As String, ByRef IP As String, ByRef API As Integer, ByRef Username As String, ByRef succeededFailed As Integer, ByRef WhoType As Integer, ByRef whoID As Integer) As TransResult

This function is used to get the login history for the given client ID. After LoginHistoryReport executes the ReportDataReceived event fires.

Parameters

Key Description 
clientID The report will show all the login history for all accounts under this client, Value of type is Integer.
FromDate Specify the duration. Value of type is String
Date in this format “DD/MM/YYYY HH: NN: SS”
“” means form beginning.
ToDate Specify the duration. Value of type is String.
Date in this format “DD/MM/YYYY HH: NN: SS”
“” means till now.
IP IP address. Value of type is String
“” means for all IPs
API To indicate if the login by was via API or using the terminal. Value of type is Integer
-1 All
1 API
0 Non API
Username Username which is required to get the login history for. Value of type is String
“” means for all usernames
SucceededFailed The succeeded login history or failed login history. Value of type is Integer.
-1 All
1 Failed
0 Succeeded
WhoType The report will show the login history of dealers or clients. Value of type is Integer.
0 means for all
1 means for dealers
2 means for client
WhoID The ID of dealer/client. Value of type is Integer.
 0 all
-1 System

Return value

Returns value of type TransResult. If the request was sent to server successfully it will return Succeeded.

Sample

Private Sub LoginHistory_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles LoginHistory.Click

    Dim Result As VertexFXBridgeAPI.TransResult

    Dim Root_ID As Integer = BO.GetBO.RootID ()

    Result= BO.GetBO.LoginHistoryReport(Root_ID,"", "", "", 0, "", 0, 0, 0)

 End Sub 

Result: 

The result of this report contains many details; the following table shows each column description

Data row Index Column name Description 
1 Login Shows the login date and time of each client/dealer.
2 Logout Shows the logout date and time of each client/dealer.
3 Dealer/Client The type of the user login (Dealer/Client).
4 Username The username of each login Client/Dealer.
5 Name The name of each login Client/Dealer.
6 IP  The order type (Buy/Sell)
 1 means Buy
-1 means Sell
7 Succeeded/Failed The status of each login client/Dealer
1 Failed
0 Succeeded
8 API/Non API The application type of each login client/dealer used to login
1 API
0 Non API

 


See Also


Back to VFXBO Index

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions