Site:API:Content
From Metrixstream
(Difference between revisions)
MetrixAdmin (Talk | contribs) m (→Required Parameters) |
MetrixAdmin (Talk | contribs) m (→Successful Response) |
||
| Line 36: | Line 36: | ||
=== Successful Response === | === Successful Response === | ||
| − | + | * <code>status=ok</code> | |
| − | + | * <code>item</code> | |
| − | + | ** <code>contentId</code>: the id of the newly created content item | |
| − | + | ** <code>canonicalId</code>: the canonical id of the newly created content item. | |
| − | + | ||
| − | + | ||
| − | + | ||
== Edit Content == | == Edit Content == | ||
Revision as of 22:23, 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. -
cst_*: custom fields related to content; replace the * with the appropriate custom field name
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 Content
This API call is responsible for editing a content item.
Authentication Restrictions
Moderators and Comment authors.
Required Parameters
- action=editcontent
- contentId
- The id of the content item.
Optional Parameters
- title
- description
- access
- release_date
- event_date
- live_host
- live_mode
- preview_offset
- preview_duration
- external_id
- allow_oversell
- price
- price1
- price2
- price3
- price4
- price_formula
- credits_to_own
- credits_per_minute
- commission_ppm_percentage
- commission_pto_percentage
- commission_gift_percentage
- commission_bandwidth_percentage
- review
- gift_credits
- user
- chat_muted
- img
- selected
- img
- title
- img
- position
- photo_hint
- add
- relationship
- del
- relationship
- playlist
- media_id
- image (multipart)
- banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)
- banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10
- banner
- photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo
- banner
- screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot
- inventory
- inventory
- stock:quantity
- featured_on_content_id
- tags
- addtag
- deletetag
- categories
- addcategory
- deletecategory
- label
- label_hint
- cst_*
- custom fields related to content; replace the * with the appropriate custom field name.
Successful Response
- status=ok
- properties
- pending
- approved
