Set Video Thumbnail

From KickApps Documentation

This API enables authorized users to set the thumbnail image associated with a video in their KickApps library. The thumbnail IDs of all available thumbnail images for a video are returned by the Get Video Thumbnails API. To set one of those thumbnail images as the thumbnail image for a specific video, authorized users pass its thumbnail ID to this API.

Contents 1 Request 1.1 HTTP Verb 1.2 URI 1.3 URI Parameters 1.4 Post Parameters 2 Permissions 3 Response: Success 3.1 HTTP Status Code 4 Response: Error 4.1 HTTP Status Code 4.2 Invalid Token 4.3 No video ID or video ID is marked as deleted 4.4 No thumbnail with thumbnailId 5 List of KickApps API Calls

Request

HTTP Verb

GET

URI

http://api.kickapps.com/rest/customers/asId/videos/videoId/thumbnail/set

URI Parameters

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

• asId. The affiliate site ID for the site to which the given video belongs.
• videoId. The ID of the video.

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".
• thumbnailId. Integer. The ID of the thumbnail you wish to use for the designated video, as returned by the get thumbnails API.

Permissions

• Affiliate Webmaster: The Affiliate Webmaster may set the thumbnail on any video in his/her AS ID.
• Editors: Editors may set the thumbnail on any video within their AS ID, except for videos contributed by the Affiliate Webmaster or by Admins within their AS ID.
• Admins: Admins may set the thumbnail on any video within their AS ID, except for videos contributed by the Affiliate Webmaster.
• Members: Members may only set the thumbnail on videos that they have contributed.

Response: Success

HTTP Status Code

200 OK

{
  "status": "1",
  "message": "Video #{videoId} is now using thumbnail ID #{thumbnailId}."
}

Response: Error

HTTP Status Code

400

Invalid Token

{
  "status": "-1",
  "message": "Invalid token"
}

No video ID or video ID is marked as deleted

{
  "status": "-1",
  "message": "There is not a video with videoId #{the video ID passed into the URI}."
}

No thumbnail with thumbnailId

{
  "status": "-1",
  "message": "Video #{videoId} does not have a thumbnail whose ID is #{thumbnailId}.  Please try another thumbnailId."
}

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.