Memberships

For linking users and groups together. The authenticated user has to be an administrator to perform these actions.

Show

GET /memberships/#{id}.xml

Show an existing membership.

Response

Status: 200 OK

<membership>
  <id type="integer">1</id>
  <group-id type="integer">1</group-id>
  <user-id type="integer">1</user-id>
  <created-at type="datetime">2007-04-23T20:25:29Z</created-at>
  <updated-at type="datetime">2007-04-23T20:25:29Z</updated-at>
</membership>

List All

GET /memberships.xml

Returns a collection of all the memberships.

Response

Status: 200 OK

<memberships>
  <membership>
    ...
  </membership>
  <membership>
    ...
  </membership>
</memberships>

Create

POST /memberships.xml

Creates a new membership between a user and a group.

Request

<membership>
  <user_id type="integer">1</user_id>
  <group_id type="integer">2</group_id>
</membership>

Response

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

<membership>
  ...
</membership>

Destroy

DELETE /memberships/#{id}.xml

Removes the membership between the user and the group.

Response

Status: 200 OK