Forum.Details.get

Description

Returns the title, description and other details related to the forum. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

Required Name Type Description
required forum string The name of the forum to return details for.

Example Request

Example Return XML

<ForumDetails xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Category>CIX</Category> 
  <Description>There are a few conferences in CIX for information...</Description> 
  <FirstPost>31/05/2002 15:42:12</FirstPost> 
  <LastPost>21/10/2008 06:34:27</LastPost> 
  <Name>cix.customer</Name> 
  <Recent>218</Recent> 
  <SubCategory>Feedback</SubCategory> 
  <Title>For all feedback on the CIX Conferencing system.</Title> 
  <Topics>16</Topics> 
  <Type>o</Type> 
</ForumDetails>

Example Return JSON

{
  "Category":"CIX",
  "Description":"There are a few conferences in CIX for information...",
  "FirstPost":"31\/05\/2002 15:42:12",
  "LastPost":"21\/10\/2008 06:34:27",
  "Name":"cix.customer",
  "Recent":"218",
  "SubCategory":"Feedback",
  "Title":"For all feedback on the CIX Conferencing system.",
  "Topics":"16",
  "Type":"o"
}

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/forum.details.get.txt · Last modified: 2008/10/21 11:17 by charlie
 
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