Skip to main content

 Web service API

How to use PageSeeder's Web service API

create comment url

/members/{member}/comments/forurl [POST]

com.pageseeder.comment.CreateComment

Description

Create a new comment for URL 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
groupsA comma-separated list of group names the comment should belong toyesstrings
titleThe title of the commentyesstring
urlThe URL for the URI with optional #fragmentyesurl
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 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 datetime
labelsA comma-separated list of label valuesnolabels
notifyThe notification behaviornonotifynormal
notify-asyncWhether emails should be sent asynchronously (for slow email servers)nobooleanfalse
priorityThe priority for the task e.g. High, Medium, Low – status MUST be setnoenum
propertiesA pipe-separated list of value pairs (e.g. x=1|y=2|)nostring
statusThe task status value, e.g. Opennoenum
typeThe type of the commentnostring
urisComma-separated list of attachments as URI IDs with optional !fragmentnolongs
urlsComma-separated list of attachments as URLs with optional #fragmentnourls

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

The member in the request might need to be a reviewer or contributor or higher depending on the group configuration for all the groups in the groups parameter.

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
0x1304The URL is invalid
0x1305The URL does not match a GroupURI
0x1306The Group is invalid
0x1307The assigned to member is invalid
0x1308The due date is invalid
0x6301If the group has no general discussion
0x6302Failed to create new comment
Created on , last edited on