Directory.Search.post

Description

To search the directory you must first populate and post a SearchRequest object. The directory search only uses the Query field.

Requires OAuth authentification.

Method

POST

Endpoint

Parameters

Required Name Type Description
required new search SearchRequest A populated SearchRequest object

Example Request

Example Return XML

<DirListings xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>275</Count> 
  <Forums> 
    <Listing> 
      <Cat>Arts</Cat> 
      <Forum>limericks</Forum> 
      <Recent>0</Recent> 
      <Sub>Literature</Sub> 
      <Title>There was a subscriber on CIX, Who got into a bit of a fix</Title> 
      <Type>o</Type> 
    </Listing> 
    <Listing> 
      <Cat>Arts</Cat> 
      <Forum>sf</Forum> 
      <Recent>2</Recent> 
      <Sub>Literature</Sub> 
      <Title>Science Fiction & Fantasy</Title> 
      <Type>o</Type> 
    </Listing> 
  </Forums> 
  <Start>0</Start> 
</DirListings>

Example Return JSON

{
  "Count":275,
  "Forums":[
    {"Cat":"Arts","Forum":"limericks","Recent":"0","Sub":"Literature",
      "Title":"There was a subscriber on CIX, Who got into a bit of a fix","Type":"o"},
    {"Cat":"Arts","Forum":"sf","Recent":"2","Sub":"Literature",
      "Title":"Science Fiction & Fantasy","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.search.post.txt · Last modified: 2008/10/16 10:18 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