<h2>Introduction</h2>
<p>Believe it or not, RuckSack has a RESTful <span class="caps">XML</span> <span class="caps">API</span>.</p>
<p>The <span class="caps">API</span> is basically a freebie offered by Rails’ RESTful controllers, so naturally it hasn’t really been formalised yet. Generally speaking, anything you can submit via a form in the interface can also be submitted in an <span class="caps">XML</span> request.</p>
<p>Objects covered in the <span class="caps">REST</span> <span class="caps">API</span> are as follows. Note that some objects are nested in other objects, notably anything that goes on a Page.</p>
<ul>
<li>Journals</li>
<li>Status</li>
<li>Reminders</li>
<li>Users
<ul>
<li>Journals</li>
<li>Reminders</li>
<li>Pages</li>
<li>Dashboard</li>
<li>Status</li>
</ul></li>
<li>Pages
<ul>
<li>Lists
<ul>
<li>ListItems</li>
</ul></li>
<li>Notes</li>
<li>Separators</li>
<li>Emails</li>
<li>UploadedFiles</li>
</ul></li>
<li>Session</li>
</ul>
<p>As you might have already noticed, some resources are duplicated within the User resource. This is mainly for convenience – the non-nested copies default to the current user, while the nested copies default to the user in the user resource.</p>
2008-10-25T11:03:15-07:00
72264
rest-api
37011
REST API
2008-10-25T11:03:15-07:00
10850