User Guide

Displaying a user’s meetings, courses, and events 31
Creating a new user
To create a new user, call the principal-update API with the following parameters: first-
name
, last-name, login, password, has-children, and type (either user or group). The
following code creates a new user for the Breeze account located at
breezeserveraddress:
http://breezeserveraddress/api/xml?action=principal-update&first-
name=Will&last-name=Tip&login=[e-mail]&password=66Mustang&has-
children=0&type=user
Adding a user to a group
To add a user to a group, call the group-membership-update API.
To a add a user to a group using the XML API, do the following:
1. Create the new user (if the user has not been created yet). For example:
http://breezeserveraddress/api/xml?action=principal-update&first-
name=Will&last-name=Tip&login=[e-mail]&password=66Mustang&has-
children=0&type=user
2. Parse the returned XML for this new user or a current user and grab the value of principal-id.
3. Call group-membership-update and pass it the principal-id of the user you want to add to
the group, as in the following example:
http://breezeserveraddress/api/xml?action=group-membership-update&group-
id=1222&principal-id=1822&is-member=true
Note the following:
■ Pass in the principal-id for the user you want to add to this group.
■ Get the group-id for the group you want the user to join and pass that in as the group-id
parameter.
■ Use the is-member parameter to add or remove a user: true adds the user and false
removes the user.
Displaying a user’s meetings, courses, and events
To display a user’s meetings and courses, call the report-my-meetings, report-my-courses,
and
report-my-events APIs. You can use sort and filter the returned XML to limit your results.
For example, the following code lists a user’s meetings in ascending order based on their start date:
http://breezeserveraddress/api/xml?action=report-my-meetings&sort-date-
begin=asc&session=#loginCookie#
Note: For more information about the session parameter, see Logging in to Breeze.