Edit Set

From KickApps Documentation

Jump to: navigation, search

Template:AvailableJuly22 Call to edit set info and media items in a set.

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

Contents

Parameters

  • as. Required. Integer. The site that the media set is being added 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".
  • name. Required. The name for the media set. Maximum length allowed is 255 characters and minimum length allowed is 1. Accepts special characters.
  • description. Optional. String. The description of the newly-created media set.
  • mediaList. Required. The comma separated list of media (Media Type and Media Id) that is to be added to the set. Note: existing media list needs to be passed along with the new media every time this field is edited. If existing media list is not passed they will be replaced by the new media.
Supported media types: Audio, video, photo, blog.
Format: {mediaType}:[mediaId},{mediaType}:[mediaId}. Example: mediaList=PHOTO:2,PHOTO:1193395
  • tags. One or more comma-separated keyword tags. Enclose multi-word tags inside quotations ("tag tag",tag).
Each media set can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.
  • adminTags. One or more comma-separated tags. You must use the administrator token in order to add admin tags. Enclose multi-word tags inside quotations ("tag tag",tag).
Each media set can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.
  • category. Optional. Up to three levels of categories that members can use to find this media set, written in the following format level1name/level2name/level3name. Level names should be preexisting categories for this site. An error will be returned if you try to add a category that does not already exist.
  • country. The member's country. The values in your upload form must exactly match those used by KIT Cloud Social.If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated.
  • state. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on this page: Geographic Values for Media Uploads.
  • stateOrProvince. The abbreviation for the member's province. The value selected in the upload form will correspond to those shown on this page: Geographic Values for Media Uploads.
  • AusState. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on this page: Geographic Values for Media Uploads.
  • otherStateOrProvince. The abbreviation for the member's state or province if country is not 1 for the United States of America, 2 for Canada, or 15 for Australia. Zip and postal codes are not validated for these values.
  • city. The member's city. The max character length for this field is 128 characters.
  • zipcode. The member's zip or postal code. The max character length for this field is 32 characters. If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated.
  • allowPublicCommenting. true or false. Default is true. By default, form is set to true. Whether members can comment on this media set.
  • allowPublicTagging. true or false. Whether members can tag this media set.
  • updatedAt. Optional. The date on which the set should be marked as modified. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm
  • createdAt. Optional. The date on which the set should be marked as created. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm

Payload

On success, the following payload will be returned: {"payload_type":"json","status":"1","error":"","message":"Media set edited successfully","mediaId":60339}

Note: If the owner of the media has put restrictions on the media such that it cannot be added by other users to their sets the following error message starting with "status" = "-1" will be returned: "Access denied."

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.