Open Kote

Open Kote API

Want to integrate your app with Kote?
Want to create a note from your app?
Want to create a widget or a tool for Kote?

Now Kote is openned for everyone!.

You can use our API to create, update, search, list and delete notes from Kote. The easiest way to let Kote users manage Kote notes.

Download our Eclipse test project or the test app in order to see how it works.

 

API

For all applications, password must be provided, this password is configured in Kote.

Current API version is 1.

Add

Add a new note.

Intent: com.crayontech.kote.openkote.action.Add

Extra params:

version (int) = API version number. Mandatory

password (string) = kote password. Mandatory

title (string) = note title (no more than 60 characters). Mandatory
note (string) = note text. Mandatory
address (string) = note address
datetime (long) = date time for note alarm

Extra returned:

noteId (int) = added note id.
resultCode (int) =

0: ok
-1: invalid version number
-2: password invalid
-3: Mandatory field needed

Update

Update an existing note. Invalid note id are not reported. Be carefull to check it by listing or searching the note.

Intent: com.crayontech.kote.openkote.action.UPDATE

Extra params:

version 9int) = API version number. Mandatory

password (string) = kote password. Mandatory

noteId (string) = Note id. Mandatory

title (string) = note title (no more than 60 characters)
note (string) = note text
address (string) = note address
datetime (long)= date time for note alarm

Extra returned:

resultCode (int) =

0: ok, note updated
-1: invalid version number
-2: invalid password.
-3: Mandatory field needed

Delete

Delete an existing note. Deleted note will be send to recycle bin.

Intent: com.crayontech.kote.openkote.action.DELETE

Extra params:

version (int) = API version number. Mandatory

password (string) = kote password. Mandatory

noteId (int) = Note id.. Mandatory

Extra returned:

resultCode (int) =

0: ok, the id of deleted note.
-1: invalid version number
-2: password invalid
-3: provided id does not exist

 Search

Search text in a note, it searchs within a title and note's text.

Intent: com.crayontech.kote.openkote.action.SEARCH

Extra params:

version (int) = API version number. Mandatory

password (string) = kote password. Mandatory

text (string) = text. Mandatory

Extra returned:

resultCode (int) =

0: ok
-1: invalid version number
-2: invalid password
-3: text can not be null or empty

ArrayList of  NotesVO class

public class NoteVO implements Serializable {
    public Integer id;
    public String title;
    public String note;
    public String address;
    public Long alarm;
    public Boolean isAlarmSet;
    public Boolean isLocked;
    public Long created;
    public Long modified;
}

List

Intent: com.crayontech.kote.openkote.action.LIST

Extra params:

version (int) = API version number. Mandatory

password (string) = kote password. Mandatory

Extra returned: ArrayList of  NotesVO class

resultCode (int) =

0: ok
-1: invalid version number
-2: invalid password

Comments

Crayontech wrote on 01-Mar-10 00:15
Uri uri = Uri.parse("content://com.crayontech.kote.provider.NotePad/notes"); uri = ContentUris.withAppendedId(uri, 1); startActivity(new Intent(Intent.ACTION_EDIT, uri)); Where 1 is the id of your note.
Jim Macon wrote on 23-Feb-10 09:35
Do you have intent to view a note. This is required for example after you search for a note you want to allow the user to click on the note view its contents from your app and perhaps update the note.

Post your comment here:

Name Comment Security Code Reload Image Verify Code

Updated: December 28, 2010