Folders 1.2

Get all folders

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

{
  "folders": [
    {
      "id": 4,
      "name": "Media"
    }, // etc
  ]
}

Create a folder

Creates a new folder and returns a new folder object

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

{
  "name": "folder name"
}

• Return codes:
• HTTP 409: If the folder exists already
• HTTP 422: If the folder name is invalid (for instance empty)
• Returns:

{
  "folders": [
    {
      "id": 4,
      "name": "Media"
    }
  ]
}

Delete a folder

Deletes a folder with the id folderId and all the feeds it contains

• Status: Implemented
• Method: DELETE
• Route: /folders/{folderId}
• Parameters: none
• Return codes:
• HTTP 404: If the folder does not exist
• Returns: nothing

Rename a folder

Only the name can be updated

• Status: Implemented
• Method: PUT
• Route: /folders/{folderId}
• Parameters:

{
  "name": "folder name"
}

• Return codes:
• HTTP 409: If the folder name does already exist
• HTTP 404: If the folder does not exist
• HTTP 422: If the folder name is invalid (for instance empty)
• Returns: nothing

Mark items of a folder as read

• Status: Implemented
• Method: PUT
• Route: /folders/{folderId}/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