Simpy : API : REST : v1 : GetNotes

Home / APIs / REST / GetNotes

GetNotes

Description:

Returns all your Notes in the reverse chronological order by add date (i.e. the most recently added Note first) or by rank, if you use this in the search mode. You can use the limit parameter to specify the maximum number of Notes to return.

Required Parameters:

none

Optional Parameters:

q: A query string that forces the API call to return only the matching Notes. You can use the usual Simpy search syntax and search fields.
limit: Limits the number of Notes returned.

Example Requests

http://www.simpy.com/simpy/api/rest/GetNotes.do

http://www.simpy.com/simpy/api/rest/GetNotes.do?q=groovy

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<notes>
  <note accessType="private">
    <uri>http://www.simpy.com/simpy/NoteDetails.do?noteId=666</uri>
    <id>666</id>
    <modDate>date here</modDate>
    <addDate>date here</addDate>
    <title>title here</title>
    <tags>
      <tag>goober</tag>
      <tag>New York</tag>
    </tags>
    <description>I like ice-cream</description>
  </note>

  <note accessType="private">
    <uri>http://www.simpy.com/simpy/NoteDetails.do?noteId=314159265</uri>
    <modDate>date here</modDate>
    <addDate>date here</addDate>
    <title>title here</title>
    <nickname>nickname here</nickname>
    <tags>
      <tag>goober</tag>
      <tag>New York</tag>
    </tags>
    <description>tea with cookies... mmmm</description>
  </note>
</notes>

Status Codes

300: Transient data retrieval error

Overview

· Base URL: ...simpy.com/simpy/api/rest