VertexFX BackOffice WCF Service

CreateGroup

137 views 0 Updated on February 7, 2024 hybrid-solutions

Syntax

 Function CreateGroup(ParentID As Integer, 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) As String

Description

The CreateGroup operation is used to create a new group under a specific given parent Integer.

Request Parameters

Name Description Required
ParentID
  • ParentIdentifier which the new group will be under it
  • Type: Integer
  • Default: None
  • Constraints: Must be valid parent ID and accessible by logged in dealer
 Yes
Name
  • Group description.
  • Type: String
  • Default: None
 Yes
Username
  • Group username.
  • Type: String.
  • Default: None
 Yes
Password
  • Group password.
  • Type: String.
  • Default: None
 Yes
isReadOnly
  • To indicate if the Group will only monitor the trades or not
  • Type: Boolean
  • Default: None
 Yes
Phone
  • Group phone number
  • Type: String.
  • Default: None
 Yes
Fax
  • GroupFax number
  • Type: String
  • Default: None
 Yes
Mobile
  • Group mobile number
  • Type: String
 Yes
TelPWD
  • GroupTelephone password number
  • Type: String
  • Default: None
 Yes
POB
  • Post office box
  • Type: String
  • Default: None
 Yes
Email
  • group email address
  • Type: String
  • Default: None
 Yes
Address
  • GroupAddress
  • Type: String
  • Default: None
 Yes
ForceChangePassword
  • To indicate if the group will force to change the password after the first login or not
  • Type: Boolean
  • Default: None
 Yes


Response Elements

Name Description
Result The operation returns a new group identifier in case of success, otherwise, an explicit error code is returned

 

See Also


VertexFX BackOffice WCF Service Index

Was this helpful?