群組¶

• 目錄
• 群組
  • /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 已建立: 群組已建立
• 422 無法處理的實體: 由於驗證失敗，群組未建立（回應主體包含錯誤訊息）

/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 無內容: 使用者已新增至群組

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

DELETE¶

從群組中移除使用者。

此端點需要管理員權限。

範例:

DELETE /groups/10/users/5.xml

回應:

• 204 無內容: 使用者已從群組中移除