User Guide

72 Chapter 4: XML API Reference
Sample results
<results>
<status code="ok" />
<principal account-id="222914" has-children="true" is-primary="true"
principal-id="222926" type="course-admins">
<description>Course managers group</description>
<login>Course Managers</login>
<name>Course Managers</name>
</principal>
</results>
The following sample XML data is returned when the type attribute of the principal element is
group:
<results>
<status code="ok" />
<principal account-id="7" has-children="true" is-primary="false"
principal-id="122" type="group">
<login>test-1</login>
<name>test-1</name>
</principal>
</results>
When the type attribute of the principal element is user, additional data about the user
contact information, user profile, and custom fields for the user is returned, as shown in the
following XML data:
<results>
<status code="ok" />
<contact contact-id="654">
<email>[e-mail]</email>
<first-name>test4</first-name>
<last-name>laxmi</last-name>
</contact>
<preferences acl-id="653" lang="en" time-zone-id="4" />
<principal account-id="7" has-children="false" is-primary="false"
principal-id="653" type="user">
<login>[e-mail]</login>
<name>test4 laxmi</name>
</principal>
<principal-custom-field-values>
<field field-id="652" custom-seq="1" account-id="7" type="optional"
principal-id="653">
<name>Phone number</name>
<value>408-1111-111</value>
</field>
</principal-custom-field-values>
</results>
See also
principal-list
, principal-list-by-field, principal-update, principals-delete.