Rest Groups » History » Version 1

Version 1/9 - Next » - Current version
Jean-Philippe Lang, 2012-06-03 15:09


Groups

/groups.:format

GET

Returns the list of groups.

Example:

GET /groups.xml

Response:

<groups type="array">
  <group>
    <id>53</id>
    <name>Managers</name>
  </group>
  <group>
    <id>55</id>
    <name>Developers</name>
  </group>
</groups>

POST

Creates a group.

Parameters:

  • group (required): a hash of the group attributes, including:
    • name (required): the group name
    • user_ids: ids of the group users (an empty group is created if not provided)

Example:

POST /groups.xml

<?xml version="1.0" encoding="ISO-8859-1" ?>
<group>
  <name>Developers</name>
  <user_ids>
    <user_id>3</user_id>
    <user_id>5</user_id>
  </user_ids>
</group>

Response:

  • 201 Created: group was created
  • 422 Unprocessable Entity: group was not created due to validation failures (response body contains the error messages)

/groups/:id.:format

TODO

/groups/:id/users.:format

TODO

/groups/:id/users/:user_id.:format

TODO