Skip to main content

 Web service API

How to use PageSeeder's Web service API

create comment

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

com.pageseeder.comment.CreateComment

Description

Create a new group comment from member.

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

Parameters

NameDescriptionRequiredTypeDefault value
contentThe content of the comment. XHTML content is sanitized.yesstring
titleThe title of the comment. Max 255 charactersyesstring
assignedtoThe ID of the member to assign the task to – status MUST be setnolong
authoremailThe email address of the author (manager only)noemailthe current member’s email
authornameThe name of the author (manager only)nostringthe current member’s name
contenttypeThe media type of the commentnomediatypetext/plain 
createdThe creation date of the comment, format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only)nodatetimethe current datetime
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 or datetimethe due date of previous comment in thread
labelsA comma-separated list of label valuesnolabel
notifyThe notification behaviornonotifynormal
notify-asyncWhether emails are 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. Opennostatusthe status of the previous comment in thread
typeThe type of the commentnostring
urisComma-separated list of attachments as URI ID with optional !fragmentnolong
urlsComma-separated list of attachments as URL with optional #fragmentnourl
draftWhether the comment is a draftnobooleanfalse

 

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

It depends on the group configuration but the default is that the member on the request needs to be a reviewer or higher.

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
0x0000Missing required title
0x1002 Invalid author email address
0x1301Author missing, if the member is invalid
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
0x1326The content was invalid
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment
Created on , last edited on