Back to the Developer home page
Returns a single note. Attachments are included, but comments are kept separate at /notes/#{id}/comments.xml.
Status: 200 OK
<note>
<id type="integer">7</id>
<subject-id type="integer">4</subject-id>
<subject-type>Party</subject-type>
<body>Hello world!</body>
<kase-id type="integer"></kase-id>
<updated-at type="datetime">2007-02-27T18:42:28Z</updated-at>
<created-at type="datetime">2006-05-16T17:26:00Z</created-at>
<visible-to>NamedGroup</visible-to>
<group-id type="integer">1</group-id>
<owner-id type="integer"></owner-id>
<author-id type="integer">3</author-id>
<attachments>
<attachment>
<id type="integer">1</id>
<url>http://example.highrisehq.com/files/1</url>
<name>picture.png</name>
<size type="integer">72633</name>
</attachment>
<attachment>
<id type="integer">2</id>
<url>http://example.highrisehq.com/files/2</url>
<name>document.txt</name>
<size type="integer">8837</name>
</attachment>
</attachments>
</note>
Returns a collection of notes that are visible to the authenticated user associated with the person
specified in the URL. The list is paginated using offsets. If 500 elements are returned (the page limit),
use ?n=500 to check for the next 500 and so on.
Status: 200 OK
<notes>
<note>
...
</note>
<note>
...
</note>
</notes>
Returns a collection of notes like List All From Person, but from a company instead. This includes all
notes that are associated with employees of the company.
Status: 200 OK
<notes>
<note>
...
</note>
<note>
...
</note>
</notes>
Returns a collection of notes like List All From Person, but from a case instead. This includes all
notes that are associated specifically with the case or with a party and the case.
Status: 200 OK
<notes>
<note>
...
</note>
<note>
...
</note>
</notes>
Creates a new note with the currently authenticated user as the author. The XML for the new note
is returned on a successful request with the timestamps recorded and ids for the contact data associated.
The subject of the note (who it belongs to) can either be set through the url or through the
subject-type and subject-id tags. Using /companies/5/notes.xml as the target for the POST is the same as
using /notes.xml with subject-type “Party” and subject-id “5”.
By default, a new note is assumed to be visible to Everyone. You can also chose to make the note only
visible to the creator using “Owner” as the value for the visible-to tag. Or “NamedGroup” and pass in a group-id
tag too.
Note: Adding attachments to a note is not yet supported.
As always, the URL for the newly-created note is passed back in the Location header.
<note>
<body>Hello world!</body>
<subject-id type="integer">4</subject-id>
<subject-type>Party</subject-type>
</note>
Status: 201 Created
Location: http://example.highrisehq.com/notes/#{new-note-id}.xml
<note>
...
</note>
Updates an existing note with new details from the submitted XML.
<note>
<body>Hello world is now part of a case!</body>
<kase-id type="integer">1</kase-id>
</note>
Status: 200 OK
Destroys the note at the referenced URL.
Status: 200 OK