Project

General

Profile

Rest Groups » History » Revision 2

Revision 1 (Jean-Philippe Lang, 2012-06-03 15:09) → Revision 2/10 (Jean-Philippe Lang, 2012-06-03 15:10)

h1. Groups 

 {{>toc}} 

 h2. /groups.:format 

 h3. GET 

 Returns the list of groups. 

 +Example+: 

   GET /groups.xml 

 +Response+: 

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

 h3. 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+: 

 <pre> 
 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> 
 </pre> 

 +Response+: 

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

 h2. /groups/:id.:format 

 h3. PUT TODO 

 h3. DELETE 

 h2. /groups/:id/users.:format 

 h3. POST TODO 

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

 h3. DELETE TODO