Skip to main content

 Services

Web services from /about to /webhooks

list url discussions

/members/{member}/discussions/forurl [GET]

com.pageseeder.comment.GetDiscussionsForURI

Description

Load a list of discussions for a URL.

Parameters

NameDescriptionRequiredTypeDefault
url The URL for the URI with optional #fragmentyesurl
attachedtoThe comments to return that are attached to this URInoenumall
commentsWhich comments to includenoenumall 
archivedIf true, include discussions where all comments are archivednobooleanfalse
resultsThe number of results to returnnolong1000
returngroupsThe groups to return in the outputnoenumnone

Comments parameter

The comment display must 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

Must 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

Must be one of:

  • none
  • all

Permission

This service can only be invoked by the own user or an administrator.

The other restriction is that the url parameter can only list discussions with public access or the current user is a guest or higher.

Response

The output has the following format:

<uri id="23"
     type="..."
     scheme="..."
     host="..."
     port="..."
     path="..."
     decodedpath="..."
     mediatype="...">
  <displaytitle> ... </displaytitle>
  <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>
    <attachedto>
      <comment ... > ... </comment>
    </attachedto>
    ...
  </locator>
  ...
</uri>

Error Handling

CodeCause / Description
0x6303Both URI and URL have been specified
0x6304The URL is invalid
Created on , last edited on