Note API

When something is not for the To Do List, and you just cannot forget it.

"Take note, I was given confirmation code ZU3A3O9A8 for Bell Internet provider on January 11th."

End Points

Add Note

URL: https://keithweaver.ca/rest/note-api/v1/note/add

Parameters:

apikey - Your Note API key

note - The contents of the note.

name - The name of the note (Optional)

Response:

{
    "success" : true,
    "message" : "Added a new note",
    "newId" : "AABADADA"
}

Tag Note

URL: https://keithweaver.ca/rest/note-api/v1/note/tag

Parameters:

apikey - Your Note API key

noteId - The id of the note you want to tag

tag - The tag

Response:

{
    "success" : true,
    "message" : "Added a tag"
}

Delete Note

URL: https://keithweaver.ca/rest/note-api/v1/note/delete

Parameters:

apikey - Your Note API key

noteId - The id of the note you want to tag

Response:

{
    "success" : true,
    "message" : "Added a new note",
}

Edit Note

URL: https://keithweaver.ca/rest/note-api/v1/note/edit

Parameters:

apikey - Your Note API key

noteId - The id of the note you want to tag

note - New content of the notes

name - (Optional) Name of the note

Response:

{
    "success" : true,
    "message" : "Updated note"
}

Search for Note

URL: https://keithweaver.ca/rest/note-api/v1/note/search

Parameters:

apikey - Your Note API key

query - What your search for

Response:

{
    "success" : true,
    "message" : "Search for note",
    "notes" : [
        {
            "id" : "AABADADA",
            "note" : "I was given confirmation code ZU3A3O9A8 for Bell Internet provider on January 11th.",
            "tags" : [
                "exampleTag",
                "exampleTag2"
            ]
        }
    ]
}

View Note

URL: https://keithweaver.ca/rest/note-api/v1/note/view

Parameters:

apikey - Your Note API key

noteId - The id of the note you want to tag

Response:

{
    "success" : true,
    "message" : "Added a new note",
    "id" : "AABADADA"
    "note" : "I was given confirmation code ZU3A3O9A8 for Bell Internet provider on January 11th."
    "tags" : [
        "exampleTag",
        "exampleTag2"
    ]
}