GetClientByID
Posted by Angham Al-Banawien, Last modified by Laith Ghawi on 03 July 2019 10:52 AM

 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

<!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>GetClientByID</title>
<script src="http://code.jquery.com/jquery-latest.js"></script>
</head>
<script >
var hisTable;
$(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"); });
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);}
}


$("#resultAction").ajaxError(function (result) { $(this).html('An error occured'); });
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);
});
function onSuccessResultAction(dataResult) {
dataResult = eval('(' + dataResult + ')');
$("#resultData").html(dataResult);
if (dataResult.ClientID > 0) {
var resultStr = "SuccessResult ... clientID is :" + dataResult.ClientID + "<br/>";
resultStr += "ParentID :" + dataResult.ParentID +"<br/>"
resultStr += "Username :" + dataResult.ClientID + "<br/>"
resultStr += "First Name :" + dataResult.FirstName + "<br/>"
resultStr += "ClientType:" + dataResult.ClientType + "<br/>"

$("#resultData").html(resultStr);
}
else { 
var errDetail = "http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4603"
$("#resultData").html("Error Code : " + dataResult + "<br/>" + " for more details see the follwing link: " + errDetail.link(errDetail));
}

}
$("#btnAction").click(function () {
$.getJSON(urlStr + "/GetClientByID?ClientID=" + $("#ClientID").val() + "&callback=?" , onSuccessResultAction);
});
});
</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="ClientID" value=""/>
<button id="btnAction"> GetClientByID </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

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions