Breeze Integration Guide
Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered tradema
CONTENTS INTRODUCTION: Before You Begin ................................... 9 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 What’s new in the Breeze XML APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 What’s changed in the Breeze XML APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Guide to instructional media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHAPTER 4: XML API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Sample API entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 API listing by function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Alphabetical API listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 API reference entries . . . . . . . . . . . . . . . .
report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 report-meeting-summary. . . . . . . . . . . . . . . .
acl-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 answer-correct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 answer-text . .
permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 physical-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 presentation-name. . .
report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 results . . . . . . . . . . . . . . . . . . . .
INTRODUCTION Before You Begin The Macromedia Breeze XML web services enable your external system (such as a web application) to interact with a Breeze server. This manual provides information on how to call XML web services (also called APIs or actions) on the Breeze server from your external system and how to interpret the XML results that Breeze returns. This manual also contains reference material explaining what each application programming interface (API) does and what its parameters are.
What’s changed in the Breeze XML APIs Some APIs that were supported in Breeze 4 are no longer supported in Breeze 5. For information about alternate APIs, where available, see the individual entries in Chapter 4, “XML API Reference,” on page 41.
• Breeze Meeting User Guide for Hosts and Presenters includes information about using the Breeze Meeting web application to host online real-time meetings. The documentation includes procedures that demonstrate the simplicity of adding slides, Flash SWF files, images, live audio, and video to your presentation. You can access Breeze Meeting User Guide for Hosts and Presenters from the Breeze Manager home page and from the Help menu within a Breeze Live meeting room (when you enter as a presenter).
Typographical conventions The following typographical conventions are used in this manual: • Italic font indicates a value that should be replaced (for example, in a folder path). • Code font indicates code. It also indicates names of APIs, names of parameters, names of tags, and names of attributes. • Boldface font indicates a verbatim entry.
CHAPTER 1 Using the Breeze XML APIs The Macromedia Breeze XML application programming interface (API) model exposes interfaces as a set of XML web services. These services let your external system (such as a portal application) communicate with the Breeze server, using HTTP or HTTPS to call APIs on the server and to receive results formatted as XML code. You can use the web services to add Breeze management and reporting capabilities to your external system.
Data flow The following diagram shows an example of the flow of data in a web application that interacts with the Breeze server: Web browser Step 1: Web browser requests page. Request Response Step 7: Web server sends finished page to requesting browser. WEB SERVER Step 2: Web server finds page and passes it to application server. Step 6: Application server inserts data in page and then passes the page to the web server. Step 3: Application server executes code.
4. As part of executing the code, the application server calls an API on the company’s Breeze server, requesting the list of courses. The API call takes the form of an HTTP POST request. 5. The Breeze server executes the API, returning the resulting XML data to the application server. 6. The application server code parses the returned XML, inserts data into the web page as appropriate, and then passes the finished page to the web server. 7.
Note: The example code in this book uses the query parameters approach, both for readability and because of limitations in using Macromedia ColdFusion Markup Language (CFML) to send XML objects containing parameter data. Macromedia recommends using the POST method when possible. Because of the way that HTTP implements GET and POST, using POST may provide higher security levels than passing parameters in the query string. For more information, see “About security” on page 18.
In some other APIs, you can provide multiple sets of parameters. For example, the groupAPI takes parameters named group-id, principal-id, and is-member. To make multiple updates in a single call, you specify each of those parameters for principal and group, and then specify them (using the same parameter names again) for another, and so on.
There are a few other kinds of IDs that aren’t associated with a principal or a SCO, such as account-id, answer-id, permission-id, and question-id. But in most cases, a parameter name that ends in -id indicates that the value of the parameter is the ID of either a principal or a SCO. About security The security model in Breeze ensures that any code calling a given API is authorized to do so. Almost every API call must include a cookie that represents a specific logged-in user.
You can specify the following permissions on a SCO: Permission Description Denied The principal cannot view, access, or manage the SCO. You cannot specify this permission on meetings or courses. Host (For meetings only) The host of a meeting. This permission lets the principal create or present the meeting, even if the principal doesn’t have View permission on the parent folder of the meeting. The Presenter permission is now an alias for Host. A presenter in Breeze 4 presenter is a host in Breeze 5.
• You can set a BREEZESESSION cookie on the user’s browser, using the value of the login cookie. However, this approach works only if your application is running on a server with the same domain name as the Breeze server. Also, if your application server is a J2EE servlet environment (such as Macromedia ColdFusion or Java), the application server might also use a cookie named BREEZESESSION, which results in potential conflicts between Breeze and the application server.
CHAPTER 2 Working with Filters The data and information in your company’s Macromedia Breeze content repository can grow significantly over time. When this occurs, you might not want to list every item in the repository for all users. For example, you could list the most recently created courses and the latest quarterly financial results presentation on your company’s intranet. You need to sort and organize your growing repository to ensure that users quickly find the information they are seeking.
Filter examples The following is a simple example to help illustrate the general concept of filters. The web service API report-my-courses returns the list of courses that you enrolled in. This same API used with a filter on the course name, for example report-my-courses&filter-like-name=Java, retrieves your courses with the specified text in the name, in this case Java.
About sort filters You can use a filter of the type sort to sort data in ascending and descending order. For example, the following filter sorts the name field in ascending order: sort-name=asc The following code sorts the name field in descending order: sort-name=desc You can also perform primary and secondary sorts.
Filtering a specific number of entries starting at a specific entry You can use the following technique to create pagination when there is too much data for one page.
Testing code in the browser You can enter a test URL in the address field of a browser window and see the XML response from the server. It is a good idea to become comfortable with filters in the browser before you write code. There are many nuances to filters that determine which types of filters you can use with certain API calls. The browser approach lets you quickly try combinations to see what works and what doesn’t.
To make your code production-ready, develop it to handle unexpected errors and situations. Make sure you check for unexpected status codes and inform your IT team when you encounter such a situation. Where to go from here The Macromedia Breeze Resource Center has an article called “Working with Filters” that describes how to build a sample application that uses filters to search and sort a list of courses.
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.
Calling your first API You can enter a test URL in the address field of a browser and see the XML response from the server displayed in the browser window. The returned XML is the same as the returned XML when you call the API in an application. You should be comfortable with calling APIs in the browser before you write code in an application. To call most APIs, a user must be logged in to Breeze. (The APIs you can call without logging in are action-list, common-info, login, and user-accounts.
Logging in to Breeze To call most APIs, you must be acting as a logged-in user, so you must call the login API before you can call most other APIs. (The exceptions—APIs you can call without logging in—are action-list, common-info, login, and user-accounts.) When you call the login API, if the XML results include a status code of ok, the response header includes a BREEZESESSION cookie. Capture the cookie and save the results to a variable, such as loginCookie.
Reviewing the code The following table describes the highlighted code and its function: Code Description Checks whether the username variable is defined. If it is, the next block of code executes. If it isn’t, a form is displayed that allows a user to provide a user name (and password). PAGE 31Creating a new user To create a new user, call the principal-update API with the following parameters: firstname, 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&firstname=Will&last-name=Tip&login=wtip@macromedia.
Creating a meeting To create a meeting room, you must have appropriate permissions. When using the XML API, you should create an administrator account with Account Administrator privileges to perform administrator functions on a Breeze account. To create a meeting, call the sco-update API while logged in to the administrator account. The following code creates a meeting: http://breezeserveraddress/api/xml?action=sco-update&folder-id=15&datebegin=2005-01-01T01:00:00.000-05:00&date-end=2005-01-02T01:00:00.
Creating and managing learning paths To create and manage learning paths, use the following APIs: learning-path-info, learningand user-transcript-update. Call learning-path-info to discover the restrictions on a particular learning object that create the learning path (for example, which learning objects must be completed, if any, before the next learning object is attempted).
2. Check that the login API completed successfully by parsing the returned XML and examining the value of the status tag’s code attribute. If the status code isn’t ok, determine what the error was and handle it appropriately, as in the following: 3.
8. For each user listed in the directory service but not in Breeze, add the user to Breeze, as follows: a Obtain the user’s first name, last name, and login name from the directory service. The Breeze login name is usually the user’s e-mail address. b Call the principal-update API, setting the type parameter equal to user. Don’t specify a principal-id parameter; leaving out principal-id indicates that you are adding a new user rather than updating an existing user.
11. For each user whose information in Breeze must be updated, obtain the user’s ID, as follows: a Examine the data returned by the principal-list API in steps 2 through 4 and search for the ID associated with the user’s login. b Obtain the user’s old first name and last name by calling the principal-info API. c Change the values as needed to match the name given by the directory service. d Call the principal-update API. e Check the returned XML to ensure the status code returned is ok.
To determine a user’s ID, given their login name and password: 1. Log in as the user. 2. Call the common-info API. 3. Parse the returned XML to find the value of the user-id attribute of the user tag. That value is the user’s ID. To check whether an entered password is correct: 1. Log in as the user. 2. If the status code returned is ok, the password is correct. This procedure is the only way to check a password; for security reasons, Breeze doesn’t let you request a user’s password from the server.
4. If you want to provide links to content items in the form of absolute URLs, determine the domain name of the folder: 5. Call the sco-contents API, using the folder’s SCO ID.
3. Call the sco-update API, using the folder’s ID for the folder-id parameter. Don’t specify a sco-id parameter. 4. Verify that the API completed successfully by checking the returned status tag. To search for content: 1. Obtain the string to search for from the user, using a web-based form. 2. Log in as the user. 3. Call the sco-search API, using the specified string as the value of the query parameter. 4.
Chapter 3: Common Tasks
CHAPTER 4 XML API Reference This chapter provides reference material for each application programming interface (API) that is exposed in the Macromedia Breeze XML API, including information about the parameters that you can pass with each API. The APIs are listed in alphabetical order. Every API returns a results tag that contains one or more other tags, including a status tag.
Parameters This section describes any parameters listed in the syntax. All parameters are required unless they are marked “optional.” Filters This section describes fields on which you can filter and sort the returned XML data. Returned elements This section identifies what, if any, XML elements the API returns. Sample results This section provides a code sample that demonstrates how to use the API. See also This section identifies APIs that are related to the API.
API Description sco-update Creates or updates presentations, courses, and meetings. sco-upload Uploads a file to the Breeze server when you create a presentation with the XML API. (For more information, see sco-update and sco-build). Curriculum and learning path management You can use the Breeze web services to create and manage learning paths associated with a curriculum and a user.
API Description login Logs in a user. logout Logs out a user, invalidating the cookie that the application received when the user logged in. Permissions The following table lists the permissions APIs supported in Breeze 5: API Description permissions-info Provides information about principals and the permissions they have for a specified SCO. permissions-reset Resets all principals’ permissions for the specified SCO, so that the permissions of the SCO’s parent apply to all principals.
API Description report-meeting-attendance Provides a list of users who have attended the specified meeting. report-meeting-concurrent-users Indicates the maximum number of users who can participate simultaneously in the specified meeting. report-meeting-sessions Provides information about all the sessions of a meeting. report-meeting-summary Indicates how many users were invited to the specified meeting and how many invitees and guests attended.
The following table lists the user management APIs supported in Breeze 5: API Description group-membership-update Adds one or more principals to a group, or removes one or more principals from a group. principal-info Provides information about the specified principal. The specified principal can be a user or a group. principal-list Provides a complete list of users and groups, including primary groups. principal-list-by-field Allows you to list principals that have a given field value.
API Description group-membership-update Adds one or more principals to a group, or removes one or more principals from a group. learning-path-info Returns a list of learning paths for a learning object that belongs to a curriculum. learning-path-update Updates the learning path for a single learning object in a curriculum. login Logs in a user. logout Logs out a user, invalidating the cookie that the application received when the user logged in.
API Description report-bulk-content-slide-views Returns slide view data for content. This API is not supported in Breeze 5. report-bulk-course-quiz Returns information about all course quizzes, including a list of quizzes, and the questions and answers for each quiz. This API is not supported in Breeze 5. report-bulk-course-results Returns results for a course quiz, including information about each user and quiz question. This API is not supported in Breeze 5.
API Description report-my-courses Provides information about each course in which the loggedin user is enrolled. report-my-events Provides information about each event that the logged-in user is scheduled to attend. report-my-meetings Provides information about each meeting that the logged-in user is scheduled to attend. report-principal-list Returns the list of all principals in the account. This API is not supported in Breeze 5.
API Description sco-delete Deletes one or more SCOs. sco-expanded-contents Lists all of the SCOs in an account. Call this API with filters to find particular SCOs. sco-info Provides information about a SCO. sco-move Moves a SCO from one folder to another. sco-nav Describes the folder hierarchy that contains the specified SCO. sco-search Provides a list of all SCOs that match the search text.
To call the accesskey-exec API, you need a special access 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 an interface to register for the meeting or course, creating a Breeze user account in the process. To obtain the special access key, call accesskey-info. This API automatically adds the selfregistering user to the self-registration group associated with the course or meeting, if the group exists.
To find out which group the user will automatically join by self-registering using the special access key, look in the access-key-group XML element. If the group exists, this element is included in the returned XML. If the group does not exist, there is no additional access-key-group element. Parameters acl-id The ID of a SCO. Filters Results cannot be filtered or sorted.
acl-field-info Availability Breeze 5. Description Returns field-ids and values for an ACL. The caller must have view permission for the ACL. You can call principal-list to determine the account-id or principal-ids. An ACL is a securable Breeze object, for example, a principal, SCO, or account. For more information, see “About principals, SCOs, and IDs” on page 17. Parameters acl-id The ID of the ACL whose field information you want to return.
concurrent-attendee See also acl-field-list, acl-field-update acl-field-list Availability Breeze 5. Description Returns the list of acl-ids and values in the logged-in account for the given field-id. For example, to list the first names of all users in an account, call this API with field-id=firstname. This API requires Administrator permission on the logged-in account.
acl-field-update Availability Breeze 5. Description Updates the field value for the given ACL and field. The caller requires modify permission on the ACL. An ACL is a securable Breeze object, for example, a principal, SCO, or account. For more information, see “About principals, SCOs, and IDs” on page 17. Parameters The ID of the ACL that you want to modify. This can be a principal-id, sco-id, or acl-id account-id. field-id value The ID of the field that you want to edit.
Mary Sue See also acl-field-list, acl-field-info acl-preference-update Availability Breeze 4. Description Updates the user profile to the specified language and time zone settings. Parameters The ID of the user for whom the preferences need to be updated. acl-id lang The language setting.
Time zone setting Parameter value (GMT-06:00) Guadalajara, Mexico City, Monterrey 30 (GMT-06:00) Central America 33 (GMT-05:00) Eastern Time (US and Canada) 35 (GMT-05:00) Indiana (East) 40 (GMT-05:00) Bogota, Lima, Quito 45 (GMT-04:00) Atlantic Time (Canada) 50 (GMT-04:00) Caracas, La Paz 55 (GMT-04:00) Santiago 56 (GMT-03:30) Newfoundland 60 (GMT-03:00) Brasilia 65 (GMT-03:00) Buenos Aires, Georgetown 70 (GMT-03:00) Greenland 73 (GMT-02:00) Mid-Atlantic 75 (GMT-01:00) Azores 8
Time zone setting Parameter value (GMT+04:00) Abu Dhabi, Muscat 165 (GMT+04:00) Baku, Tbilisi, Yerevan 170 (GMT+04:30) Kabul 175 (GMT+05:00) Ekaterinburg 180 (GMT+05:00) Islamabad, Karachi, Tashkent 185 (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi 190 (GMT+05:45) Kathmandu 193 (GMT+06:00) Astana, Dhaka 195 (GMT+06:00) Sri Jayawardenepura 200 (GMT+06:00) Almaty, Novosibirsk 201 (GMT+06:30) Rangoon 203 (GMT+07:00) Bangkok, Hanoi, Jakarta 205 (GMT+07:00) Krasnoyarsk 207 (GMT+
Filters Results cannot be filtered or sorted. Returned elements None. Sample results action-list Availability Breeze 4. Description Returns a list of Breeze web service APIs (also referred to as actions). Caution: Not all APIs in this list are documented, and not all documented APIs are in this list. Parameters None. Filters Results cannot be filtered or sorted.
common-info Availability Breeze 4. Description Provides basic information about the current user and server. If you call common-info without logging in first, the same information is returned, except that the user tag is not included, and the account-id value may be different. Parameters None. Filters Results cannot be filtered or sorted. Returned elements common Sample results breezm5qtgnye46zpckbf.MARIANNE 2004-02-12T15:53:19.
Parameters field-id The ID of the field to be updated (can be obtained by calling the custom-fields API). This parameter needs to be specified only when updating an existing field. name The name of the custom field (can be 1 to 60 characters long). comments Any comments on the custom field (can be 0 to 60 characters long). This parameter is optional. type The type of the custom field.
Parameters None. Filters Results can be filtered only on field-id. You can also use the filter-out modifier on the type parameter. Results cannot be sorted. The default sort is by ascending field-id.
See also acl-field-info, acl-field-list, acl-field-update group-membership-update Availability Breeze 4. Description Adds one or more principals to a group, or removes one or more principals from a group. To update multiple principals and groups, specify multiple trios of group-id, principal-id, and is-member parameters. For more information, see “About parameters” on page 16. Parameters group-id The ID of the group for which you are updating the membership.
Parameters curriculum-id sco-id The ID of the curriculum to which this learning object belongs. The ID of the learning object.
New Hire Safety Beginning Electronics Electronics 2
The ID of the learning object that restricts access to the current learning object. For example, if a learning object has a prerequisite requirement, the prerequisite SCO is the target-sco-id. target-sco-id Consider the following scenario: a student must pass the “Intro to Programming” class before taking the “Intermediate Programming” class.
The following Java example parses the HTTP headers to store the cookie, and then indicates how it can be passed on for all subsequent requests: login="john@example.com" password="abcdefg" baseurl="http://breeze.example.com/" URL loginUrl=new URL(baseUrl + "api/xml?action=login&login=" + login + "&password=" + password); URLConnection conn=loginUrl.openConnection(); conn.connect(); InputStream resultStream=conn.getInputStream(); Document doc=new SAXBuilder(false).
Returned elements None. Sample results See also logout logout Availability Breeze 4. Description Logs out a user, invalidating the cookie that the application received when the user logged in. Parameters None. Filters Results cannot be filtered or sorted. Returned elements None. Sample results See also login permissions-info Availability Breeze 4.
For more information about permissions, see “About permissions” on page 18. For more information about filters, see Chapter 2, “Working with Filters,” on page 21. Parameters acl-id The ID of a specific SCO. principal-id The ID of a specific principal. This parameter is optional.
The following XML data is returned when the principal-id parameter is passed: If the principal was not assigned permissions to the SCO, the status code no-data is returned. See also permissions-reset, permissions-update permissions-reset Availability Breeze 4. Description Resets all principals’ permissions for the specified SCO, so the permissions of the SCO’s parent apply to all principals.
For information about permissions, see “About permissions” on page 18. To update multiple principals’ permissions, specify multiple trios of acl-id, permission-id, and principal-id parameters. For more information, see “About parameters” on page 16. Parameters acl-id The ID of a SCO. permission-id principal-id The ID of a permission. The ID of a principal (a user or group). Filters Results cannot be filtered or sorted. Returned elements None.
Sample results Course managers group Course Managers Course Managers The following sample XML data is returned when the type attribute of the principal element is group:
principal-list Availability Breeze 4. Description Provides a complete list of users and groups, including primary groups. Parameters None.
See also principal-info, principal-update, principal-list-by-field, principals-delete. principal-list-by-field Availability Breeze 5. Description Allows you to list principals that have a given field value. Parameters value The field value on which you want to search.
See also principal-info, principal-list, principal-update, principals-delete principal-update Availability Breeze 4. Description Updates information for a principal in the current account or creates a new principal. For information about principals, see “About principals, SCOs, and IDs” on page 17. In most cases, you must acquire the original version of the principal’s information (using principal-info) before calling the principal-update API.
Returned elements If you update an existing principal, no elements are returned. If you create a new principal, principal is returned (in the same format as the returned elements for principal-info). Sample results The following sample results are for creating a new principal: jake3@example.
report-account-meeting-attendance Availability Breeze 4. This API is not supported in Breeze 5. To discover which principals attended which meetings, use the report-meeting-attendance or the report-bulk-consolidated-transactions API. Description Returns the meeting attendance log for the account. Parameters None.
name> test-mtg-1 2004-07-09T14:33:06.577-07:00 2004-07-09T14:33:43.547-07:00 Enterprise Administrator report-active-meeting-presenters Availability Breeze 4. Description Provides a list of the users who are currently presenting meetings.
report-active-meetings Availability Breeze 4. Description Provides a list of meetings that are currently in progress. Parameters None. Filters Results cannot be filtered or sorted. Returned elements report-active-meetings Sample results 022305 Stephanie Test /r27873068/ 2005-02-28T16:09:28.
Returned elements report-bandwidth Sample results report-bulk-consolidated-transactions Availability Breeze 5 Description Returns information about all of the transactions in an account. A transaction is an instance of one principal visiting one SCO. Consider the following examples: • If a principal attends a meeting twice, there are two transactions for that principal: one for each time that she attended the meeting.
Sample results Default Meeting Template /r-182228/ bharm@macromedia.com Ben Harm completed 2005-01-29T14:02:04.
Sample results - test-quiz Quiz test 1 Who is Randy Johnson ? A baseball pitcher with the Arizona Diamondbacks YES
|
Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort date-time-attempted Filter only presentation-attempt-id Filter only presentation-id Filter only question-number Filter and sort quiz-id Filter only user-id Filter and sort user-login Filter only user-response Filter only Returned elements report-bulk-content-quiz-results Sample results |
Parameters None.
report-bulk-course-quiz Availability Breeze 4. This API is not supported in Breeze 5. Description Returns information about all course quizzes, including a list of quizzes, and the questions and answers for each quiz. The returned results are similar to the “Course Quiz Information” report, except that the API returns XML data and the report contains downloadable CSV-formatted data. Parameters None. Filters Results cannot be filtered or sorted.
report-bulk-course-results Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by the report-quiz-interactions API. Description Returns results for a course quiz, including information on each user and quiz question. The returned data is similar to the “Course Quiz Responses and Results” report, except that the API returns XML data and the report returns CSV-formatted data. Parameters None.
2004-07-13T10:54:09.030-07:00 00:00:34.017 Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center. report-bulk-meeting Availability Breeze 4. This API is not supported in Breeze 5.
report-bulk-meeting-attendance Availability Breeze 4. This API is not supported in Breeze 5. Description Returns meeting attendance data. The results are similar to the “Meeting Attendance” report, except that the API returns XML data and the report returns downloadable CSV-formatted data. Parameters None.
report-bulk-objects Availability Breeze 5. Description Returns information about every object on the Breeze server. Object types include archive, attachment, authorware, captivate, course, curriculum, external-event, FLV, image, meeting, presentation, and SWF. Use filters to limit the returned XML.
/p30542007/ presentation 181438 Bullet Animation Test.ppt 2003-07-14T14:54:16.757-07:00 2003-07-14T14:54:16.757-07:00 2003-07-14T14:52:32.327-07:00
See also report-bulk-consolidated-transactions, report-bulk-questions, report-bulk-slideviews, report-bulk-users report-bulk-questions Availability Breeze 5.
false 2005-03-24T16:36:36.100-08:00 Apples can be <1> or <2>. The name of the grocery store is <3> {green,red,Bob's} 2005-03-24T15:16:39.030-08:00
Apples can be <1> or <2>.
Returned elements report-bulk-slide-views Sample results 0 2005-03-24T16:36:41.820-08:00
4 2005-03-24T16:37:53.070-08:00
5 2005-03-24T16:38:09.
report-bulk-users Availability Breeze 5. Description Returns information about all users in an account. Remember to use filters to limit your results. For example, the following call returns in ascending order all users who have the letters “Jo” in their name: http://admin.ibreeze.macromedia.com/api/xml?action=report-bulk-users&sortname=asc&filter-like-name=Jo Parameters None.
user vish_laxmi@yahoo.com laxmi vish vish_laxmi@yahoo.com user
acobbler@macromedia.com Apple Cobbler acobbler@macromedia.com pangel@macromedia.
When the principal-id parameter is passed in, the following XML may be returned: 2004-07-27T12:53:42.297-07:00 report-course-takers Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by report-quiz-takers.
Returned elements report-quiz-takers Sample results bcassaly@macromedia.com 2005-03-02T16:00:33.
report-meeting-attendance Availability Breeze 4. Description Provides a list of users who have attended the specified meeting. If the meeting hasn’t started, the returned data contains no rows. The data does not include users who were invited but did not attend the meeting. Parameters sco-id The ID of a meeting.
2005-03-15T10:13:12.810-08:00 Bart Cassaly report-meeting-concurrent-users Availability Breeze 4. Description Indicates the maximum number of users who can participate simultaneously in the specified meeting. This maximum is determined by the account license. Parameters sco-id The ID of a meeting. Filters Results cannot be filtered or sorted.
Parameters sco-id The ID of a meeting. This value must match the sco-id for a specific meeting session. To obtain the list of all sessions and their associated sco-ids, call the report-meetingsessions API. Filters Results cannot be filtered or sorted. Returned elements report-meeting-session Sample results test-mtg-1 - 1 2004-07-09T13:00:32.
Field Filter/Sort num-participants Sort sco-id Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-meeting-sessions Sample results 2005-03-15T09:30:28.233-08:00 2005-03-15T09:45:36.
2004-02-14T06:30:00.000-08:00 2004-02-14T06:40:00.000-08:00 2004-02-14T06:40:00.000-08:00 2004-02-14T06:50:00.000-08:00
2004-02-14T06:50:00.000-08:00 2004-02-14T07:00:00.
Parameters None. Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort date-begin Filter and sort date-created Filter and sort date-modified Filter and sort expired Sort name Filter and sort sco-id Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
report-my-events Availability Breeze 5. Description Provides information about each event that the logged-in user is scheduled to attend. Parameters None.
report-my-meetings Availability Breeze 4. Description Provides information about each meeting the logged-in user is scheduled to attend. Parameters None.
01:00:00.000 report-principal-list Availability Breeze 4. This API is not supported in Breeze 5. The custom field information that was returned by report-principal-list was moved to ACLs in Breeze 5. For more information, see the acl-field-info, acl-field-list, and aclfield-update API entries. Description Returns the list of all principals in the account. Similar to the principal-list API, but returns additional user custom field information.
Enterprise Administrator lraj@macromedia.com Account Administrators Account Administrators
test1 laxmi test1-laxmi@test.enang.
Sample results The following XML contains attributes for answer options 1 through 8, even if the quiz question has fewer possible answers: Who is Randy Johnson ?
Who is Allan Iverson ?
<
Sample results 22
0
4
150,000,000 kilometers
1 parsec
<
Parameters sco-id The ID of a presentation that contains a quiz. Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort body Filter and sort chapter-id Filter and sort date-modified Filter and sort question-id Filter and sort question-number Filter and sort score Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
report-quiz-interactions Availability Breeze 4. Description Provides information about all the interactions that users have had with the specified quiz. An interaction consists of a user making a choice in a quiz, so this report provides information about every answer that every user has ever given to questions on the quiz. In the results for this API, the score attribute indicates the score that the quiz-taker received on that question. Parameters sco-id The ID of a presentation that contains a quiz.
2005-03-11T12:04:29.200-08:00 A human being usually has <1> fingers. 10 report-quiz-question-answer-distribution Availability Breeze 4. Description Indicates how many users selected a particular answer to a specified quiz question (also called an interaction).
0
2
C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E
1
|
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-question-response Sample results Barry Cassidy D 2005-03-14T14:20:43.
report-quiz-question-totals Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by the report-quiz-question-distribution API. Description For the specified quiz question, indicates the total number of users who answered the question and the number of users who answered the question correctly. Use report-quiz-definition-answers or report-quiz-definition-questions to determine the ID of a question (to use as the question-id parameter).
Sample results 2005-03-14T14:20:43.967-08:00 80
report-quiz-takers Availability Breeze 4. Description Provides information about everyone who has taken a particular quiz.
Field Filter/Sort login Filter and sort principal-id Filter and sort principal-name Filter and sort status Filter and sort score Filter and sort time-taken Filter and sort transcript-id Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
Parameters None. Filters Results cannot be filtered or sorted. Returned elements report-quotas Sample results 2003-08-15T13:12:33.260-07:00 2999-12-31T16:00:00.000-08:00 2004-03-24T13:13:18.
Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort date-created Sort slide Sort views Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-sco-slides Sample results 2005-03-14T14:20:46.
Sample results One Question - New 2005-03-14T14:20:43.967-08:00 2005-03-14T14:20:43.967-08:00
report-survey-question-response Availability Breeze 4. This API is not supported in Breeze 5.
test1 laxmi how are you? ok
sco-build Availability Breeze 4. Description Causes the Breeze server to build the specified SCO when you create presentations with the XML API. (For more information, see sco-update and sco-upload). No one can view a SCO until it has been built. Call this API after you use the sco-upload API to upload a SCO.
sco-contents Availability Breeze 4. Description Provides a list of the SCOs in a specified folder. Because folders are SCOs, the returned list includes the folders that are contained in the specified folder. The returned list does not include the contents of those subfolders. Breeze includes the following types of SCOs: SCO Description content A viewable file uploaded to the Breeze server, for example, an FLV file, an HTML file, an image, a pod, and so on. curriculum A Breeze curriculum.
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements scos Sample results The name and date-modified elements are always returned, but the date-begin, date-end, and duration elements are present only for SCOs whose type attribute is course or meeting. PPT meeting tests 2004-01-29T06:22:49.
Filters Results cannot be filtered or sorted. Returned elements None. Sample results See also sco-info, sco-move, sco-nav sco-expanded-contents Availability Breeze 5. Description Lists all of the SCOs in a folder. Parameters sco-id The ID of a folder. Filters Results cannot be sorted or filtered.
sco-info Availability Breeze 4. Description Provides information about a SCO. For information about SCOs, see “About principals, SCOs, and IDs” on page 17. Parameters sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements The returned tags depend on the SCO type of the specified item.
n 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.250-07:00 test-slide /p27916084/ 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.
l 2004-07-13T10:46:48.000-07:00 2004-07-13T10:47:23.810-07:00 test-quiz /p67601053/ sco-move Availability Breeze 4. Description Moves a SCO from one folder to another.
In the returned results, the sco tag’s depth attribute indicates how many hierarchical levels away the folder is from the specified SCO. That is, a depth attribute equal to 0 indicates the SCO itself; a depth of 1 indicates the folder that contains the SCO; and so on. Parameters sco-id The ID of a SCO. Filters Results cannot be filtered or sorted.
Filters You can restrict the returned data to a specific number of rows by using the filter-rows and filter-start parameters. For example, the following code returns the first five rows of data: filter-rows=5&filter-start=0 Note: The filter-rows parameter indicates the number of rows to be returned, and filter-start indicates where the row count should begin. For more information about filters, see Chapter 2, “Working with Filters,” on page 21.
2005-03-30T16:32:42.280-08:00 2005-03-30T16:32:42.280-08:00 2 slide /Viewer.swf?slide=2 sco-shortcuts Availability Breeze 4. Description Provides IDs for a set of folders that contain content relevant to the logged-in user: a folder for the user to place meetings, a folder for the user to place content, and so on.
http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.
To use sco-update with a Breeze presentation: 1. Call sco-update with the folder-id parameter to create a SCO. Pass the following parameters: folder-id, description, name, author-info-1 (the author’s name), author-info-2 (the author’s title), author-info-3 (the company name), type=presentation, and lang. 2. Call sco-upload to associate content with this SCO. Note: See sco-upload for a sample of an HTML form that associates content with a presentation created through the XML API. 3.
folder-id The ID of the folder in which the server will create the new SCO. This parameter is optional and cannot be specified with sco-id. last-name name sco-id The last name of the contact person for the SCO. (Used only for presentations.) The name of the SCO. The ID of a SCO to update. This parameter is optional and cannot be specified with folder-id. sco-tag A label for the SCO. Can contain any arbitrary data; for example, for an Economics 101 course, you might specify 101 for the sco-tag parameter.
To upload a different SCO and rebuild the presentation, call sco-upload and sco-build in that order. The following sample results are returned when a presentation is updated: The following sample XML is returned when a course is created: 2004-07-26T24:41:58.
sco-upload Availability Breeze 4. Description Uploads a file to the Breeze server when creating a presentation using the XML API. (For more information, see sco-update and sco-build.) You must send the parameters for this API using the multipart/form-data media type. The easiest way to create the file parameter is to use a form control of file type in a form on a web page. After you upload a file, call the sco-build API to build it.
Filters Results cannot be filtered or sorted. Returned elements files Sample results 38181499/38111519-1/input/Test.ppt See also sco-build, sco-update user-accounts Availability Breeze 4. Description Provides a list of the accounts to which the specified user belongs. An enterprise (nonhosted) Breeze system usually has only one account; if you have an enterprise Breeze system, you are unlikely to need this API.
smith@example.com 2004-01-24T00:59:59.000-07:00 jones@example.com 2004-01-24T00:59:59.000-07:00 user-transcript-update Availability Breeze 5. Description Use this API to override the score on an item within a curriculum. For example, you could use this API to give the user a score for an external training that you know the user has taken.
user-update-pwd Availability Breeze 4. Description Changes a user’s password. Parameters password The new password. password-old The user’s current password. password-verify user-id A second copy of the new password, for verification. The ID of the user. Filters Results cannot be filtered or sorted. Returned elements None.
CHAPTER 5 XML Results Reference This chapter describes the XML tags, data, and status codes returned by the Macromedia Breeze server in response to an API call. For information about the APIs you can call on the server, see Chapter 4, “XML API Reference,” on page 41. About returned XML code When you call an API on the Breeze server, the server returns a block of XML code. The parent tag of the XML code is always a results tag.
If there is no data available for a tag that would normally be returned in response to an API, the tag isn’t returned. In the previous example, if the calling application didn’t specify a logged-in user, there would be no user tag in the returned results. When your web application receives the returned XML code, it must parse the code to determine what the returned values are. For examples, see Chapter 3, “Common Tasks,” on page 27.
Tag Description acl Contains information about an access control list. acl-field-list Contains a list of custom fields associated with an access control list. acl-fields Contains information about the custom fields of an access control list. action The name of an API. answer-correct The text for a correct answer. answer-text The text of an answer to a quiz question as part of the results returned by a report API.
Tag Description description A description of a principal. domain-name The fully qualified domain name of the location of a SCO. duration The duration of a SCO. email A user’s e-mail address. event Contains information about an event. expanded-scos Contains information about the contents of a SCO. expired A Boolean value indicating whether a SCO has expired. field Contains information about custom fields. file Contains information about the path of an uploaded SCO.
Tag Description permissions Contains information about one or more principals and their permissions. physical-path The path on the server to a SCO. preferences Contains information about user preferences. presentation-name The name of a Breeze presentation. principal Contains information about a principal. principal-list Contains one or more principal tags. principal-name The name of a principal. question The text of a quiz question. question-text The text of a quiz question.
Tag Description report-disk-usage Indicates how much hard disk space the Breeze content uses, in bytes. report-meeting-attendance Contains one or more row tags, each containing information about a user who attended a particular meeting. report-meeting-concurrent-users The maximum number of users who participated simultaneously in the specified meeting. report-meeting-session Contains information about a meeting. report-meeting-sessions Contains information about all the sessions of a meeting.
Tag Description report-survey-question-response Contains information about the list of all users who answered the specified question and their answer. report-training-concurrent-users Indicates the largest number of users who have used the system at the same time. response A user’s response to a survey question. results Contains all results returned by any API. row Contains a single record of information in a report.
Tag Description user-last-name A user’s last name. user-login A user’s login (usually an e-mail address). user-name A user name. users Contains one or more user tags, each containing information about a user and an account. value The value of a custom field. version The Breeze version number. view-date-time The time and date that a slide was viewed. access-key (container) There are two tags named access-key; they are described in different sections.
Attributes None. Contained tags None (content only). Returned by accesskey-info Example vb7gmg6ohtz4y7k6 See also access-key (container), access-keys access-key-group Description Container tag; contains information about which group the user automatically joins by selfregistering using the special access key. Also contains a login and name tag. Attributes account-id The ID of the account of which the principal is a member.
■ hosted-support ■ learners ■ live-admins ■ seminar-admins ■ user Contained tags login, name Returned by accesskey-info Example COURSE-test1-self-reg-group COURSE-test1-self-reg-group access-keys Description Container tag; contains one or more access keys. Attributes None.
Contained tags None (empty tag). Returned by common-info Example acl Description Container tag; contains information about an access control list (ACL). Attributes acl-id The ID of an ACL. Contained tags value Returned by acl-field-list Example Mary acl-field-list Description Container tag; contains information about ACLs. Attributes None.
Mike Mary acl-fields Description Container tag; contains information about ACL fields. Attributes None. Contained tags field Returned by acl-field-info Example action Description The name of an API.
actions Description Container tag; contains a list of APIs. Attributes None. Contained tags action Returned by action-list Example accesskey-exec accesskey-info action-list ... [other APIs listed here] ... user-accounts user-update-pwd answer-correct Description The text for a correct answer. Attributes None. Contained tags None (content only).
answer-text Description The text of an answer to a quiz question as part of the results returned by a report API. Attributes None. Contained tags None (content only). Returned by report-quiz-answer-distribution, report-quiz-question-response Example ECMA-262 body Description The text of a returned item, such as the text of a quiz question in a quiz-related report. Attributes None. Contained tags None (content only).
Returned by custom-field-update Example any comment goes here common Description Container tag; contains tags that provide information about the server and the logged-in user. If you call common-info without logging in first, the same information is returned except for the user tag. Attributes locale The locale of the currently logged-in user.
Contained tags email, first-name, last-name Returned by principal-info Example test4-lnagaraj@test.enang.com test4 laxmi cookie Description The value of the Java servlet session cookie, named BREEZESESSION. This is the same cookie that you send with every API call to indicate which user is making the call. If you call common-info without logging in first, the server returns a new cookie.
Contained tags date-begin, date-created, date-end, date-modified, expired, name, url, url-path Returned by report-my-courses Example My Name admin.breeze.example.com/p38547860/ 2004-02-09T14:40:38.497-08:00 2004-02-09T14:40:44.623-08:00 2004-02-09T14:30:00.000-08:00 2004-02-09T14:30:00.
date Description The current date and time on the server, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by common-info Example 2004-02-12T15:53:19.797-07:00 date-begin Description The date and time that a SCO is, or was, scheduled to begin, in ISO 8601 date format. Attributes None. Contained tags None (content only).
Returned by report-meeting-attendance Example 2004-01-29T00:59:41.470-08:00 date-created Description The date and time that a SCO was created, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by accesskey-info, report-active-meeting-presenters, report-meeting-attendance, report-my-courses, report-quiz-interactions, sco-info, sco-search Example 2004-02-09T14:40:38.
date-expired Description The date that an account is, or was, scheduled to expire, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by user-accounts Example 2004-01-24T00:59:59.000-07:00 date-last-taken Description The date that a course was last taken, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-course-status Example 2004-07-13T10:55:28.
Returned by report-my-courses, report-quiz-definition-questions, sco-contents, sco-info, scosearch Example 2004-02-09T14:40:44.623-08:00 date-taken Description The date that a particular user took a particular quiz, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-quiz-takers Example 2004-01-13T01:33:49.
description Description The description of a principal. Attributes None. Contained tags None (content only). Returned by principal-info, principal-list Example Account administrators group domain-name Description The fully qualified domain name of the location of a SCO. Attributes None. Contained tags None (content only). Returned by report-my-meetings, sco-shortcuts Example admin.breeze.example.com duration Description The duration of a SCO.
Example 1900-01-02T/+:00:00.000+00:00 email Description A user’s e-mail address. Attributes None. Contained tags None (content only). Returned by principal-list, sco-info Example tennant@example.com event Description Container tag; contains information about an event. Attributes None.
expanded-scos Description Container tag; contains information about the contents of a SCO. Attributes None. Contained tags sco Returned by sco-expanded-contents Example Beginning Electronics /l47843877/ 2005-03-31T12:16:54.840-08:00 2005-03-31T12:17:39.
field Description Container tag; contains information about a new custom field. Attributes The ID of the field. field-id account-id The ID of the ACL. acl-id custom-seq type The ID of the account. The custom field number. The type of the custom field. It must be one of the following values: Value Description required Required account custom field. optional Optional and show during self-registration. optional-no-self-reg Optional and hide during self-registration.
Contained tags path Returned by sco-upload Example 38181499/38111519-1/input/Test.ppt files Description Container; contains information about uploaded SCO files. Attributes None. Contained tags file Returned by sco-upload Example 38181499/38111519-1/input/Test.ppt first-name Description A user’s first name. Attributes None. Contained tags None (content only).
hit Description A number indicating which slide contains a search term. Attributes None. Contained tags None (content only). Returned by sco-search Example 5 host Description The URL of the host that the Breeze server is running on. Attributes None. Contained tags None (content only). Returned by common-info Example http://admin.breeze.example.com invalid Description Container tag; contains information about why a particular call to an API is invalid.
Attributes The name of the parameter that was invalid. field subcode The reason that the parameter was invalid. The following table shows the possible values for this attribute: Value Description duplicate The call attempted to add a duplicate item in a context where uniqueness is required. format A passed parameter had the wrong format. illegal-operation The requested operation violates integrity rules (for example, moving a folder into itself is an illegal operation).
last-viewed Description The date and time of the most recent time that a SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-slides Example 2004-01-13T16:35:39.517-08:00 last-viewed-date Description The most recent date and time that the SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-views Example 2004-01-13T17:11:47.
Contained tags name Returned by learning-path-info Example Tester learning-paths Description Container tag; contains information about learning paths in a curriculum. Attributes None.
Contained tags None (content only). Returned by common-info, permissions-info, principal-info, principal-list, report-coursetakers, report-meeting-attendance, report-quiz-takers Example tennant@example.com meeting Description Container tag; contains information about a meeting. Attributes active-participants The number of current participants. The permissions the user has for the meeting. For more information, see “About security” on page 18.
most-recent-session Description The starting time of the most recent session of a meeting. Attributes None. Contained tags None. Returned by report-meeting-summary Example 2005-02-28T17:05:54.953-08:00 my-courses Description Container tag; contains information about one or more courses. Attributes None.
my-events Description Container tag; contains information about one or more events. Attributes None. Contained tags event Returned by report-my-events Example 1st Event bcassidy02 /e95598585/ 2005-03-05T13:00:00.000-08:00 2005-03-10T13:00:00.000-08:00 true 5d 00:00:00.
true 01:00:00.000 name Description A user’s name. For example, depending on the context, the tag may contain the name of a person, the name of a group, the name of a SCO, an e-mail address, or another kind of name. Attributes None. Contained tags None (content only).
path Description The path of an uploaded SCO file. Attributes None. Contained tags None. Returned by sco-upload Example 38181499/38111519-1/input/Test.ppt permission Description Contains information about a specific principal and its permissions. Attributes acl-id The ID of a specific SCO. permission-id The permissions that the principal has for the specified SCO. This attribute is returned only by the permissions-info API. principal-id The ID of the principal.
Contained tags principal Returned by permissions-info Example Englesberg, Ari englesberg@example.com physical-path Description The path on the server to a SCO. Attributes None. Contained tags None (content only).
Language Parameter value Japanese ja Korean ko time-zone-id The time zone setting.
Time zone setting Parameter value Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) 100 Brussels, Copenhagen, Madrid, Paris (GMT+01:00) 105 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (GMT+01:00) 110 West Central Africa (GMT+01:00) 113 Bucharest (GMT+02:00) 115 Cairo(GMT+02:00) 120 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) 125 Athens, Istanbul, Minsk (GMT+02:00) 130 Jerusalem (GMT+02:00) 135 Harare, Pretoria (GMT+02:00) 140 Moscow, St.
Time zone setting Parameter value Seoul (GMT+09:00) 230 Osaka, Sapporo, Tokyo (GMT+09:00) 235 Yakutsk (GMT+09:00) 240 Darwin (GMT+09:30) 245 Adelaide (GMT+09:30) 250 Canberra, Melbourne, Sydney (GMT+10:00) 255 Brisbane (GMT+10:00) 260 Hobart (GMT+10:00) 265 Vladivostok (GMT+10:00) 270 Guam, Port Moresby (GMT+10:00) 275 Magadan, Solomon Islands, New Caledonia (GMT+11:00) 280 Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) 285 Auckland, Wellington (GMT+12:00) 290 Nuku’alofa (
principal Description Contains information about a principal. For general information about principals, see “About principals, SCOs, and IDs” on page 17. Attributes account-id The ID of the account of which the principal is a member. This attribute is returned only by the principal-info API. Indicates whether the principal has children. Groups have children and users don’t, so this attribute indicates whether the principal is a group.
Contained tags login, name, email, first-name, last-name Returned by permissions-info, principal-update, principal-info Example sblye@macromedia.com Sonya Blye sblye@macromedia.com Sonya Blye principal-list Description Container tag; contains one or more principal tags.
Contained tags None (content only). Returned by report-course-takers, report-quiz-takers Example Chiang, Ed question Description The text of a quiz question. Attributes None. Contained tags None (content only). Returned by report-quiz-interactions, report-survey-question-response Example What is 2+2? question-text Description The text of a quiz question. Attributes None. Contained tags None (content only).
quiz-name Description The name of a quiz. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz Example Who is Randy Johnson? quiz-definition-answers Description Container tag; contains one or more row tags, each containing information about a particular answer to a particular quiz question. Attributes None.
quiz-definition-questions Description Container tag; contains one or more row tags, each containing information about a particular quiz question. Attributes None. Contained tags row Returned by report-quiz-definition-questions Example What is 2+2? 2004-01-13T17:09:40.
quota Description Container tag; contains information on the account quotas. Attributes The ID of the account SCO. acl-id The ID of a quota. Breeze enforces different quotas, for example, the Training concurrent user peak, the download used, the authors used, and so on. Each quota has an associated unique quota ID. quota-id The amount of quota that was used. For example, if the account allows a maximum of five authors, and three authors exist in the account, the value of used would be 3.
Example lraj@macromedia.com Enterprise Administrator test-mtg-1 2004-07-09T13:00:28.920-07:00 2004-07-09T13:02:55.
2004-02-17T16:50:00.327-08:00 report-active-meetings Description Container tag; contains a list of meetings that are currently in progress. Attributes None. Contained tags sco Returned by report-active-meetings Example 022305 Stephanie Test /r27873068/ 2005-02-28T16:09:28.
report-bulk-consolidated-transactions Description Container tag; contains information about all the transactions in an account. Attributes None. Contained tags row Returned by report-bulk-consolidated-transactions Example Default Meeting Template /r-182228/ bsharm@macromedia.
Example test-quiz Quiz test 1 Who is Randy Johnson? A baseball pitcher with the Arizona Diamondbacks YES
|
report-bulk-course-quiz Description Container tag; contains rows that contain information about all course quizzes, including a list of quizzes. Attributes None.
Returned by report-bulk-course-results Example lraj@macromedia.com 2004-07-13T10:54:09.030-07:00 00:00:43.017
lraj@macromedia.
report-bulk-meeting-attendance Description Container tag; contains information about all meeting attendees. Attributes None. Contained tags row Returned by report-bulk-meeting-attendance Example test-mtg-1 Enterprise Administrator 2004-07-09T13:00:28.920-07:00 2004-07-09T13:02:55.
232654 2003-10-30T12:14:52.740-08:00 /p30542007/ presentation 181438 Bullet Animation Test.ppt 2003-07-14T14:52:32.327-07:00
/p77876740/ presentation Background 2003-07-14T14:53:08.700-07:00
/p82537206/ presentation Huge 2003-07-14T14:54:16.
Apples can be <1> or <2>. The name of the grocery store is <3> {green,red,Bob's} 2005-03-24T15:16:39.030-08:00 Apples can be <1> or <2>. The name of the grocery store is <3> {j,k,Bob's} 2005-03-24T11:52:14.
2 2005-03-24T16:37:04.303-08:00
3 2005-03-24T16:37:15.710-08:00
6 2005-03-24T16:38:29.
report-course-status Description Container tag; contains information about the status of a course. Attributes total-course-completions The total number of courses completed. total-unique-course-completions The total number of unique courses completed. num-passed The number of courses passed. num-failed The number of courses failed. num-enrollees The number of enrollees in a course.
report-meeting-attendance Description Container tag; contains one or more row tags, each containing information about a user who attended a particular meeting. Attributes None. Contained tags row Returned by report-meeting-attendance Example bcassaly@macromedia.com Bart Cassaly 8th Meeting 2005-03-15T10:11:00.
Example report-meeting-session Description Container tag, contains information about a meeting. Attributes The number of participants who entered the meeting as guests rather than registered attendees. num-guests num-participants sco-id The total number of participants in the meeting. The ID of the parent meeting. A unique identifier for the individual session.
Returned by report-meeting-sessions Example My Meeting 2004-03-05T10:33:09.030-08:00
report-meeting-session-slots Description Container tag; contains one or more row tags, each containing information about a particular session slot. Attributes None.
The number of invited users who attended. num-invitees-attended is-public A Boolean value indicating whether the room is public (true) or not (false). num-guests-attended The number of participants who entered the meeting as guests rather than registered attendees.
100-07-7777 report-quiz-answer-distribution Description Container tag; contains one or more row tags, each indicating how many users selected each answer to the specified quiz question. Attributes None.
Returned by report-quiz-interactions Example Barry Cassidy All Question Types Quiz 2005-03-11T12:04:29.200-08:00 A human being usually has <1> fingers.
percentage-responded="40"> Which international standard defines ECMAScript? ECMA-262 report-quiz-question-distribution Description Container tag; contains one or more row tags, each indicating how many users answered a question in the specified quiz correctly. Attributes None.
Returned by report-quiz-question-response Example Barry Cassidy D 2005-03-14T14:20:43.967-08:00
Barry Cassidy 0 2005-03-14T14:20:43.
Contained tags None (empty tag). Returned by report-quiz-question-totals Example report-quiz-results Description The number of users who took a specified quiz and their range of scores. Attributes average-score The average of the scores of the users who took the quiz. The highest score. high-score The lowest score low-score numdistincttaken numtaken The number of distinct users who have taken the quiz.
Example 2005-03-14T14:20:43.967-08:00 80
report-quiz-takers Description Container tag; contains one or more row tags, each containing information about a user who has taken the specified course or quiz. Attributes None.
report-quotas Description Container tag; contains information about the account quotas. Attributes None. Contained tags quota Returned by report-quotas Example 2003-08-15T13:12:33.260-07:00 2999-12-31T16:00:00.
Returned by report-sco-slides Example 2004-01-13T16:35:39.517-08:00
2004-01-13T16:35:42.350-08:00
2004-01-13T16:35:44.
Contained tags row Returned by report-survey-question-response Example Enterprise Administrator how are you? fine
test1 laxmi how are you? ok
report-training-concurrent-users Description Indicates the largest
response Description A user’s response to a survey question. Attributes None. Contained tags None (content only). Returned by report-survey-question-response Example fine results Description Container tag; contains all results returned by any API. Attributes None. Contained tags Any. Returned by All APIs. Example row Description Contains a single record of information in a report.
Contained tags The tags contained in the row tag vary widely depending on which API the tag is responding to and may include custom tags.
2003-07-10T13:05:42.180+00:00 2003-06-30T19:33:38.317+00:00 another - 06/30/2003 12:33 PM /p62559548/ The following example is returned by the report-active-meetings API: 022305 Stephanie Test /r27873068/ 2005-02-28T16:09:28.
slide-count The number of slides in the SCO. A value of -1 indicates that the slide count doesn’t apply; for example, if the SCO is a meeting rather than a presentation, the slide count is -1. The version number of the SCO. version width The width of the SCO, in pixels. Contained tags date-created, date-modified, physical-path Returned by sco-info Example 2004-01-26T20:47:05.
Returned by sco-nav Example User Meetings tennant@example.com sco-search-info Description Container tag; contains one or more sco tags, each containing information about a SCO that matches the specified search text. Attributes None.
scos Description Container tag; contains one or more sco tags, each containing information about a SCO inside the specified folder. Attributes None. Contained tags sco Returned by sco-contents Example PPT meeting tests 2004-01-29T06:22:49.157-08:00 My Name 2003-08-27T00:00:00.
Example http://admin.breeze.example.com http://admin.breeze.example.com ... [Other sco tags here.] ... http://admin.breeze.example.
status Description A status code returned by the Breeze server whenever an API is called. This section provides information about all the status codes and subcodes that Breeze can return. Attributes code The status of the API. The following values are possible for this attribute: Value Description invalid Indicates that a call is invalid in some way. If the code attribute is set to "invalid", the status tag contains an invalid tag that provides more detail about what’s wrong.
Contained tags invalid Returned by All APIs. Example time-slot-begin Description The start date and time for a meeting session, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-meeting-session-slots Example 2004-02-14T06:50:00.000-08:00 time-slot-end Description The end date and time for a meeting session, in ISO 8601 date format. Attributes None. Contained tags None (content only).
time-taken Description The time a course was taken. Attributes None. Contained tags None (content only). Returned by report-bulk-course-results Example 00:34:23.011 url Description A URL. Attributes None. Contained tags None (content only). Returned by common-info, report-my-courses Example /api/xml?action=common-info url-path Description The path on the Breeze server to the specified SCO. Attributes None. Contained tags None (content only).
Example /r99718924/ user (common-info) Description Container tag; contains information about a user. Attributes user-id The ID of the user. Contained tags login, name Returned by common-info Example Greg Erweck gerweck@example.com user (user-accounts) Description Container tag; contains information about a user and an account. Attributes user-id The ID of the user. account-id The ID of an account.
user-agent Description The host browser information. Attributes None. Contained tags None. Returned by common-info Example Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 user-first-name Description A user’s first name. Attributes None. Contained tags None. Returned by report-bulk-content-slide-views Example Enterprise user-last-name Description A user’s last name. Attributes None.
Returned by report-bulk-content-slide-views Example Administrator user-login Description The login of a user. Attributes None. Contained tags None. Returned by report-bulk-content-quiz-results Example lraj@macromedia.com user-name Description A user name. Attributes None. Contained tags None (content only).
users Description Container tag; contains one or more user tags, each containing information about a user and an account. Attributes None. Contained tags user (user-accounts) Returned by user-accounts Example james@example.com 2004-01-24T00:59:59.000-07:00 smith@example.com 2004-01-24T00:59:59.
version Description The Breeze version number. Attributes None. Contained tags None (content only). Returned by common-info Example breeze_402_r116 view-date-time Description The time and date that a slide was viewed. Attributes None. Contained tags None. Returned by report-bulk-content-slide-views Example 2004-06-30T11:46:12.
INDEX A access control lists (ACLs) 18 access keys acquiring 51 special 146, 148 access-key tag 146 access-key-group tag 147 access-keys tag 148 accesskey-exec action 50 accesskey-info action 51 account tag 148 accounts limits 98 listing 136 acl tag 149 acl-field-info action 53 acl-field-list action 54 acl-field-list tag 149 acl-field-update action 55 acl-fields tag 150 acl-id parameters 17 acl-preference-update action 56 ACLs 18 action tag 150 action-list action 59 actions accesskey-exec 50 accesskey-info
report-disk-usage 96 report-meeting-attendance 97 report-meeting-concurrent-users 98 report-meeting-session 98 report-meeting-session-slots 100 report-meeting-sessions 99 report-meeting-summary 101 report-my-courses 31, 37, 101 report-my-events 31 report-my-meetings 31, 37, 103, 104 report-principal-list 105 report-quiz-answer-distribution 106 report-quiz-definition-answers 107 report-quiz-definition-questions 108 report-quiz-interactions 110 report-quiz-question-answer-distribution 111 report-quiz-question
code samples overview 27 parsing returned XML code 34 use of CFML 15 ColdFusion Markup Language.
my-content 37 permissions 19 relevant to current user 130 See also SCOs G generate reports 39 GET and POST requests (HTTP) 15, 34 group-id parameters 17 group-membership-update action 63 groups about 17 Built-in 17 membership, updating 63 permissions 19 See also principals; users H help systems 10 hierarchies of folders 127 hit tag 165 host tag 165 HTTP GET and POST requests 15 parameters 34 I identity verification 66 IDs about 17 account 148 permissions 18 quiz questions 113 user’s, determining 37 informat
scheduled 103, 104 schedules for meetings 98 sessions 99 See also SCOs meetings, attendance attendees in ten-minute period 100 list of users 97 maximum 98 number of attendees 98 summary 101 most-recent-session tag 170 moving SCOs 127 multiple parameters, specifying overview 16 permissions update 71 principals, deleting 76 SCOs, deleting 123 my-content folder 37 my-courses tag 170 my-events tag 171 my-meetings tag 171 N name tag 172 names of actions 150 O online resources 11 optional parameters 16 P paramete
Q query strings, building 15 question tag 180 question-text tag 180 questions in quizzes IDs, determining 113 listing 108 See also quizzes quiz-definition-answers tag 181 quiz-definition-questions tag 182 quiz-name tag 181, 182 quizzes answers, distribution of 111 answers, text of 152 dates taken 159 interactions 110 number of answering users 115 questions 108 questions answered correctly 112 scoring 110 summaries of results 115 users who took a quiz 116 See also SCOs 110 quota tag 183 R rebuild SCOs 121 re
report-quiz-summary tag 203 report-quiz-takers action 39, 116 report-quiz-takers tag 204 report-quotas action 117 report-quotas tag 205 report-sco-slides action 118 report-sco-slides tag 205 report-sco-views action 119 report-sco-views tag 206 report-survey-question-response action 120 report-survey-question-response tag 206 report-training-concurrent-users tag 207 reports bulk 80 CSV format 39 generating 39 required parameters 16 resetting permissions 70 resources bandwidth, reporting 79 disk space, report
status codes invalid 165 overview 215 XML results 29 status tag 34, 139, 215 students, enrolled in course 95 students, listing 95 subfolders, listing 122 summaries of quiz results 115 synchronizing with directory services 33 T tables, displaying 38 tags access-key 146 access-key-group 147 access-keys 148 account 148 acl 149 acl-field-list 149 acl-fields 150 action 150 actions 151 answer-correct 151 answer-text 152 body 152 cfhttp (in CFML) 34 comment 152 common 153 contact 153 cookie 154 course 154 custom-f
report-bulk-users 193 report-course-status 194 report-disk-usage 194 report-meeting-attendance 195 report-meeting-concurrent-users 195 report-meeting-session 196 report-meeting-session-slots 197 report-meeting-sessions 196 report-meeting-summary 197 report-principal-list 198 report-quiz-answer-distribution 199 report-quiz-interactions 199 report-quiz-question-answer-distribution 200 report-quiz-question-distribution 201 report-quiz-question-response 201 report-quiz-question-totals 202 report-quiz-results 20
listing 34 logging in 36, 66 logging out 68 meeting attendance, maximum 98 meetings, attending 97 meetings, scheduled 37, 103, 104 passwords, changing 137, 138 permissions 68 quiz takers 116 updating information for 36 See also principals; groups users tag 221 V value tag 221 verifying identity 66 version number, Breeze 222 version tag 222 view presentations 119 slides 118 View permission 19 view-date-time tag 222 W web services architecture overview 13 introduction 11 See also actions workflow 14 X XML cre
