Mod.Rules.get

Mod.Rules.get

Description

Gets a list of rules in a forum. Requires OAuth authentification.

Method

GET

Endpoint

http://api.cixonline.com/v1.0/cix.svc/moderator/{forum}/rules(.xml/.json)

Parameters

Required	Name	Type	Description
required	forum	string	The forum to return rules for.

Example Request

http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/rules.xml

Example Return XML

<RuleResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>2</Count> 
  <Rules> 
    <Rule> 
      <Banned>False</Banned> 
      <CanPost>False</CanPost> 
      <Forum>cix.customer</Forum> 
      <RuleID>38</RuleID> 
      <Topic /> 
      <Username>xxx</Username> 
    </Rule> 
    <Rule> 
      <Banned>False</Banned> 
      <CanPost>False</CanPost> 
      <Forum>cix.customer</Forum> 
      <RuleID>40</RuleID> 
      <Topic /> 
      <Username>xxx</Username> 
    </Rule> 
  </Rules> 
  <Start>0</Start> 
</RuleResultSet>

Example Return JSON

{
  "Count":2,
  "Rules":[
    {"Banned":"False","CanPost":"False","Forum":"cix.customer","RuleID":"38","Topic":"","Username":"xxx"},
    {"Banned":"False","CanPost":"False","Forum":"cix.customer","RuleID":"40","Topic":"","Username":"xxx"},
  ],
  "Start":0
}

Error Codes

Code	Description
401	Authentication failed. Missing required parameter : {parameter name}.
401	Signature expired. Either the timestamp or the nonce have expired or are invalid.