Starred.get

Description

List the user starred messages. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

Required Name Type Description

Example Request

Example Return XML

<StarSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>117</Count> 
  <Stars> 
    <Star> 
      <Author>xxx</Author> 
      <Conf>cix.customer</Conf> 
      <MsgID>2732</MsgID> 
      <PostedDate>2008-10-10T15:17:44</PostedDate> 
      <Subject>Forums "sync on sign in"...</Subject> 
      <Topic>8feedback</Topic> 
      <starID>882</starID> 
    </Star> 
    <Star> 
      <Author>xxx</Author> 
      <Conf>products</Conf> 
      <MsgID>771</MsgID> 
      <PostedDate>2008-10-08T11:09:05</PostedDate> 
      <Subject>_PM Terminology_</Subject> 
      <Topic>forums</Topic> 
      <starID>876</starID> 
    </Star> 
  </Stars> 
  <Start>1</Start> 
</StarSet>

Example Return JSON

{
  "Count":117,
  "Stars":[
    {"Author":"xxx","Conf":"cix.customer","MsgID":2732,
      "PostedDate":"\/Date(1223648264000+0100)\/","Subject":"Forums \"sync on sign in\" ...",
      "Topic":"8feedback","starID":882},
    {"Author":"xxx","Conf":"products","MsgID":771,
      "PostedDate":"\/Date(1223460545000+0100)\/","Subject":"_PM Terminology_...",
      "Topic":"forums","starID":876}
  ],
  "Start":1
}

Error Codes

Code Description
401 Authentication failed. Missing required parameter : {parameter name}.
401 Signature expired. Either the timestamp or the nonce have expired or are invalid.
 
cix.api/starred.get.txt · Last modified: 2008/10/20 13:08 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