Web service API

How to use PageSeeder's Web service API

create comment url public

/comments/forurl [POST]

com.pageseeder.comment.CreateComment

Description

Create a new comment on a URL.

The URL does not have to exist in PageSeeder or even point to a valid resource. But it must be a valid URL.

This service is useful to attach comments to a common anchor that can be queried when there is no URI or when it would cause too many comments to be posted on a group.

Parameters

NameDescriptionRequiredTypeDefault value
authornameThe name of the authoryesstring
contentThe content of the commentyesstring
groupsA comma-separated list of the groups the comment should belong toyesstring
titleThe title of the commentyesstring
urlThe URL for the URI with optional #fragmentyesurl
assignedtoThe member ID of the member the task should be assigned to - status MUST be setnolong
authoremailThe email of the authornoemail
contenttypeThe content type of the commentnomediatypetext/plain 
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 labelsnostrings
notifyThe notification behavior.nonotifynormal
priorityThe priority for task e.g. 'High', 'Medium', 'Low' - status MUST be setnopriority
propertiesA pipe-separated list of properties as value pairs (e.g. x=1|y=2|)nostring
statusThe task status e.g. 'Open'nostatus
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

Status

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

The status must be specified for the assignedto and priority parameters to take effect.

Permission

Undocumented permissions requirements.

Response

The XML response wraps the created comment as <comment> inside a <comment-creation> element.

<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">
         <fullname>Ali Baba</fullname>
       </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 id="789">...</uri>
       <context>
       <attachment>
       <uri id="189">...</uri>
       </attachment>
       <attachment fragment="5">
       <uri id="289">...</uri>
       </attachment>
    </comment>
 </comment-creation>
 

Error handling

CodeCause / Description
0x1002 Invalid email address
0x1301 If the author is missing
0x1302 If the author is existing and was specified using authorname or authoremail
0x1303 Both URI and URL have been specified
0x1304 The URL is invalid
0x1305 The URL does not match a GroupURI
0x1306 The Group is invalid
0x1307 The assigned to member is invalid
0x1308 The due date is invalid
0x6301 If the group has no general discussion
0x6302 Failed to create new comment

Created on , last edited on