Web service API

How to use PageSeeder's Web service API

create comment uri

/members/{member}/uris/{uri}/comments [POST]

com.pageseeder.comment.CreateComment

Description

Create a new comment for URI from member

Create a comment for group, reply, url or uri/fragment.

Parameters

NameDescriptionRequiredTypeDefault value
content The content of the comment yes string
groups A comma-separated list of the groups the comment should belong to yes strings
title The title of the comment yes string
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 (manager only) no email the current member's email
authorname The name of the author (manager only) no string the current member's name
contenttype The content type of the comment no string text/plain 
created the creation date of the comment in ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only) no datetime the current datetime
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 labels
notify The notification behavior no enum normal
priority The priority for task e.g. 'High', 'Medium', 'Low' - status MUST be set no enum
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 enum
type The type of the comment no string
uris The attachments to this comment as a comma-separated list of URI IDs with optional !fragments (e.g. 123,23,456!content,34!title) no longs
urls The attachments to this comment as a 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'.

Priority

The task priority should be one of the valid status values defined in your group properties. For example: 'High', 'Medium', 'Low'.

Permission

Undocumented permissions requirements.

Response

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