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

Page: 58 / 196

58 Chapter 4: Action Reference
To specify custom field values when creating or updating a user, pass the custom field values as
name, value pairs, as shown in the following example:
field-id=xx&value=xxx&field-id=xx&value=xxx
You can determine the
field-id
values from the data returned by the
custom-fields
action.
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.
description
The new group’s description. Use only when creating a new group.
first-name
The new first name to assign to the user. Use only when creating or updating a
user.
has-children
Indicates whether the principal has children. If the principal is a group, set this
parameter to 1. If the principal is a user, set this parameter to 0.
last-name
The new last name to assign to the user. Use only when creating or updating a user.
login
The principal’s new login name, which is usually the principal’s e-mail address. This
parameter must be specified only when creating or updating a user.
name
The new group’s name. Use only when creating a new group.
password
The new user’s password. Use only when creating a new user.
principal-id
The ID of the principal for which you’re changing data. If you omit this
parameter, the
principal-update
action creates a new principal.
type
The type of the new principal. Use only when creating a new principal. For information
about the available types, see “About principals, SCOs, and IDs” on page 16 .
Filters
Results cannot be filtered or sorted.
Returned elements
If you update an existing principal, no elements are returned.
If you create a new principal,
principal
(in the same format as the returned elements for
principal-info
).
Sample results
The following sample results are for creating a new principal:
<results>
<status code="ok" />
<principal type="user" principal-id="2500848" has-children="0" account-
id="181224">
<login>jake3@example.com</login>
<name>doe, jake</name>
</principal>
</results>