Web service API

How to use PageSeeder's Web service API

get discussion public

/discussions/{discussion} [GET]

com.pageseeder.comment.GetDiscussion

Description

This service returns a public discussion.

If a reply comment ID is specified for the discussion, it will return the containing discussion.

Note

This service only returns comments posted on a public group.

To return comments on private groups, use /groups/{group}/discussions/{discussion} [GET]

Parameters

NameDescriptionRequiredTypeDefault value
commentsThe comments to include, can be "none", "first", "last", "all", "archive".nostringall
discussionsizeThe maximum number of comments to return per discussion.nostring1000

Permission

Permissions requirements to be updated.

Response

This service returns a single discussion as a <discussion> element.

<discussion id="49"
            title="Original comment"
            replycount="3"
            lastcommentid="52"
            lastcommentdate="2017-02-17T13:51:24+11:00">
    <uri id="30"> ... </uri>
    <comment id="49"
             contentrole="Comment"
             created="2017-02-17T13:48:46+11:00">
        <title>Original comment</title>
        <author id="1"> ... </author>
        <content type="text/plain">Original comment</content>
    </comment>
    <comment id="50"
             contentrole="Comment"
             created="2017-02-17T13:49:13+11:00">
        <title>Original comment</title>
        <author id="1"> ... </author>
        <content type="text/plain">First reply</content>
    </comment>
    <comment id="51"
             contentrole="Comment"
             created="2017-02-17T13:49:26+11:00">
        <title>Original comment</title>
        <author id="1"> ... </author>
        <content type="text/plain">Second reply</content>
    </comment>
    <comment id="52"
             contentrole="Comment"
             created="2017-02-17T13:51:24+11:00">
        <title>Original comment</title>
        <author id="1"> ... </author>
        <content type="text/plain">Other reply</content>
    </comment>
</discussion>

By default, all discussion comments are included.

The effect of the comments parameter on the response is described here.

Error Handling

CodeCause / Description
0x1316 the discussion was not found

Created on , last edited on