Forum.TopicThreads.get

Forum.TopicThreads.get

Description

Returns a list of root messages in a topic. Requires OAuth authentification.

Method

GET

Endpoint

http://api.cixonline.com/v1.0/cix.svc/forums/{forum}/{topic}/threads(.xml/.json)[?start={start}&maxresults={maxresults}]

Parameters

Required	Name	Type	Description
required	forum	string	The forum containing the topic.
	topic	string	The topic to list threads for.
optional	maxresults	string	The max number of results to retreive (Default 200)
	start	string	The position to start from (Default 0)

Example Request

http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/8feedback/threads.xml

Example Return XML

<ThreadResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>145</Count> 
  <Start>0</Start> 
  <Threads> 
    <Thread> 
      <Author>xxx</Author> 
      <Body>Fencepost error...</Body> 
      <Date>2008-10-14T15:18:50.0000000</Date> 
      <Forum>cix.customer</Forum> 
      <ID>3096</ID> 
      <LastAuthor>xxx</LastAuthor> 
      <LastPost>2008-10-14T15:20:25.0000000</LastPost> 
      <Priority>true</Priority> 
      <Replies>2</Replies> 
      <RootID>0</RootID> 
      <Starred>false</Starred> 
      <Topic>8feedback</Topic> 
      <Unread>2</Unread> 
    </Thread> 
    <Thread> 
      <Author>xxx</Author> 
      <Body>Groups on forums...</Body> 
      <Date>2008-10-02T12:54:36.0000000</Date> 
      <Forum>cix.customer</Forum> 
      <ID>1747</ID> 
      <LastAuthor>xxx</LastAuthor> 
      <LastPost>2008-10-14T15:14:49.0000000</LastPost> 
      <Priority>true</Priority> 
      <Replies>506</Replies> 
      <RootID>0</RootID> 
      <Starred>false</Starred> 
      <Topic>8feedback</Topic> 
      <Unread>20</Unread> 
    </Thread> 
  </Threads> 
</ThreadResultSet>

Example Return JSON

{
  "Count":145,
  "Start":0,
  "Threads":[
    {"Author":"admorton","Body":"Fencepost error...",
      "Date":"2008-10-14T15:18:50.0000000","Forum":"cix.customer","ID":3096,
      "LastAuthor":"admorton","LastPost":"2008-1014T15:20:25.0000000",
      "Priority":true,"Replies":2,"RootID":0,"Starred":false,
      "Topic":"8feedback","Unread":2},
    {"Author":"ratcatcher","Body":"Groups on forums...",
      "Date":"2008-10-02T12:54:36.0000000","Forum":"cix.customer","ID":1747,
      "LastAuthor":"ceebee","LastPost":"2008-10-14T15:14:49.0000000",
      "Priority":true,"Replies":506,"RootID":0,"Starred":false,
      "Topic":"8feedback","Unread":20}
  ]
}

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.