Synotes - Notes for the best of us.
Synotes on iPad
Synotes on iPhone
Synotes on the Web
 
Synotes REST API (beta):
The Synotes REST API is created to give application developers the ability to write applications that interact with Synotes.

Don't forget to also pop us an email with what you have created. We intend to feature some exciting projects you create on the Syncode site. So please feel free to email us with what you have created, any feedback you have on the API, any errors you find or to just say hi. api@syncode.co.uk
Methods
login
load_notes
save_note
add_note
delete_note

Variables
Licence
Synotes REST API Method: login
Created to check username & password credentials and hence will return a success variable of 1 for logged in or 0 for failed to login.

URL:
https://www.syncode.co.uk/synotesapi/login.format
Formats:
xml or json
HTTP Method(s):
GET
Requires Authentication:
Yes
Parameters:
none
Response: XML example
<xml version="1.0">
<message>Your username and password is correct.</message>
<success>1</success>
</xml>
Possible Errors:
01 - Username/Password is incorrect.
Usage examples:
cURL:
curl -u user:password https://www.syncode.co.uk/synotesapi/login.xml
Synotes REST API Method: load_notes
Returns a feed of all the authenticated users notes.

URL:
https://www.syncode.co.uk/synotesapi/load_notes.format
Formats:
xml or json
HTTP Method(s):
GET
Requires Authentication:
Yes
Parameters:
none
Response: XML example
<xml version="1.0">
<notes>
<note>
<note_uuid> NOTE-ACD8C9FC-B985-49FB-ACDB-24B17D35E149-135E149-00DB24B17D35E148 </note_uuid> <note_title>My Holiday</note_title>
<note_text>I need to pack.</note_text>
<note_icon>default</note_icon>
<created>1262414672</created>
<last_updated>1262792970</last_updated>
<order>1</order>
</note>
<note>
<note_uuid>
NOTE-61340B22-317F-4B08-97AE-C7B50006FF6E-26904-0000FEB8BF7EDD7D </note_uuid>
<note_title>Shopping List</note_title>
<note_text>1. iPhone</note_text>
<note_icon>network_error</note_icon>
<created>1262334642</created>
<last_updated>1262626634</last_updated>
<order>2</order>
</note>
</notes>
</xml>
Possible Errors:
01 - Username/Password is incorrect.
Usage examples:
cURL:
curl -u user:password https://www.syncode.co.uk/synotesapi/load_notes.xml
Synotes REST API Method: save_note
Saves/updates a note into the Synotes database and returns the updated note.

URL:
https://www.syncode.co.uk/synotesapi/save_note.format
Formats:
xml or json
HTTP Method(s):
GET or POST
Requires Authentication:
Yes
Parameters:
Response: XML example
<xml version="1.0">
<notes>
<note>
<note_uuid> NOTE-ACD8C9FC-B985-49FB-ACDB-24B17D35E149-135E149-00DB24B17D35E148 </note_uuid> <note_title>My Holiday 2.0</note_title>
<note_text>I need to pack and book airfares.</note_text>
<note_icon>star</note_icon>
<created>1262414672</created>
<last_updated>1262792970</last_updated>
<order>1</order>
</note>
</notes>
</xml>
Possible Errors:
01 - Username/Password is incorrect.
02 - Unable to find the specified note.
03 - Required field left blank.
04 - Icon is not an accepted variable.
Usage examples:
cURL:
curl -u user:password https://www.syncode.co.uk/synotesapi/save_note.json?note_uuid=[note-uuid]¬e_title=[note-title]¬e_text[note-text]¬e_icon=[note-icon]
Synotes REST API Method: add_note
Creates a new note inside the Synotes' database and returns the created note. (The return is useful for grabbing the new note's uuid)

URL:
https://www.syncode.co.uk/synotesapi/add_note.format
Formats:
xml or json
HTTP Method(s):
GET or POST
Requires Authentication:
Yes
Parameters:
  • note_title. Required. The new title of the note.
  • note_text. Required. The new text of the note.
  • note_icon. Optional. The new icon of the note. (see variables for icon options).
Response: XML example
<xml version="1.0">
<notes>
<note>
<note_uuid> NOTE-ACD8C9FC-B985-49FB-ACDB-24B17D35E149-135E149-00DB24B17D35E148 </note_uuid> <note_title>My Holiday 1.0</note_title>
<note_text>I need to book airfares.</note_text>
<note_icon>star</note_icon>
<created>1262414672</created>
<last_updated>1262414672</last_updated>
<order>1</order>
</note>
</notes>
</xml>
Possible Errors:
01 - Username/Password is incorrect.
03 - Required field left blank.
04 - Icon is not an accepted variable.
Usage examples:
cURL:
curl -u user:password https://www.syncode.co.uk/synotesapi/add_note.json?note_title=[note-title]¬e_text[note-text]¬e_icon=[note-icon]
Synotes REST API Method: delete_note
Deletes a new note from the Synotes' database.

URL:
https://www.syncode.co.uk/synotesapi/delete_note.format
Formats:
xml or json
HTTP Method(s):
GET or POST
Requires Authentication:
Yes
Parameters:
  • note_uuid. Required. The uuid of the note to delete.
Response: XML example
<xml version="1.0">
<message>Note Deleted.</message>
<success>1</success>
</xml>
Possible Errors:
01 - Username/Password is incorrect.
02 - Unable to find the specified note.
Usage examples:
cURL:
curl -u user:password https://syncode.co.uk/synotesapi/delete_note.json?note_uuid=[note-uuid]
Synotes REST API Variables:
note_uuid
  • About: A unique identifier is given to each note.
  • Usage: Used to identify the note for updating and deleting.
  • Example: NOTE-ACD8C9FC-B985-49FB-ACDB-24B17D35E149-135E149-00DB24B17D35E148
  • Properties: Must be formatted as above.
note_title
  • About: A title of any given note created as a user definable identity for the note.
  • Usage: Used when adding and saving notes.
  • Example: This is a note title.
  • Properties: Plain Text. utf8 characters allowed. Must be fewer than 255 characters.
note_text
  • About: The text contents of the note.
  • Usage: Used when adding and saving notes.
  • Example: This is some note text.
  • Properties: Plain Text. utf8 characters allowed. No character limit.
note_icon
  • About: An optional add-on created to categorize notes and add style. Developers can download the same icons we use or design their own.
  • Usage: Used when adding and saving notes.
  • Example: default
  • Properties: Limited to default, address_book, alert, banned, bubble, cloud, cogwheel, music, network_error, note_info, padlock, pedestrain, pencil, star, support, sync, tick, water, window
  • Download: http://syncode.co.uk/files/synotes_icons.zip
created
  • About: The UNIX timestamp at which the note was created.
  • Usage: Returned when loading, updating and saving notes.
  • Example: 1262414672
  • Properties: Unix Timestamp
last_updated
  • About: The UNIX timestamp from when the note was last updated.
  • Usage: Returned when loading, updating and saving notes.
  • Example: 1262414672
  • Properties: Unix Timestamp
order
  • About: An integer of where the note sits in the user defined order.
  • Usage: Returned when loading, updating and saving notes.
  • Example: 1
  • Properties: Integer

Synotes REST API Licence:
We encourage developers to create unique applications and utilities using the Synotes API. For this reason no developers can duplicate functionality already created by Syncode. This includes but is not limited to web applications not providing new functionality and ANY iPhone & iPod touch applications. Duplicating functionality will result in more complicated security and keys placed upon the API that we wish to avoid.