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 attached to the specified URL.

To create a comment on a public URL, use the /comments/forurl [POST] service.

Parameters

NameDescriptionRequiredTypeDefault value
url The URL for the URI with optional #fragment.yesurl
attachedtoThe comments to return that are attached to this URI.noenumall
commentsWhich comments to include in each discussion.noenumall 
archivedIf "true", include discussions where all comments are archived.nobooleanfalse
resultsThe number of results to return.nolong1000
returngroupsThe groups to return in the output.noenumnone
discussionsizeMax number of comments per discussion.nolong100

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

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)

url

The URL defines where the discussions are attached.

If the URL does not include a fragment part (i.e. no locator following a '#'), then all discussions attached to the URL are returned. Example: http://example.com/abc

If the URL includes a fragment part (i.e. locator following a '#'), then only the discussions attached to that locator are returned. Example: http://example.com/abc#part1

If the URL ends with '#default', only the discussions attached the URL itself are returned. In other words, discussions attached to specific locators are not returned. Example: http://example.com/abc#default

Permission

Permissions requirements to be updated.

Response

This service returns a <uri> corresponding to the specified URL.

Each discussion is returned under the <locator> onto which they are attached.

See example below:

<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
0x1304The URL is invalid
0x1314The URL was not specified
0x1315The URL was not found

Created on , last edited on