API Reference

AdjustRewardPoints

Adjusts the RedCritter reward points for a RedCritter user or team within a certain App Domain. Reward points can be spent by a user on reward items that you configure for the App Domain's rewards store.

Collapse Variations, Expand Variations

Variation 1

This version of the AdjustRewardPoints command adds or subtracts a user or team's reward points based on the ProfileEntity value.

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

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.
Points	int32	yes	The Points parameter refers to he number of reward points you want to adjust. This can either be positive (default) or negative by adding a minus (-) sign to the number.
Comment	string	no	The Comment paramater gives you a chance to explain the reason that the reward points have been adjusted.

Code Samples

Javascript, C#

AdjustRewardPoints with JavaScript

This is a minimal example of calling the AdjustRewardPoints 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 adjustRewardPoints(secretKey, profileEntity, points, comment, cbSuccess, cbFail) {

            $.getJSON(connecterURL + "services/gamificationv1/adjustRewardPoints?jsoncallback=?", { secretKey: secretKey, profileEntity: profileEntity, points: points, comment: comment },
              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>Points</td>
            <td>
                <input type="text" id="tPoints" />
            </td>
        </tr>
        <tr>
            <td>Comment</td>
            <td>
                <input type="text" id="tComment" />
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <input type="button" onclick="adjustRewardPoints($('#tSecretKey').val(), $('#tProfileEntity').val(), $('#tPoints').val(), $('#tComment').val(), onMyAddActionSuccessHandler, onMyAddActionFailHandler)" value="Adjust Reward Points" /></td>
        </tr>
    </table>
</body>
</html>

Download

AwardRewardPoints with C#

This is a minmal example of calling the AwardRewardPoints 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 AdjustRewardPointsResponse
    {
        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 AdjustRewardPoints
    {

        public delegate void OnAdjustRewardPointsResponse(AdjustRewardPointsResponse AdjustRewardPointsResponse);
        public event OnAdjustRewardPointsResponse onAdjustRewardPointsResponse;

        public delegate void OnAdjustRewardPointsResponseError(AdjustRewardPointsResponse AdjustRewardPointsResponse);
        public event OnAdjustRewardPointsResponseError onAdjustRewardPointsResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
        
        public void Execute(String SecretKey, String ProfileEntity, String comment, Double points)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&comment=" + System.Web.HttpUtility.UrlEncode(comment) + "&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 += onAdjustRewardPointsResponseReceived;

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

        }

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

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

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

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 13:25:21.8449993</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

JSON Response

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-15 13:30:04.0334062",
  "APIVersion": "1.0.0",
  "ReturnParam1": "",
  "ReturnParam2": "",
  "ReturnParam3": "",
  "ErrorCode": 0
}

Variation 2

This version of the AwardRewardPoints command adds or subtracts a user or team's reward points. The Secret Key must be the App Secret Key.

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

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.
Points	int32	yes	The Points parameter refers to he number of reward points you want to adjust. This can either be positive (default) or negative by adding a minus (-) sign to the number.
Comment	string	no	The Comment paramater gives you a chance to explain the reason that the reward points have been adjusted.

Code Samples

Javascript, C#

AdjustRewardPoints with JavaScript

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

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

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

Download

AdjustRewardPoints with C#

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

        public delegate void OnAdjustRewardPointsResponse(AdjustRewardPointsResponse AdjustRewardPointsResponse);
        public event OnAdjustRewardPointsResponse onAdjustRewardPointsResponse;

        public delegate void OnAdjustRewardPointsResponseError(AdjustRewardPointsResponse AdjustRewardPointsResponse);
        public event OnAdjustRewardPointsResponseError onAdjustRewardPointsResponseError;

        const string CONST_ConnecterBaseURL = "https://www.redcritterconnecter.com/";
       
        public void Execute(String SecretKey, String ExternalAccountID, String ProfileEntity, String comment, Double points)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "secretkey=" + System.Web.HttpUtility.UrlEncode(SecretKey) + "&externalaccountid=" + System.Web.HttpUtility.UrlEncode(ExternalAccountID) + "&comment=" + System.Web.HttpUtility.UrlEncode(comment) + "&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 += onAdjustRewardPointsResponseReceived;

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

        }

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

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

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

Download

Responses

JSON, XML

XML Result

        
<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 18:58:49.9384315</RequestID>
    <ReturnParam1 />
    <ReturnParam2 />
    <ReturnParam3 />
    <Submitted>true</Submitted>
</Response>

JSON Result

        
{
  "ErrorMessage": "",
  "Submitted": true,
  "RequestID": "2013-08-15 19:00:08.0955205",
  "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