Web service API

How to use PageSeeder's Web service API

list uri fragment discussions public

/uris/{uri}/fragments/{+fragment}/discussions [GET]

com.pageseeder.comment.GetDiscussionsForURI

Description

Load the discussions on a URI fragment.

Parameters

NameDescriptionRequiredTypeDefault value
attachedtoThe comments to return that are attached to this URI.noenumall
commentsWhich comments to include.noenumall 
archivedIf "true", include discussions where all comments are archived.nobooleanfalse
resultsThe number of discussions/attachedtos to return.nolong1000
returngroupsThe groups to return in the output.noenumnone
discussionsizeThe maximum number of comments to return per discussion.nolong100

Comments parameter

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
  • none – no comments

Returngroups parameter

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)

Attachedto parameter

Should be one of:

  • none
  • all

Permission

Permissions requirements to be updated.

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
0x6303Both URI and URL have been specified
0x6304The URL is invalid

Created on , last edited on