Rate Media

From KickApps Documentation

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

Overview

Given a media id, rate the media item with a thumbs up / thumbs down, vote or star rating. You can make an HTTP POST or GET request when using this call.

For contest entries and media with a voting type of:

• vote, the only rating allowed will be 1.
• thumbs, the only ratings allowed will be integers 1 (down) or 5 (up).
• stars, the only ratings allowed will be integers from 1( worst)-5 (best).

Note: These ratings are discretely accumulated as number of ratings of value 1,... number of ratings of value 5.

Request URL

http://api.kickapps.com/rest/rate/{rating}/{mediaType}/{mediaId}/{as}

Request Parameters

Required

• t - the user token generated via the "Create Token" API call.
• mediaId – media id
• mediaType – media Type
• rating – Integers from 1 to 5
  • Where:
    • VotingType for contest entries:
      • Thumbs only allows a rating of 1 (down) or 5 (up)
      • Vote only allows a rating of 1
      • Stars only allows integers from 1 through 5
      • Votes aren’t allowed if a mediaObject is a contest entry in a contest where voting isn’t enabled.
    • For media that’s not a contest entry:
      • Any integer from 1 through 5

Response Parameters

• status – 1 on success and -1 on error.
• error – A message indicating the error condition
• errid – A numeric reference to the error condition
• ratingAdded – Boolean value that indicates the comment was rated successfully.
• rating - The average of all ratings for this media.
• votes - The number of ratings issued.
• numOfTimesRated1. The number of times this media item was rated 1. (In scope of Contests release.)
• numOfTimesRated2. The number of times this media item was rated 2. (In scope of Contests release.)
• numOfTimesRated3. The number of times this media item was rated 3. (In scope of Contests release.)
• numOfTimesRated4. The number of times this media item was rated 4. (In scope of Contests release.)
• numOfTimesRated5. The number of times this media item was rated 5. (In scope of Contests release.)

Error codes:

• 69 - Invalid rating for contest entry of voting type <votes || thumbs || stars>
• 70 - Votes aren’t allowed for this contest at this time

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

Contests Add Contest Edit Contest View Contest Retrieve All Contests Add Contest Entry Edit Contest Entry Remove Contest Entry View Contest Entry Retrieve Entries for Contest Select Contest Winner Flag Contest Entry Points and Levels Add to Member Offset Retrieve Member Points Set Member Custom Level Set Member Offset 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.