User Guide
52 Chapter 4: XML API Reference
To find out which group the user will automatically join by self-registering using the special access
key, look in the
access-key-group XML element. If the group exists, this element is included in
the returned XML. If the group does not exist, there is no additional
access-key-group
element.
Parameters
acl-id
The ID of a SCO.
Filters
Results cannot be filtered or sorted.
Returned elements
access-keys
, access-key-group
Sample results
The following sample XML is returned when a group doesn’t exist and therefore does not include
an
access-key-group element:
<results>
<status code="ok" />
<access-keys>
<access-key acl-id="622847" action="action-self-reg-meeting"
parent-acl-id="503265">
<access-key>3hzvnifcfmphn3id</access-key>
<date-created>2004-03-05T10:28:14.750-08:00</date-created>
</access-key>
</access-keys>
</results>
The following sample results are returned when a group exists and therefore includes an
accesskey-group element:
<results>
<status code="ok" />
<access-key-group account-id="7" has-children="true" is-primary="false"
principal-id="630" type="group">
<login>COURSE-test1-self-reg-group</login>
<name>COURSE-test1-self-reg-group</name>
</access-key-group>
<access-keys>
<access-key acl-id="126" action="action-self-reg-course" parent-acl-
id="630">
<access-key>2cw6np2kx2dtdop2</access-key>
<date-created>2004-07-07T12:27:04.590-07:00</date-created>
</access-key>
</access-keys>
</results>