Web service API

How to use PageSeeder's Web service API

create comment uri

/members/{member}/uris/{uri}/comments [POST]

com.pageseeder.comment.CreateComment

Description

Create a new comment for URI from member

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

Parameters

NameDescriptionRequiredTypeDefault value
contentThe content of the commentyesstring
groupsA comma-separated list of the groups the comment should belong toyesstrings
titleThe title of the comment. Max 255 characters.yesstring
assignedtoThe member ID of the member the task should be assigned to - status MUST be setnolong
authoremailThe email of the author (manager only)noemailthe current member's email
authornameThe name of the author (manager only)nostringthe current member's name
contenttypeThe content type of the commentnostringtext/plain 
createdthe creation date of the comment in 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 labelsnolabel
notifyThe notification behaviornonotifynormal
priorityThe priority for task e.g. 'High', 'Medium', 'Low' - 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
typeThe type of the commentnostring
urisThe attachments to this comment as a comma-separated list of URI IDs with optional !fragments (e.g. 123,23,456!content,34!title)nolong
urlsThe attachments to this comment as a comma-separated list of urls with optional #fragmentsnourl
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
0x1306Missing required groups or the Group is invalid.
0x0000Missing required title
0x1306The URI was not accessible to the group. The status is required to validate.
0x1307The assigned to member is invalid. The status is required to validate.
0x1308The due date is invalid
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment
0x0802The title can has maximum length of 255.

Created on , last edited on