http://dev.metrixstream.com/w/index.php?action=history&feed=atom&title=Site%3AAPI%3AForums 2026-09-12T17:41:23Z Revision history for this page on the wiki MediaWiki 1.19.1 http://dev.metrixstream.com/w/index.php?title=Site:API:Forums&diff=245&oldid=prev 2012-04-30T23:08:01Z

<p>Created page with &quot;= Forums = == Add Forum == This API call is responsible for adding a forum to a site. === Authentication Restrictions === Administrators only. === Required Parameters === ;...&quot;</p> <p><b>New page</b></p><div>= Forums =<br /> <br /> == Add Forum ==<br /> <br /> This API call is responsible for adding a forum to a site.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Administrators only.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=addforum<br /> ;title<br /> :the forum title; this field is used to calculate the canonical_id, if not provided.<br /> <br /> === Optional Parameters ===<br /> <br /> ; description<br /> : the forum description.<br /> ;layout<br /> : the position of this forum relative to other forums.<br /> ;label<br /> : allows grouping of forums based on label.<br /> ;canonical_id<br /> : the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> ;item<br /> <br /> :;forum<br /> <br /> ::;id<br /> ::: the id of the newly created forum.<br /> <br /> ::;canonical_id<br /> ::: the canonical_id of the newly created forum.<br /> <br /> == Edit Forum ==<br /> <br /> This API call is responsible for editing a forum.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Administrators only.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=editforum<br /> ;forumId<br /> :the forum id.<br /> <br /> === Optional Parameters ===<br /> <br /> ;title<br /> :the forum title; this field is used to calculate the canonical_id, if not provided.<br /> ; description<br /> : the forum description.<br /> ;layout<br /> : the position of this forum relative to other forums.<br /> ;label<br /> : allows grouping of forums based on label.<br /> ;canonical_id<br /> : the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> <br /> == Delete Forum ==<br /> <br /> This API call is responsible for deleting a forum and all of its threads and replies.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Administrators only.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=delforum<br /> ;forumId<br /> :the forum id.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> <br /> == Add Thread ==<br /> <br /> This API call is responsible for adding a thread to a forum.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Any authenticated user.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=addthread<br /> ;forumId<br /> :the forum id<br /> ;title<br /> :the thread title; this field is used to calculate the canonical_id, if no canonical_id is supplied.<br /> ; description<br /> : the thread description.<br /> <br /> === Optional Parameters ===<br /> <br /> ;canonical_id<br /> : the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.<br /> <br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> ;item<br /> <br /> :;thread<br /> <br /> ::;id<br /> ::: the id of the newly created thread.<br /> <br /> ::;canonical_id<br /> ::: the canonical_id of the newly created thread.<br /> <br /> == Add Reply ==<br /> <br /> This API call is responsible for adding a reply to a forum post.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Any authenticated user.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=addreply<br /> ;postId<br /> :the post id; this can be either a thread id or a reply id.<br /> ; description<br /> : the reply description.<br /> <br /> === Optional Parameters ===<br /> ;quote<br /> :text that you want to quote in your reply; this only applies if postId is a reply id; this is limited to 255 characters.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> ;item<br /> <br /> :;reply<br /> <br /> ::;id<br /> ::: the id of the newly created reply.<br /> <br /> == Edit Post ==<br /> <br /> This API call is responsible for editing a forum post.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Superuser or user with moderator or administrator access. Post user is only able to update title and description for threads and description for replies.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=editpost<br /> ;postId<br /> :the post id; this can be either a thread id or a reply id.<br /> <br /> === Optional Parameters ===<br /> ; title<br /> : the post title; only applies if postId is a thread id;<br /> ; description<br /> : the post description.<br /> ;canonical_id<br /> :the canonical id of the forum post; only applies if postId is a thread id.<br /> ;forumId<br /> :the id of the forum that this post belongs to; only applies if postId is a thread id.<br /> ;sticky=yes|no<br /> :whether or not this post is sticky; only applies if postId is a thread id.<br /> ;quote<br /> :text that you want to quote in your reply; only applies if postId is a reply id; this is limited to 255 characters.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok<br /> <br /> == Delete Post ==<br /> <br /> This API call is responsible for deleting a forum post.<br /> <br /> === Authentication Restrictions ===<br /> <br /> Administrators or Moderators; Post user is able to delete as long as post is not a thread with a reply count greater than 0.<br /> <br /> === Required Parameters ===<br /> <br /> ;action=forum<br /> ;verb=delpost<br /> ;postId<br /> :the post id; this can be either a thread id or a reply id.<br /> <br /> === Successful Response ===<br /> <br /> ;status=ok</div>

MetrixAdmin