List Badges

From KickApps Documentation

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

Overview

This method is an admin method that will list all badges for an AS either site-wide or for a specific location. This can be further filtered by published status. This method will require a Webmaster / moderator token.

Request URL

 
http://api.kickapps.com/rest/badges/list/{as}

Request Parameters

Required

• t - the user token generated via the "Create Token" API call. Must be a webmaster / moderator token.
• as - The site Id to search. as is unique for each of the affiliate's sites.

Optional

• callback. String. Optional. The name of your JavaScript callback function.
• location – customer’s designation of the area of their web site the queried badges belong to [64 characters] If omitted from the query, all badges for this AS are returned. If specified, only badges associated with the location will be returned.
• published – if true, returns all published badges. If false, returns all badges that aren’t published. If not provided in the query, all badges are returned regardless of their published status.

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…});

Success:
{
   "status":1,
   "badges":[
      {
         "badgeId":"1234",
   "location":"XXXX",
         "name":"XXXX",
         "verbosename":"XXXX",
         "published":"true",
         "url":"http://someimage.com/image.jpg",
         "link":"http://someurlontheweb.com"
      },
      {
         "badgeId":"2345",
   "location":"YYYY",
         "name":"YYYY",
         "verbosename":"YYYY",
   "published":"false",
         "url":"http://someimage.com/image.jpg",
   "link":"http://someurlontheweb.com"
      }
   ]
}

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

Response Parameters

• status – 1 on success and -1 on error.
• error – A message indicating the error condition
• errorId – A numeric reference to the error condition
• badges
• badgeId – The ID of the badge just added into the system.
• location – location of badge in site
• name – brief name of badge
• verbosename – Verbose name of badge
• published – true, false (Is the badge turned on?)
• url – A URL to the badge's image file.
• link – link to area associated with this badge – no validation

errorId and errors

(*Note: This error may only occur if the corresponding optional request parameter is provided. Null values provided for optional parameters result in ignoring the parameter; treating it as if it was not provided. While the error message may read “cannot be null”, there will never be a condition where a null value for an optional parameter can result in an error.)

• 1 = invalid token
• 7 = invalid value for published (must be true or false) (*)
• 8 = location cannot be blank (*)
• 18 = Insufficient user permissions for this operation
• 20 = location cannot exceed 64 characters
• 44 = token required

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.