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 set a custom level for a member.

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/setlevel/{userId}/{as}

Parameters

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

• userId. The id of the user whose points are being returned.
• 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".
• customLevel. Required. The actual text or HTML for the custom level. Doesn't have a character limit.

JSON Payload

On success, a return that begins with "status":"1","message":"Custom level set succesfully". On failiure, a return that begins with "status":"-1","message":"Custom level could not be set".

Permissions

Only webmaster, admin and editors can access this call.

This page was last modified on 20 July 2010, at 21:12. - This page has been accessed 637 times. -

About KickApps API Reference