Site:API

From Metrixstream
(Difference between revisions)
Jump to: navigation, search
(Parameters)
(Add Forum)
Line 5: Line 5:
 
This API call is responsible for adding a forum to a site.
 
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 ===
 
=== Required Parameters ===
Line 13: Line 14:
 
;verb=addforum
 
;verb=addforum
 
;title
 
;title
 +
:the forum title; this field is used to calculate the canonical_id, if not provided.
  
 
=== Optional Parameters ===
 
=== Optional Parameters ===
  
;description
+
; description
:optional
+
: the forum description.
 
;layout
 
;layout
:optional
+
: the position of this forum relative to other forums.
 
;label
 
;label
:optional
+
: allows grouping of forums based on label.
 
;canonical_id
 
;canonical_id
:optional; if left blank, this is calculated for you.
+
: the nice looking identifier for human readable ids.
  
 
=== Successful Response ===
 
=== Successful Response ===
Line 29: Line 31:
 
;status=ok
 
;status=ok
 
;item
 
;item
::;forum
+
 
::::;id
+
:;forum
::::;canonical_id
+
 
 +
::;id
 +
::: the id of the newly created forum.
 +
 
 +
::;canonical_id
 +
::: the canonical_id of the newly created forum.

Revision as of 12:44, 11 April 2012

Contents

Forums

Add Forum

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

Authentication Restrictions

Superuser or user with moderator or administrator access.

Required Parameters

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

Optional Parameters

description
the forum description.
layout
the position of this forum relative to other forums.
label
allows grouping of forums based on label.
canonical_id
the nice looking identifier for human readable ids.

Successful Response

status=ok
item
forum
id
the id of the newly created forum.
canonical_id
the canonical_id of the newly created forum.
Personal tools