API Reference

AddAction

Triggers one of the actions that you have created in RedCritter Connecter. This can affect a user's badges, certs, leaderboard standings or skills. If you call AddAction with an action name that doesn't exist, RedCritter will create the action for you. You can configure the action in the RedCritter Connecter portal afterwards.

Collapse Variations, Expand Variations

Variation 1

This version of the AddAction command is used to add action points to the users and teams specified with the ProfileEntity value.

https://redcritterconnecter.com/services/gamificationv1/AddAction?SecretKey={SecretKey}&ProfileEntity={ProfileEntity}&ActionName={ActionName}&Value={Value}

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.
ActionName	string	yes	The ActionName represents the action that you want to trigger. If the action already exists, it will be run as normal. If it doesn't exist yet, it will be created and triggered. The following characters cannot be used : \| = [ ] , ;
Value	double	yes	The Value parameter represents a point value that can be associated with the triggered action. This can be a positive or a negative decimal number.

Code Samples

Javascript, C#

AddAction with C#

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

        public delegate void OnAddActionResponse(AddActionResponse addActionResponse);
        public event OnAddActionResponse onAddActionResponse;

        public delegate void OnAddActionResponseError(AddActionResponse addActionResponse);
        public event OnAddActionResponseError onAddActionResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";

        public void Execute(String SecretKey, String ProfileEntity, String ActionName, Double Value)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&actionname=" + System.Web.HttpUtility.UrlEncode(ActionName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity) + "&value=" + Value;

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

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

        }

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

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

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

Download

AddAction with Javascript

This is a minimal example of calling the AddAction API via HTML and Javascript. Remember to never use your Secret Keys on the client side.

        
<!DOCTYPE html>
<html>
<head>
    <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 addAction(secretKey, profileEntity, actionName, value, cbSuccess, cbFail) {
            $.getJSON(connecterURL + "services/gamificationv1/addaction?jsoncallback=?", { secretKey: secretKey, profileEntity: profileEntity, actionName: actionName, value: value },
              function (data) {
                  if (data.Submitted) {
                      cbSuccess(data);
                  } else {
                      cbFail(data);
                  }
              });
        }

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

        //My Failure Callback
        function onMyAddActionFailHandler(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>Action Name</td>
            <td>
                <input type="text" id="tActionName" />
            </td>
        </tr>
        <tr>
            <td>Value</td>
            <td>
                <input type="text" id="tValue" />
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <input type="button" onclick="addAction($('#tSecretKey').val(), $('#tProfileEntity').val(), $('#tActionName').val(), $('#tValue').val(), onMyAddActionSuccessHandler, onMyAddActionFailHandler)" value="Add Action" /></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-14 15:37:44.8153379</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

JSON Response

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-14 15:39:50.9514758",
  "APIVersion": "1.0.0",
  "ReturnParam1": "",
  "ReturnParam2": "",
  "ReturnParam3": "",
  "ErrorCode": 0
}

Variation 2

This version of the AddAction command is used to add action points to the users and teams specified with the ProfileEntity value. The Secret Key must be the App Secret Key.

https://redcritterconnecter.com/services/gamificationv1/AddAction?SecretKey={SecretKey}&ExternalAccountID={ExternalAccountID}&ProfileEntity={ProfileEntity}&ActionName={ActionName}&Value=(Value}

Name	Type	Required	Description
SecretKey	string	yes	This SecretKey is an 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. 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.
ActionName	string	yes	The ActionName represents the action that you want to trigger. If the action already exists, it will be run as normal. If it doesn't exist yet, it will be created and triggered. The following characters cannot be used : \| = [ ] , ;
Value	double	yes	The Value parameter represents a point value that can be associated with the triggered action. This can be a positive or a negative decimal number.

Code Samples

Javascript, C#

AddAction for App Domain with JavaScript

This is a minimal example of calling the AddAction API via HTML and Javascript. Remember to never use your Secret Keys on the client side.

        
<html>
<head>
    <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 addAction(secretKey, externalAccountID, profileEntity, actionName, value, cbSuccess, cbFail) {

            $.getJSON(connecterURL + "services/gamificationv1/addaction?jsoncallback=?", { secretKey: secretKey, externalaccountid: externalAccountID, profileEntity: profileEntity, actionName: actionName, value: value },
              function (data) {
                  if (data.Submitted) {
                      cbSuccess(data);
                  } else {
                      cbFail(data);
                  }
              });
        }

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

        //My Failure Callback
        function onMyAddActionFailHandler(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>ExternalAccountID</td>
            <td>
                <input type="text" id="tExternalAccountID" />
            </td>
        </tr>
        <tr>
            <td>Profile Entity</td>
            <td>
                <input type="text" id="tProfileEntity" />
            </td>
        </tr>
        <tr>
            <td>Action Name</td>
            <td>
                <input type="text" id="tActionName" />
            </td>
        </tr>
        <tr>
            <td>Value</td>
            <td>
                <input type="text" id="tValue" />
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <input type="button" onclick="addAction($('#tSecretKey').val(), $('#tExternalAccountID').val(), $('#tProfileEntity').val(), $('#tActionName').val(), $('#tValue').val(), onMyAddActionSuccessHandler, onMyAddActionFailHandler)" value="Add Action" /></td>
        </tr>
    </table>
</body>
</html>

Download

AddAction 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 AddActionResponse
    {
        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 AddAction
    {

        public delegate void OnAddActionResponse(AddActionResponse addActionResponse);
        public event OnAddActionResponse onAddActionResponse;

        public delegate void OnAddActionResponseError(AddActionResponse addActionResponse);
        public event OnAddActionResponseError onAddActionResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";

        public void Execute(String SecretKey,String ExternalAccountID, String ProfileEntity, String ActionName, Double Value)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&externalaccountid=" + System.Web.HttpUtility.UrlEncode(ExternalAccountID) + "&actionname=" + System.Web.HttpUtility.UrlEncode(ActionName) + "&profileentity=" + System.Web.HttpUtility.UrlEncode(ProfileEntity) + "&value=" + Value;

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

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

        }

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

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

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

Download

Responses

JSON, XML

Test 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-14 15:37:44.8153379</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

Test JSON Response

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-14 15:39:50.9514758",
  "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