Retrieve Media Meta Data
From KickApps Documentation
Retrieves all meta data associated with a media.
Your request will look something like the following.
As shown above, your call will include the following parameters:
- mediaType. String. Supported media types are: audio, photo , blog, video and emedia. Note that for this call, user is not a valid value.
- mediaId. Integer. The id of the media for which the meta data is being requested.
- as. Integer.The site to search. as is unique for each of the affiliate's sites.
- t. String. Required. Your access permissions.
- 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 for external media only (do not include in other calls). The URL of the external media (same as pathToMedia).
On success, a payload that begins with status":"1","error":""
- media. The media file and related information associated with the given play page.
|adminTags||A comma-separated list of tags added by administrators or webmasters.|
|averageRating||The average rating calculated using all the ratings issued for this media.|
|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 media.
Added by administrators in the Affiliate Center, under the Media management settings. Members can choose from these categories when working with media.
|city||The member's home city.|
|country||The member's country of residence.|
|createdAt||A nested object stating when the media was created in the following format. All times are returned as Greenwich Mean Time (GMT).
This would appear as follows:
|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.|
|id||The id of the media to play.|
|groups||A nested element containing the groups with which this media is associated.|
|isAdultContent||true or false. Default is false.|
|isPrivacyEnabled||Boolean. true or false. True if the media is private. False if media is public.|
|inappropriateFlagCount||The number of inappropriate flags that members have issued for this media.|
|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.|
|isRatedByMe||true or false. Default is false. Whether or not the member has already rated this media Id.|
|isVisible||true or false. Default is true.|
|name||The name given to the media when it was uploaded.|
|pathtoMedia||The path to the stored media.|
|pathtoPreview||The path to the media preview:
|pathToPreview48X48||The path to media preview in 48x48 dimension.|
|postalCode||The member's postal or zip code.|
|reviewed||true or false. Default is false. Whether or not an admin or webmaster has reviewed the media item on behalf of the community.|
|stateOrProvinceName||The U.S. state or Canadian province of the member who uploaded this media.|
|tags||Zero or more searchable, descriptive keywords entered by members. Appears as a comma-separated list.|
|type||The media type. audio, photo or video. KIT Cloud Social's sample applications use type to check for the Flash player to use to display the file to members.|
|updatedAt||A nested object stating when the media was created in the following format. All times are returned as Greenwich Mean Time (GMT).
This would appear as follows:
|updatedBy||The user Id of the user who last updated the media.|
|uploadedByPhoto||The path to the profile photo of the member who uploaded the media.|
|uploadedByName||The username of the member who uploaded the media.|
|uploadToAkamai||Date and timestamp of upload to CDN that KIT Cloud Social uses for storing video files.|
|uploadToLimelight||Date and timestamp of upload to CDN that KIT Cloud Social uses for storing video files.|
|userId||The numeric ID of the person who uploaded the media.|
|views||The number of times this media item was viewed. views increments each time the media item is viewed.|
|votes||The number of times the media was rated.|
|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.)|
|setIds||An array of all the sets that the media belongs to.|
|isAddToMediaSetAllowed||Boolean. True or False. Indicates if the media contributor has restricted the media from being added to sets that belong to other members. True if its restricted. False if not restricted.|
- contest. A nested object that contains the following for the contest this media object is entered in. This will be empty if the media object is not a contest entry.
|id||Id of the contest this media is associated with. (5.2.1) Note: If this is 0, no other contest fields will be returned.|
|entryId||Id of the contest entry this media is associated with. (5.2.1)|
|communityRank||The rank of this entry based on community voting and the Bayesian Ranking. (5.2.1)|
|rank||The rank of this entry as selected by the site administrator. (5.2.1)|
|votingStartDate||The date on which the voting period starts for the contest. Formatted as POSIX time: http://en.wikipedia.org/wiki/Unix_time. (5.2.1)|
|votingEndDate||The date on which voting will be closed for the currently running contest. Formatted as POSIX time: http://en.wikipedia.org/wiki/Unix_time. (5.2.1)|
|votingEnabled||Is community voting enabled for this contest? true or false(5.2.1)|
|votingType||The type of voting that will be used. The available options are: thumbs, stars and votes.(5.2.1)|
|winnerAnnounceDate||The date on which the contest will announce its winner. Formatted as POSIX time: http://en.wikipedia.org/wiki/Unix_time.(5.2.1)|
|timeZone||Time zone the contest dates apply to expressed as an offset from UTC – See: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones . (5.2.1)|
List of Kit Cloud Social API Calls
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.