Forum Class

Description

The Forum class is used for submiting forum details to the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point.

Property Type Description
Name string The name of the forum.
Type string Must be o,p or c for open/private/closed.
Category string Must be a valid top level directory category.
SubCategory string Must be a valid sub category of the category.
Title string The title of the forum (max length 255).
Description string The description of the forum.

Example XML

<Forum xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <Category>cix</Category>
   <Description>A test forum with description</Description>
   <Name>TestForum</Name>
   <Title>A test forum<Title>
   <Type>o</Type>
   <SubCategory>development</SubCategory>
</Forum>

Example JSON

{
   "Name":"TestForum",
   "Type":"o",
   "Category":"cix",
   "SubCategory":"development",
   "Title":"A test forum",
   "Description":"A test forum with description"
}
 
cix.api/class.forum.txt · Last modified: 2008/10/16 12:12 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