From KickApps API Reference

Contents 1 Overview 2 Parameters 3 Post Parameters 4 JSON Payload 5 Permissions 6 List of KickApps API Calls

Overview

This call enables you to reset the offset value for a member. To add (or substract) points from member offset, see Add to Member Offset

systemGeneratedPoints: are points earned by community members for completing various tasks like adding media, friends, etc.

offset: are points that the webmaster gives to a member in addition to the points he has earned through participating in the community. These points are tracked separately from the system generated points.

totalPoints: is the sum of systemGeneratedPoints and offset.

levels: webmasters can also define Levels, which are essentially status titles earned by the member (like Super Member, Ninja, etc.) when they have accumulated the required number of points.

customLevel: are special level's (Webmaster, Editor, etc.) that can be assigned to a community member outside of the regular points and level system. These levels will supercede the levels defined in the points system.

You can make an HTTP POST or GET request when using this call.

Your request will look something like the following:

http://api.kickapps.com/rest/points/setoffset/{userId}/{as}

Parameters

As shown above, your call will include the following parameters:

• userId. The id of the user whose offset is being reset.
• as. The site Id to search. as is unique for each of the affiliate's sites.

Post Parameters

• t. String. Required. Your access permissions.
• callback. String. Optional. The name of your JavaScript callback function.
• clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".
• offset. Required. Integer. The value for the offset. Accepts negative values.

JSON Payload

• userId. The numeric id for the user whose offset was reset.
• totalPoints. A sum of members' offset and system generated points.
• offset. The numeric value for the new offset value.
• systemGeneratedPoints. Numeric value for the points that a user has attained through interacting with the community.
• memberLevel. The level the member is currently assigned.
• username. The username of the member whose points are being requested.
• pathToIcon. The path to the stored thumbnail for this user.

Permissions

Only webmaster and editor should be able to use this call.

List of KickApps API Calls

Create Token Social Networking Retrieve Member Profile ( Updated!) Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" KickConnect Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads 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 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 Search Search

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 Media Sets (Private Beta) Add Media Set Points and Levels Add to Member Offset Retrieve Member Points Set Member Custom Level Set Member Offset Categories and Tags Add Tags To 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 Retrieve Pending Media Retrieve Active Member Count

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.

This page was last modified on 16 October 2009, at 11:04. - This page has been accessed 310 times. -

About KickApps API Reference