Web service API

How to use PageSeeder's Web service API

reply comment public

/comments/{xlinkid}/reply [POST]

com.pageseeder.comment.CreateComment

Description

Create a reply to an existing comment with author as a parameter.

Parameters

NameDescriptionRequiredTypeDefault value
authornameThe name of the author.yesstring
contentThe content of the comment.yesstring
assignedtoThe ID of the member to assign the task to – status or previous status MUST be set.nolongthe assigned member of the previous comment in thread
authoremailThe email address of the author.noemail
contenttypeThe content type of the comment.nomediatypetext/plain
dueThe task due date format is ISO-8601 – status or previous status MUST be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00).nodatethe due date of previous comment in thread
groupsThe name of groups to attach the comment.no stringsthe reply to comment's groups that are allowed
labelsA comma-separated list of label values.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 or previous status MUST be set.noprioritythe priority of the previous comment in thread
propertiesA pipe-separated list of value pairs (e.g. 'x=1|y=2|').nostring
statusThe task status value, e.g. 'Open'.nostatusthe status of the previous comment in thread
titleThe title of the comment.nostringthe reply to comment's title
typeThe type of the comment.nostring
urisComma-separated list of attachments as URI ID with optional !fragment.nolongs
urlsComma-separated list of attachments as URL with optional #fragment.nourls

Permission

Permissions requirements to be updated.

Response

<comment-creation [notification-email-delayed="true"|
                  notification-email-failed="true"|
                  moderator-email-failed="true"]
                  [notify-param-ignored="true"]
                  [public="true"]>
    <comment id="123"
             discussionid="122"
             contentrole="Comment" 
             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>
        <context fragment="2">
            <uri|group  id="789"> ... </uri|group>
        </context>
        <attachment>
            <uri id="189"> ... </uri>
        </attachment>
        <attachment fragment="5">
            <uri id="289"> ... </uri>
        </attachment>
    </comment>
</comment-creation>

Error Handling

CodeCause / Description
0x1301 If the author is missing
0x1302 If the author is existing and was specified using authorname or authoremail
0x6301 If the group has no general discussion
0x6302 Failed to create new comment

Created on , last edited on