Revision as of 12:44, 11 April 2012

Forums

This API call is responsible for adding a forum to a site.

Superuser or user with moderator or administrator access.

action=forum
verb=addforum
title: the forum title; this field is used to calculate the canonical_id, if not provided.

@@ Line 5: / Line 5: @@
 This API call is responsible for adding a forum to a site.
-=== Security ===
+=== Authentication Restrictions ===
+Superuser or user with moderator or administrator access.
 === Required Parameters ===
@@ Line 13: / Line 14: @@
 ;verb=addforum
 ;title
+:the forum title; this field is used to calculate the canonical_id, if not provided.
 === Optional Parameters ===
-;description
+; description
-:optional
+: the forum description.
 ;layout
-:optional
+: the position of this forum relative to other forums.
 ;label
-:optional
+: allows grouping of forums based on label.
 ;canonical_id
-:optional; if left blank, this is calculated for you.
+: the nice looking identifier for human readable ids.
 === Successful Response ===
@@ Line 29: / Line 31: @@
 ;status=ok
 ;item
-::;forum
-::::;id
+:;forum
-::::;canonical_id
+::;id
+::: the id of the newly created forum.
+::;canonical_id
+::: the canonical_id of the newly created forum.