Syntax
Public Function CreateDealer(ParentUsername As String, vDealerType As DealerType, Username As String, Password As String, ClientID As Integer, DealerDesc As String, GMTOffset As String,DealerTreePriv As Long ,Optional IsBranch As Boolean = False) As CallingResultsEnum
Description
This function is used to create a new dealer , Group or department type under the giving dealer username. After CreateDealer executed the CreateDealerResultReceived event fired.
Parameters
Parameter |
Description |
ParentUsername |
Dealer username that wants to create a dealer under it, a value of type string. |
vDealerType |
A created dealer type can be one of the DealerType. |
Username |
New dealer username, a value of type string. |
Password |
The dealer password, a value of type String. |
ClientID |
Client identifier that the new dealer will be has a privilege on. Value of Integer. |
DealerDesc |
The dealer description, a value of type String. |
GMTOffset |
The value of the dealer country GMT offset, a value of type String. |
DealerTreePriv |
The Dealer Id that the created dealer has privilege on, Value of type is Long. pass it -1 if want to create a dealer without specific privilege |
IsBranch |
If dealer type is department type then this value used to indicate it branch or not, an Optional value of type Boolean. |
Return value
Returns a value of type CallingResultsEnum, If the request was sent to the server successfully it will return SuccessResult.
Sample
Private Sub CreateDealer _Click()
Dim Res as CallingResultsEnum
Dim vClient as COClient = BOAPI.ClientByIndex(1)
Res = BOAPI.CreateDealer(“ParentUsername”,1,”Username”,”Password”, vClient.clientID, ”DealerDes”, Cstr(BOAPI.GMTOffset),-1,false)
End sub
See Also
VertexFX Backoffice API Index
Last Modified: 29 June 2018
|