REST API

Introduction

Believe it or not, RuckSack has a RESTful XML API.

The API 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 XML request.

Objects covered in the REST API are as follows. Note that some objects are nested in other objects, notably anything that goes on a Page.

• Journals
• Status
• Reminders
• Users
  • Journals
  • Reminders
  • Pages
  • Dashboard
  • Status
• Pages
  • Lists
    • ListItems
  • Notes
  • Separators
  • Emails
  • UploadedFiles
• Session

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.