组别¶

• 目录
• 组别
  • /groups.:format
    • GET
    • POST
  • /groups/:id.:format
    • GET
    • PUT
    • DELETE
  • /groups/:id/users.:format
    • POST
  • /groups/:id/users/:user_id.:format
    • DELETE

/groups.:format¶

GET¶

返回组别列表。

此端点需要管理员权限。

示例:

GET /groups.xml

响应:

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

POST¶

创建一个组别。

此端点需要管理员权限。

参数:

• group (必需): 组别属性的哈希，包括
  • name (必需): 组别名称
  • user_ids: 组别用户的ID（如果没有提供，则创建一个空组别）

示例:

POST /groups.xml

<group>
  <name>Developers</name>
  <user_ids type="array">
    <user_id>3</user_id>
    <user_id>5</user_id>
  </user_ids>
</group>

POST /groups.json

{
  "group": {
    "name": "Developers",
    "user_ids": [ 3, 5 ]
  }
}

响应:

• 201 Created: 组别已创建
• 422 Unprocessable Entity: 由于验证失败，组别未创建（响应体包含错误消息）

/groups/:id.:format¶

GET¶

返回组别的详细信息。

此端点需要管理员权限。

参数:

• include (可选): 要包含在响应中的关联列表，以逗号分隔
  • users
  • memberships

示例:

GET /groups/20.xml?include=users

响应:

<group>
  <id>20</id>
  <name>Developers</name>
  <users type="array">
    <user id="5" name="John Smith"/>
    <user id="8" name="Dave Loper"/>
  </users>
</group>

PUT¶

更新现有的组别。

此端点需要管理员权限。

DELETE¶

删除现有的组别。

此端点需要管理员权限。

/groups/:id/users.:format¶

POST¶

将现有用户添加到组别中。

此端点需要管理员权限。

参数:

• user_id (必需): 要添加到组别的用户的ID。

示例:

POST /groups/10/users.xml

<user_id>5</user_id>

响应:

• 204 No Content: 用户已添加到组别

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

DELETE¶

从组别中删除用户。

此端点需要管理员权限。

示例:

DELETE /groups/10/users/5.xml

响应:

• 204 No Content: 用户已从组别中删除