Rule Class

Rule Class

Description

The Rule class is used for submiting new rule 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
RuleID	string	The id of the rule 0 for a new one.
Username	string	The user the rule is to apply to.
Forum	string	The forum being moderated.
Topic	string	The topic the rule is for (can be blank to imply for all topics).
CanPost	string	1 to say the user can post 0 to block posts.
Banned	string	1 if the user is to be blocked from joining, 0 to all the user to join.

Example XML

<Forum xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <Banned>0</Banned>
   <CanPost>0</CanPost>
   <Forum>TestForum</Forum>
   <RuleID>0<RuleID>
   <Topic/>
   <Username>charlie</Username>
</Forum>

Example JSON

{
   "RuleID":"0",
   "Username":"charlie",
   "Forum":"TestForum",
   "Topic":"",
   "CanPost":"0",
   "Banned":"0"
}