Web service API

How to use PageSeeder's Web service API

create comment public

/groups/{group}/comments [POST]

com.pageseeder.comment.CreateComment

Description

Create a new comment with author as a parameter

This service should be used to create a comment and specifying the author using parameters.

Note

When the author is an existing member, you can use Service: /members/{member}/groups/{group}/comments [POST] instead.

Parameters

NameDescriptionRequiredTypeDefault value
authornameThe name of the authoryesstring
contentThe content of the commentyesstring
titleThe title of the commentyesstring
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
labelsA comma-separated list of labelsnostring
notifyThe notification behavior.nostringnormal
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 status for task e.g. 'Open', 'Resolved', 'Closednostatus
typeThe type of the commentnostring
urisThe attachments to this comment (comma-separated list of URI IDs with optional !fragments)nolong
urlsThe attachments to this comment (comma-separated list of urls with optional #fragments)nourl
draftWhether the comment is a draftnobooleanfalse

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

Permission

Undocumented permissions requirements.

Response

The XML response includes the created comment as a <comment> wrapped in a <comment-creation> element to indicate whether notification has been sent and if the comment is public.

<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
0x0000Missing required title
0x1002Invalid email address
0x1301Missing required authorname
0x1302If the author is existing and was specified using authorname or authoremail
0x1304The URL is invalid
0x1307The assigned to member is invalid. The status is required to validate.
0x1308The due date is invalid. The status is required to validate.
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment

Created on , last edited on