Note

Read/write

This resource type refers to a feed note.

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

"rel": "note"

GET /api/v1/note(int: note_id)/

Synopsis:Gets a feed note.

Example request:

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

Example response:

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

{
    "collection": {
        "href": "https://localhost:8000/api/v1/note35/",
        "items": [
            {
                "data": [
                    {
                        "name": "title",
                        "value": ""
                    },
                    {
                        "name": "content",
                        "value": ""
                    }
                ],
                "href": "https://localhost:8000/api/v1/note35/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/35/",
                        "rel": "feed"
                    }
                ]
            }
        ],
        "links": [],
        "template": {
            "data": [
                {
                    "name": "title",
                    "value": ""
                },
                {
                    "name": "content",
                    "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
• 403 Forbidden – you do not have permission to perform this action
• 404 Not Found – not found

Properties (API semantic descriptors):

• title (string) – note’s title. Can be part of the template object in PUT requests
• content (string) – note’s content. Can be part of the template object in PUT requests

Link Relations:

• feed – links to the corresponding feed