Forum.TopicThread.get

Forum.TopicThread.get

Description

Returns a subset or all of the messages in a thread. Requires OAuth authentification.

Method

GET

Endpoint

http://api.cixonline.com/v1.0/cix.svc/forums/{forum}/{topic}/{msgid}/thread(.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.
	msgid	string	The id of a message in the thread.
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/2/thread.xml

Example Return XML

<MessageResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>5</Count> 
  <Messages> 
    <Message> 
      <Author>xxx</Author> 
      <Body>Welcome to cix.customer/8feedback...Body> 
      <DateTime>31/05/2008 15:10:11</DateTime> 
      <Depth>0</Depth> 
      <Forum>cix.customer</Forum> 
      <ID>2</ID> 
      <Priority>true</Priority> 
      <ReplyTo>0</ReplyTo> 
      <RootID>2</RootID> 
      <Starred>false</Starred> 
      <Status>R</Status> 
      <Topic>8feedback</Topic> 
    </Message> 
    <Message> 
      <Author>xxx</Author> 
      <Body>Curious...</Body> 
      <DateTime>31/05/2008 15:16:37</DateTime> 
      <Depth>1</Depth> 
      <Forum>cix.customer</Forum> 
      <ID>3</ID> 
      <Priority>true</Priority> 
      <ReplyTo>2</ReplyTo> 
      <RootID>2</RootID> 
      <Starred>false</Starred> 
      <Status>R</Status> 
      <Topic>8feedback</Topic> 
    </Message> 
  </Messages> 
  <Start>0</Start> 
</MessageResultSet>

Example Return JSON

{
  "Count":5,
  "Messages":[
    {"Author":"xxx","Body":"Welcome to cix.customer\/8feedback...",
      "DateTime":"31\/05\/2008 15:10:11","Depth":0,"Forum":"cix.customer","ID":2,
      "Priority":true,"ReplyTo":0,"RootID":2,"Starred":false,
      "Status":"R","Topic":"8feedback"},
    {"Author":"xxx","Body":"Curious...",
      "DateTime":"31\/05\/2008 15:16:37","Depth":1,"Forum":"cix.customer","ID":3,
      "Priority":true,"ReplyTo":2,"RootID":2,"Starred":false,
      "Status":"R","Topic":"8feedback"}
  ],
  "Start":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.