Site:API:Content
From Metrixstream
(Difference between revisions)
MetrixAdmin (Talk | contribs) (Created page with "= Content = == Add Content == This API call is responsible for creating a content item. === Authentication Restrictions === Any authenticated user. === Required Parameter...") |
MetrixAdmin (Talk | contribs) (→Optional Parameters) |
||
| Line 22: | Line 22: | ||
:the content item description; no more than 65k characters. | :the content item description; no more than 65k characters. | ||
;release_date | ;release_date | ||
| + | :the release date of this content item. | ||
;credits_per_minute | ;credits_per_minute | ||
| + | :the current amount of credits to stream this item on a per minute basis; only applies to videos and songs. | ||
;credits_to_own | ;credits_to_own | ||
| + | :the current amount of credits to purchase this item. | ||
;price | ;price | ||
| + | :the cash value of this item. | ||
:only available for types that are not a product or project. | :only available for types that are not a product or project. | ||
;inventory | ;inventory | ||
| Line 34: | Line 38: | ||
;addtag | ;addtag | ||
:an array of tags | :an array of tags | ||
| + | ;featured_on_content_id | ||
| + | :an advanced feature for featuring products during a live broadcast. | ||
| + | ;inventory:stock:quantity | ||
| + | :only available for types that are inventory; initializes stock to this value. | ||
| + | ;inventory:stock:external_id | ||
| + | :only available for types that are inventory; an optional external_id for this stock. | ||
| + | ;inventory:stock:external2_id | ||
| + | :only available for types that are inventory; an optional external_id for this stock. | ||
| + | ;inventory:stock:note | ||
| + | :only available for types that are inventory; an optional note for this stock. | ||
=== Successful Response === | === Successful Response === | ||
Revision as of 20:49, 20 August 2012
Contents |
Content
Add Content
This API call is responsible for creating a content item.
Authentication Restrictions
Any authenticated user.
Required Parameters
- action=addcontent
- type
- blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event
- title
- the content item title; no more than 1000 characters.
Optional Parameters
- description
- the content item description; no more than 65k characters.
- release_date
- the release date of this content item.
- credits_per_minute
- the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.
- credits_to_own
- the current amount of credits to purchase this item.
- price
- the cash value of this item.
- only available for types that are not a product or project.
- inventory
- only available for types that are event.
- label
- will be prefixed by the site's user prefix label.
- addcategory
- an array of category ids
- addtag
- an array of tags
- featured_on_content_id
- an advanced feature for featuring products during a live broadcast.
- inventory
- stock:quantity
- only available for types that are inventory; initializes stock to this value.
- inventory
- stock:external_id
- only available for types that are inventory; an optional external_id for this stock.
- inventory
- stock:external2_id
- only available for types that are inventory; an optional external_id for this stock.
- inventory
- stock:note
- only available for types that are inventory; an optional note for this stock.
Successful Response
- status=ok
- item
- contentId
- the id of the newly created content item;
- canonicalId
- the canonical id of the newly created content item.
Edit Comment
This API call is responsible for editing a comment.
Authentication Restrictions
Moderators and Comment authors.
Required Parameters
- action=comment
- verb=editcomment
- commentId
- The id of the comment.
Optional Parameters
- msg
- the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.
- approved=yes|no
- the comment approval state; Only Moderators have access to this field.
Successful Response
- status=ok
Delete Comment
This API call is responsible for deleting a comment.
Authentication Restrictions
Moderators; Comment owners;
Required Parameters
- action=comment
- verb=delcomment
- commentId
- The id of the comment.
Successful Response
- status=ok
