Retrieve External Media

From KickApps Documentation

“External media” is a placeholder within the KickApps media database, allowing you to create rows for content that is hosted on your own site or CMS. This feature allows you to add KickApps-powered comments and ratings to non-KickApps content. You can read more about adding external media in the Add External Media section, below.

Your request will look something like the following.

http://api.kickapps.com/rest/externalmedia/{as}

The response payload returns the data and metadata for the specified external media object (similar to the Retrieve Play Page call).

Note:The comments array will only contain the first 100 comments. You should refer to the Retrieve Comments call for accessing the full comment list.

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

Parameters

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

• as. The site that you are searching. Each affiliate site has a unique as.

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".
• url. Required. The URL of the media to be returned – this should match the value of the pathToMedia parameter that was included when the external media was added to the database.
• incrementView. Optional. Either set to true or false, and tells KickApps whether to increment the view count for that item (Default: false).

Payload

On success, a response that begins with "status":"1","error":"" will be returned with the comment objects and media object.

• comments. The comments object contains a list of all comments that were left on the article.
  • body. Body of the comment.
  • createdAt. The date on which the comment was added.
  • fromUserId. The id for the user who added the comment.
  • isDefaultUserIconUploaded. true or false. True is the webmaster has uploaded a default icon for members.
  • isDisabled. true or false. true if the comment is disabled by the webmaster.
  • isVisible. true or false. true if the comment is visible to the community members.
  • messageId. The id for the comment.
  • pathToPhoto. The path to photo of the commentors profile image.
  • reviewed. true or false. True if the comment has been reviewed by the webmaster.
  • updatedAt. The date on which the comment was last updated.
  • username. Username of the commentor.

• media. The media object contains all the information about the external media that is being requested.
  • isPublicTaggingAllowed. true or false. true if other users can tag this media.
  • categories. Categories that the emedia belongs too.
  • pathToMedia. This is the original pathToMedia value provided when Add External Media was called.
  • adminTags. The admin tags assigned to this media by the webmaster.
  • views. The number of times the media has been viewed.
  • uploadedByName. The username of the member who uploaded this media.
  • isAdultContent. true or false. true if the media is flagged as adult content.This parameter is no longer in use now.
  • updatedAt. The date on which the media was last updated.
  • country. The name of the country that the media is tagged with.
  • pathToPreview48X48. The profile photo of the user who added the external media.
  • inappropriateFlagCount. The number of times the media was flagged as in appropriate.
  • isRatedByMe. T or F. T if the user making this call has already rated the media.
  • tags. Comma separated list of tags assigned to the media.
  • originalFileFormat. The original file format of the media. This parameter will always be return blank for external media.
  • isFavorite. T or F. T if the user making this call as favorited the media being called.
  • userId. The id of the user who added the media.
  • name. The title of the external media. This parameter is the same as the "title" parameter below.
  • description. The description of the media.
  • createdAt. The date on which the media was created.
  • isVisible. true or false. true if the media is visible to the community members.
  • postalCode. The postal code the media is tagged with.
  • title. The title of the external media.
  • isPublicCommentingAllowed. true or false. true if other members can comment on the media.
  • stateOrProvinceName. The U.S. state or Canadian province of the member who uploaded this media.
  • author. The name of the author of the external media specified when the media was first added.
  • reviewed. true or false. True if the comment has been reviewed by the webmaster.
  • city. The name of the city that the media is tagged with.
  • updatedBy. The id of the member who last updated the media.
  • pathToPreview. This parameter is reserved for future use and will always be returned blank.
  • type. This parameter will always return "externalMedia".
  • uploadToLimelight. This parameter is no longer in use.
  • votes. The number of times the media has been rated.
  • averageRating. The average rating calculated by taking the average of all the ratings assigned to the media.
  • isPrivacyEnabled. True if media is private. false if media is public.

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.