Web service API

How to use PageSeeder's Web service API

list url discussions public

/discussions/forurl [GET]

com.pageseeder.comment.GetDiscussionsForURI

Description

Returns the list of public discussions for the specified URL.

 

Parameters

NameDescriptionRequiredTypeDefault value
url The URL for the URI with optional #fragmentyesurl
attachedtoThe comments to return that are attached to this URInoenumall
commentsWhich comments to includenoenumall 
resultsThe number of results to returnnolong1000
returngroupsThe groups to return in the outputnoenumnone

attachedto

Should be one of:

  • none
  • all

comments

The comment display should be one of:

  • all  all comments in the discussion
  • archive  all comments including archived comments
  • first  only the first comment
  • last  only the last comment

returngroups

Should be one of:

  • none  do not include the group
  • user  only include the group that the use belongs to
  • all (Only administrators can use this option)

 

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<uri id="23"
     type="..."
     scheme="..."
     host="..."
     port="..."
     path="..."
     decodedpath="..."
     mediatype="...">
   <title>...</title>
   <labels>...</labels>
   <locator fragment="12">
     <discussion id="123"
                 title="My thread"
                 replycount="3"
                 lastcommentid="234"
                 lastcommentdate="2012-08-20T14:27:48+10:00">
       <comment id="234"
                contentrole="File Attachment"
                created="2012-03-08T12:34:00+10:00">
         <title>My thread</title>
         <content type="text/plain">
           Some text
         </content>
         <attachment>
           <uri id="189">...</uri>
         </attachment>
         <attachment fragment="5">
           <uri id="289">...</uri>
         </attachment>
       </comment>
     </discussion>
     <discussion id="100">
       ...
     </discussion>
   </locator>
   ...
 </uri>

Error handling

CodeCause / Description
0x6303 Both URI and URL have been specified
0x6304 The URL is invalid

Created on , last edited on