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
contentThe content of the comment.yesstring
groupsA comma-separated list of group names the comment should belong to.yesstrings
titleThe title of the comment. Max 255 characters.yesstring
assignedtoThe ID of the member to assign the task to – status MUST be set.nolong
authoremailThe email address of the author (manager only).noemailThe current member's email.
authornameThe name of the author (manager only).nostringThe current member's name.
contenttypeThe content type of the comment.nostringtext/plain 
createdThe creation date of the comment in ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only).nodatetimeThe current datetime.
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 datetimeThe due date of previous comment in thread.
labelsA comma-separated list of label values.nolabel
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.nopriorityThe priority of the previous comment in thread.
propertiesA pipe-separated list of value pairs (e.g. 'x=1|y=2|').nostring
statusThe task status value, e.g. 'Open'.nostatusThe status of the previous comment in thread.
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.nolong
urlsComma-separated list of attachments as URL with optional #fragment.nourl
draftWhether the comment is a draft.nobooleanfalse

 

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

Permission

Permissions requirements to be updated.

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
0x1306Missing required groups or the Group is invalid.
0x0000Missing required title
0x1306The URI was not accessible to the group. The status is required to validate.
0x1307The assigned to member is invalid. The status is required to validate.
0x1308The due date is invalid
0x0201Missing required content
0x6301If the group has no general discussion
0x6302Failed to create new comment
0x0802The title can has maximum length of 255.

Created on , last edited on