User.ForumTopics.get

Description

Returns the topics for a forum and includes the users read status. Requires OAuth authentification.

<Flag> contains an R if the topic is Read Only, otherwise the topic is Read/Write.

<Status> contains an A or an L. A means the topic is Archived and L means the topic is 'Live'. I believe that Live means that the topic has had postings in the past 6 months.

The idea was that Archived topics would be hidden from the user so that in conferences with lots and lots of topics, many old, users were not inundated with old topics.

There is a flaw in this concept. For instance, files and announcements could be topics that may not receive new postings, but should always be on view. Moderators really need the ability to set certain topics to never be archived and this facility does not exist at the moment.

Method

GET

Endpoint

Parameters

Required Name Type Description
required forum string The forum to containing the topics.

Example Request

Example Return XML

<UserTopicResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>12</Count> 
  <Start>0</Start> 
  <UserTopics> 
    <UserTopic> 
      <Flag>R</Flag> 
      <Msgs>0</Msgs> 
      <Name>2feedback</Name> 
      <Status>A</Status> 
      <UnRead>0</UnRead> 
    </UserTopic> 
    <UserTopic> 
      <Flag> </Flag> 
      <Msgs>0</Msgs> 
      <Name>3feedback</Name> 
      <Status>A</Status> 
      <UnRead>0</UnRead> 
    </UserTopic> 
  </UserTopics> 
</UserTopicResultSet>

Example Return JSON

{
  "Count":12,
  "Start":0,
  "UserTopics":[
    {"Flag":"R","Msgs":"0","Name":"2feedback","Status":"A","UnRead":"0"},
    {"Flag":" ","Msgs":"0","Name":"3feedback","Status":"A","UnRead":"0"}
  ]
}

Error Codes

Code Description
400 Bad request. Check input parameters.
401 Authentication failed. Missing required parameter : {parameter name}.
401 Signature expired. Either the timestamp or the nonce have expired or are invalid.
 
cix.api/user.forumtopics.get.txt · Last modified: 2011/11/21 16:33 by mat
 
Except where otherwise noted, content on this wiki is licensed under the following license:Public Domain
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Debian Driven by DokuWiki