Syntax
Public Function GetClientsInfo(ClientID As Long) As String
Description
The GetClientsInfo operation is used to get a list of client information for all clients that are related to the given parent identifier.
Request Parameters
| Name |
Description |
Required |
| ClientID |
- Parent identifier to get list information for clients that belong to.
- Type: long
- Default: None
- Constraints: Must be valid client ID and accessible by logged in dealer
|
Yes |
Response Elements
| Name |
Description |
| Result |
The operation returns a list of types ClientInfos, otherwise, an explicit error code is returned if ClientID is less than 0.
The Following are the ClientInformation data member
- ClientID : Client number
- ParentID: parent number which the client is belong to
- Username: the client’s username
- FirstName: client first name
- SecondName: client second name.
- ThirdName: client third name
- LastName : client last
- Phone: client phone number
- Email: client Email
- Address: client
- Country: client Country
- Mobile: client Mobile
- TelFax: client TelFax
- Pop: Client pop
- Fax: client Fax
- Read_Only : Boolean value that indicates if client is read-only or not
- ClientType (1 = client type , 2 = Office Type, 3 Group Type)
- ForceChangePW : Boolean value that indicate if the client will force password after first login or not
- Accounts: List of AccountInfos that contains a following
- ID : account number
- AccountType : 1 = normal Account
2 = Coverage Account
- MarginAccount: Boolean value to indicate if an account is a margin or not.
- DemoAccount: Indicate accounts demo or not
- LockLiquidate : Indicate whether accounts are locked or not
- DontLiquidate : indicate if the account will liquidate or not when reach the liquidation point
|
See Also
VertexFX BackOffice WCF Service Index