Latest revision as of 10:59, 1 May 2012

[edit] Comments

[edit] Add Comment

This API call is responsible for adding a comment to an object.

[edit] Authentication Restrictions

Any authenticated user.

[edit] Required Parameters

action=comment

verb=addcomment

objtype

content, owner, user

objid

msg

the comment message; no more than 2048 characters.

[edit] Successful Response

status=ok

item

comment

id

the id of the newly created comment.

[edit] Edit Comment

This API call is responsible for editing a comment.

[edit] Authentication Restrictions

Moderators and Comment authors.

[edit] Required Parameters

action=comment

verb=editcomment

commentId

The id of the comment.

[edit] Optional Parameters

msg

the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.

approved=yes|no

the comment approval state; Only Moderators have access to this field.

[edit] Successful Response

status=ok

[edit] Delete Comment

This API call is responsible for deleting a comment.

[edit] Authentication Restrictions

Moderators; Comment owners;

[edit] Required Parameters

action=comment

verb=delcomment

commentId

The id of the comment.

[edit] Successful Response

status=ok