MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES, Use Manual

Page: 55 / 196

principal-info 55
Returned elements
None.
Sample results
<results>
<status code="ok" />
</results>
principal-info
Description
Provides information about the specified principal. The specified principal can be a user or a
group.
To determine the ID to use as the
principal-id
parameter, call the
principal-list
action
(possibly with a filter to limit the returned data) to return an ID for the principal.
For information about principals, see “About principals, SCOs, and IDs” on page 16 .
Parameters
accesskey
The access key for your account.
Note: The
accesskey
parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you
include this parameter in Breeze 4.1, it is ignored.
principal-id
The ID of a specific principal.
Filters
Results cannot be filtered or sorted.
Returned elements
principal , contact , preferences , principal-custom-field-values
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>