<h2>Introduction</h2>
<p>Believe it or not, RailsCollab has a RESTful <span class="caps">XML</span> <span class="caps">API</span> (not to be confused with the Basecamp <span class="caps">API</span> implementation).</p>
<p>Currently RailsCollab implements resources for the following objects:</p>
<ul>
<li>Task lists (/project/:project_id/task_lists)</li>
<li>Tasks (/project/:project_id/task_lists/:task_list_id/tasks)</li>
<li>Messages (/project/:project_id/messages)</li>
<li>Message Categories (/project/:project_id/categories)</li>
<li>Files (/project/:project_id/files)</li>
<li>File Folders (/project/:project_id/folders)</li>
<li>Milestones (/project/:project_id/milestones)</li>
<li>Times (/project/:project_id/times)</li>
</ul>
<p>The following have yet to be implemented:</p>
<ul>
<li>Projects (/project)</li>
<li>Users (/users)</li>
<li>Companies (/companies)</li>
</ul>
<p>Since token logins are not yet implemented for these RESTful API’s, you will need to snatch a session id from a current session.</p>
<h2>Task Lists</h2>
<p>Task Lists are located at “/project/:project_id/task_lists.xml”, and are represented as follows:</p>
<pre><code>
<task-list>
<description>Task List Description</description>
<id type="integer">1</id>
<is-private type="boolean">false</is-private>
<milestone-id type="integer">2</milestone-id>
<name>The first TODO LIST!</name>
<priority type="integer">1</priority>
<tags/>
</task-list>
</code></pre>
<p>As you have probably figured out, task items are not represented in the <span class="caps">XML</span> response.</p>
<p>The properties you can assign are as follows:</p>
<ul>
<li>name (string)</li>
<li>priority (integer)</li>
<li>description (text)</li>
<li>milestone-id (integer)</li>
<li>is-private (boolean)</li>
<li>tags (string, comma separated)</li>
</ul>
<p>Normal rails resource routing applies, i.e.:</p>
<ul>
<li><span class="caps">POST</span> “/project/:project_id/task_lists.xml” to create task lists</li>
<li><span class="caps">PUT</span> “/project/:project_id/task_lists/:task_list_id.xml” to update a task list</li>
<li><span class="caps">DELETE</span> “/project/:project_id/task_lists/:task_list_id.xml” to delete a task list</li>
</ul>
<h2>Task List Items</h2>
<p>Task Lists Items are located at “/project/:project_id/task_lists/:task_list_id/tasks.xml”, and are represented as follows:</p>
<pre><code>
<task>
<completed-by-id type="integer">1</completed-by-id>
<completed-on type="datetime">2008-10-16T00:01:25+01:00</completed-on>
<created-by-id type="integer">1</created-by-id>
<created-on type="datetime">2008-10-16T00:01:23+01:00</created-on>
<id type="integer">4</id>
<order type="integer">2</order>
<text>Fudge</text>
<updated-on type="datetime">2008-10-16T00:01:25+01:00</updated-on>
<assigned-to-id>0</assigned-to-id>
</task>
</code></pre>
<p>The properties you can assign are as follows:</p>
<ul>
<li>text (text)</li>
<li>assigned-to-id (integer, prefixed with c for company then company-id, otherwise user-id)</li>
<li>task-list-id (integer)</li>
</ul>
<p>Normal rails resource routing applies, i.e.:</p>
<ul>
<li><span class="caps">POST</span> “/project/:project_id/task_lists/:task_list_id/tasks.xml” to create tasks</li>
<li><span class="caps">PUT</span> “/project/:project_id/task_lists/:task_list_id/tasks/:task_id.xml” to update a task</li>
<li><span class="caps">DELETE</span> “/project/:project_id/task_lists/:task_list_id/tasks/:task_id.xml” to delete a task</li>
</ul>
2008-10-16T01:24:23-07:00
67878
rest-api
18257
REST API
2009-07-23T06:08:08-07:00
10850