Syntax
Function GetClientByID (ClientID As long) As String
Description
The GetClientByID operation is used to get client information for a given client number.
Request Parameters
Name |
Description |
Required |
ClientID
|
- Client number to get its information
- 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 JSON object of type ClientInformation, otherwise an explicit error code is returned if ClientID is less than 0.
The Following are the client Information data member
- ClientID : Client idintifier.
- ParentID : parent idintifier which the client is belong to
- UserName : client username
- FirstName : client first name
- SecondName : client second name.
- ThirdName : client third name
- lastName : client last name
- Phone : client phone number
- Email : client Email
- Address : client Address
- Country : client Country
- Mobile : client Mobile
- TelFax : client TelFax
- Pop : Client pop
- Fax : client Fax
- Demo : Boolean value that indicate if client is demo or not
- Read_Only : Boolean value that indicate if client is read only or not
- ClientType (1 = client type , 2 = Office Type, 3 Group Type)
- ForceChangePW : Detect if the client will be force change password after the first login
|
Sample
See Also
VertexFX Backoffice WCF Service Index
|