BroadcastMessage
Posted by Angham Al-Banawien, Last modified by Diab Mansour on 19 July 2021 09:59 PM

 Syntax

 Public Function BroadcastMessage (ClientID As Long, Title As String, Message As String) As String

Description

The BroadcastMessage operation is used to send specific message to the given client/Group/Office ID. 

Request Parameters

Name Description  Required
ClientID
  • Client identifier to send message for
  • Type : Long
  • Default : None
  • Constraints : Must be valid client Id and accessible by logged in dealer

Yes

Title
  • Message title
  • Type : String
  • Default : None
Yes  
Message
  • Message title
  • Type : String
  • Default : None
Yes 


Response Elements

Name Description 
 Result

The operation return ”1” in case success, otherwise an explicit error code is returned 


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>BroadcastMessage</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 onSuccessResultOrder(dataResult) {
var result = eval('(' + dataResult + ')');
var rst = ""



if (result == 1) {
rst += "The broadcast message has been sent : </br>" ;
$("#resultAction").html(rst);
}



else {
var rst = "https://support.hybridsolutions.com//index.php?/Knowledgebase/Article/View/1964"
$("#resultAction").html("Error Code : " + result + "<br/>" + " for more details see the follwing link: " + rst);
}



}
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 + "/BroadcastMessage?ClientID=" + $("#txtClientID").val() + "&Title=" + $("#txtTitle").val() + "&Message=" + $("#txtMessage").val() + "&callback=?", onSuccessResultOrder);
});
});
</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 ="" /> 
Title: <input type="text" id="txtTitle" value ="" /> 
Message: <input type="text" id="txtMessage" value ="" />
</td>
</tr>
<tr>
<td><button id="btnAction"> BroadcastMessage </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