User.ScratchPad.get

User.ScratchPad.get

Description

Gets the next x number of messages for a custom client. Requires OAuth authentification.

Method

GET

Endpoint

http://api.cixonline.com/v1.0/cix.svc/user/{client}/{max}/{back}/scratchpad(.xml/.json)

Parameters

Required	Name	Type	Description
yes	client	string	The name of your given client.
yes	max	int	The number of messages to return.
yes	back	int	Retrieve x messages from new topics. Usually set to 0.

Example Request

http://api.cixonline.com/v1.0/cix.svc/user/cixtoast/5/0/scratchpad(.xml/.json)

Example Return XML

<Scratchpad xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>5</Count> 
  <Messages> 
    <Msg> 
      <Author>phinch</Author> 
      <Body>Advocates... trimmed for readability.</Body> 
      <DateTime>26/10/2009 11:55:01</DateTime> 
      <Flag /> 
      <Forum>linux</Forum> 
      <ID>3961</ID> 
      <Read /> 
      <Replies>0</Replies> 
      <ReplyTo>3960</ReplyTo> 
      <Topic>10beginners</Topic> 
    </Msg> 
    <Msg> 
      <Author>phinch</Author> 
      <Body>Whilst I disagree... trimmed for readability.</Body> 
      <DateTime>26/10/2009 11:55:01</DateTime> 
      <Flag /> 
      <Forum>linux</Forum> 
      <ID>3428</ID> 
      <Read /> 
      <Replies>0</Replies> 
      <ReplyTo>3360</ReplyTo> 
      <Topic>3lounge</Topic> 
    </Msg> 
    <Msg> 
      <Author>phinch</Author> 
      <Body>> Windows didn't go 3.0 -> 3.11... trimmed for readability.</Body> 
      <DateTime>26/10/2009 11:55:02</DateTime> 
      <Flag /> 
      <Forum>linux</Forum> 
      <ID>3429</ID> 
      <Read /> 
      <Replies>0</Replies> 
      <ReplyTo>3366</ReplyTo> 
      <Topic>3lounge</Topic> 
    </Msg> 
    <Msg> 
      <Author>phinch</Author> 
      <Body>Good point... trimmed for readability.</Body> 
      <DateTime>26/10/2009 11:55:02</DateTime> 
      <Flag /> 
      <Forum>linux</Forum> 
      <ID>3430</ID> 
      <Read /> 
      <Replies>0</Replies> 
      <ReplyTo>3368</ReplyTo> 
      <Topic>3lounge</Topic> 
    </Msg> 
    <Msg> 
      <Author>phinch</Author> 
      <Body>This Windows 2000 PC... trimmed for readability.</Body> 
      <DateTime>26/10/2009 11:55:02</DateTime> 
      <Flag /> 
      <Forum>pc</Forum> 
      <ID>1110</ID> 
      <Read /> 
      <Replies>0</Replies> 
      <ReplyTo>1102</ReplyTo> 
      <Topic>9general</Topic> 
    </Msg> 
  </Messages> 
</Scratchpad>

Example Return JSON

{
  "Count":8,
  "Messages":[
    {
      "Author":"pmcleod",
      "Body":"£20\u000a\u000aPete Mc\u000a\u000a",
      "DateTime":"25\/10\/2009 17:02:08",
      "Flag":"",
      "Forum":"auction",
      "ID":"3556",
      "Read":"",
      "Replies":0,
      "ReplyTo":3553,
      "Topic":"22bids"
    },
    {
      "Author":"urbanwt",
      "Body":"AVR without... trimmed for readability.",
      "DateTime":"26\/10\/2009 10:47:28",
      "Flag":"",
      "Forum":"avr",
      "ID":"3786",
      "Read":"",
      "Replies":0,
      "ReplyTo":0,
      "Topic":"2chatter"
    },
    {"Author":"gjwalker","Body":"Yes but at least... trimmed for readability.","DateTime":"25\/10\/2009 14:04:37","Flag":"","Forum":"bbc.radio","ID":"3404","Read":"","Replies":1,"ReplyTo":3403,"Topic":"tellytootoo"},
    {"Author":"efrog","Body":";-)... trimmed for readability.","DateTime":"25\/10\/2009 15:02:10","Flag":"","Forum":"bbc.radio","ID":"3405","Read":"","Replies":0,"ReplyTo":3404,"Topic":"tellytootoo"},
    {"Author":"igordon","Body":"I know... trimmed for readability.","DateTime":"25\/10\/2009 15:05:25","Flag":"","Forum":"bikers","ID":"3008","Read":"","Replies":0,"ReplyTo":3006,"Topic":"19nonbike_qury"},
    {"Author":"fullbore","Body":"But once again... trimmed for readability.","DateTime":"25\/10\/2009 16:50:51","Flag":"","Forum":"bikers","ID":"3009","Read":"","Replies":0,"ReplyTo":3007,"Topic":"19nonbike_qury"},
    {"Author":"hypercube","Body":"Well I just had... trimmed for readability.","DateTime":"26\/10\/2009 04:46:57","Flag":"","Forum":"bikers","ID":"3010","Read":"","Replies":0,"ReplyTo":2948,"Topic":"19nonbike_qury"},
    {"Author":"techhelp","Body":"there you go... trimmed for readability.","DateTime":"26\/10\/2009 11:44:51","Flag":"","Forum":"bikers","ID":"3011","Read":"","Replies":0,"ReplyTo":3003,"Topic":"19nonbike_qury"}]}

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.