Groups

Showing and creating groups. The authenticated user has to be an administrator to perform these actions.

Show

GET /groups/#{id}.xml

Returns a single group and the users associated with it.

Response

Status: 200 OK

<group>
  <id type="integer">1</id>
  <name>Partners</name>
  <users>
    <user>
      <id type="integer">1</id>
      <person-id type="integer">2</person-id>
      <name>david</name>
      <created-at type="datetime">2007-04-23T20:25:29Z</created-at>
      <updated-at type="datetime">2007-04-23T20:25:29Z</updated-at>
    </user>
    <user>
      <id type="integer">2</id>
      <person-id type="integer">3</person-id>
      <name>jason</name>
      <created-at type="datetime">2007-04-23T20:25:29Z</created-at>
      <updated-at type="datetime">2007-04-23T20:25:29Z</updated-at>
    </user>
  </users>
</group>

List All

GET /groups.xml

Returns a collection of groups.

Response

Status: 200 OK

<groups>
  <group>
    ...
  </group>
  <group>
    ...
  </group>
</groups>

Create

POST /groups.xml

Creates a new empty group. Users are added to the group through memberships.

Request

<group>
  <name>Partners</name>
</group>

Response

Status: 200 OK

Status: 201 Created
Location: http://example.highrisehq.com/groups/#{new-group-id}.xml

<group>
  ...
</group>

Update

PUT /groups/#{id}.xml

Updates an existing group with a new name.

Request

<group>
  <name>Senior Partners</name>
</group>

Response

Status: 200 OK

Destroy

DELETE /groups/#{id}.xml

Destroys the group at the referenced URL.

Response

Status: 200 OK