Knowledgebase: > Reports
Posted by Mohammad Rahhal, Last modified by Diana Alkouni on 25 August 2020 10:33 AM


 Public 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,TransTag As String) As VertexFXBOAPI10.CallingResultsEnum


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


Parameter Description 
ClientID Client ID that want to get the history login for, value of type Integer

Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means from beginning 

ToDate Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means till now 
IP IP address value of type String
“” means for all IPs
API To indicate if the login by the API or using the terminal
-1 ALL
0 Non API.
Username Username that want to get the login history for
“” means for all usernames
SucceededFailed The succeeded login history , or failed login history
-1 All
1 Failed 
0 Succeeded
WhoType The report will show the login history of Dealers or client
0 means for all
1 means for Dealers
2 means for Client
WhoID The ID of Dealer/client
0 means for all ID
TransTag String value used to mark the requested report when the result came from server

Return value
Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult.


 Private Sub loginHis_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles loginHis.Click

    ‘BOAPI is a predefined variable as CVertexBOAPI10

     Dim Result As CallingResultsEnum

     Result= BOAPI.LoginHistoryReport(BOAPI.RootID, "", "", "", -1,"",-1, 0, 0,"")

     MsgBox (Result.ToString)

 End Sub 


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 for each client/ dealer
 2 Logout The logout date and time for each client/ dealer
 3 Dealer/Client  The type of the login user (Dealer/ Client)
 4 Username The username for each login client/ dealer
 5 Name The name for each login client/ dealer
 6  IP The used IP address for each login client/ dealer 
 7 Succeeded/Failed The status of each login client/ dealer 
1 : means Failed 
0 : means Succeeded
8 API/Non-API The application type for each login client/ dealer 
 1: means API
0 : means non API
TransTag The same string which sent by the requested report.

See Also

VertexFX Backoffice API Index

(0 vote(s))
Not helpful

Comments (0)
Post a new comment
Full Name:
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