Table of Contents
Advertisement
Action reference entries
The following section lists the Breeze web service actions alphabetically.
accesskey-exec
Description
Executes special functions associated with special access keys.
Currently, letting users self-register for meetings and courses is the only supported special
function. The documentation for this action covers only the self-registration function.
To call this
accesskey-exec
key associated with a meeting or course. Someone who isn't a Breeze user can be given the special
access key and can then use a UI to register for the meeting or course, creating a Breeze user
account for themselves in the process.
To obtain the special access key, call the
The difference between using
is that you can call
update
This action automatically adds the self-registering user to the self-registration group associated
with the course or meeting, if the group exists. For more information, see
Additionally, you can specify custom fields for new users when you call
so, pass the custom fields to
as shown in the following example:
field-id=xx&value=xxx&customfield-id=xx&value=xxx
The
parameters can be determined from the data returned by the
field-id
action.
Parameters
The access key for your account.
accesskey
Note: The
accesskey
4.1. If you include this parameter in Breeze 4.1, it is ignored.
The special access key that lets the user self-register.
access-key
The new user's first name.
first-name
has-children
The new user's last name.
last-name
The new user's login name, which is usually the user's e-mail address.
login
The new user's password.
password
Always set this parameter to
type
Filters
Results cannot be filtered or sorted.
, you need the normal access key for the account and a special access
accesskey-exec
accesskey-exec
accesskey-exec
parameter is required only in Breeze 4.0; it is not required for Breeze version
Always set this parameter to 0 when registering a new user.
"user"
action.
accesskey-info
to create a new user and using
without being logged in or being an administrator.
as additional parameters in name and value pairs,
when registering a new user.
principal-
.
accesskey-info
. To do
accesskey-exec
custom-fields
accesskey-exec
41
Advertisement
Table of Contents
