Awards a RedCritter badge to a RedCritter user or team. This Badge must be configured in RedCritter Connecter before it can be awarded.
This version of the AwardBadge command is used to award a badge to the users and teams specified with the ProfileEntity value.
https://redcritterconnecter.com/services/gamificationv1/AwardBadge?SecretKey={SecretKey}&ProfileEntity={ProfileEntity}&BadgeName={BadgeName}
| SecretKey | string | yes | This SecretKey is an App or App Domain Secret Key. If an App Secret Key is specified, your default App Domain will be assumed. If an App Domain Secret Key is specified, that App Domain will be used. |
| ProfileEntity | string | yes | The ProfileEntity represents to whom the API call will apply. This can be an email address or a team name. Multiple email addresses or teams can be specified by separating them with a semicolon. Team names can be any string value other than an email address. If a team's profile does not exist, RedCritter will create one dynamically. |
| BadgeName | string | yes | The BadgeName parameter represents the name of the badge that you want to award to a RedCritter User. The following characters cannot be used : | = [ ] , ; |
Code Samples Javascript, C#
AwardBadge with C#
This is a minmal example of calling the AwardBadge API and parsing the JSON result into a populated C# object. This example uses asynchronous techniques to raise a callback when the response is received.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Net;
using System.IO;
using System.Web; //Add reference to System.Web
using System.Runtime.Serialization.Json; //Add reference to System.Runtime.Serialization
namespace RedCritterConnecter.Samples
{
//Create a class to contain the response
public class AwardBadgeResponse
{
public String ErrorMessage { get; set; }
public Boolean Submitted { get; set; }
public String RequestID { get; set; }
public String APIVersion { get; set; }
public String ReturnParam1 { get; set; }
public String ReturnParam2 { get; set; }
public String ReturnParam3 { get; set; }
private Int32 ErrorCode { get; set; }
}
public class AwardBadge
{
public delegate void OnAwardBadgeResponse(AwardBadgeResponse AwardBadgeResponse);
public event OnAwardBadgeResponse onAwardBadgeResponse;
public delegate void OnAwardBadgeResponseError(AwardBadgeResponse AwardBadgeResponse);
public event OnAwardBadgeResponseError onAwardBadgeResponseError;
const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
public void Execute(String SecretKey, String ProfileEntity, String BadgeName)
{
try
{
//Create url encoded parameters in query string
String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&badgename=" + System.Web.HttpUtility.UrlEncode(BadgeName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity);
//Create a new instance of a WebClient
WebClient wc = new System.Net.WebClient();
//Prevent this request from caching in order to ensure that it is sent to server
wc.CachePolicy = new System.Net.Cache.RequestCachePolicy(System.Net.Cache.RequestCacheLevel.NoCacheNoStore);
//Attach an event handler to receive the response
wc.DownloadStringCompleted += onAwardBadgeResponseReceived;
//Make the call
wc.DownloadStringAsync(new Uri(CONST_ConnecterBaseURL + "services/gamificationv1/AwardBadge?" + queryString, UriKind.Absolute));
}
catch
{
//Something went wrong communicating with the server
if (onAwardBadgeResponseError != null)
{
onAwardBadgeResponseError(null);
}
}
}
private void onAwardBadgeResponseReceived(object sender, DownloadStringCompletedEventArgs e)
{
try
{
//Create a JSON serializer
System.Runtime.Serialization.Json.DataContractJsonSerializer s = new DataContractJsonSerializer(typeof(AwardBadgeResponse));
//Copy the string into a memory stream
MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(e.Result));
//Read the stream into an object matching the response's type
AwardBadgeResponse AwardBadgeResponse = (AwardBadgeResponse)s.ReadObject(ms);
//Work with the populated response object
if (AwardBadgeResponse.Submitted == true)
{
//Request was accepted, raise the success event
onAwardBadgeResponse(AwardBadgeResponse);
}
else
{
//Something went wrong
if (onAwardBadgeResponseError != null)
{
//Request failed, raise the error event
onAwardBadgeResponseError(AwardBadgeResponse);
}
}
}
catch
{
//Something went wrong
onAwardBadgeResponseError(null);
}
}
}
}
AwardBadge with JavaScript
This is a minimal example of calling the AwardBadge API via HTML and Javascript. Remember to never use your Secret Keys on the client side.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<script src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.9.0.js"></script>
<script type="text/javascript">
var connecterURL = "https://www.redcritterconnecter.com/";
function awardBadge(secretKey, profileEntity, badgename, cbSuccess, cbFail) {
$.getJSON(connecterURL + "services/gamificationv1/awardBadge?jsoncallback=?", { secretKey: secretKey, profileEntity: profileEntity, badgename: badgename },
function (data) {
if (data.Submitted) {
cbSuccess(data);
} else {
cbFail(data);
}
});
}
//My Success Callback
function onMyawardBadgeSuccessHandler(data) {
//data is JSON response
alert("Request was successful");
}
//My Failure Callback
function onMyawardBadgeFailHandler(data) {
//Something went wrong
alert("Something went wrong");
}
</script>
</head>
<body>
<table>
<tr>
<td>Secret Key</td>
<td>
<input type="text" id="tSecretKey" style="width: 500px" />
</td>
</tr>
<tr>
<td>Profile Entity</td>
<td>
<input type="text" id="tProfileEntity" />
</td>
</tr>
<tr>
<td>Badge Name</td>
<td>
<input type="text" id="tBadgeName" />
</td>
</tr>
<td></td>
<td>
<input type="button" onclick="awardBadge($('#tSecretKey').val(), $('#tProfileEntity').val(), $('#tBadgeName').val(), onMyawardBadgeSuccessHandler, onMyawardBadgeFailHandler)" value="Award Badge" /></td>
</tr>
</table>
</body>
</html>
Responses JSON, XML
XML Response
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="Connecter">
<APIVersion>1.0.0</APIVersion>
<ErrorCode>0</ErrorCode>
<ErrorMessage />
<RequestID>2013-08-16 16:51:07.2559115</RequestID>
<ReturnParam1 />
<ReturnParam2 />
<ReturnParam3 />
<Submitted>true</Submitted>
</Response>
JSON Response
{
"ErrorMessage": "",
"Submitted": true,
"RequestID": "2013-08-16 16:52:38.2027178",
"APIVersion": "1.0.0",
"ReturnParam1": "",
"ReturnParam2": "",
"ReturnParam3": "",
"ErrorCode": 0
}
This version of the AwardBadge command is used to award a badge to the users and teams specified with the ProfileEntity value. The Secret Key must be the App Secret Key.
https://redcritterconnecter.com/services/gamificationv1/AwardBadge?SecretKey={SecretKey}&ExternalAccountID={ExternalAccountID}&ProfileEntity={ProfileEntity}&BadgeName={BadgeName}
| SecretKey | string | yes | This SecretKey is the App Secret Key. The App Domain is determined by the External Account ID you provide. |
| ExternalAccountID | string | yes | A unique ID for an App Domain that you create and manage. For example an App could have 2 App Domains managed separately by specifying an ExternalAccountID of 'Sales Dept' or 'IT Dept'. When passed as a parameter if the External Account ID does not exist. RedCritter Connecter will create a new App Domain on the fly with the ID that you specify. |
| ProfileEntity | string | yes | The ProfileEntity represents to whom the API call will apply. This can be an email address or a team name. Multiple email addresses or teams can be specified by separating them with a semicolon.The ProfileEntity represents to whom the API call will apply. This can be an email address or a team name. Multiple email addresses or teams can be specified by separating them with a semicolon. Team names can be any string value other than an email address. If a team's profile does not exist, RedCritter will create one dynamically. |
| BadgeName | string | yes | The BadgeName parameter represents the name of the badge that you want to award to a RedCritter User. The following characters cannot be used : | = [ ] , ; |
Code Samples Javascript, C#
AwardBadge with C#
This is a minmal example of calling the AwardBadge API and parsing the JSON result into a populated C# object. This example uses asynchronous techniques to raise a callback when the response is received.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Net;
using System.IO;
using System.Web; //Add reference to System.Web
using System.Runtime.Serialization.Json; //Add reference to System.Runtime.Serialization
namespace RedCritterConnecter.Samples
{
//Create a class to contain the response
public class AwardBadgeResponse
{
public String ErrorMessage { get; set; }
public Boolean Submitted { get; set; }
public String RequestID { get; set; }
public String APIVersion { get; set; }
public String ReturnParam1 { get; set; }
public String ReturnParam2 { get; set; }
public String ReturnParam3 { get; set; }
private Int32 ErrorCode { get; set; }
}
public class AwardBadge
{
public delegate void OnAwardBadgeResponse(AwardBadgeResponse AwardBadgeResponse);
public event OnAwardBadgeResponse onAwardBadgeResponse;
public delegate void OnAwardBadgeResponseError(AwardBadgeResponse AwardBadgeResponse);
public event OnAwardBadgeResponseError onAwardBadgeResponseError;
const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
public void Execute(String SecretKey, String ExternalAccountID, String ProfileEntity, String BadgeName)
{
try
{
//Create url encoded parameters in query string
String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&externalaccountid=" + System.Web.HttpUtility.UrlEncode(ExternalAccountID) + "&badgename=" + System.Web.HttpUtility.UrlEncode(BadgeName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity);
//Create a new instance of a WebClient
WebClient wc = new System.Net.WebClient();
//Prevent this request from caching in order to ensure that it is sent to server
wc.CachePolicy = new System.Net.Cache.RequestCachePolicy(System.Net.Cache.RequestCacheLevel.NoCacheNoStore);
//Attach an event handler to receive the response
wc.DownloadStringCompleted += onAwardBadgeResponseReceived;
//Make the call
wc.DownloadStringAsync(new Uri(CONST_ConnecterBaseURL + "services/gamificationv1/AwardBadge?" + queryString, UriKind.Absolute));
}
catch
{
//Something went wrong communicating with the server
if (onAwardBadgeResponseError != null)
{
onAwardBadgeResponseError(null);
}
}
}
private void onAwardBadgeResponseReceived(object sender, DownloadStringCompletedEventArgs e)
{
try
{
//Create a JSON serializer
System.Runtime.Serialization.Json.DataContractJsonSerializer s = new DataContractJsonSerializer(typeof(AwardBadgeResponse));
//Copy the string into a memory stream
MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(e.Result));
//Read the stream into an object matching the response's type
AwardBadgeResponse AwardBadgeResponse = (AwardBadgeResponse)s.ReadObject(ms);
//Work with the populated response object
if (AwardBadgeResponse.Submitted == true)
{
//Request was accepted, raise the success event
onAwardBadgeResponse(AwardBadgeResponse);
}
else
{
//Something went wrong
if (onAwardBadgeResponseError != null)
{
//Request failed, raise the error event
onAwardBadgeResponseError(AwardBadgeResponse);
}
}
}
catch
{
//Something went wrong
onAwardBadgeResponseError(null);
}
}
}
}
AwardBadge with JavaScript
This is a minimal example of calling the AwardBadge API via HTML and Javascript. Remember to never use your Secret Keys on the client side.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<script src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.9.0.js"></script>
<script type="text/javascript">
var connecterURL = "https://www.redcritterconnecter.com/";
function awardBadge(secretKey, externalAccountID, profileEntity, badgeName, cbSuccess, cbFail) {
$.getJSON(connecterURL + "services/gamificationv1/awardBadge?jsoncallback=?", { secretKey: secretKey, externalAccountID: externalAccountID,
profileEntity: profileEntity, badgeName: badgeName },
function (data) {
if (data.Submitted) {
cbSuccess(data);
} else {
cbFail(data);
}
});
}
//My Success Callback
function onMyawardBadgeSuccessHandler(data) {
//data is JSON response
alert("Request was successful");
}
//My Failure Callback
function onMyawardBadgeFailHandler(data) {
//Something went wrong
alert("Something went wrong");
}
</script>
</head>
<body>
<table>
<tr>
<td>Secret Key</td>
<td>
<input type="text" id="tSecretKey" style="width: 500px" />
</td>
</tr>
<tr>
<td>External Account ID</td>
<td>
<input type="text" id="tExternalAccountID" />
</td>
</tr>
<tr>
<tr>
<td>Profile Entity</td>
<td>
<input type="text" id="tProfileEntity" />
</td>
</tr>
<tr>
<td>Badge Name</td>
<td>
<input type="text" id="tBadgeName" />
</td>
</tr>
<td></td>
<td>
<input type="button" onclick="awardBadge($('#tSecretKey').val(), $('#tExternalAccountID').val(), $('#tProfileEntity').val(),
$('#tBadgeName').val(), onMyawardBadgeSuccessHandler, onMyawardBadgeFailHandler)" value="Award Badge" /></td>
</tr>
</table>
</body>
</html>
Responses JSON, XML
XML Response
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="Connecter">
<APIVersion>1.0.0</APIVersion>
<ErrorCode>0</ErrorCode>
<ErrorMessage />
<RequestID>2013-08-16 16:53:44.5302132</RequestID>
<ReturnParam1 />
<ReturnParam2 />
<ReturnParam3 />
<Submitted>true</Submitted>
</Response>
JSON Response
{
"ErrorMessage": "",
"Submitted": true,
"RequestID": "2013-08-16 16:55:26.5792481",
"APIVersion": "1.0.0",
"ReturnParam1": "",
"ReturnParam2": "",
"ReturnParam3": "",
"ErrorCode": 0
}
|
| Use |
Runtime |
| Method |
HTTP GET |
| Invites User |
Yes |
| Billable |
Yes |
| Response |
JSON,XML |
| API Version |
1 |
|