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 author.yesstring
contentThe content of the comment.yesstring
groupsA comma-separated list of group names the comment should belong to.yesstring
titleThe title of the comment.yesstring
urlThe URL for the URI with optional #fragment.yesurl
assignedtoThe ID of the member to assign the task to – status MUST be set.nolong
authoremailThe email address of the author.noemail
contenttypeThe content type of the comment.nomediatypetext/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 label values.nostrings
notifyThe notification behavior.nonotifynormal
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 set.nopriority
propertiesA pipe-separated list of value pairs (e.g. 'x=1|y=2|').nostring
statusThe task status value, e.g. 'Open'.nostatus
typeThe type of the comment.nostring
urisComma-separated list of attachments as URI ID with optional !fragment e.g. 123,23,456!content,34!title.nolongs
urlsComma-separated list of attachments as URL with optional #fragment.nourls

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”.

 

Status

The value should match a valid status as defined in Group Properties. For example: 'Open', 'Resolved', 'Closed'.

To process assignedto and priority parameters requires that status be specified.

Permission

Permissions requirements to be updated.

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