Retrieve Member Profile

From KickApps Documentation

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

Overview

This is the new and improved Retrieve Member Profile call. This call has all the data that we have available on our hosted profile pages minus the fat that the older profile call had for the member's media, enabling this call to have a much improved response time.

This call will only contain the following information for the members media: mediaId, description, name and pathToPreview. All other members media data has been descoped.

The "Watch this member" feature that appears on hosted profile pages is not offered by the REST API.

Your request will look something like the following:

http://api.kickapps.com/rest/user/profile/{userId}/{as}

Parameters

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

• userId. Integer. The ID number of the member whose profile is being retrieved.
• as. Integer. The ID number of the KickApps community site that this media id is associated with. 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".
• include. Comma Delimited String. Optional. Use the include parameter to include addtional data from a the get user profile call. Accepted values: basic, audios, blogs, photos, videos, sets, friends, favoriteAudios, favoriteVideos, favoritePhotos, favoriteExternalMedias, favoriteSets, favoriteBlogs, sets
  • Note: The field value, basic indicates you want all fields that are not (audios, blogs, photos, videos, sets, friends, favoriteAudios, favoriteVideos, favoritePhotos, favoriteExternalMedias, favoriteSets, favoriteBlogs, sets) returned in the payload. (It's intentionally not an exclude parameter.)
• exclude. Comma Delimited String. Optional. Use the exclude parameter to exclude data from a the get user profile call. Accepted values: audios, blogs, photos, videos, sets, friends, favoriteAudios, favoriteVideos, favoritePhotos, favoriteExternalMedias, favoriteSets, favoriteBlogs, sets

JSON Payload

On success, a return that begins with "status":"1","error":"".

• lastLoggedIn. The date the user last logged into the community. Shown "lastLoggedIn":"27 Mar 2009 08:16:58 GMT"
• birthday. The value for the user's date of birth. Shown "birthday":"1 Jan 1946 18:30:00 GMT"
• averageRating. The average of all ratings issued for this member.
• favoritePhotos. A comma-separated list of the user's favorite photos. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• favoriteExternalMedias. A comma-separated list of the user's favorite external media. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":""}
• isVerified. true or false. Returns whether a users email address has been verified by him or now. Applicable to communities that have email verification set to 'on'.
• votes. The number of votes issued for this member by other members.
• pathToPhoto. The URL to the members full profile photo.
• aboutMe. A personal statement from the member.
• blogs. A comma-separated list of the blog posts added by this member. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• updatedBy. The numeric Id of the member who last updated this profile.
• city. The member's home city.
• numComments. The number of comments on that have been left on the members' profile.
• id. The numeric Id for the member who owns the profile.
• userId. The numeric Id for the member who owns the profile.
• audios. A comma-separated list of the audio files added by this member. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• qandAnswer. The user’s responses to the 10 custom profile questions. Contains a list of nodes named question and answer.
• username. The username of the member who owns the profile.
• friends. A comma-separated list of the friends associated with this member.
• postalCode. The member's postal or zip code.
• age. The members age as specified by the member.
• gender. M for male. F for female. This is an option a member selects during registration.
• stateOrProvince. The U.S. state or Canadian province.
• astrologicalSign. Aries, Taurus, Gemini, Cancer, Leo, Virgo, Libra, Scorpio, Sagittarius, Capricorn, Aquarius, or Pisces. Members' astrological signs are calculated from their birth date, although members can also manually enter their astrological signs in their profiles.
• favoriteVideos. A comma-separated list of the user's favorite videos. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• offset. The numeric value for the offset points given by the webmaster to the user. Can be negative. Only applicable to communities that have the Points and Level feature turned 'on' in the AC.
• firstName. String. The member's first name. firstName can have up to 32 characters, including special characters.
• memberSince. The date the user joined the community. Shown "memberSince":"7 Jul 2006 13:57:41 GMT",
• lastName. The member's last name. lastName can have up to 32 characters, including special characters.
• favoriteBlogs. A comma-separated list of the user's favorite blog posts. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• favoriteAudios. A comma-separated list of the user's favorite audio files. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• videos. A comma-separated list of the videos added by this member. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• pathToIcon. The URL to the stored thumbnail for the member's profile photo.
• isDeliveredToEmail. true or false. Default is true. This is an option that members can select via the edit account page in My Home. If this option is selected (isDeliveredToEmail="false") then members are opting out of receiving emails on their personal email addresses, specified during registeration, but will continue to recieve emails in their community inbox.
• photos. A comma-separated list of the photos added by this member. Shown {"description":"","id":"","name":"","pathToPreview":"","pathToMedia":"","isPrivacyEnabled":""}
• isDisabled. true or false. Default is false. In the Affiliate Center's Member Management area, affiliates can see and manage member status's (pending/approved/disabled). If a member or media is disabled or pending, then the value for this field will be returned as true. A disabled/pending member is not searchable and is not visible to other members or in community feeds/pages.
• updatedAt. A nested object stating when the members' profile was last updated. Shown "updatedAt":"22 Dec 2008 13:33:43 GMT",
• systemGeneratedPoints. Numeric value for the points that a user has attained through interacting with the community. Only applicable to communities that have the Points and Level feature turned 'on' in the AC. Can be negative.
• favoriteCount. This is a placeholder for a future feature.
• createdBy.
• email. The member's email address.
• views. The number of times others have viewed this profile.
• isCurrentPortraitApproved. true or false. Whether the current portrait selected by the member is approved.
• memberLevel. The level the member is currently assigned. Only applicable to communities that have the Points and Level feature turned 'on' in the AC.
• totalPoints. A sum of members' offset and system generated points. Only applicable to communities that have the Points and Level feature turned 'on' in the AC. Can be negative.
• categories. The category that the member is assigned to. A member can assign himself to a category created by the affiliate using the edit profile page. An affiliate can assign a category to a member through the member details page.
• country. The member's country of residence.
• countryCode. The members country code.
• links. Returns a comma-separated list of the links added by the member.
• address1. The member's first address.
• address2. The member's second address.
• address3. The member's third address.
• adminTags. The admin tags assigned to the user by the webmaster.
• facebookUserId. The facebook Id for that user.
• profilePrivacy. Returns the users profile privacy settings. The value ”E” will be returned when when the profile is public. The value “F” will be returned when the profile is private.
• sets. A comma-separated list of the sets added by this member. Shown {"description":"","id":"","name":"","pathToPreview":"","createdAt":""}
• favoriteSets. A comma-separated list of the user's favorite sets. Shown {"description":"","id":"","name":"","pathToPreview":"","createdAt":""}
• isRatedByMe. Boolean. True if the profile was rated by the user whose token is being used. False if the profile has not yet been rated by the member whose token is being used.
• role. String. The role of the member whose profile is being accessed. The following Roles are available in the KickApps System - "MEMBER", "EDITOR", "ADMIN", or "WEBMASTER"
• inappropriateFlagCount. - Integer. The number of times the members profile has been flagged.

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.