API Reference

AdjustSkill

Adjusts a RedCritter skill that you have created in RedCritter Connecter. You can add or subtract skill points that will affect the user's skill level.

Collapse Variations, Expand Variations

Variation 1

This version of the AdjustSkill command is used to add or subtract skill points for the users and teams specified with the ProfileEntity value.

https://redcritterconnecter.com/services/gamificationv1/AdjustSkill?SecretKey={SecretKey}&ProfileEntity={ProfileEntity}&SkillName={SkillName}&Points={Points}

Name	Type	Required	Description
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.
SkillName	string	yes	The SkillName parameter represents the skill that you want to adjust. This skill must be created in RedCritter Connecter before the AdjustSkill command is called. The following characters cannot be used : \| = [ ] , ;
Points	int32	yes	The Points parameter refers to the number of points associated with this process. This can either be positive (default) or negative by adding a minus (-) sign to the number.

Code Samples

Javascript, C#

AdjustSkill with C#

This is a minmal example of calling the AdjustSkill 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 AdjustSkillResponse
    {
        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 AdjustSkill
    {

        public delegate void OnAdjustSkillResponse(AdjustSkillResponse AdjustSkillResponse);
        public event OnAdjustSkillResponse onAdjustSkillResponse;

        public delegate void OnAdjustSkillResponseError(AdjustSkillResponse AdjustSkillResponse);
        public event OnAdjustSkillResponseError onAdjustSkillResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
        
        public void Execute(String SecretKey, String ProfileEntity, String SkillName, Double Points)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&skillname=" + System.Web.HttpUtility.UrlEncode(SkillName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity) + "&points=" + Points;

                //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 += onAdjustSkillResponseReceived;

                //Make the call
                wc.DownloadStringAsync(new Uri(CONST_ConnecterBaseURL + "services/gamificationv1/AdjustSkill?" + queryString, UriKind.Absolute));
            }
            catch
            {
                //Something went wrong communicating with the server
                if (onAdjustSkillResponseError != null)
                {
                    onAdjustSkillResponseError(null);
                }
            }

        }

        private void onAdjustSkillResponseReceived(object sender, DownloadStringCompletedEventArgs e)
        {
            try
            {
                //Create a JSON serializer
                System.Runtime.Serialization.Json.DataContractJsonSerializer s = new DataContractJsonSerializer(typeof(AdjustSkillResponse));

                //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
                AdjustSkillResponse AdjustSkillResponse = (AdjustSkillResponse)s.ReadObject(ms);

                //Work with the populated response object
                if (AdjustSkillResponse.Submitted == true)
                {
                    //Request was accepted, raise the success event
                    onAdjustSkillResponse(AdjustSkillResponse);
                }
                else
                {
                    //Something went wrong
                    if (onAdjustSkillResponseError != null)
                    {
                        //Request failed, raise the error event
                        onAdjustSkillResponseError(AdjustSkillResponse);
                    }
                }
            }
            catch
            {
                //Something went wrong
                onAdjustSkillResponseError(null);
            }
        }
    }
}

Download

AdjustSkill with JavaScript

This is a minimal example of calling the AdjustSkill 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 adjustSkill(secretKey, profileEntity, skillname, points, cbSuccess, cbFail) {
    $.getJSON(connecterURL + "services/gamificationv1/adjustSkill?jsoncallback=?", { secretKey: secretKey, profileEntity: profileEntity, skillname: 

skillname, points: points },
      function (data) {
          if (data.Submitted) {
              cbSuccess(data);
          } else {
              cbFail(data);
          }
      });
}

        //My Success Callback
        function onMyadjustSkillSuccessHandler(data) {
            //data is JSON response
            alert("Request was successful");
        }

        //My Failure Callback
        function onMyadjustSkillFailHandler(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>Skill Name</td>
            <td>
                <input type="text" id="tSkillName" />
            </td>
        </tr>
        <tr>
            <td>Points</td>
            <td>
                <input type="text" id="tPoints" />
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <input type="button" onclick="adjustSkill($('#tSecretKey').val(), $('#tProfileEntity').val(), $('#tSkillName').val(), 

$('#tPoints').val(), onMyadjustSkillSuccessHandler, onMyadjustSkillFailHandler)" value="Adjust Skill" /></td>
        </tr>
    </table>
</body>
</html>

Download

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-15 20:50:03.0467220</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

JSON Response

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-15 20:51:16.9928338",
  "APIVersion": "1.0.0",
  "ReturnParam1": "",
  "ReturnParam2": "",
  "ReturnParam3": "",
  "ErrorCode": 0
}

Variation 2

This version of the AdjustSkill command is used to add or subtract skill points for the users and teams specified with the ProfileEntity value. The Secret Key must be the App Secret Key.

https://redcritterconnecter.com/services/gamificationv1/AdjustSkill?SecretKey={SecretKey}&ExternalAccountID={ExternalAccountID}&ProfileEntity={ProfileEntity}&SkillName={SkillName}&Points={Points}

Name	Type	Required	Description
SecretKey	string	yes	This SecretKey is an App 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.
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. 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.
SkillName	string	yes	The SkillName parameter represents the skill that you want to adjust. This skill must be created in RedCritter Connecter before the AdjustSkill command is called. The following characters cannot be used : \| = [ ] , ;
Points	int32	yes	The Points parameter refers to the number of points associated with this process. This can either be positive (default) or negative by adding a minus (-) sign to the number.

Code Samples

Javascript, C#

AdjustSkill with C#

        
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 AdjustSkillResponse
    {
        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 AdjustSkill
    {

        public delegate void OnAdjustSkillResponse(AdjustSkillResponse AdjustSkillResponse);
        public event OnAdjustSkillResponse onAdjustSkillResponse;

        public delegate void OnAdjustSkillResponseError(AdjustSkillResponse AdjustSkillResponse);
        public event OnAdjustSkillResponseError onAdjustSkillResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
          
        public void Execute(String SecretKey, String ExternalAccountID, String ProfileEntity, String SkillName, Double Points)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&externalaccountid=" + System.Web.HttpUtility.UrlEncode(ExternalAccountID) + "&skillname=" + System.Web.HttpUtility.UrlEncode(SkillName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity) + "&points=" + Points;

                //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 += onAdjustSkillResponseReceived;

                //Make the call
                wc.DownloadStringAsync(new Uri(CONST_ConnecterBaseURL + "services/gamificationv1/AdjustSkill?" + queryString, UriKind.Absolute));
            }
            catch
            {
                //Something went wrong communicating with the server
                if (onAdjustSkillResponseError != null)
                {
                    onAdjustSkillResponseError(null);
                }
            }

        }

        private void onAdjustSkillResponseReceived(object sender, DownloadStringCompletedEventArgs e)
        {
            try
            {
                //Create a JSON serializer
                System.Runtime.Serialization.Json.DataContractJsonSerializer s = new DataContractJsonSerializer(typeof(AdjustSkillResponse));

                //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
                AdjustSkillResponse AdjustSkillResponse = (AdjustSkillResponse)s.ReadObject(ms);

                //Work with the populated response object
                if (AdjustSkillResponse.Submitted == true)
                {
                    //Request was accepted, raise the success event
                    onAdjustSkillResponse(AdjustSkillResponse);
                }
                else
                {
                    //Something went wrong
                    if (onAdjustSkillResponseError != null)
                    {
                        //Request failed, raise the error event
                        onAdjustSkillResponseError(AdjustSkillResponse);
                    }
                }
            }
            catch
            {
                //Something went wrong
                onAdjustSkillResponseError(null);
            }
        }
    }
}

Download

AdjustSkill with JavaScript

This is a minimal example of calling the AdjustSkill 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 adjustSkill(secretKey, externalAccountID, profileEntity, skillname, points, cbSuccess, cbFail) {
    $.getJSON(connecterURL + "services/gamificationv1/adjustSkill?jsoncallback=?", { secretKey: secretKey, externalAccountID: externalAccountID, profileEntity: profileEntity, skillname: skillname, points: points },
      function (data) {
          if (data.Submitted) {
              cbSuccess(data);
          } else {
              cbFail(data);
          }
      });
}

        //My Success Callback
        function onMyadjustSkillSuccessHandler(data) {
            //data is JSON response
            alert("Request was successful");
        }

        //My Failure Callback
        function onMyadjustSkillFailHandler(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" style="width: 500px" />
            </td>
        </tr>
        <tr>
            <td>Profile Entity</td>
            <td>
                <input type="text" id="tProfileEntity" />
            </td>
        </tr>
        <tr>
            <td>Skill Name</td>
            <td>
                <input type="text" id="tSkillName" />
            </td>
        </tr>
        <tr>
            <td>Points</td>
            <td>
                <input type="text" id="tPoints" />
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <input type="button" onclick="adjustSkill($('#tSecretKey').val(), $('#tExternalAccountID').val(), $('#tProfileEntity').val(), $('#tSkillName').val(), $('#tPoints').val(), onMyadjustSkillSuccessHandler, onMyadjustSkillFailHandler)" value="Adjust Skill" /></td>
        </tr>
    </table>
</body>
</html>

Download

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-15 20:52:36.3534547</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

JSON Response

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-15 20:53:12.4961011",
  "APIVersion": "1.0.0",
  "ReturnParam1": "",
  "ReturnParam2": "",
  "ReturnParam3": "",
  "ErrorCode": 0
}

API Information

Use	Runtime
Method	HTTP GET
Invites User	Yes
Billable	Yes
Response	JSON,XML
API Version	1