Syntax
Public Function GetClientsInfo(ClientID As Long) As String
Description
The GetClientsInfo operation is used to get a list of client information for all client that 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 list of type ClientInformation , 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 : client 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
- 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 : Boolean value that indicate if the client will force password after first login or not
- AccountsInfo: List of Account that contains a following
- AccountID: account number
- AccountType : 1 = normal Account
2 = Coverage Account
- IsMargin: Boolean value to indicate if account is margin or not .
- DemoAccount : Indicate if account is demo or not
- LockLiquidate : Indicate if account is locked or not
- DontLiquidate : indicate if the account will liquidate or not when reach to the liqudation point
|
Sample
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>GetClientsInfo</title>
<script src="http://code.jquery.com/jquery-latest.js"></script>
</head>
<script>
$(document).ready(function () {
var urlStr = "http://173.249.35.43/webtrader/webservice.svc";
jQuery.support.cors = true;
$("#progress").ajaxStart(function () { $(this).css("display", "block"); });
$("#progress").ajaxComplete(function () { $(this).css("display", "none"); });
$("#resultAction").ajaxError(function (result) { $(this).html('An error occured'); });
function onSuccessResultt(dataResult) {
var result = eval(dataResult);
var rst = ""
if (result[0].ClientID > 0) {
for (var i = 0; i < result.length; i++) {
rst += "ClientID : " + result[i].ClientID + "<br/>"
rst += "ParentID : " + result[i].ParentID + "<br/>"
rst += "ClientType : " + result[i].ClientType + "<br/>"
rst += "FirstName : " + result[i].FirstName + "<br/>"
rst += "SecondName : " + result[i].SecondName + "<br/>"
rst += "ThirdName : " + result[i].ThirdName + "<br/>"
rst += "Country : " + result[i].Country + "<br/>"
rst += "Email : " + result[i].Email + "<br/>"
rst += "Read_Only : " + result[i].Read_Only + "<br/>"
rst += "Demo : " + result[i].Demo + "<br/>"
if (result[i].ClientType == 1 || result[i].ClientType == 2) {
rst += "-------------------Accounts Info-----------------------------" + "<br/>"
for (var j = 0 ; j < result[i].AccountsInfo.length ; j ++) {
rst += "AccountID : " + result[i].AccountsInfo[j].AccountID + "<br/>"
rst += "AccountType : " + result[i].AccountsInfo[j].AccountType + "<br/>"
rst += "IsMargin : " + result[i].AccountsInfo[j].IsMargin + "<br/>"
rst += "LockLiquidate : " + result[i].AccountsInfo[j].LockLiquidate + "<br/>"
rst += "DemoAccount : " + result[i].AccountsInfo[j].DemoAccount + "<br/>"
rst += "DontLiquidate : " + result[i].AccountsInfo[j].DontLiquidate + "<br/>"
rst += "<br/>"
}
}
rst += "--------------------------------------------------" + "<br/>"
$("#resultAction").html(rst)
}
}
else {
$("#resultAction").html("Error Code : " + result[0].ClientID + "<br/>" );
}
}
function onSuccessResult(response) {
response = eval('(' + response + ')')
if (response.UserId == -1 || response.UserId == -207) {
$("#resultData").html("Invalid username or password");
}
else if (response.UserId == -231) {
$("#resultData").html("You must have at least one account");
}
else if (response == null || response == "" || response.UserId < 0) {
$("#resultData").html("Error while login.Please try later");
}
else {
$("#resultData").html("SuccessResult ... UserId is :" + response.UserId);
}
}
function onErrorResult(result) {
alert('Service call faild : ' + result.status + ' ' + result.statusText);
}
$("#btnLogin").click(function () {
$.getJSON(urlStr + "/BackofficeLogin?username=" + $("#txtusername").val() + "&password=" + $("#txtpassword").val() + "&callback=?" , onSuccessResult);
});
$("#btnAction").click(function () {
$.getJSON(urlStr + "/GetClientsInfo?ClientID="+ $("#txtClientID").val() + "&callback=?", onSuccessResultt);
});
});
</script>
<body>
<table border="1px">
<tbody>
<tr>
<td>
Username: <input type="text" id="txtusername" value=""/>
password: <input type="text" id="txtpassword" value=""/>
<button id="btnLogin"> Login </button>
</td>
</tr>
<tr>
<td>ClientID : <input type="text" id="txtClientID" value ="" /> </td>
<td><button id="btnAction"> GetClientsInfo </button></td>
</tr>
</tbody>
</table>
<div id="resultData"> </div>
<div id="resultAction"> </div>
<div style="display:none" id="progress">Loading ... </div>
</body>
</html>
See Also
VertexFX Backoffice WCF Service Index
|