Skip to content
Bernhard Posselt edited this page Aug 18, 2013 · 15 revisions

Get all notes

  • Status: Implemented
  • Method: GET
  • Route: /notes
  • Parameters: none
  • Returns:
[
    {
        id: 76,
        modified: 1376753464,
        title: "New note"
        content: "New note\n and something more",
    }, // etc
]

Get a note

  • Status: Implemented
  • Method: GET
  • Route: /notes/{noteId}
  • Parameters: none
  • Return codes:
  • HTTP 404: If the note does not exist
  • Returns:
{
    id: 76,
    modified: 1376753464,
    title: "New note"
    content: "New note\n and something more",
}

Create a note

Creates a new note and returns the note. This does not set any title or content. The returned JSON includes an id which can be used to create an update request.

  • Status: Implemented
  • Method: POST
  • Route: /notes
  • Parameters:
{
    content: "New content",
    title: "New title"
}
  • Returns:
{
    id: 76,
    content: "",
    modified: 1376753464,
    title: ""
}

Update a note

Updates a note with the id noteId. Always update your app with the returned title because the title can be renamed if there are collisions on the server

  • Status: Implemented
  • Method: PUT
  • Route: /notes/{noteId}
  • Parameters:
{
    content: "New content",
    title: "New title"
}
  • Return codes:
  • HTTP 404: If the note does not exist
  • Returns:
{
    id: 76,
    content: "New content",
    modified: 1376753464,
    title: "New title"
}

Delete a note

Deletes a note with the id noteId

  • Status: Implemented
  • Method: DELETE
  • Route: /notes/{noteId}
  • Parameters: none
  • Return codes:
  • HTTP 404: If the note does not exist
  • Returns: nothing
Clone this wiki locally