Set Member Custom Level

From KickApps Documentation

Jump to: navigation, search

Contents

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

Overview

KIT Cloud Social API call that lets you post activities done outside the community into the community activity feeds for members.

Your request will look something like the following:

http://api.kickapps.com/rest/kickconnect/{memberId}/{as} 

Parameters

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

  • memberId. The id of the user for who the update is being made.
  • 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".
  • storyContent. Required. Accepts HTML and text. Allows 5,000 characters. Be sure to urlEncode the string that you pass for this variable.
  • storyIcon. Optional. url of the image to be associated with the story. Recommended size is 16 X 16.
  • postedFromSource. Optional. This is the name of the service from which the activity is being posted from. Allows 200 characters.
  • postToGroups. Optional. Should accept comma separated groupID's. Should only post to a group if the user is a member of that group.

JSON Payload

  • On success, the call will return "status":"1","message":"Story published successfully."
  • On failure, the call will return "status":"-1","message":"Story could not be published. Please make sure that the provided information is accurate."
  • If the user doesn't belong to the group(s) return, "status":"-1","message":"Story could not be published. Please make sure that the member belongs to the group(s)."

Permissions

List of Kit Cloud Social API Calls


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.