Directory.Categories.get

Description

Returns a list of the directories categories and sub categories. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

Required Name Type Description

Example Request

Example Return XML

<CategoryResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Categories> 
    <Category> 
      <Name>Arts</Name> 
      <Sub>Film</Sub> 
    </Category> 
    <Category> 
      <Name>Arts</Name> 
      <Sub>Literature</Sub> 
    </Category> 
  </Categories> 
  <Count>78</Count> 
  <Start>0</Start> 
</CategoryResultSet>

Example Return JSON

{
  "Categories":[
    {"Name":"Arts","Sub":"Film"},
    {"Name":"Arts","Sub":"Literature"}
  ],
  "Count":78,
  "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.categories.get.txt · Last modified: 2008/10/16 09:52 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