REST API

At a high level, the API is an HTTP based protocol, using URLs to identify objects and HTTP commands to identify actions on those objects. Right now, there are just two objects:

• Users
• Congas.

The HTTP commands work as follows.

• Create/read/update/delete is handled by POST/GET/PUT/DELETE commands.
• Success/failure is handled through the normal HTTP return codes.
  • 200 - the request succeeded
  • 400 - the request is badly formed (usually due to missing fields)
  • 403 - the request is not authorised
  • 404 - the requested object cannot be found
  • 409 - the request is disallowed due to consistency checks (usually adding an existing conga)
• Requests generally return the current state of the object being manipulated (or blank for deletes).
• Register/deregister is just user creation/deletion - i.e. POST/DELETE.
• Joining a conga is just updating the conga - i.e. PUT.