Alerts.get

Description

Get a list of messages a user has an alert for. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

^Required ^Name ^Type ^Description ^

Example Return XML

<AlertSet xmlns="http://schemas.datacontract.org/2004/07/CIX.API.Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Alerts> 
    <Alert> 
      <Active>false</Active> 
      <Conf>home_cinema</Conf> 
      <Date>2008-07-15T14:25:53.147</Date> 
      <ID>278</ID> 
      <MsgID>3763</MsgID> 
      <Topic>lounge</Topic> 
      <Type>Message</Type> 
    </Alert> 
    <Alert> 
      <Active>false</Active> 
      <Conf>home_cinema</Conf> 
      <Date>2008-07-15T14:26:47.333</Date> 
      <ID>279</ID> 
      <MsgID>3760</MsgID> 
      <Topic>lounge</Topic> 
      <Type>Thread</Type> 
    </Alert> 
  </Alerts> 
  <Count>2</Count> 
  <Start>0</Start> 
</AlertSet>

Example Return JSON

{
  "Alerts":[
    {"Active":false,"Conf":"home_cinema","Date":"\/Date(1216128353147+0100)\/",
       "ID":278,"MsgID":3763,"Topic":"lounge","Type":3},
    {"Active":false,"Conf":"home_cinema","Date":"\/Date(1216128407333+0100)\/",
       "ID":279,"MsgID":3760,"Topic":"lounge","Type":1}
  ],
  "Count":2,
  "Start":0
}

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/alerts.get.txt · Last modified: 2008/10/17 14:26 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