Revision as of 13:06, 11 April 2012 (view source) MetrixAdmin (Talk | contribs) (→‎Add Reply) ← Older edit		Revision as of 11:51, 12 April 2012 (view source) MetrixAdmin (Talk | contribs) (→‎Add Forum) Newer edit →
Line 39:		Line 39:
	::;canonical_id		::;canonical_id
	::: the canonical_id of the newly created forum.		::: the canonical_id of the newly created forum.
		+
		+	== Edit Forum ==
		+
		+	This API call is responsible for editing a forum.
		+
		+	=== Authentication Restrictions ===
		+
		+	Superuser or user with moderator or administrator access.
		+
		+	=== Required Parameters ===
		+
		+	;action=forum
		+	;verb=editforum
		+
		+	=== Optional Parameters ===
		+
		+	;title
		+	:the forum title; this field is used to calculate the canonical_id, if not provided.
		+	; 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; filtering will be performed to ensure proper syntax.
		+
		+	=== Successful Response ===
		+
		+	;status=ok
	== Add Thread ==		== Add Thread ==

---

Revision as of 11:51, 12 April 2012

Contents 1 Forums 1.1 Add Forum 1.1.1 Authentication Restrictions 1.1.2 Required Parameters 1.1.3 Optional Parameters 1.1.4 Successful Response 1.2 Edit Forum 1.2.1 Authentication Restrictions 1.2.2 Required Parameters 1.2.3 Optional Parameters 1.2.4 Successful Response 1.3 Add Thread 1.3.1 Authentication Restrictions 1.3.2 Required Parameters 1.3.3 Successful Response 1.4 Add Reply 1.4.1 Authentication Restrictions 1.4.2 Required Parameters 1.4.3 Optional Parameters 1.4.4 Successful Response

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.

Edit Forum

This API call is responsible for editing a forum.

Authentication Restrictions

Superuser or user with moderator or administrator access.

Required Parameters

action=forum

verb=editforum

Optional Parameters

title

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

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; filtering will be performed to ensure proper syntax.

Successful Response

status=ok

Add Thread

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

Authentication Restrictions

Any authenticated user.

Required Parameters

action=forum

verb=addthread

forumId

the forum id

title

the thread title; this field is used to calculate the canonical_id.

description

the thread description.

Successful Response

status=ok

item

thread

id

the id of the newly created thread.

canonical_id

the canonical_id of the newly created thread.

Add Reply

This API call is responsible for adding a reply to a forum post.

Authentication Restrictions

Any authenticated user.

Required Parameters

action=forum

verb=addreply

postId

the post id; this can be either a thread id or an existing reply id.

description

the reply description.

Optional Parameters

quote

text that you want to quote in your reply; this only applies if postId is a reply id; this is limited to 255 characters.

Successful Response

status=ok

item

reply

id

the id of the newly created reply.