Web service API

How to use PageSeeder's Web service API

create comment public

/groups/{group}/comments [POST]

com.pageseeder.comment.CreateComment

Description

Create a comment using parameters to specify the author.

Note

To create a comment for an existing member, use

 Service: /members/{member}/groups/{group}/comments [POST]

Parameters

NameDescriptionRequiredTypeDefault value
authornameThe name of the author.yesstring
contentThe content of the comment.yesstring
titleThe title of the comment.yesstring
assignedtoThe ID of the member to assign the task to – status MUST be set.nolong
authoremailThe email address of the author.noemail
contenttypeThe content type of the comment.nomediatypetext/plain
dueThe task due date format is ISO-8601 – status MUST be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00).nodate
labelsA comma-separated list of labels.nostring
notifyThe notification behavior.nonotifynormal
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse
priorityThe priority for the task e.g. 'High', 'Medium', 'Low' – status MUST be set.nopriority
propertiesA pipe-separated list of value pairs (e.g. 'x=1|y=2|').nostring
statusThe task status value, e.g. 'Open'.nostatus
typeThe type of the comment.nostring
urisComma-separated list of attachments as URI ID with optional !fragment.nolong
urlsComma-separated list of attachments as URL with optional !fragment.nourl
draftWhether the comment is a draft.nobooleanfalse

Permission

Permissions requirements to be updated.

Response

The XML response is a <comment> wrapped by a <comment-creation> element that indicates whether a notification has been sent and whether the comment is public.

<comment-creation  [notification-email-delayed="true"|
                   notification-email-failed="true"|
                   moderator-email-failed="true"]
                   [notify-param-ignored="true"]
                   [public="true"]>
    <comment  id="123"
              contentrole="[Comment|File Attachment]"
              created="2012-03-08T12:34:00+10:00"
              status="Open"
              due="2012-03-10T18:00:00+10:00"
              priority="High"
              [moderated="true"]>
        <title>Cavern stolen!</title>
        <author  email="alibaba@fortythieves.com.au" ...> ... </author>
        <assignedto  id="123"
                     date="2012-03-09T..." ...> ... </assignedto> 
        <modifiedby  id="456"
                     date="2012-03-09T..." ...> ... </modifiedby>
        <content  id="789"
                  type="text/plain">
            Sesame opened the door
        </content>
        <attachment>
          <uri  id="189" > ... </uri>
        </attachment>
        <attachment  fragment="5" >
          <uri  id="289" > ... </uri>
        </attachment>
    </comment>
</comment-creation>

Error Handling

CodeCause / Description
0x0000Missing required title
0x1002Invalid email address
0x1301Missing required authorname
0x1302If the author is existing and was specified using authorname or authoremail
0x1304The URL is invalid
0x1307The assigned to member is invalid. The status is required to validate.
0x1308The due date is invalid. The status is required to validate.
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment

Created on , last edited on