GetUserProfileVersion

Retrieves the version number of various sections of a RedCritter profile.

This retrieves a list of the version numbers of various parts of the profile. This can help determine if you have the most recent version of information about badges, accolades, certs, etc… This minimizes the need to pull down the entire profile if it hasn't been updated recently.

https://redcritterconnecter.com/services/gamificationv1/GetUserProfileVersion?userID={userID}

Name	Type	Required	Description
UserID	string	yes	The User ID of a RedCritter user.

Code Samples

Javascript, C#

GetUserProfileVersion with JavaScript

This is a minmal example of calling the GetUserProfileVersion 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.

        
<!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>

    <style type='text/css'>
body {
font-family: "Arial";
}
.rctable{
padding-top:20px;
padding-bottom:10px;
border-bottom:solid 1px #ccc;
width:600px;
}
.rclabel {
font-size:14px;
font-weight:bold;
}
.rcval{
font-size:14px;
padding-left:10px;
}
    </style>

    <script type="text/javascript">
	   var connecterURL = "https://www.redcritterconnecter.com/";

	function getUserProfileVersion(userID, cbSuccess, cbFail) { 
 		   $.getJSON(connecterURL + "services/gamificationv1/getUserProfileVersion?jsoncallback=?", { userID: userID },
   	   function (data) {
   		       if (data.Result) { 
              cbSuccess(data);
    	      } else { 
   	           cbFail(data);
  	        }
 	     });
	}

     //My Success Callback
        function onMygetUserProfileVersionSuccessHandler(data) {
            //data is JSON response
            renderItems(data)
        }

        //My Failure Callback
        function onMygetUserProfileVersionFailHandler(data) {
            //Something went wrong
            alert("Something went wrong");
        }

	//Sample function to generate the list output in html
        function renderItems(data) {

        var h = "";
	var h = "<table class='rctable'>";
 	h += "<tr><td class='rclabel'>UserID : </td><td class='rcval'>" + HTMLEncode(data.UserID) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version: </td><td class='rcval'>" + HTMLEncode(data.Version) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Accolades: </td><td class='rcval'>" + HTMLEncode(data.VersionAccolades) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version AppDomains: </td><td class='rcval'>" + HTMLEncode(data.VersionAppDomains) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Apps: </td><td class='rcval'>" + HTMLEncode(data.VersionApps) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Badges: </td><td class='rcval'>" + HTMLEncode(data.VersionBadges) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Certs: </td><td class='rcval'>" + HTMLEncode(data.VersionCerts) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Feed: </td><td class='rcval'>" + HTMLEncode(data.VersionFeed) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Leaderboards: </td><td class='rcval'>" + HTMLEncode(data.VersionLeaderboards) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Profile: </td><td class='rcval'>" + HTMLEncode(data.VersionProfile) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Rewards: </td><td class='rcval'>" + HTMLEncode(data.VersionRewards) + "</td></tr>"
	h += "<tr><td class='rclabel'>Version Skills: </td><td class='rcval'>" + HTMLEncode(data.VersionSkills) + "</td></tr>"
	h += "</table>";
	$("#results").html(h);
   	//display the results
            $("#results").html(h);
        }


        function HTMLEncode(str) {
            var div = document.createElement('div');
            var text = document.createTextNode(str);
            div.appendChild(text);
            return div.innerHTML;
        }
    </script>
</head>
<body>
    <table>
        <tr>
            <td>User ID</td>
            <td>
                <input type="text" id="tUserID" style="width: 500px" />
            </td>
        </tr>

        <tr>
            <td></td>
            <td>
                <input type="button" onclick="getUserProfileVersion($('#tUserID').val(), onMygetUserProfileVersionSuccessHandler, onMygetUserProfileVersionFailHandler)" value="Get User Profile" /></td>
        </tr>
    </table>
    <br />
    <div id="results"></div>
</body>
</html>

Download

GetUserProfileVersion 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 GetUserProfileVersionResponse
    {   
        public Boolean Result { get; set; }
        public String UserID { get; set; }
        public String Version { get; set; }
        public String VersionAccolades { get; set; }
        public String VersionAppDomains { get; set; }
        public String VersionApps { get; set; }
        public String VersionBadges { get; set; }
        public String VersionCerts { get; set; }
        public String VersionFeed { get; set; }
        public String VersionLeaderboards { get; set; }
        public String VersionProfile { get; set; }
        public String VersionRewards { get; set; }
        public String VersionSkills { get; set; }
    }


    public class GetUserProfileVersion
    {

        public delegate void OnGetUserProfileVersionResponse(GetUserProfileVersionResponse GetUserProfileVersionResponse);
        public event OnGetUserProfileVersionResponse onGetUserProfileVersionResponse;

        public delegate void OnGetUserProfileVersionResponseError(GetUserProfileVersionResponse GetUserProfileVersionResponse);
        public event OnGetUserProfileVersionResponseError onGetUserProfileVersionResponseError;

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

        public void Execute(String UserID)
        {
            try
            {
                //Create url encoded parameters in query string
                String queryString = "userid=" + System.Web.HttpUtility.UrlEncode(UserID);

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

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

        }

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

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

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

Download

Responses

JSON, XML

XML Response

        
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="Connecter">
    <Result>true</Result>
    <ResultMessage />
    <ResultTitle />
    <UserID>135</UserID>
    <Version>635127884996507238</Version>
    <VersionAccolades>635127884996507238</VersionAccolades>
    <VersionAppDomains>635123013179790405</VersionAppDomains>
    <VersionApps>635121087215174449</VersionApps>
    <VersionBadges>635126894873000974</VersionBadges>
    <VersionCerts>635125182660204931</VersionCerts>
    <VersionFeed>635126894873000974</VersionFeed>
    <VersionLeaderboards>0</VersionLeaderboards>
    <VersionProfile>635127884996507238</VersionProfile>
    <VersionRewards>635123013179790405</VersionRewards>
    <VersionSkills>635126009836777025</VersionSkills>
</Response>

JSON Response

        
{
  "UserID": 135,
  "Version": 635127884996507238,
  "VersionApps": 635121087215174449,
  "VersionAppDomains": 635123013179790405,
  "VersionProfile": 635127884996507238,
  "VersionAccolades": 635127884996507238,
  "VersionBadges": 635126894873000974,
  "VersionCerts": 635125182660204931,
  "VersionLeaderboards": 0,
  "VersionSkills": 635126009836777025,
  "VersionRewards": 635123013179790405,
  "VersionFeed": 635126894873000974,
  "Result": true,
  "ResultTitle": "",
  "ResultMessage": ""
}

API Information

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