Retrieve Related Media

From KickApps Documentation

Template:AvailableJuly22 Use this call to retrieve related items for a media by passing its media id.

http://api.kickapps.com/rest/media/related/{mediaType}/{mediaId}/{as}

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

Parameters

• mediaType. Required. String. Suported media types: audio, video, photo, set and blogs
• as. Required. Integer. The site that the media belongs to. 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".

Payload

On success, a payload that starts with status = 1 is returned. For each related media the following information is returned. Note: This call is only supported in JSON format.

• author. The username of the member who uploaded the media.
• avgRating. The average rating calculated using all the ratings issued for this media.
• createdAt. A nested object stating when the media was created in the following format. All times are returned as Greenwich Mean Time (GMT).

dayOfMonth month hour:minute:second GMT

This would appear as follows:

"createdAt":"22 Feb 2008 02:07:19 GMT"

• id. The id of the media.
• keywords. A comma separated list of Keywords assigned to the media.
• mediaAdminTag. A comma-separated list of tags added by administrators or webmasters.
• mediaType. The type of media.
• name. The name of the media.
• playpageurl. The url of the play page.
• siteId. The affiliate site ID that the media belongs to.
• siteName. The name of the site that the media belongs to.
• thumb_320_240. The path to media preview in 320x240 dimension.
• url. The url for the media location.
• userId. User id for the member who uploaded the media.
• views. The number of times this media item was viewed. views increments each time the media item is viewed.
• totalMediaItems. Only returned when Set media type is used. It is the total number of media items inside the set.

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.