Forum.Search.post

Description

To search forums you must first populate and post a SearchRequest object.

Requires OAuth authentification.

Method

POST

Endpoint

Parameters

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

Example Request

Example Return XML

<SearchResultSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>2</Count> 
  <Messages> 
    <SearchResult> 
      <Author>xxx</Author> 
      <DateTime>14/03/2008 14:58:42</DateTime> 
      <Forum>pc_pro</Forum> 
      <ID>62</ID> 
      <Score>3</Score> 
      <Subject>Anecdotal data...</Subject> 
      <Topic>6chatter</Topic> 
    </SearchResult> 
    <SearchResult> 
      <Author>xxx</Author> 
      <DateTime>14/03/2008 20:26:48</DateTime> 
      <Forum>pc_pro</Forum> 
      <ID>68</ID> 
      <Score>3</Score> 
      <Subject>My old iBook...</Subject> 
      <Topic>6chatter</Topic> 
    </SearchResult> 
  </Messages> 
  <Start>0</Start> 
</SearchResultSet>

Example Return JSON

{
  "Count":2,
  "Messages":[
    {"Author":"tayside","DateTime":"14\/03\/2008 14:58:42",
      "Forum":"pc_pro","ID":"62","Score":"3","Subject":"Anecdotal data...","Topic":"6chatter"},
    {"Author":"hex","DateTime":"14\/03\/2008 20:26:48",
      "Forum":"pc_pro","ID":"68","Score":"3","Subject":"My old iBook...","Topic":"6chatter"}
  ],
  "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/forum.search.post.txt · Last modified: 2008/10/15 16:10 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