Web service API

How to use PageSeeder's Web service API

reply group comment public

/groups/{group}/comments/{xlinkid}/reply [POST]

com.pageseeder.comment.CreateComment

Description

Create a new group reply.

Create a comment for group, reply, url or uri/fragment.

Parameters

NameDescriptionRequiredTypeDefault value
authornameThe name of the author.yesstringthe current member's name
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
groupcComma-separated list of group names the comment should belong to.nostring
authoremailThe email address of the author.noemailthe current member's email
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).nodate or datetimethe due date of previous comment in thread
labelsA comma-separated list of labels.nolabel
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. Max 255 characters.nostring
typeThe type of the comment.nostring
urisComma-separated list of attachments as URI IDs with optional !fragments.nolong
urlsComma-separated list of attachments as URLs with optional #fragments.nourl
draftWhether the comment is a draft.nobooleanfalse

 

Status

The  @status attribute must use a value that has been defined in the group properties. For example: “Open”, “Resolved”, “Closed”.

Priority

The @priority attribute must use a value that has been defined in the group properties. For example: “High”, “Medium”, “Low”.

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"
              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>
        <attachment>
            <uri  id="189"> ... </uri>
        </attachment>
        <attachment  fragment="5">
            <uri  id="289"> ... </uri>
        </attachment>
    </comment>
</comment-creation>

Error Handling

CodeCause / Description
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