Site:API

From Metrixstream
(Difference between revisions)
Jump to: navigation, search
(Forums)
(Add Thread)
Line 71: Line 71:
 
::;canonical_id
 
::;canonical_id
 
::: the canonical_id of the newly created thread.
 
::: 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.
 +
;title
 +
:the thread title; this field is used to calculate the canonical_id.
 +
; description
 +
: the thread 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.

Revision as of 13:05, 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.

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.
title
the thread title; this field is used to calculate the canonical_id.
description
the thread 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.
Personal tools