Skip to main content

 Services

Web services from /about to /webhooks

list uri discussions public

/uris/{uri}/discussions [GET]

com.pageseeder.comment.GetDiscussionsForURI

Description

Load public discussions for a URI.

Parameters

NameDescriptionRequiredTypeDefault
attachedtoThe comments to return that are attached to this URInoenumall
commentsWhich comments to includenoenumall 
resultsThe number of discussions/attachedtos to returnnolong1000
archivedWhether to include discussions/attachedtos where all comments are archived (true if comments=archive)nobooleanfalse
returngroupsThe groups to return in the outputnoenumnone
discussionsizeThe maximum number of comments to return per discussionnolong100

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 user belongs to
  • all (Only administrators can use this option)

Attachedto parameter

Must be one of:

  • none
  • all

Permission

This service is public, anyone can invoke it but the URI must be in a public group.

Response

If the URI is found, 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>
       [<group .../> ...]
      </comment>
    </discussion>
    <discussion id="100"> ... </discussion>
    <attachedto>
      <comment ...> ... </comment>
    </attachedto>
    ...
  </locator>
  ...
</uri>

 

Error Handling

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