Syntax
Function CreateClient(ParentUsername As String,FirstName As String,SecondName As String,ThirdName As String, LastName As String,Username As String,Password As String,Phone As String,Fax As String, Mobile As String, TelPW As String ,POB As String,Country As String,Email As String,Address As String , ReadOnlyLogin As Boolean , ChangePW As Boolean, TransTag As String, Optional ParentUserID as Integer = -1) As CallingResultsEnum
Description
This function used to create a new client under a specific valid parent on the dealer tree.After CreateClient method executes CreateClientResult event fire
Parameters
Part |
Description |
ParentUsername |
Parent Username where you want to create client under it, a value of type String. |
FirstName |
First name of the client, value of type String. |
SecondName |
The second name of the client, value of type String. |
ThirdName |
Third name of the client, a value of type String. |
LastName |
Last name of the client, a value of type String. |
Username |
Client's Username, a value of type String. |
Password |
Client's Password, a value of type String. |
Phone |
Client's Phone Number, a value of type String |
Fax |
Client's Fax Number, a value of type String. |
Mobile |
Client's Mobile Number, a value of type String |
TelPW |
Client's Telephone Password, a value of type String. |
POB |
Post office box, a value of type String. |
Country
|
Client's country, a value of type String
|
Email
|
Client's email, a value of type String |
Address |
Client's Address value of type String. |
ReadOnlyLogin |
If it true the client will only monitor the trades, a value of type Boolean. |
TransTag |
It's custom string to know the identity of the sender upon receipt of the result |
ChangePW |
Used to detect if the created client will force change password after the first login, value of type Boolean. |
ParentUserID |
If the username is empty you can pass the parent Id that you want to create the client under , an optional value of type is Integer |
Return value
Returns a value of type CallingResultsEnum. if the requested sent to the server successfully it will return SuccessResult.
Sample
Public WithEvents m_oBOAPI As New CVertexFXBOAPI
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Dim result As VertexFXBOAPI11.CallingResultsEnum
Dim ParentUsername, FirstName, SecondName, ThirdName, LastName, Username As String
Dim Password, Fax, Phone, mob, TelPW, POB, Country, Email, Address, TransTag As String
Dim ReadOnlyLogin As Boolean
Dim ParentUserID as Integer =-1
FirstName = "test"
SecondName = "sec"
ThirdName = "third"
LastName = "last"
Username = "test1"
Password = "1234"
Fax = "11223"
TelPW = "123456789"
ParentUsername = "trial1"
POB = "1001"
Country = "Jordan"
Email = "abc@abc.com"
Address = "amman"
TransTag = "xxx"
ReadOnlyLogin = False
result = m_oBOAPI.CreateClient(ParentUsername, FirstName, SecondName, ThirdName, LastName, Username, Password, Phone, Fax, mob, TelPW, POB, Country, Email, Address, ReadOnlyLogin,false ,TransTag,ParentUserID )
MsgBox(result.ToString)
End Sub
Private Sub m_oBOAPI_CreateClientResult(ByRef Result As VertexFXBOAPI10.CreateClientResultEnum, ByRef tag As String) Handles m_oBOAPI.CreateClientResult
msgbox (Result.ToString)
End Sub
See Also
VertexFX Backoffice API Index
|