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 authoryesstringthe current member's name
contentThe content of the commentyesstring
assignedtoThe member ID of the member the task should be assigned to - status or previous status MUST be setnolongthe assigned member of the previous comment in thread
groupsA comma-separated list of the groups the comment should belong tonostring
authoremailThe email of the authornoemailthe current member's email
contenttypeThe content type of the commentnomediatypetext/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 labelsnolabel
notifyThe notification behavior.nonotifynormal
priorityThe priority for task e.g. 'High', 'Medium', 'Low' - status or previous status MUST be setnoprioritythe priority of the previous comment in thread
propertiesA pipe-separated list of properties as value pairs (e.g. x=1|y=2|)nostring
statusThe status for task e.g. 'Open', 'Resolved', 'Closednostatusthe status of the previous comment in thread
titleThe title of the comment. Max 255 characters.nostring
typeThe type of the commentnostring
urisThe attachments to this comment (comma-separated list of URI IDs with optional !fragments)nolong
urlsThe attachments to this comment (comma-separated list of urls with optional #fragments)nourl
draftWhether the comment is a draftnobooleanfalse

 

Status

The task status should be one of the valid status values defined in your Group Properties. For example: 'Open', 'Resolved', 'Closed'.

Priority

The task priority should be one of the valid status values defined in your group properties. For example: 'High', 'Medium', 'Low'.

Permission

Undocumented permissions requirements.

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