VertexFX BackOffice WCF Service

UpdateGroupInfo

80 views 0 Updated on February 13, 2024 hybrid-solutions

Syntax

 Function UpdateGroupInfo(ClientID As Long, Name As String, GroupUsername As String, Password As String, IsReadOnly As String, Phone As String, Fax As String, Mobile As String, TelPWD As String, POB As String, Email As String, Address As String, ForceChangePassword as Boolean)  As String

Description

The UpdateGroupInfo operation is used to update information for a specific given group id. Use GetClientsIDs to get a list of IDs under the specific parent
name.

Request Parameters

Name Description Required
ClientID
  • group identifier to be updated.
  • Type: Integer
  • Default: None
  • Constraints: Must be valid group ID and accessible by logged in dealer
 Yes
Name
  • Group description.
  • Type: String
  • Default: None
 Yes
GroupUsername
  • 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: String
  • 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 change password after the first login or not
  • Type: Boolean
  • Default: None
 Yes


Response Elements

Name Description
Result The operation return an updated group identifier in case of success, otherwise, an explicit error code is returned

See Also


VertexFX BackOffice WCF Service Index

Was this helpful?