CreateGroup
Posted by Mohammad Rahhal, Last modified by Laith Ghawi on 01 July 2019 11:05 AM

Syntax

 Function CreateGroup(ParentUsername As String,Name As String,Username As String,Password As String, ReadOnlyLogin As Boolean,Phone As String,Fax As String,Mobile As String,TelPWD As String,POB As String,Email As String,Address As String,ChangePW As Boolean, TransTag As String,Optional ParentUserID as Integer = -1 ) As CallingResultsEnum

Description

This function uses to make new group under specific parent from the parent tree. After CreateGroup method executes the CreateGroupResult event fire

Parameters

Part Description 
ParentUsername Parent Username where you want to create a group under, a value of type String.
Name  The name of the group, a value of type String.
Username The username of the group, a value of type String.
Password The password of the group, a value of type String.
ReadOnlyLogin Boolean Parameter, if true the group will only monitor the trades.
Phone Group’s Phone Number, a value of type String.
Fax Group’s Fax Number, a value of type String.
Mobile Group’s Mobile Number, a value of type String.
TelPWD Group’s Telephone Password, a value of type String.
POB Post Office Box, a value of type String.
Email Group’s Email, a value of type String.
Address Group’s Address. a value of type String.
TransTag String value to mark the create group operation when the result came from the server
ChangePW Used to detect if the created group will force change password after the first login, a value of type Boolean.
ParentUserID If the username is empty you can pass the parent Id that you want to create the Group 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 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, Name, Username, Password, Fax, Phone, mob As String 
   Dim TelPW, POB, Email, Address As String
     Dim ReadOnlyLogin As Boolean

   Dim ParentUserId as Integer =-1

   Name = "test"

   Username = "test1"

   Password = "1234"

   Fax = "11223"

   TelPW = "123456789"

   ParentUsername = "trial1"

   POB = "1001"

   Email = "abc@abc.com"

   Address = "amman"

   TransTag = "xxx"

   ReadOnlyLogin = False

   result = m_oBOAPI.CreateGroup(ParentUsername,Name, Username, Password,ReadOnlyLogin ,Phone, Fax, mob, TelPW, POB, Email, Address, false ,TransTag,ParentUserId)

    MsgBox(result.ToString) ' if it equal SuccessResult  that mean it sent to the server successfully. 

  End Sub

 Private Sub m_oBOAPI_CreateGroupResult(ByRef Result As VertexFXBOAPI11.CreateClientResultEnum, ByRef tag As String) Handles m_oBOAPI.CreateGroupResult

      msgbox (Result.ToString)

End Sub 

 


 See Also


VertexFX Backoffice API 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