Feed item

Read/write

This resource type refers to a user’s feed item.

In other Collection+JSON resource representations this resource type is linked by any link relation with attribute:

"rel": "feed"

GET /api/v1/(int: feed_id)/

Synopsis:Gets an authenticated user’s feed.

Example request:

GET /api/v1/35/ HTTP/1.1
Host: localhost:8000
Accept: application/vnd.collection+json

Example response:

HTTP/1.1 200 OK
Allow: GET, PUT, DELETE
Content-Type: application/vnd.collection+json

{
    "collection": {
        "href": "https://localhost:8000/api/v1/35/",
        "items": [
            {
                "data": [
                    {
                        "name": "name",
                        "value": ""
                    }
                ],
                "href": "https://localhost:8000/api/v1/35/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/users/2/",
                        "rel": "owner"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/note35/",
                        "rel": "note"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/tags/",
                        "rel": "tags"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/comments/",
                        "rel": "comments"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/files/",
                        "rel": "files"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/instances/60/",
                        "rel": "plugin_inst"
                    }
                ]
            }
        ],
        "links": [],
        "template": {
            "data": [
                {
                    "name": "name",
                    "value": ""
                },
                {
                    "name": "owner",
                    "value": ""
                }
            ]
        },
        "version": "1.0"
    }
}

Request Headers:  

• Accept – application/vnd.collection+json

Response Headers:  

• Content-Type – application/vnd.collection+json

Status Codes:

• 200 OK – no error
• 401 Unauthorized – authentication credentials were not provided
• 404 Not Found – not found

Properties (API semantic descriptors):

• name (string) – feed’s name. Can be part of the template object in PUT requests
• owner (string) – username of a new feed’s owner. Can be part of the template object in PUT requests. Feeds can have more than one owner so they can be shared between users

Link Relations:

• owner – links to an owner of the feed
• note – links to the feed’s note
• tags – links to the feed’s collection of tags
• comments – links to the feed’s collection of comments
• files – links to the feed’s collection of files
• plugin_inst – links to the plugin instance that created the feed