Feeds 1.2

Sanitation

The following attributes are not sanitized meaning: including them in your web application can lead to XSS:

• title
• link

Get all feeds

• Status: Implemented
• Method: GET
• Route: /feeds
• Parameters: none
• Returns:

{
  "feeds": [
    {
      "id": 39,
      "url": "http://feeds.feedburner.com/oatmealfeed",
      "title": "The Oatmeal - Comics, Quizzes, & Stories",
      "faviconLink": "http://theoatmeal.com/favicon.ico",
      "added": 1367063790,
      "folderId": 4,
      "unreadCount": 9,
      "ordering": 0, // 0 means no special ordering, 1 means oldest first, 2 newest first, new in 5.1.0
      "link": "http://theoatmeal.com/",
      "pinned": true // if a feed should be sorted before other feeds, added in 6.0.3,
      "updateErrorCount": 0, // added in 8.6.0, 0 if no errors occured during the last update, 
                             // otherwise is incremented for each failed update. 
                             // Once it reaches a threshold, a message should be displayed to the user 
                             // indicating that the feed has failed to update that many times. 
                             // The webapp displays the message after 50 failed updates
      "lastUpdateError": "error message here"  // added in 8.6.0, empty string or null if no update 
                                               // error happened, otherwise contains the last update error message
    }, // etc
  ],
  "starredCount": 2,
  "newestItemId": 3443  // only sent if there are items
}

Create a feed

Creates a new feed and returns the feed

• Status: Implemented
• Method: POST
• Route: /feeds
• Parameters:

{
  "url": "http:\/\/www.cyanogenmod.org\/wp-content\/themes\/cyanogenmod\/images\/favicon.ico",
  "folderId": 81 //  id of the parent folder, 0 for root
}

• Return codes:
• HTTP 409: If the feed exists already
• HTTP 422: If the feed cant be read (most likely contains errors)
• Returns:

{
  "feeds": [
    {
      "id": 39,
      "url": "http://feeds.feedburner.com/oatmealfeed",
      "title": "The Oatmeal - Comics, Quizzes, & Stories",
      "faviconLink": "http://theoatmeal.com/favicon.ico",
      "added": 1367063790,
      "folderId": 4,
      "unreadCount": 9,
      "ordering": 0, // 0 means no special ordering, 1 means oldest first, 2 newest first, new in 5.1.0
      "link": "http://theoatmeal.com/",
      "pinned": true // if a feed should be sorted before other feeds, added in 6.0.3
    }
  ],
  "newestItemId": 23 // only sent if there are items
}

Delete a feed

Deletes a feed with the id feedId and all of its items

• Status: Implemented
• Method: DELETE
• Route: /feeds/{feedId}
• Parameters: none
• Return codes:
• HTTP 404: If the feed does not exist
• Returns: nothing

Move a feed to a different folder

• Status: Implemented
• Method: PUT
• Route: /feeds/{feedId}/move
• Parameters:

{
  "folderId": 0 //  id of the parent folder, 0 for root
}

• Return codes:
• HTTP 404: If the feed does not exist
• Returns: nothing

Rename a feed

• Status: Implemented in 1.807
• Method: PUT
• Route: /feeds/{feedId}/rename
• Parameters:

{
  "feedTitle": 'New Title'
}

• Return codes:
• HTTP 404: If the feed does not exist
• Returns: nothing

Mark items of a feed as read

• Status: Implemented
• Method: PUT
• Route: /feeds/{feedId}/read
• Parameters:

{
  // mark all items read lower than equal that id
  // this is mean to prevent marking items as read which the client/user does not yet know of
  "newestItemId": 10 
}

• Return codes:
• HTTP 404: If the feed does not exist
• Returns: nothing