-
Notifications
You must be signed in to change notification settings - Fork 47
Notes 0.2
Bernhard Posselt edited this page Feb 4, 2014
·
15 revisions
- Status: Implemented
- Method: GET
- Route: /notes
-
Parameters:
- exclude (0.5): fields which should be excluded, seperated with a comma (e.g.: ?exclude=content,title)
- Returns:
[
{
id: 76,
modified: 1376753464,
title: "New note"
content: "New note\n and something more",
}, // etc
]
- 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",
}
Creates a new note and returns the note. The title is generated from the first line of the content. If no content is passed, a translated string New note will be returned as title
- Status: Implemented
- Method: POST
- Route: /notes
- Parameters:
{
content: "New content"
}
- Returns:
{
id: 76,
content: "",
modified: 1376753464,
title: ""
}
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. The title is generated from the first line of the content. If no content is passed, a translated string New note will be returned as title
- Status: Implemented
- Method: PUT
- Route: /notes/{noteId}
- Parameters:
{
content: "New content",
}
- Return codes:
- HTTP 404: If the note does not exist
- Returns:
{
id: 76,
content: "New content",
modified: 1376753464,
title: "New title"
}
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