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

Page: 16 / 196

16 Chapter 1: Architecture Overview
For some actions, you can provide multiple parameters with the same name. For example, the
principals-delete
action takes a parameter named
principal-id
; you can specify multiple
principal-id
name-value pairs (each with the name
principal-id
) when you call the action
on the Breeze server. The following CFML code example shows how to delete two specified users
in a single action call, by specifying two
principal-id
parameters. (This example relies on
variables called
baseurl
,
accesskey
, and
loginCookie
that you set during the login process. For
more information, see “Integrating Breeze with a directory service” on page 28 .)
<cfset idOne=12345>
<cfset idTwo=23456>
<cfhttp url="#baseurl#api/xml?action=principals-
delete&accesskey=#accesskey#&principal-id=#idOne#&principal-id=#idTwo#"
method="post">
<cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#">
</cfhttp>
In some other actions, you can provide multiple sets of parameters. For example, the
group-
membership-update
action takes parameters named
group-id
,
principal-id,
and
is-member
;
to make multiple updates in a single call, specify each of those parameters for principal and group,
and then specify them (using the same parameter names again) for another, and so on.
About principals, SCOs, and IDs
There are two basic kinds of entities in Breeze: principals and Shareable Content Objects (SCOs).
A principal is any entity that can have permissions that control how it can interact with SCOs.
The following are the most common types of principals:
user
A specific user.
group
A group of users.
There are other types of principals, known as primary groups :
admins
,
authors
,
live-admins
,
and
course-admins
. For information about primary groups, see Using the Breeze Manager .
You can create and modify users and groups, but not primary groups.
A SCO is a Breeze document, such as a meeting or a presentation. Folders are also SCOs.
Breeze includes the following types of SCOs:
tree
The root of a folder hierarchy. A tree’s root is treated as an independent hierarchy; you
can’t determine the parent folder of a tree from inside the tree.
folder
A folder on the server’s hard disk, containing Breeze content.
presentation
A presentation.
course
A course.
meeting
A meeting.
flv
A Flash video file.
swf
A Flash SWF file.
image
An image file.