Get Super Fan Ranking

From KickApps Documentation

Contents 1 Overview 2 Request URL 3 Request Parameters 4 Response 5 Response Fields 6 List of KickApps API Calls

Overview

This method returns a user’s badge earning ranking by specified location. “Locations" is returned containing the location and rank of the specified user within that location. Rank is determined by a “descending sort of badge quantity” + “timestamp of user’s last earned badge for the location” by location for the specified user; users with the same number of badges (a tie) are given a higher ranking by time the last badge was awarded. Use Case: The user’s profile displays a user’s superfan rank for each site location. The users returned in the result set must have earned enough badges to meet or exceeded the number of badges required for the specified location.

Request URL

http://api.kickapps.com/rest/mostbadged/userrank/get/{as}

Request Parameters

Required

• t - the user token generated via the "Create Token" API call.
• as - The site Id to search. as is unique for each of the affiliate's sites.
• locations – A comma separated list of location identifiers that corresponds to a page / area within the community. Standard comma separated conventions will be followed; e.g. “51, area”, area, “area 42”.

Optional

• user_id – the user ID of the user we’re retrieving super fan ranking of. (When this is not provided, the user_id will be derived from the token.)
• callback. String. Optional. The name of your JavaScript callback function.

Response

Note: if callback is provided as an optional argument, the results illustrated below will be returned within the callback string provided for execution of a JavaScript function; e.g. callback=”MyCallbackFunc” will return something similar to:

MyCallbackFunc({…the success or failure response contained in curly braces you see below…});

Note: Any location where the user has not fulfilled defined criteria will return a rank of 0. Note: A disabled user will return a rank of 0.

Success:
{
   "status":1,
   "userId":"XXXX",
   "locations":[
      {
         "location":"51,area",
         "rank":"4"
      },
      {
         "location":"area",
         "rank":"1"
      },
      {
         "location":"area 42",
         "rank":"0"
      },
      {
         "location":"area with undefined superfan criteria",
         "rank":"NAN"
      },
      
   ]
}

Failure:  {"status": -1, "errorId": "123", "error": "Error Message"}

Response Fields

• status – 1 on success and -1 on error.
• userId – the ID of the user whose badges are being retrieved.
• error – A message indicating the error condition
• errorId – A numeric reference to the error condition
• locations – list of location and rank sets for the user_id
  • location – A location identifier that corresponds to a page / area within the community.
  • rank – The badge earning rank of this user for this location
  • time – human readable time the rank was established (“3 Nov 2010 08:21:48 GMT”)

Error codes:

• 1 = invalid token
• 44 = token required
• 46 = locations cannot be null or blank

List of KickApps API Calls

API Change Log Create Token Call Social Networking Retrieve Member Profile Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" Retrieve User by Facebook Id KickConnect Assign Member Profile Photo Remove Member Profile Photo Member Profile Edit/Update SSO Method Member Register SSO Method Combined Member Sign On and Register SSO Method Member Change Username SSO Method Member Change Email SSO Method OpenAuth Create Message Board Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Delete Member Media Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Retrieve Related Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads Get Video Thumbnails Set Video Thumbnail Blogging Add Blog Post Edit Blog Post Comments and Rating Add External Media Retrieve External Media Edit External Media Add Group Comment Add Media Comment Add Profile Comment Retrieve Comments Search Comments Edit Comment Edit Group Comment Delete Comment Delete Group Comment Flag Comment Flag Group Comment Rate Media Retrieve Media Ratings Retrieve Media Rated By Member Retrieve Likes By User ID Search Search Media Sets Add Media Set Edit Set Retrieve Set Delete Set Add Media to Set Remove Media from Set Groups Add Group Retrieve Group Page Edit Group Request A Group Add/Remove Media To Group Add/Remove Member To Group Retrieve Member Groups Upload Group Photo Remove Group Photo Polls Creating Polls Using the Tag API’s

Badges Add Badge Edit Badge List Badges Add Action List Actions Add Badge Requirement Edit Badge Requirement List Badge Requirements Add User Action Retrieve User's Badges Retrieve User's Badge Status Retrieve Super Fans Get Super Fan Ranking Set Super Fan Badge Criteria Categories and Tags Add Tags To Media, Members and Groups Remove Tags From Media, Members and Groups Add Admin Tags To Media, Members and Groups Remove Admin Tags From Media, Members and Groups Retrieve Admin Tags Retrieve Tag Count Add Category Edit Category Retrieve Category Delete Category Add Custom Meta Data Remove Custom Meta Data Retrieve Custom Meta Data Member and Media Management Approve Member Reject Member Approve Member Media Reject Member Media Delete Member Media Retrieve Pending Media Retrieve Active Member Count Retrieve Site Settings CRM Connectors KickApps SugarCRM Connector KickApps Salesforce Connector CRM Connectors (COMING SOON!!) IBM Websphere Microsoft Dynamic CRM NetSuite Oracle CRM On Demand Oracle E-Business Suite CRM PeopleSoft Enterprise CRM Oracle Siebel CRM SAP CRM Sugar Professional Maximizer CRM Pegasystems Customer Process Manager

Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.