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 authoryesstring
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
authoremailThe email of the authornoemail
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)nodatethe due date of previous comment in thread
groupsThe name of groups to attach the commentno stringsthe reply to comment's groups that are allowed
labelsA comma-separated list of labelsnostring
notifyThe notification behavior.nostringnormal
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 commentnostringthe reply to comment's title
typeThe type of the commentnostring
urisThe attachments to this comment (comma-separated list of URI IDs with optional !fragments)nolongs
urlsThe attachments to this comment (comma-separated list of urls with optional #fragments)nourls

Notify parameter

This parameter must be one of:

  • normal  notify based on each member's notification settings;
  • announce  will ignore members' individual notifications settings;
  • silent  no notification

 

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"
                   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