MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Use Manual page 58

Using the breeze xml web services
Table of Contents

Advertisement

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
Parameters
The access key for your account.
accesskey
Note: The
accesskey
include this parameter in Breeze 4.1, it is ignored.
description
The new first name to assign to the user. Use only when creating or updating a
first-name
user.
has-children
parameter to 1. If the principal is a user, set this parameter to 0.
The new last name to assign to the user. Use only when creating or updating a user.
last-name
The principal's new login name, which is usually the principal's e-mail address. This
login
parameter must be specified only when creating or updating a user.
The new group's name. Use only when creating a new group.
name
The new user's password. Use only when creating a new user.
password
principal-id
parameter, the
principal-update
The type of the new principal. Use only when creating a new principal. For information
type
about the available types, see
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-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>
58
Chapter 4: Action Reference
values from the data returned by the
field-id
parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you
The new group's description. Use only when creating a new group.
Indicates whether the principal has children. If the principal is a group, set this
The ID of the principal for which you're changing data. If you omit this
action creates a new principal.
"About principals, SCOs, and IDs" on page
principal
).
(in the same format as the returned elements for
action.
custom-fields
16.

Advertisement

Table of Contents
loading

This manual is also suitable for:

Breeze

Table of Contents