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 for URL

Parameters

NameDescriptionRequiredTypeDefault value
authorname The name of the author yes string
content The content of the comment yes string
groups A comma-separated list of the groups the comment should belong to yes string
title The title of the comment yes string
url The URL for the URI with optional #fragment yes url
assignedto The member ID of the member the task should be assigned to - status MUST be set no long
authoremail The email of the author no email
contenttype The content type of the comment no mediatype text/plain 
due The task due date format is ISO-8601 - status MUST be set e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00) no date or datetime
labels A comma-separated list of labels no strings
notify The notification behavior. no enum normal
priority The priority for task e.g. 'High', 'Medium', 'Low' - status MUST be set no priority
properties A pipe-separated list of properties as value pairs (e.g. x=1|y=2|) no string
status The status for task e.g. 'Open', 'Resolved', 'Closed no status
type The type of the comment no string
uris The attachments to this comment (comma-separated list of URI IDs with optional !fragments) no longs
urls The attachments to this comment (comma-separated list of urls with optional #fragments) no urls

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

Status

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

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