group/{group_identifier}The group_identifier can be a group name (cn) or a regid. The request must not contain an If-Match header.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11/dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
</head>
<body>
<div class="group">
Regid: <span class="regid">Group's regid</span>
<br/>
Desc: <span class="description">Group's title</span>
<ul class="names">
<li class="name">Group_name</li>
</ul>
<!-- version v2 and greater -->
Authn factor: <span class="authnfactor">1</span>
<br/>
Classification: <span class="classification">u|p|r|c</span>
<br/>
Membership dependency group: <span class="dependson">dependency group cn</span>
<br/>
<!-- end v2 -->
<!-- The enabled flag is "uwexchange" or "disabled" -->
Email Enabled: <span class="emailenabled">uwexchange</span>
<!-- publishemail is set to group_name@uw.edu when the group is created. Updates to the value will be ignored -->
Published email address: <span class="publishemail">email_address</span>
Allowed senders:
<ul class="authorigs">
<li class="authorig">sender id</li>
<!-- More (li) if there are multiple allowed senders -->
</ul>
<!-- reporttoorig is a deprecated attribute. New groups will not return the attribute. Updates to the value will be ignored -->
Report to originator: <span class="reporttoorig">0 or 1</span>
Group contact: <span class="contact">contact id</span>
Admins:
<ul class="admins">
<li class="admin" type="(type)">identifier</li>
<!-- More (li) if the group has more admins -->
</ul>
<br/>
Allowed updaters:
<ul class="updaters">
<li class="updater" type="(type)">identifier</li>
<!-- More (li) if the group has multiple updaters -->
</ul>
<br/>
Allowed creators:
<ul class="creators">
<li class="creator" type="(type)">identifier</li>
<!-- More (li) if the group has multiple creators -->
</ul>
<br/>
Allowed readers
<ul class="readers">
<li class="reader" type="(type)">identifier</li>
<!-- More (li) if the group has multiple readers -->
</ul>
<br/>
Allowed viewers:
<ul class="viewers">
<li class="viewer" type="(type)">identifier</li>
<!-- More (li) if the group has multiple viewers -->
</ul>
<br/>
<!-- version v2 and greater -->
Allowed optin:
<ul class="optins">
<li class="optin" type="(type)">identifier</li>
<!-- More (li) if the group has multiple optins -->
</ul>
<br/>
Allowed optout:
<ul class="optouts">
<li class="optout" type="(type)">identifier</li>
<!-- More (li) if the group has multiple optouts -->
</ul>
<br/>
<!-- end v2 -->
<a rel="members" href="(root)/group/{regid}/member">members</a>
</div>
</body>
</html>
201 | Content is the same as for a GET. |
400 | Invalid xhtml in the upload data. |
Invalid regid | |
401 | No authorization. |
| Group names did not match the name in the URL |
412 | If-Match header in the request. |
4 Comments
Adam B. Graffunder
UW Group Naming Plan
Adam B. Graffunder
This seems to reply with 201 when a request to create a group succeeds, rather than a 200 as it claims.
Nathan Dors
As of Dec 21, 2009, you must specify at least one name (element of class=name).
Also, class=title can be used to specify the group display name.
And lastly, it seems odd that the 201 Created response doesn't provide a Location header.
Michael Reynolds
What's the meaning of this stanza towards the end?
<a rel="members" href="(root)/group/<regid>/member">members</a>
It seems to imply we can specify members when we create the group, but I've had no success doing so. Is it your intention that we will always first create a group and then in a separate REST transaction add members?