Get a group
Resource
- GET| (root)/
group/{group_id}
The group_id can be a group name (cn) or a regid.
Return
200 | Content of the response contains one class "group". Other html is for browser formatting. More than one name can be returned. |
| - An ACL identifier of "dc=all" (type="none") means everyone.
- An ACL identifier of "dc=none" (type="none") means no one.
If email is enabled, the Contact field must be present and non-null.
<!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" version="version_no">
Regid: <span class="regid">Group's regid</span>
<br/>
<span class="names">
<span class="name">Group_name</span>
</span>
Title: <span class="title">Group's title</span>
Description: <span class="description">Group's description</span>
Group contact: <span class="contact">contact id</span>
<br/>
Created: <span class="createtime">group create time</span>
<br/>
Modified: <span class="modifytime">group modify time</span>
<br/>
Membership modified: <span class="membermodifytime">membership modify time</span>
<br/>
<!-- version v2 and greater -->
Authn factor: <span class="authnfactor">1|2</span>
<br/>
Classification: <span class="classification">u|p|r|c</span>
<br/>
Membership dependency group: <span class="dependson">dependency group cn</span>
<br/>
GID: <span class="gid">gid_value</span>
<!-- end v2 -->
<!-- The enabled flag is "UWExchange" or "disabled" -->
Email Enabled: <span class="emailenabled">UWExchange</span>
<br/>
Published email address: <span class="publishemail">email_address</span>
<br/>
Allowed senders:
<ul class="authorigs">
<li class="authorig">sender id</li>
<!-- More (li) if there are multiple allowed senders -->
</ul>
Report to originator: <span class="reporttoorig">0 or 1</span>
<br/>
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>
<br/>
<a rel="owners" href="(root)/group/{regid}/owner">owners</a>
</div>
</body>
</html>
If the group represents a course, course information is included in the group element
<br/>
Course information
<br/>
Quarter: <span class="course_qtr">win|spr|sum|aut</span>
<br/>
Year: <span class="course_year">YYYY</span>
<br/>
Curriculum: <span class="course_curr">curriculum code</span>
<br/>
Number: <span class="course_no">number</span>
<br/>
Section: <span class="course_sect">section letter</span>
<br/>
SLN: <span class="course_sln">SLN</span>
Instructors: <ul class="course_instructors">
<li class="course_instructor">UWNetID</li>
...
</ul>
|
304 | If-None-Match header matches group's ETag |
400 | Email-enabled, but no contact |
404 | Group not found |
Notes
- The response always includes an ETag header, which can be used on subsequent GETs and must be used on subsequent updates or deletes.