Retrieve Set

From KickApps Documentation

Use this call to retrieve all meta data associated with a set.

http://api.kickapps.com/rest/sets/get/{setId}/{as}

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

Parameter

• setId. The set Id of the set whose media is being retrieved.
• as. Required. Integer. The site that the media set is being added to. as is unique for each of the affiliate's sites.

Post Parameter

• 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

• adminTags. A comma-separated list of tags added by administrators or webmasters.
• author The username of the member who created the set.
• averageRating. The average rating calculated using all the ratings issued for this set.
• categories. Zero or more descriptive categories (for example, categories that were specified by the affiliate). Passed back in the payload as a comma-separated list.

Categories can be created by the affiliate and can contain up to three levels of subcategories. The play page should contain any categories and subcategories (displaying the category name and URL) that are :::associated with the set.

Added by administrators in the Affiliate Center, under the Media management settings. Members can choose from these categories when working with media.

• city. The city associated with the set.
• country. The country associated with the set.
• 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"

• description. A text description of this media. This description is entered by the owner when the media is uploaded. The text can be no longer than 500 characters.
• groups. A nested element containing the groups with which this media is associated.
• id. The id of the set.
• inappropriateFlagCount. The number of inappropriate flags that members have issued for this set.
• isPrivacyEnabled. Boolean. true or false. True if the media is private. False if media is public.
• isPublicCommentingAllowed. true or false. Default is true. Members can comment as long as they are logged and the item is not disabled.
• isPublicTaggingAllowed. true or false. Default is true. The member who owns the item can specify whether others can tag it.
• isVisible. true or false. Default is true.
• mediaList. The array of media that belongs to the set. The following information for each media is included in the array:
  • mediaName. The name of the media.
  • mediaId. The media Id of the media.
  • mediaType. The media type of the media.
  • pathToPhoto. The he URL to the media preview image
  • position. The position of the media in the media set.
• name. The name of the set.
• pathToPreview. The path to set preview. For sets its the thumbnail preview of one of the items that are included in the set. If none of the items were chosen for preview the thumbnail of the first item will be

used as a thumbnail.

• pathToPreview48X48. The path to set preview in 48X48 size.
• postalCode. The postal code associated with the set.
• reviewed. Boolean. true or false. true if the set is approved and live on the site.
• reviewedAt. The date on which the media was approved.
• stateOrProvinceName. The state or province name associated with the set.
• tags. Comma separated list of tags assigned to the set.
• totalMediaItems. Total number of media items added to the site.
• type. The media types as referenced in the system. In this case it will be SET.
• updatedAt. The date on which the set was last updated.
• updatedBy. The userId of the user who last updated the set.
• uploadedByName. The username of the user who created the set.
• uploadedByPhoto. The profile picture of the user who uploaded the set.
• userId. The userId of the user who created the set.
• views. The number of times the set has been viewed.
• votes. The total number of votes that the set has received.

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.