Directory.CategoryForums.get

Description

Returns all the forums listed under a directory category. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

Required Name Type Description
required category string The category to return results for.

Example Request

Example Return XML

<DirListings xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>33</Count> 
  <Forums> 
    <Listing> 
      <Cat>Arts</Cat> 
      <Forum>films</Forum> 
      <Recent>1</Recent> 
      <Sub>Film</Sub> 
      <Title>What's happening on the big screen.</Title> 
      <Type>o</Type> 
    </Listing> 
    <Listing> 
      <Cat>Arts</Cat> 
      <Forum>acronyms</Forum> 
      <Recent>11</Recent> 
      <Sub>Literature</Sub> 
      <Title>Everything you wanted to know...</Title> 
      <Type>o</Type> 
    </Listing> 
  </Forums> 
  <Start>0</Start> 
</DirListings>

Example Return JSON

{
  "Count":33,
  "Forums":[
    {"Cat":"Arts","Forum":"films","Recent":"1","Sub":"Film",
      "Title":"What's happening on the big screen.","Type":"o"},
    {"Cat":"Arts","Forum":"acronyms","Recent":"11","Sub":"Literature",
      "Title":"Everything you wanted to know...","Type":"o"}
  ],
  "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.
 
cix.api/directory.categoryforums.get.txt · Last modified: 2008/10/16 10: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