User Guide

27
CHAPTER 3
Common Tasks
This chapter describes common scenarios for integrating Macromedia Breeze with external
applications or systems. These scenarios show how to accomplish several common tasks. To
perform each task, you call one or more APIs on the Breeze server and then parse the XML tags
that the server returns. In some cases, you use returned information as parameter values for the
next API.
This chapter also provides sample code demonstrating how to perform some of the tasks using
Macromedia ColdFusion Markup Language (CFML).
Note: Not all the task descriptions include sample code. The syntax for calling an API is consistent for
all APIs, so you can use the sample code from tasks that include it as models for code to perform
other tasks.
For detailed information about each API and each XML tag, see Chapter 4, “XML API
Reference,” on page 41 and Chapter 5, “XML Results Reference,” on page 139. The following
tasks are covered in this chapter:
Calling your first API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Logging in to Breeze . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Creating a new user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding a user to a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Creating a meeting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creating a meeting from a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Displaying a user’s meetings, courses, and events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Creating and managing learning paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Integrating Breeze with a directory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Integrating Breeze with a portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Generating reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39