1. Manuals
  2. Brands
  3. MACROMEDIA Manuals
  4. Software
  5. BREEZE 5
  6. Integration manual

MACROMEDIA BREEZE 5 Integration Manual

Hide thumbs Also See for BREEZE 5:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Manual
Breeze Integration Guide

Advertisement

Table of Contents
loading

Related Manuals for MACROMEDIA BREEZE 5

Summary of Contents for MACROMEDIA BREEZE 5

  • Page 1 Breeze Integration Guide...
  • Page 2 Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally.

  • Page 3: Table Of Contents

    CONTENTS INTRODUCTION: Before You Begin ........9 Audience .
  • Page 4 CHAPTER 4: XML API Reference ........41 Sample API entry .
  • Page 5 report-meeting-concurrent-users ........98 report-meeting-session.
  • Page 6 acl-fields ............150 action .
  • Page 7 permission............173 permissions .
  • Page 8 report-sco-views..........206 report-survey-question-response .

  • Page 9: Introduction Before You Begin

    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.

  • Page 10: What's Changed In The Breeze Xml Apis

    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.

  • Page 11: Additional Resources

    • Using the Macromedia Breeze Presenter describes the plug-in that allows you to create Breeze presentations from PowerPoint. You can access Using the Macromedia Breeze Presenter from the Breeze Manager home page and from the Breeze menu in Microsoft PowerPoint by selecting Breeze >...

  • Page 12: Typographical Conventions

    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). • indicates code. It also indicates names of APIs, names of parameters, names of tags, Code font and names of attributes.

  • Page 13: Chapter 1: Using The Breeze Xml Apis

    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.

  • Page 14: Data Flow

    Breeze Server The following example describes what might happen when a user connects to a training portal intranet site that was created with Macromedia ColdFusion MX and that uses Breeze XML web services: A logged-in user uses a web browser to request a page that shows a list of the courses that the user is signed up for.

  • Page 15: Calling An Api On The Server

    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 request. POST The Breeze server executes the API, returning the resulting XML data to the application server. 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.

  • Page 16: About Parameters

    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 method when possible.

  • Page 17: About Principals, Scos, And Ids

    <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> In some other APIs, you can provide multiple sets of parameters. For example, the group- API takes parameters named membership-update group-id principal-id, 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.

  • Page 18: About Security

    There are a few other kinds of IDs that aren’t associated with a principal or a SCO, such as , and . But in most cases, a parameter account-id answer-id permission-id question-id name that ends in indicates that the value of the parameter is the ID of either a principal or a SCO.
  • Page 19 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.
  • Page 20 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...

  • Page 21: Chapter 2: Working With Filters

    Filters are the mechanism within Macromedia Breeze XML web services that you can use to define the criteria for retrieving data from Breeze. You use one or more filters with a specific XML API to ensure that the data your users see matches exactly what they are seeking.
  • Page 22 Filter examples The following is a simple example to help illustrate the general concept of filters. The web service returns the list of courses that you enrolled in. This same API used with report-my-courses 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.

  • Page 23: About Sort Filters

    About sort filters You can use a filter of the type to sort data in ascending and descending order. For example, sort the following filter sorts the field in ascending order: name sort-name=asc The following code sorts the name field in descending order: sort-name=desc You can also perform primary and secondary sorts.

  • Page 24: Filter Reference

    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. The following example shows 25 records starting at the 100th record: filter-rows=25&filter-start=100 Filtering by membership in standard groups To filter by membership in standard groups, filter by the type field, as in the following example:...

  • Page 25: Testing Code In The Browser

    <?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <my-courses> <course sco-id="2649026" status="active" type="course"> <name>Understanding Filters Part 2</name> <description>Second course in the series, covering important topics such as date and range filtering.</description> <url>admin.ibreeze.macromedia.com/p40583853/</url> <date-created>2004-05-26T17:51:40.840-07:00</date-created> <date-modified>2004-05-26T17:51:47.750-07:00</date-modified> <date-begin>2004-05-24T14:00:00.000-07:00</date-begin> <url-path>/p40583853/</url-path> <expired>false</expired> </course> </my-courses> </results>...

  • Page 26: Where To Go From Here

    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. In...

  • Page 27: Chapter 3: Common Tasks

    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.

  • Page 28: Calling Your First 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.

  • Page 29: Logging In To Breeze

    Logging in to Breeze To call most APIs, you must be acting as a logged-in user, so you must call the API before login you can call most other APIs. (The exceptions—APIs you can call without logging in—are , and action-list common-info login...
  • Page 30 Reviewing the code The following table describes the highlighted code and its function: Code Description Checks whether the variable is defined. If <cfif IsDefined("FORM.username")> username 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 31: Creating A New User

    Breeze account located at breezeserveraddress: http://breezeserveraddress/api/xml?action=principal-update&first- name=Will&last-name=Tip&login=wtip@macromedia.com&password=66Mustang&has- children=0&type=user Adding a user to a group To add a user to a group, call the API. group-membership-update To a add a user to a group using the XML API, do the following: Create the new user (if the user has not been created yet).

  • Page 32: Creating A Meeting

    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 API while logged in to the administrator account.

  • Page 33: Creating And Managing Learning Paths

    Creating and managing learning paths To create and manage learning paths, use the following APIs: learning-path-info learning- , and . Call to discover the path-update user-transcript-update learning-path-info 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).
  • Page 34 Check that the API completed successfully by parsing the returned XML and examining login the value of the tag’s attribute. status code If the status code isn’t , determine what the error was and handle it appropriately, as in the following: <cfset xml= XmlParse(cfhttp.FileContent)>...
  • Page 35 For each user listed in the directory service but not in Breeze, add the user to Breeze, as follows: 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. Call the API, setting the parameter equal to...

  • Page 36: Integrating Breeze With A Portal

    For each user whose information in Breeze must be updated, obtain the user’s ID, as follows: Examine the data returned by the API in steps 2 through 4 and search for principal-list the ID associated with the user’s login. Obtain the user’s old first name and last name by calling the API.
  • Page 37 To determine a user’s ID, given their login name and password: Log in as the user. Call the API. common-info Parse the returned XML to find the value of the attribute of the tag. user-id user That value is the user’s ID. To check whether an entered password is correct: Log in as the user.
  • Page 38 If you want to provide links to content items in the form of absolute URLs, determine the domain name of the folder: <cfset domainElement= XmlSearch(xml, "//sco[@tree-id='#myTreeId#']/domain-name")> <cfset domainName= domainElement[1].XmlText> Call the API, using the folder’s SCO ID. sco-contents The following API provides a list of the contents of the specified folder: <cfhttp url="#baseurl#api/xml? action=sco-contents&sco-id=#contentSco#"...

  • Page 39: Generating Reports

    Call the API, using the folder’s ID for the parameter. Don’t specify a sco-update folder-id parameter. sco-id Verify that the API completed successfully by checking the returned tag. status To search for content: Obtain the string to search for from the user, using a web-based form. Log in as the user.
  • Page 40 Chapter 3: Common Tasks...

  • Page 41: Chapter 4: Xml Api Reference

    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.

  • Page 42: Api Listing By Function

    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.
  • Page 43 Description Creates or updates presentations, courses, and meetings. sco-update Uploads a file to the Breeze server when you create a sco-upload presentation with the XML API. (For more information, see sco-update 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.
  • Page 44 Description Logs in a user. login Logs out a user, invalidating the cookie that the application logout received when the user logged in. Permissions The following table lists the permissions APIs supported in Breeze 5: Description Provides information about principals and the permissions permissions-info they have for a specified SCO.
  • Page 45 Description Provides a list of users who have attended the specified report-meeting-attendance meeting. Indicates the maximum number of users who can participate report-meeting-concurrent-users simultaneously in the specified meeting. Provides information about all the sessions of a meeting. report-meeting-sessions Indicates how many users were invited to the specified report-meeting-summary meeting and how many invitees and guests attended.

  • Page 46: Alphabetical Api Listing

    The following table lists the user management APIs supported in Breeze 5: Description Adds one or more principals to a group, or removes one or group-membership-update more principals from a group. Provides information about the specified principal. The principal-info specified principal can be a user or a group. Provides a complete list of users and groups, including principal-list primary groups.
  • Page 47 Description Adds one or more principals to a group, or removes one or group-membership-update more principals from a group. Returns a list of learning paths for a learning object that learning-path-info belongs to a curriculum. Updates the learning path for a single learning object in a learning-path-update curriculum.
  • Page 48 Description Returns slide view data for content. This API is not supported report-bulk-content-slide-views in Breeze 5. Returns information about all course quizzes, including a list report-bulk-course-quiz of quizzes, and the questions and answers for each quiz. This API is not supported in Breeze 5. Returns results for a course quiz, including information about report-bulk-course-results each user and quiz question.
  • Page 49 Description Provides information about each course in which the logged- report-my-courses in user is enrolled. Provides information about each event that the logged-in report-my-events user is scheduled to attend. Provides information about each meeting that the logged-in report-my-meetings user is scheduled to attend. Returns the list of all principals in the account.

  • Page 50: Api Reference Entries

    Description Deletes one or more SCOs. sco-delete Lists all of the SCOs in an account. Call this API with filters to sco-expanded-contents find particular SCOs. Provides information about a SCO. sco-info Moves a SCO from one folder to another. sco-move Describes the folder hierarchy that contains the specified sco-nav SCO.

  • Page 51: Accesskey-Info

    To call the API, you need a special access key associated with a meeting or accesskey-exec 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 .
  • Page 52 To find out which group the user will automatically join by self-registering using the special access key, look in the XML element. If the group exists, this element is included in access-key-group the returned XML. If the group does not exist, there is no additional access-key-group element.

  • Page 53: Acl-Field-Info

    The fields are specified at account creation time and stored in an ACL field. <results> <status code="ok"/> <acl-fields> <field acl-id="38181499" field-id="email"> <value>dblack@macromedia.com</value> </field> <field acl-id="38181499" field-id="first-name"> <value>Daryl</value> </field> <field acl-id="38181499" field-id="last-name">...

  • Page 54: Acl-Field-List

    <field acl-id="38181499" field-id="pricing-model-meeting"> <value>concurrent-attendee</value> </field> </acl-fields> </results> See also acl-field-list acl-field-update acl-field-list Availability Breeze 5. Description Returns the list of and values in the logged-in account for the given . For acl-ids field-id example, to list the first names of all users in an account, call this API with field-id=first- .

  • Page 55: Acl-Field-Update

    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”...

  • Page 56: Acl-Preference-Update

    <acl acl-id="38140560"> <value>Mary Sue</value> </acl> </acl-field-list> </results> 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 The language setting.
  • Page 57 Time zone setting Parameter value (GMT-06:00) Guadalajara, Mexico City, Monterrey (GMT-06:00) Central America (GMT-05:00) Eastern Time (US and Canada) (GMT-05:00) Indiana (East) (GMT-05:00) Bogota, Lima, Quito (GMT-04:00) Atlantic Time (Canada) (GMT-04:00) Caracas, La Paz (GMT-04:00) Santiago (GMT-03:30) Newfoundland (GMT-03:00) Brasilia (GMT-03:00) Buenos Aires, Georgetown (GMT-03:00) Greenland (GMT-02:00) Mid-Atlantic...
  • Page 58 Time zone setting Parameter value (GMT+04:00) Abu Dhabi, Muscat (GMT+04:00) Baku, Tbilisi, Yerevan (GMT+04:30) Kabul (GMT+05:00) Ekaterinburg (GMT+05:00) Islamabad, Karachi, Tashkent (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi (GMT+05:45) Kathmandu (GMT+06:00) Astana, Dhaka (GMT+06:00) Sri Jayawardenepura (GMT+06:00) Almaty, Novosibirsk (GMT+06:30) Rangoon (GMT+07:00) Bangkok, Hanoi, Jakarta (GMT+07:00) Krasnoyarsk (GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi...

  • Page 59: Action-List

    Filters Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </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.

  • Page 60: Common-Info

    common-info Availability Breeze 4. Description Provides basic information about the current user and server. If you call without logging in first, the same information is returned, except that common-info tag is not included, and the value may be different. user account-id Parameters None.

  • Page 61: Custom-Fields

    Parameters The ID of the field to be updated (can be obtained by calling the field-id custom-fields API). This parameter needs to be specified only when updating an existing field. The name of the custom field (can be 1 to 60 characters long). name Any comments on the custom field (can be 0 to 60 characters long).

  • Page 62: Custom-Fields-Delete

    Parameters None. Filters Results can be filtered only on . You can also use the modifier on the field-id filter-out type parameter. Results cannot be sorted. The default sort is by ascending field-id Returned elements custom-fields field Sample results <results> <status code="ok"...

  • Page 63: Group-Membership-Update

    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 parameters. For more information, see “About parameters”...
  • Page 64 Parameters The ID of the curriculum to which this learning object belongs. curriculum-id The ID of the learning object. sco-id Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort Filter and sort current-sco-id Filter and sort curriculum-id...

  • Page 65: Learning-Path-Update

    <learning-path curriculum-id="5400246" current-sco-id="5400246" target- sco-id="5400247" path-type="completion-required"> <name>New Hire Safety</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" target- sco-id="5400248" path-type="completion-required"> <name>Beginning Electronics</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" target- sco-id="5400413" path-type="completion-required"> <name>Electronics 2</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" target- sco-id="5400414" path-type="completion-required"> <name>Electronics 3</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400249" target- sco-id="5400248"...

  • Page 66: Login

    The ID of the learning object that restricts access to the current learning target-sco-id object. For example, if a learning object has a prerequisite requirement, the prerequisite SCO is target-sco-id Consider the following scenario: a student must pass the “Intro to Programming” class before taking the “Intermediate Programming”...
  • Page 67 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();...

  • Page 68: Logout

    Returned elements None. Sample results <results> <status code="ok" /> </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.
  • Page 69 For more information about permissions, see “About permissions” on page For more information about filters, see Chapter 2, “Working with Filters,” on page Parameters The ID of a specific SCO. acl-id The ID of a specific principal. This parameter is optional. principal-id Filters The following table lists the fields on which the data can be filtered and sorted:...

  • Page 70: Permissions-Reset

    The following XML data is returned when the parameter is passed: principal-id <results> <status code="ok" /> <permission acl-id="27" permission-id="manage" principal-id="8" /> </results> If the principal was not assigned permissions to the SCO, the status code is returned. no-data See also permissions-reset permissions-update permissions-reset...

  • Page 71: Principal-Info

    For information about permissions, see “About permissions” on page To update multiple principals’ permissions, specify multiple trios of acl-id permission-id parameters. For more information, see “About parameters” on page principal-id Parameters The ID of a SCO. acl-id The ID of a permission. permission-id The ID of a principal (a user or group).
  • Page 72 Sample results <results> <status code="ok" /> <principal account-id="222914" has-children="true" is-primary="true" principal-id="222926" type="course-admins"> <description>Course managers group</description> <login>Course Managers</login> <name>Course Managers</name> </principal> </results> The following sample XML data is returned when the attribute of the element is type principal group <results> <status code="ok" /> <principal account-id="7"...

  • Page 73: Principal-List

    Returned elements principal-list Sample results <results> <status code="ok" /> <principal-list> <principal principal-id="8" contact-id="3" type="user" has- children="false" is-primary="false" is-hidden="0"> <name>Enterprise Administrator</name> <login>lraj@macromedia.com</login> <email>lraj@macromedia.com</email> </principal> <principal principal-id="18" contact-id="" type="authors" has- children="true" is-primary="true" is-hidden="0"> <name>Account Authors</name> <login>Account Authors</login> <description>Account authors group</description> principal-list...

  • Page 74: Principal-List-By-Field

    For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements principal-list Sample results <results> <status code="ok" /> <principal-list> <principal account-id="7" principal-id="10018" type="user" has- children="false" is-primary="false" is-hidden="false"> <name>John Doe</name> <login>jdoe@macromedia.com</login> <description>Example User</description> Chapter 4: XML API Reference...

  • Page 75: Principal-Update

    </principal> </principal-list> </results> 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 In most cases, you must acquire the original version of the principal’s information (using ) before calling the API.

  • Page 76: Principals-Delete

    Returned elements If you update an existing principal, no elements are returned. If you create a new principal, is returned (in the same format as the returned elements principal principal-info Sample results The following sample results are for creating a new principal: <results>...

  • Page 77: Report-Account-Meeting-Attendance

    Filter and sort Returned elements report-account-meeting-attendance Sample results <results> <status code="ok" /> <report-account-meeting-attendance> <row account-id="7" transcript-id="670" sco-id="623" principal-id="8" contact-id="3"> <login>lraj@macromedia.com</login> <session-name>Enterprise Administrator</session-name> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T13:00:28.920-07:00</date-created> <date-closed>2004-07-09T13:02:55.810-07:00</date-closed> <participant-name>Enterprise Administrator</participant-name> </row> <row account-id="7" transcript-id="685" sco-id="623" principal-id="8" contact-id="3"> <login>lraj@macromedia.com</login> <session-name>Enterprise Administrator</session- report-account-meeting-attendance...

  • Page 78: Report-Active-Meeting-Presenters

    name> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T14:33:06.577-07:00</date- created> <date-closed>2004-07-09T14:33:43.547-07:00</date- closed> <participant-name>Enterprise Administrator</participant- name> </row> </report-account-meeting-attendance> </results> report-active-meeting-presenters Availability Breeze 4. Description Provides a list of the users who are currently presenting meetings. Parameters The ID of a meeting; if specified, the report returns information about that meeting sco-id only.

  • Page 79: Report-Active-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 <results> <status code="ok"/> <report-active-meetings> <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path>...

  • Page 80: Report-Bulk-Consolidated-Transactions

    Returned elements report-bandwidth Sample results <results> <status code="ok" /> <report-bandwidth total="71000000" /> </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: •...

  • Page 81: Report-Bulk-Content-Quiz

    Sample results <results> <status code="ok" /> <report-bulk-consolidated-transactions> <row transaction-id="3777813" principal-id="2564976" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>bharm@macromedia.com</login> <user-name>Ben Harm</user-name> <status>completed</status> <date-created>2005-01-29T14:02:04.733-08:00</date-created> </row> <row transaction-id="4832819" principal-id="181271" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>gho@macromedia.com</login> <user-name>Gung Ho</user-name> <status>completed</status> <date-created>2005-01-04T10:10:09.077-08:00</date-created> </row> </report-bulk-consolidated-transactions> </results> See also report-bulk-objects...

  • Page 82: Report-Bulk-Content-Quiz-Results

    Sample results <results> <status code="ok" /> - <report-bulk-content-quiz> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" question- number="1" question-value="10" answer-id="1"> <presentation-name>test-quiz</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson ?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answer- text> <answer-correct>YES</answer-correct> </row> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" question- number="1"...

  • Page 83: Report-Bulk-Content-Slide-Views

    Filter only user-login Filter only user-response Returned elements report-bulk-content-quiz-results Sample results <results> <status code="ok" /> <report-bulk-content-quiz-results> <row user-id="8" presentation-attempt-id="725" presentation-id="720" quiz-id="1" question-number="1" user-response="1"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:51:35.047-07:00</date-time- attempted> <time-taken>00:00:28.017</time-taken> </row> <row user-id="8" presentation-attempt-id="726" presentation-id="720" quiz-id="1" question-number="2" user-response="3"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:52:23.780-07:00</date-time- attempted> <time-taken>00:00:45.046</time-taken> </row>...
  • Page 84 Sort Sort user-login Sort view-date-time Returned elements report-bulk-slide-views Sample results <results> <status code="ok" /> <report-bulk-slide-views> <row session-id="10000022" viewing-session="32" presentation-id="27" slide-number="1"> <user-login>lraj@macromedia.com</user-login> <user-first-name>Enterprise</user-first-name> <user-last-name>Administrator</user-last-name> <presentation-name>test-slide</presentation-name> <view-date-time>2004-06-30T11:46:10.280-07:00</view-date-time> </row> <row session-id="10000022" viewing-session="32" presentation-id="27" slide-number="2"> <user-login>lraj@macromedia.com</user-login> <user-first-name>Enterprise</user-first-name> <user-last-name>Administrator</user-last-name> <presentation-name>test-slide</presentation-name> <view-date-time>2004-06-30T11:46:12.500-07:00</view-date-time> </row> </report-bulk-slide-views>...

  • Page 85: Report-Bulk-Course-Quiz

    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.

  • Page 86: Report-Bulk-Course-Results

    Sort user-login user-response Sort Returned elements report-bulk-course-quiz-results Sample results <results> <status code="ok" /> <report-bulk-course-quiz-results> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="1" user-response="2"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time- attempted> <time-taken>00:00:14.017</time-taken> </row> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="2" user-response="1"> <user-login>lraj@macromedia.com</user-login> Chapter 4: XML API Reference...

  • Page 87: Report-Bulk-Meeting

    <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time- attempted> <time-taken>00:00:34.017</time-taken> </row> </report-bulk-course-quiz-results> </results> Caution: There was an issue with the formatting of the XML tag, which has been fixed in time-taken the Breeze 4.1 updater. If you see incorrect formatting in the content of a XML tag, time-taken download the updater from the Licensed Support...

  • Page 88: Report-Bulk-Meeting-Attendance

    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.

  • Page 89: Report-Bulk-Objects

    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. For example, to return a list of all the meetings in an account, filter on the field, as in the following example: type...

  • Page 90: Report-Bulk-Questions

    </row> <row> <url>/p30542007/</url> <type>presentation</type> <name>181438 Bullet Animation Test.ppt</name> <date-created>2003-07-14T14:54:16.757-07:00</date-created> <date-end>2003-07-14T14:54:16.757-07:00</date-end> <date-modified>2003-07-14T14:52:32.327-07:00</date-modified> </row> </report-bulk-objects> </results> See also report-bulk-consolidated-transactions report-bulk-questions report-bulk-slide- views report-bulk-users report-bulk-questions Availability Breeze 5. Description Returns information about every quiz question in a particular account. Parameters None. Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort date-created...

  • Page 91: Report-Bulk-Slide-Views

    <response>false</response> <date-created>2005-03-24T16:36:36.100-08:00</date-created> </row> <row transaction-id="5335430" score="10" principal-id="4975764"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{green,red,Bob's}</response> <date-created>2005-03-24T15:16:39.030-08:00</date-created> </row> <row transaction-id="5335151" score="0" principal-id="4954032"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question>...
  • Page 92 Returned elements report-bulk-slide-views Sample results <results> <status code="ok"/> <report-bulk-slide-views> <row transaction-id="38484112" principal-id="38181502"> <page>0</page> <date-created>2005-03-24T16:36:41.820-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>4</page> <date-created>2005-03-24T16:37:53.070-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>5</page> <date-created>2005-03-24T16:38:09.070-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>1</page> <date-created>2005-03-24T16:36:47.663-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>2</page> <date-created>2005-03-24T16:37:04.303-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>3</page>...

  • Page 93: Report-Bulk-Users

    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&sort- name=asc&filter-like-name=Jo Parameters None.

  • Page 94: Report-Course-Status

    <type>user</type> </row> <row principal-id="182532"> <login>vish_laxmi@yahoo.com</login> <name>laxmi vish</name> <email>vish_laxmi@yahoo.com</email> <type>user</type> </row> <row principal-id="3914851"> <login>acobbler@macromedia.com</login> <name>Apple Cobbler</name> <email>acobbler@macromedia.com</email> <manager>pangel@macromedia.com</manager> <type>user</type> </row> </report-bulk-users> </results> See also report-bulk-objects report-bulk-questions report-bulk-slide-views report-bulk- consolidated-transactions report-course-status Availability Breeze 4. Description Returns course status for either a principal or a SCO, based on the parameters passed in.

  • Page 95: Report-Course-Takers

    </report-course-status> </results> When the parameter is passed in, the following XML may be returned: principal-id <results> <status code="ok" /> <report-course-status total-course-completions="4" total-unique-course- completions="4" num-passed="3" num-failed="1"> <date-last-taken>2004-07-27T12:53:42.297-07:00</date-last-taken> </report-course-status> </results> report-course-takers Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by report-quiz-takers Description...

  • Page 96: Report-Disk-Usage

    Returned elements report-quiz-takers Sample results <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="13106" sco-id="13105" principal-id="10021" status="user-passed" score="2" certificate="13106" attempts="1"> <login>bcassaly@macromedia.com</login> <date-taken>2005-03-02T16:00:33.170-08:00</date-taken> <principal-name>Bart Cassaly</principal-name> </row> <row transcript-id="13110" sco-id="13105" principal-id="11211" status="user-failed" score="0" certificate="13110" attempts="1"> <login>gbest@macromedia.com</login> <date-taken>2005-03-02T16:03:36.750-08:00</date-taken> <principal-name>George Best</principal-name> </row> <row transcript-id="14102" sco-id="13105" principal-id="12029"...

  • Page 97: Report-Meeting-Attendance

    Filter and sort transcript-id For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-meeting-attendance Sample results <results> <status code="ok" /> <report-meeting-attendance> <row transcript-id="18308" sco-id="18302" principal-id="10021" answered- survey="0"> <login>bcassaly@macromedia.com</login> <session-name>Bart Cassaly</session-name> <sco-name>8th Meeting</sco-name> <date-created>2005-03-15T10:11:00.700-08:00</date-created> report-meeting-attendance...

  • Page 98: Report-Meeting-Concurrent-Users

    <date-end>2005-03-15T10:13:12.810-08:00</date-end> <participant-name>Bart Cassaly</participant-name> </row> </report-meeting-attendance> </results> 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 The ID of a meeting. sco-id Filters Results cannot be filtered or sorted.

  • Page 99: Report-Meeting-Sessions

    Parameters The ID of a meeting. This value must match the for a specific meeting session. sco-id sco-id To obtain the list of all sessions and their associated call the sco-ids, report-meeting- API. sessions Filters Results cannot be filtered or sorted. Returned elements report-meeting-session Sample results...

  • Page 100: Report-Meeting-Session-Slots

    Field Filter/Sort num-participants Sort Filter and sort sco-id For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-meeting-sessions Sample results <results> <status code="ok" /> <report-meeting-sessions> <row sco-id="18302" asset-id="18304" num-participants="1"> <date-created>2005-03-15T09:30:28.233-08:00</date-created> <date-end>2005-03-15T09:45:36.903-08:00</date-end> </row> <row sco-id="18302"...

  • Page 101: Report-Meeting-Summary

    <time-slot-begin>2004-02-14T06:30:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T06:40:00.000-08:00</time-slot-end> </row> <row num-attendees="0"> <time-slot-begin>2004-02-14T06:40:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T06:50:00.000-08:00</time-slot-end> </row> <row num-attendees="0"> <time-slot-begin>2004-02-14T06:50:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T07:00:00.000-08:00</time-slot-end> </row> </report-meeting-session-slots> </results> report-meeting-summary Availability Breeze 4. Description Indicates how many users were invited to the specified meeting and how many invitees and guests attended. Parameters The ID of a meeting. sco-id Filters Results cannot be filtered or sorted.
  • Page 102 For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements my-courses Sample results <results> <status code="ok"/> <my-courses> <course sco-id="555038" type="content" icon="course" permission- id="view"> <name>foooboo</name> <url>professor.ibreeze.macromedia.com/p38547860/</url> <date-created>2004-02-09T06:40:38.497-08:00</date-created> <date-modified>2005-02-13T13:21:33.937-08:00</date-modified> <date-begin>2004-02-09T06:30:00.000-08:00</date-begin> <date-end>2006-02-09T06:30:00.000-08:00</date-end> <url-path>/p38547860/</url-path> <expired>false</expired> <completed>true</completed> </course> <course sco-id="558906" type="content" icon="course" permission- id="view"> <name>1234test</name>...

  • Page 103: Report-My-Events

    </my-courses> </results> report-my-events Availability Breeze 5. Description Provides information about each event that the logged-in user is scheduled to attend. Parameters None. Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort Filter and sort date-begin Filter and sort...

  • Page 104: Report-My-Meetings

    </my-events> </results> report-my-meetings Availability Breeze 4. Description Provides information about each meeting the logged-in user is scheduled to attend. Parameters None. Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort Sort active-participants Sort date-begin...

  • Page 105: Report-Principal-List

    <duration>01:00:00.000</duration> </meeting> </my-meetings> </results> report-principal-list Availability Breeze 4. This API is not supported in Breeze 5. The custom field information that was returned by was moved to report-principal-list ACLs in Breeze 5. For more information, see the , and acl-field-info acl-field-list acl- API entries.

  • Page 106: Report-Quiz-Answer-Distribution

    <name>Enterprise Administrator</name> <login>lraj@macromedia.com</login> <custom0 /> <custom1 /> </row> <row principal-id="17" type="admins" has-children="true" is- primary="true"> <name>Account Administrators</name> <login>Account Administrators</login> <custom0 /> <custom1 /> </row> <row principal-id="123" type="user" has-children="false" is- primary="false"> <name>test1 laxmi</name> <login>test1-laxmi@test.enang.com</login> <custom0>ENGG</custom0> <custom1>100-07-7777</custom1> </row> </report-principal-list> </results> report-quiz-answer-distribution Availability Breeze 4. This API is not supported in Breeze 5.

  • Page 107: Report-Quiz-Definition-Answers

    Sample results The following XML contains attributes for answer options 1 through 8, even if the quiz question has fewer possible answers: <results> <status code="ok" /> <report-quiz-answer-distribution> <row question-number="1" question-id="257" a1="0" a2="1" a3="0" a4="1" a5="0" a6="0" a7="0" a8="0" total="2"> <body>Who is Randy Johnson ?</body> </row>...

  • Page 108: Report-Quiz-Definition-Questions

    Sample results <results> <status code="ok" /> <quiz-definition-answers> <row answer-id="1" question-id="257" correct="0"> <body>22</body> </row> <row answer-id="2" question-id="257" correct="0"> <body>0</body> </row> <row answer-id="3" question-id="257" correct="1"> <body>4</body> </row> <row answer-id="1" question-id="258" correct="1"> <body>150,000,000 kilometers</body> </row> <row answer-id="2" question-id="258" correct="0"> <body>1 parsec</body> </row> <row answer-id="3" question-id="258" correct="0"> <body>100 kilometers</body>...
  • Page 109 Parameters The ID of a presentation that contains a quiz. sco-id 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 Filter and sort date-modified Filter and sort question-id...

  • Page 110: Report-Quiz-Interactions

    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 attribute indicates the score that the quiz-taker received on score...

  • Page 111: Report-Quiz-Question-Answer-Distribution

    <date-created>2005-03-11T12:04:29.200-08:00</date-created> <description>A human being usually has <1> fingers.</description> <response>10</response> </row> </report-quiz-interactions> </results> 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). report-quiz-definition-answers report-quiz-definition-questions determine the ID of a question (to specify as the parameter).

  • Page 112: Report-Quiz-Question-Distribution

    <row display-seq="0" interaction-id="17809" score="1" num-selected="1"> <response>0</response> </row> <row display-seq="0" interaction-id="17810" score="0" num-selected="1"> <response>2</response> </row> <row display-seq="0" interaction-id="17811" score="0" num-selected="1"> <response>C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E</response> </row> <row display-seq="1" interaction-id="17812" score="1" num-selected="1"> <response>1</response> </row> <row display-seq="2" interaction-id="17813" score="1" num-selected="1"> <response>2</response> </row> </report-quiz-question-answer-distribution> </results> report-quiz-question-distribution Availability Breeze 4.

  • Page 113: Report-Quiz-Question-Response

    For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-quiz-question-distribution Sample results <results> <status code="ok" /> <report-quiz-question-distribution> <row display-seq="1" interaction-id="17807" num-correct="1" num- incorrect="0" total-responses="1" percentage-correct="100" score="10"> <name>Interaction20008</name> <description>Which of the following is the capital city of California</ description>...
  • Page 114 For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-quiz-question-response Sample results <results> <status code="ok" /> <report-quiz-question-response> <row principal-id="10021" interaction-id="17807"> <user-name>Barry Cassidy</user-name> <response>D</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17809"> <user-name>Barry Cassidy</user-name> <response>0</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row>...

  • Page 115: Report-Quiz-Question-Totals

    report-quiz-question-totals Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by the API. report-quiz-question-distribution 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. report-quiz-definition-answers report-quiz-definition-questions determine the ID of a question (to use as the...

  • Page 116: Report-Quiz-Takers

    Sample results <results> <status code="ok" /> <report-quiz-summary> <row num-questions="0" average-score="10" low-score="10" high-score="10" numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> <date-created>2005-03-14T14:20:43.967-08:00</date-created> <passing-score>80</passing-score> </row> </report-quiz-summary> </results> report-quiz-takers Availability Breeze 4. Description Provides information about everyone who has taken a particular quiz. To get a list of SCOs that a specified principal viewed, pass the parameter instead principal-id of the...

  • Page 117: Report-Quotas

    Sample results <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="17466" sco-id="17438" principal-id="10021" status="user-failed" score="0" attempts="2" time-taken="152000" certificate="" answered-survey="1"> <name>All Question Types Quiz</name> <login>bcassaly@macromedia.com</login> <date-created>2005-03-11T12:07:04.890-08:00</date-created> <principal-name>Barry Cassaly</principal-name> </row> <row transcript-id="17619" sco-id="17438" principal-id="11211" status="user-passed" score="60" attempts="1" time-taken="89360" certificate="17619" answered-survey="1"> <name>All Question Types Quiz</name>...

  • Page 118: Report-Sco-Slides

    Parameters None. Filters Results cannot be filtered or sorted. Returned elements report-quotas Sample results <results> <status code="ok" /> <report-quotas> <quota acl-id="181224" quota-id="2" used="6545516" limit="unlimited" soft- limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="download-quota" used="0" limit="unlimited" soft-limit="1000000000"> <date-begin>2004-03-24T13:13:18.467-08:00</date-begin> <date-end>2999-12-31T16:00:00.077-08:00</date-end> </quota> <quota acl-id="181224" quota-id="user-quota" used="6545516" limit="unlimited"...

  • Page 119: Report-Sco-Views

    Filters The following table lists the fields on which the data can be filtered and sorted: Field Filter/Sort date-created Sort Sort slide Sort views For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-sco-slides Sample results <results>...

  • Page 120: Report-Survey-Question-Response

    Sample results <results> <status code="ok" /> <report-sco-views> <row sco-id="17803" type="content" is-folder="0" views="1" principal- id="10021" transcript-id="17808" asset-id="17805"> <name>One Question - New</name> <last-viewed-date>2005-03-14T14:20:43.967-08:00</last-viewed-date> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> </report-sco-views> </results> report-survey-question-response Availability Breeze 4. This API is not supported in Breeze 5. This API was replaced by report-quiz-question-response Description Returns the list of all users who answered the specified question and their answer.

  • Page 121: Sco-Build

    </row> <row principal-id="123" question-number="1"> <user-name>test1 laxmi</user-name> <question>how are you?</question> <response>ok</response> </row> </report-survey-question-response> </results> 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 ). No one can view a SCO until it sco-update sco-upload has been built.

  • Page 122: Sco-Contents

    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: Description content...

  • Page 123: Sco-Delete

    For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements scos Sample results elements are always returned, but the name date-modified date-begin date-end elements are present only for SCOs whose attribute is duration type course meeting...

  • Page 124: Sco-Expanded-Contents

    Filters Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </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 The ID of a folder. sco-id Filters Results cannot be sorted or filtered.

  • Page 125: Sco-Info

    sco-info Availability Breeze 4. Description Provides information about a SCO. For information about SCOs, see “About principals, SCOs, and IDs” on page Parameters The ID of a SCO. sco-id Filters Results cannot be filtered or sorted. Returned elements The returned tags depend on the SCO type of the specified item. Some tags that might be returned include the following: sco-author sco-data...
  • Page 126 <author-info-2>n</author-info-2> <date-created>2004-06-30T11:45:03.717-07:00</date-created> <date-modified>2004-06-30T11:53:33.250-07:00</date-modified> <name>test-slide</name> <url-path>/p27916084/</url-path> </sco> <sco-data byte-count="766632" height="540" length="11280" sco-data-id="29" slide-count="2" version="0" width="720"> <date-created>2004-06-30T11:45:03.717-07:00</date-created> <date-modified>2004-06-30T11:53:33.090-07:00</date-modified> <physical-path>7/27/</physical-path> </sco-data> <source-sco /> </results> The following is sample XML from a SCO whose attribute is type folder <results> <status code="ok" /> <sco folder-id="24" host-id="" lang="en" learning-time="" sco-data-id="746" sco-id="744"...

  • Page 127: Sco-Move

    <source-sco folder-id="12" host-id="" lang="en" learning-time="" sco-data- id="722" sco-id="720" source-sco-id="" status="active" tree-id="11" type="presentation"> <author-info-1>l</author-info-1> <date-created>2004-07-13T10:46:48.000-07:00</date-created> <date-modified>2004-07-13T10:47:23.810-07:00</date-modified> <name>test-quiz</name> <url-path>/p67601053/</url-path> </source-sco> </source-sco> </results> sco-move Availability Breeze 4. Description Moves a SCO from one folder to another. For information about rules regarding moves and their necessary permissions, see Breeze Help. Parameters The ID of the destination folder.

  • Page 128: Sco-Search

    In the returned results, the tag’s attribute indicates how many hierarchical levels away depth the folder is from the specified SCO. That is, a attribute equal to 0 indicates the SCO depth itself; a of 1 indicates the folder that contains the SCO; and so on. depth Parameters The ID of a SCO.
  • Page 129 Filters You can restrict the returned data to a specific number of rows by using the filter-rows parameters. For example, the following code returns the first five rows of data: filter-start filter-rows=5&filter-start=0 Note: The parameter indicates the number of rows to be returned, and filter-rows filter-start indicates where the row count should begin.

  • Page 130: Sco-Shortcuts

    <date-created>2005-03-30T16:32:42.280-08:00</date-created> <date-modified>2005-03-30T16:32:42.280-08:00</date-modified> <hit>2</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=2</hit-url> <thumbnail-path /> </sco> </sco-search-info> </results> 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. To determine the URL of a SCO, concatenate the domain name returned by this API with the URL returned by the API in the...

  • Page 131: Sco-Update

    <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181227" sco-id="181412" type="my-content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181225" sco-id="181225" type="content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181226" sco-id="181226" type="courses"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181227" sco-id="181227" type="user-content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181228" sco-id="181228" type="meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181230" sco-id="181230" type="user-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> </shortcuts> </results> See also sco-info sco-expanded-contents...
  • Page 132 To use sco-update with a Breeze presentation: Call with the parameter to create a SCO. sco-update folder-id Pass the following parameters: (the author’s folder-id description name author-info-1 name), (the author’s title), (the company name), author-info-2 author-info-3 , and type=presentation lang Call to associate content with this SCO.
  • Page 133 The ID of the folder in which the server will create the new SCO. This parameter is folder-id optional and cannot be specified with sco-id The last name of the contact person for the SCO. (Used only for presentations.) last-name The name of the SCO.
  • Page 134 To upload a different SCO and rebuild the presentation, call in that sco-upload sco-build order. The following sample results are returned when a presentation is updated: <results> <status code="ok" /> </results> The following sample XML is returned when a course is created: <results>...

  • Page 135: Sco-Upload

    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 sco-build You must send the parameters for this API using the multipart/form-data media type. The easiest way to create the parameter is to use a form control of type in a form on a web page.

  • Page 136: User-Accounts

    Filters Results cannot be filtered or sorted. Returned elements files Sample results <results> <status code="ok"/> <files> <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> </files> </results> 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;...

  • Page 137: User-Transcript-Update

    <name>smith@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="214251" account-id="214191"> <name>jones@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> </users> </results> 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. This API works only in the context of a curriculum, and manage permissions for the curriculum are required.

  • Page 138: User-Update-Pwd

    user-update-pwd Availability Breeze 4. Description Changes a user’s password. Parameters The new password. password The user’s current password. password-old A second copy of the new password, for verification. password-verify The ID of the user. user-id Filters Results cannot be filtered or sorted. Returned elements None.

  • Page 139: Chapter 5: Xml Results Reference

    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 About returned XML code When you call an API on the Breeze server, the server returns a block of XML code.

  • Page 140: Sample Xml Tag Entry

    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 tag in the returned results.
  • Page 141 Description Contains information about an access control list. Contains a list of custom fields associated with an access acl-field-list control list. Contains information about the custom fields of an access acl-fields control list. The name of an API. action The text for a correct answer. answer-correct The text of an answer to a quiz question as part of the results answer-text...
  • Page 142 Description A description of a principal. description The fully qualified domain name of the location of a SCO. domain-name The duration of a SCO. duration A user’s e-mail address. email Contains information about an event. event Contains information about the contents of a SCO. expanded-scos A Boolean value indicating whether a SCO has expired.
  • Page 143 Description Contains information about one or more principals and their permissions permissions. The path on the server to a SCO. physical-path Contains information about user preferences. preferences The name of a Breeze presentation. presentation-name Contains information about a principal. principal Contains one or more principal tags.
  • Page 144 Description Indicates how much hard disk space the Breeze content report-disk-usage uses, in bytes. Contains one or more tags, each containing information report-meeting-attendance about a user who attended a particular meeting. The maximum number of users who participated report-meeting-concurrent-users simultaneously in the specified meeting. Contains information about a meeting.
  • Page 145 Description Contains information about the list of all users who answered report-survey-question-response the specified question and their answer. Indicates the largest number of users who have used the report-training-concurrent-users system at the same time. A user’s response to a survey question. response Contains all results returned by any API.

  • Page 146: Access-Key (Container)

    Description A user’s last name. user-last-name A user’s login (usually an e-mail address). user-login A user name. user-name Contains one or more tags, each containing information users user about a user and an account. The value of a custom field. value The Breeze version number.

  • Page 147: Access-Key-Group

    Attributes None. Contained tags None (content only). Returned by accesskey-info Example <access-key>vb7gmg6ohtz4y7k6</access-key> See also access-key (container) access-keys access-key-group Description Container tag; contains information about which group the user automatically joins by self- registering using the special access key. Also contains a login and name tag. Attributes The ID of the account of which the principal is a member.

  • Page 148: Access-Keys

    hosted-support learners live-admins seminar-admins user Contained tags login name Returned by accesskey-info Example <access-key-group account-id="7" has-children="true" is-primary="false" principal-id="630" type="group"> <login>COURSE-test1-self-reg-group</login> <name>COURSE-test1-self-reg-group</name> </access-key-group> access-keys Description Container tag; contains one or more access keys. Attributes None. Contained tags access-key (container) Returned by accesskey-info Example <access-keys>...

  • Page 149: Acl

    Contained tags None (empty tag). Returned by common-info Example <account account-id="222914"/> Description Container tag; contains information about an access control list (ACL). Attributes The ID of an ACL. acl-id Contained tags value Returned by acl-field-list Example <acl acl-id="38140560"> <value>Mary</value> </acl> acl-field-list Description Container tag;...

  • Page 150: Acl-Fields

    <value>Mike</value> </acl> <acl acl-id="38140560"> <value>Mary</value> </acl> </acl-field-list> acl-fields Description Container tag; contains information about ACL fields. Attributes None. Contained tags field Returned by acl-field-info Example <acl-fields> <field acl-id="38351541" field-id="x-tel-conference-number"/> <field acl-id="38351541" field-id="x-tel-participant-code"/> <field acl-id="38351541" field-id="x-tel-moderator-code"/> </acl-fields> action Description The name of an API. Attributes None.

  • Page 151: Actions

    actions Description Container tag; contains a list of APIs. Attributes None. Contained tags action Returned by action-list Example <actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action> [other APIs listed here] <action>user-accounts</action> <action>user-update-pwd</action> </actions> answer-correct Description The text for a correct answer. Attributes None. Contained tags None (content only).

  • Page 152: Answer-Text

    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 <answer-text>ECMA-262</answer-text> body Description The text of a returned item, such as the text of a quiz question in a quiz-related report. Attributes None.

  • Page 153: Common

    Example <common locale="en"> <cookie>breezcywdihbvipp9kcrg.P01BRZPR36</cookie> <date>2005-02-24T17:10:05.190-08:00</date> <host>http://admin.breezecentral.com</host> <url>/api/xml?action=common-info</url> <version>breeze_500_r271</version> <account account-id="38181499"/> <user user-id="38181502" type="user"> <name>Sonya Blye</name> <login>sblye@macromedia.com</login> </user> <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> </common> contact Description Container tag; contains information about a contact. Attributes The ID of a contact.

  • Page 154: Cookie

    Contained tags email first-name last-name Returned by principal-info Example <contact contact-id="654"> <email>test4-lnagaraj@test.enang.com</email> <first-name>test4</first-name> <last-name>laxmi</last-name> </contact> 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.

  • Page 155: Custom-Fields

    Contained tags date-begin date-created date-end date-modified expired name url-path Returned by report-my-courses Example <course sco-id="555038" status="active" type="course"> <name>My Name</name> <url>admin.breeze.example.com/p38547860/</url> <date-created>2004-02-09T14:40:38.497-08:00</date-created> <date-modified>2004-02-09T14:40:44.623-08:00</date-modified> <date-begin>2004-02-09T14:30:00.000-08:00</date-begin> <date-end>2004-02-09T14:30:00.000-08:00</date-end> <url-path>/p38547860/</url-path> <expired>true</expired> </course> custom-fields Description Container tag; contains information about the custom fields of an account. Attributes None.

  • Page 156: Date

    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 <date>2004-02-12T15:53:19.797-07:00</date> date-begin Description The date and time that a SCO is, or was, scheduled to begin, in ISO 8601 date format. Attributes None.

  • Page 157: Date-Created

    Returned by report-meeting-attendance Example <date-closed>2004-01-29T00:59:41.470-08:00</date-closed> 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 <date-created>2004-02-09T14:40:38.497-08:00</date-created> date-end Description The date and time that a SCO is, or was, scheduled to end, in ISO 8601 date format.

  • Page 158: Date-Expired

    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 <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> date-last-taken Description The date that a course was last taken, in ISO 8601 date format. Attributes None.

  • Page 159: Date-Taken

    Returned by report-my-courses report-quiz-definition-questions sco-contents sco-info sco- search Example <date-modified>2004-02-09T14:40:44.623-08:00</date-modified> 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 <date-taken>2004-01-13T01:33:49.460-08:00</date-taken> date-time-attempted Description The date that a particular user took a particular quiz, in ISO 8601 format.

  • Page 160: Description

    description Description The description of a principal. Attributes None. Contained tags None (content only). Returned by principal-info principal-list Example <description>Account administrators group</description> 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...

  • Page 161: Email

    Example <duration>1900-01-02T/+:00:00.000+00:00</duration> email Description A user’s e-mail address. Attributes None. Contained tags None (content only). Returned by principal-list sco-info Example <email>tennant@example.com</email> event Description Container tag; contains information about an event. Attributes None. Contained tags name domain-name url-path date-begin date-end expired duration Returned by my-events...

  • Page 162: Expanded-Scos

    expanded-scos Description Container tag; contains information about the contents of a SCO. Attributes None. Contained tags Returned by sco-expanded-contents Example <expanded-scos> <sco depth="0" sco-id="5400248" folder-id="5400246" type="link" icon="producer" lang="en" source-sco-id="5413507" display-seq="1" source- sco-type="0"> <name>Beginning Electronics</name> <url-path>/l47843877/</url-path> <date-created>2005-03-31T12:16:54.840-08:00</date-created> <date-modified>2005-03-31T12:17:39.437-08:00</date-modified> </sco> </expanded-scos> expired Description A Boolean value that indicates whether a SCO has expired.

  • Page 163: Field

    field Description Container tag; contains information about a new custom field. Attributes The ID of the field. field-id The ID of the account. account-id The ID of the ACL. acl-id The custom field number. custom-seq The type of the custom field. It must be one of the following values: type Value Description...

  • Page 164: Files

    Contained tags path Returned by sco-upload Example <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> files Description Container; contains information about uploaded SCO files. Attributes None. Contained tags file Returned by sco-upload Example <files> <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> </files> first-name Description A user’s first name. Attributes None.

  • Page 165: Hit

    Description A number indicating which slide contains a search term. Attributes None. Contained tags None (content only). Returned by sco-search Example <hit>5</hit> host Description The URL of the host that the Breeze server is running on. Attributes None. Contained tags None (content only).

  • Page 166: Last-Name

    Attributes The name of the parameter that was invalid. field The reason that the parameter was invalid. The following table shows the possible subcode values for this attribute: Value Description duplicate The call attempted to add a duplicate item in a context where uniqueness is required.

  • Page 167: Last-Viewed

    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 <last-viewed>2004-01-13T16:35:39.517-08:00</last-viewed> last-viewed-date Description The most recent date and time that the SCO was viewed, in ISO 8601 date format. Attributes None.

  • Page 168: Learning-Paths

    Contained tags name Returned by learning-path-info Example <learning-path curriculum-id="38184158" current-sco-id="38184158" target-sco- id="38345286" path-type="completion-required"> <name>Tester</name> </learning-path> learning-paths Description Container tag; contains information about learning paths in a curriculum. Attributes None. Contained tags learning-path Returned by learning-path-info Example <learning-paths> <learning-path curriculum-id="38184158" current-sco-id="38184158" target- sco-id="38345286"...

  • Page 169: Meeting

    Contained tags None (content only). Returned by common-info permissions-info principal-info principal-list report-course- takers report-meeting-attendance report-quiz-takers Example <login>tennant@example.com</login> meeting Description Container tag; contains information about a meeting. Attributes The number of current participants. active-participants The permissions the user has for the meeting. For more information, see permission-id “About security”...

  • Page 170: Most-Recent-Session

    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 <most-recent-session>2005-02-28T17:05:54.953-08:00</most-recent-session> my-courses Description Container tag; contains information about one or more courses. Attributes None. Contained tags course Returned by report-my-courses Example <my-courses>...

  • Page 171: My-Events

    my-events Description Container tag; contains information about one or more events. Attributes None. Contained tags event Returned by report-my-events Example <my-events> <event sco-id="13923" type="event" icon="event" permission-id="host"> <name>1st Event</name> <domain-name>bcassidy02</domain-name> <url-path>/e95598585/</url-path> <date-begin>2005-03-05T13:00:00.000-08:00</date-begin> <date-end>2005-03-10T13:00:00.000-08:00</date-end> <expired>true</expired> <duration>5d 00:00:00.000</duration> </event> </my-events> my-meetings Description Container tag; contains information about one or more meetings. Attributes None.

  • Page 172: Name

    <expired>true</expired> <duration>01:00:00.000</duration> </meeting> </my-meetings> 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.

  • Page 173: Path

    path Description The path of an uploaded SCO file. Attributes None. Contained tags None. Returned by sco-upload Example <path>38181499/38111519-1/input/Test.ppt</path> permission Description Contains information about a specific principal and its permissions. Attributes The ID of a specific SCO. acl-id The permissions that the principal has for the specified SCO. This attribute is permission-id returned only by the API.

  • Page 174: Physical-Path

    Contained tags principal Returned by permissions-info Example <permissions> <principal principal-id="181248" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Englesberg, Ari</name> <login>englesberg@example.com</login> </principal> </permissions> physical-path Description The path on the server to a SCO. Attributes None. Contained tags None (content only). Returned by sco-info Example <physical-path>222914/503227/</physical-path>...
  • Page 175 Language arameter value Japanese Korean The time zone setting. Breeze currently supports the following 75 time zones: time-zone-id Time zone setting Parameter value International Date Line West (GMT-12:00) Midway Island, Samoa (GMT-11:00) Hawaii (GMT-10:00) Alaska (GMT-09:00) Pacific Time (US and Canada); Tijuana (GMT-08:00) Mountain Time (US and Canada) (GMT-07:00)
  • Page 176 Time zone setting Parameter value Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) Brussels, Copenhagen, Madrid, Paris (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (GMT+01:00) West Central Africa (GMT+01:00) Bucharest (GMT+02:00) Cairo (GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) Athens, Istanbul, Minsk (GMT+02:00) Jerusalem (GMT+02:00)

  • Page 177: Presentation-Name

    Time zone setting Parameter value Seoul (GMT+09:00) Osaka, Sapporo, Tokyo (GMT+09:00) Yakutsk (GMT+09:00) Darwin (GMT+09:30) Adelaide (GMT+09:30) Canberra, Melbourne, Sydney (GMT+10:00) Brisbane (GMT+10:00) Hobart (GMT+10:00) Vladivostok (GMT+10:00) Guam, Port Moresby (GMT+10:00) Magadan, Solomon Islands, New Caledonia (GMT+11:00) Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) Auckland, Wellington (GMT+12:00)

  • Page 178: Principal

    principal Description Contains information about a principal. For general information about principals, see “About principals, SCOs, and IDs” on page Attributes The ID of the account of which the principal is a member. This attribute is account-id returned only by the API.

  • Page 179: Principal-List

    Returned by permissions-info principal-update principal-info Example <principal account-id="38181499" has-children="false" is-hidden="false" is- primary="false" principal-id="38181502" type="user"> <login>sblye@macromedia.com</login> <name>Sonya Blye</name> <email>sblye@macromedia.com</email> <first-name>Sonya</first-name> <last-name>Blye</last-name> </principal> principal-list Description Container tag; contains one or more principal tags. Attributes None. Contained tags...

  • Page 180: Question

    Contained tags None (content only). Returned by report-course-takers report-quiz-takers Example <principal-name>Chiang, Ed</principal-name> 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 <question>What is 2+2?</question> question-text Description The text of a quiz question. Attributes None.

  • Page 181: Quiz-Name

    quiz-name Description The name of a quiz. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz Example <question-text>Who is Randy Johnson?</question-text> quiz-definition-answers Description Container tag; contains one or more tags, each containing information about a particular answer to a particular quiz question. Attributes None.

  • Page 182: Quiz-Definition-Questions

    quiz-definition-questions Description Container tag; contains one or more tags, each containing information about a particular quiz question. Attributes None. Contained tags Returned by report-quiz-definition-questions Example <quiz-definition-questions> <row question-number="1" question-id="257" score="20" chapter-id="1"> <body>What is 2+2?</body> <date-modified>2004-01-13T17:09:40.230-08:00</date-modified> </row> <row question-number="2" question-id="258" score="20" chapter-id="1"> <body>How far is it from Earth to the sun?</body>...

  • Page 183: Quota

    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 quota-id concurrent user peak, the download used, the authors used, and so on. Each quota has an associated unique quota ID.

  • Page 184: Report-Active-Meeting-Presenters

    Example <report-account-meeting-attendance> <row account-id="7" transcript-id="670" sco-id="623" principal-id="8" contact-id="3"> <login>lraj@macromedia.com</login> <session-name>Enterprise Administrator</session- name> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T13:00:28.920-07:00</date- created> <date-closed>2004-07-09T13:02:55.810-07:00</date- closed> <participant-name>Enterprise Administrator</participant- name> </row> <row account-id="7" transcript-id="685" sco-id="623" principal-id="8" contact-id="3"> <login>lraj@macromedia.com</login> <session-name>Enterprise Administrator</session- name> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T14:33:06.577-07:00</date- created> <date-closed>2004-07-09T14:33:43.547-07:00</date- closed> <participant-name>Enterprise Administrator</participant- name> </row>...

  • Page 185: Report-Active-Meetings

    <date-created>2004-02-17T16:50:00.327-08:00</date-created> </sco> </report-active-meeting-presenters> report-active-meetings Description Container tag; contains a list of meetings that are currently in progress. Attributes None. Contained tags Returned by report-active-meetings Example <report-active-meetings> <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path> <date-created>2005-02-28T16:09:28.510-08:00</date-created> </sco> <sco sco-id="38345152" active-participants="1" length-minutes="1"> <name>Status Meeting</name>...

  • Page 186: Report-Bulk-Consolidated-Transactions

    Container tag; contains information about all the transactions in an account. Attributes None. Contained tags Returned by report-bulk-consolidated-transactions Example <report-bulk-consolidated-transactions> <row transaction-id="3777813" principal-id="2564976" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>bsharm@macromedia.com</login> <user-name>Ben Harm</user-name> <status>completed</status> <date-created>2005-01-29T14:02:04.733-08:00</date-created> </row> <row transaction-id="4832819" principal-id="181271" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>gho@macromedia.com</login> <user-name>Gung Ho</user-name> <status>completed</status>...

  • Page 187: Report-Bulk-Content-Quiz-Results

    Container tag; contains row information about the results for a content quiz. Attributes None. Contained tags Returned by report-bulk-content-quiz-results Example <report-bulk-content-quiz-results> <row user-id="8" presentation-attempt-id="725" presentation-id="720" quiz- id="1" question-number="1" user-response="1"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:51:35.047-07:00</date-time-attempted> <time-taken>00:00:28.017</time-taken> </row> <row user-id="8" presentation-attempt-id="726" presentation-id="720" quiz- id="1" question-number="2" user-response="3"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:52:23.780-07:00</date-time-attempted> <time-taken>00:00:14.017</time-taken> </row>...

  • Page 188: Report-Bulk-Course-Quiz

    report-bulk-course-quiz Description Container tag; contains rows that contain information about all course quizzes, including a list of quizzes. Attributes None. Contained tags Returned by report-bulk-course-quiz Example <report-bulk-course-quiz> <row course-id="727" quiz-id="1" quiz-passing-score="10" question- number="1" question-value="10" answer-id="1"> <presentation-name>quiz-course-ln</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answer- text>...

  • Page 189: Report-Bulk-Meeting

    Returned by report-bulk-course-results Example <report-bulk-course-quiz-results> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="1" user-response="2"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-attempted> <time-taken>00:00:43.017</time-taken> </row> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="2" user-response="1"> <user-login>lraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-attempted> <time-taken>00:00:67.017</time-taken> </row> </report-bulk-course-quiz-results> report-bulk-meeting Description Container tag; contains information about all meetings. Attributes None. Contained tags...

  • Page 190: Report-Bulk-Meeting-Attendance

    report-bulk-meeting-attendance Description Container tag; contains information about all meeting attendees. Attributes None. Contained tags Returned by report-bulk-meeting-attendance Example <report-bulk-meeting-attendance> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T13:00:28.920-07:00</attendee-join> <attendee-exit>2004-07-09T13:02:55.810-07:00</attendee-exit> </row> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T14:33:06.577-07:00</attendee-join> <attendee-exit>2004-07-09T14:33:43.547-07:00</attendee-exit> </row> </report-bulk-meeting-attendance> report-bulk-objects Description Container tag;...

  • Page 191: Report-Bulk-Questions

    <name>232654</name> <date-modified>2003-10-30T12:14:52.740-08:00</date-modified> </row> <row> <url>/p30542007/</url> <type>presentation</type> <name>181438 Bullet Animation Test.ppt</name> <date-modified>2003-07-14T14:52:32.327-07:00</date-modified> </row> <row> <url>/p77876740/</url> <type>presentation</type> <name>Background</name> <date-modified>2003-07-14T14:53:08.700-07:00</date-modified> </row> <row> <url>/p82537206/</url> <type>presentation</type> <name>Huge</name> <date-modified>2003-07-14T14:54:16.757-07:00</date-modified> </row> <row> <url>/p39862939/</url> <type>presentation</type> <name>Animated</name> <date-modified>2003-07-14T14:55:15.160-07:00</date-modified> </row> </report-bulk-objects> report-bulk-questions Description Container tag; contains information about all the quiz questions in an account. Attributes None.

  • Page 192: Report-Bulk-Slide-Views

    <question>Apples can be <1> or <2>. The name of the grocery store is <3></ question> <response>{green,red,Bob's}</response> <date-created>2005-03-24T15:16:39.030-08:00</date-created> </row> <row transaction-id="5335151" score="0" principal-id="4954032"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></ question> <response>{j,k,Bob's}</response> <date-created>2005-03-24T11:52:14.280-08:00</date-created> </row> <row transaction-id="5335144"...

  • Page 193: Report-Bulk-Users

    </report-bulk-slide-views> report-bulk-users Description Container tag; contains data about all the users in an account. Attributes None. Contained tags Returned by report-bulk-users Example <report-bulk-users> <row principal-id="181231"> <login>nson@macromedia.com</login> <name>Nathan Son</name> <email>nson@macromedia.com</email> <manager>abenedict@macromedia.com</manager> <type>user</type> </row> <row principal-id="182532"> <login>vish_laxmi@yahoo.com</login> <name>laxmi vish</name> <email>vish_laxmi@yahoo.com</email> <type>user</type> </row>...

  • Page 194: Report-Course-Status

    report-course-status Description Container tag; contains information about the status of a course. Attributes The total number of courses completed. total-course-completions The total number of unique courses completed. total-unique-course-completions The number of courses passed. num-passed The number of courses failed. num-failed The number of enrollees in a course.

  • Page 195: Report-Meeting-Attendance

    Attributes None. Contained tags Returned by report-meeting-attendance Example <report-meeting-attendance> <row transcript-id="18308" sco-id="18302" principal-id="10021" answered- survey="0"> <login>bcassaly@macromedia.com</login> <session-name>Bart Cassaly</session-name> <sco-name>8th Meeting</sco-name> <date-created>2005-03-15T10:11:00.700-08:00</date-created> <date-closed>2005-03-15T10:13:12.810-08:00</date-closed> <participant-name>Bart Cassaly</participant-name> </row> </report-meeting-attendance> report-meeting-concurrent-users Description The maximum number of users who participated simultaneously in the specified meeting.

  • Page 196: Report-Meeting-Session

    Example <results> <status code="ok" /> <report-meeting-concurrent-users max-users="2" max-participants-freq="5" /> report-meeting-session Description Container tag, contains information about a meeting. Attributes The number of participants who entered the meeting as guests rather than num-guests registered attendees. The total number of participants in the meeting. num-participants The ID of the parent meeting.

  • Page 197: Report-Meeting-Session-Slots

    Returned by report-meeting-sessions Example <report-meeting-sessions> <row sco-id="622852" num-participants="1" num-guests="0" num-polls="0"> <name>My Meeting</name> <date-begin>2004-03-05T10:33:09.030-08:00</date-begin> </row> </report-meeting-sessions> report-meeting-session-slots Description Container tag; contains one or more tags, each containing information about a particular session slot. Attributes None. Contained tags Returned by report-meeting-session-slots Example <report-meeting-session-slots>...

  • Page 198: Report-Principal-List

    Container tag; contains information about the principals. Attributes None. Contained tags Returned by report-principal-list Example <report-principal-list> <row principal-id="8" type="user" has-children="false" is-primary="false"> <name>Enterprise Administrator</name> <login>lraj@macromedia.com</login> <custom0 /> <custom1 /> </row> <row principal-id="17" type="admins" has-children="true" is-primary="true"> <name>Account Administrators</name> <login>Account Administrators</login> <custom0 /> <custom1 /> </row>...

  • Page 199: Report-Quiz-Answer-Distribution

    <custom1>100-07-7777</custom1> </row> </report-principal-list> report-quiz-answer-distribution Description Container tag; contains one or more tags, each indicating how many users selected each answer to the specified quiz question. Attributes None. Contained tags Returned by report-quiz-answer-distribution Example <report-quiz-answer-distribution> <row question-number="1" question-id="257" a1="0" a2="0" a3="5" a4="3" total="8">...

  • Page 200: Report-Quiz-Question-Answer-Distribution

    Returned by report-quiz-interactions Example <report-quiz-interactions> <row display-seq="1" transcript-id="17452" interaction-id="17442" sco- id="17438" score="10"> <name>Barry Cassidy</name> <sco-name>All Question Types Quiz</sco-name> <date-created>2005-03-11T12:04:29.200-08:00</date-created> <description>A human being usually has <1> fingers.</description> <response>10</response> </row> </report-quiz-interactions> report-quiz-question-answer-distribution Description Container tag; contains one or more tags, each indicating how many users selected a particular answer to a particular quiz question.

  • Page 201: Report-Quiz-Question-Distribution

    percentage-responded="40"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-262</answer-text> </row> </report-quiz-question-answer-distribution> report-quiz-question-distribution Description Container tag; contains one or more tags, each indicating how many users answered a question in the specified quiz correctly. Attributes None. Contained tags Returned by report-quiz-question-distribution Example <report-quiz-question-distribution> <row question-id="257"...

  • Page 202: Report-Quiz-Question-Totals

    Returned by report-quiz-question-response Example <report-quiz-question-response> <row principal-id="10021" interaction-id="17807"> <user-name>Barry Cassidy</user-name> <response>D</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17809"> <user-name>Barry Cassidy</user-name> <response>0</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17810"> <user-name>Barry Cassidy</user-name> <response>2</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17811"> <user-name>Barry Cassidy</user-name> <response>C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17812"> <user-name>Barry Cassidy</user-name>...

  • Page 203: Report-Quiz-Results

    Contained tags None (empty tag). Returned by report-quiz-question-totals Example <report-quiz-question-totals question-id="260" total-responses="8" num-correct-answers="5" /> report-quiz-results Description The number of users who took a specified quiz and their range of scores. Attributes The average of the scores of the users who took the quiz. average-score The highest score.

  • Page 204: Report-Quiz-Takers

    Example <report-quiz-takers> <row transcript-id="17466" sco-id="17438" principal-id="10021" status="user- failed" score="0" attempts="2" time-taken="152000" certificate="" answered- survey="1"> <name>All Question Types Quiz</name> <login>bcassaly@macromedia.com</login> <date-created>2005-03-11T12:07:04.890-08:00</date-created> <principal-name>Bart Cassaly</principal-name> </row> <row transcript-id="17619" sco-id="17438" principal-id="11211" status="user- passed" score="60" attempts="1" time-taken="89360" certificate="17619" answered-survey="1"> <name>All Question Types Quiz</name>...

  • Page 205: Report-Quotas

    report-quotas Description Container tag; contains information about the account quotas. Attributes None. Contained tags quota Returned by report-quotas Example <report-quotas> <quota acl-id="181224" quota-id="2" used="6545516" limit="unlimited" soft- limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="download-quota" used="0" limit="unlimited" soft-limit="1000000000"> <date-begin>2004-03-24T13:13:18.467-08:00</date-begin> <date-end>2999-12-31T16:00:00.077-08:00</date-end> </quota> <quota acl-id="181224" quota-id="user-quota" used="6545516" limit="unlimited"...

  • Page 206: Report-Sco-Views

    Returned by report-sco-slides Example <report-sco-slides> <row slide="1" views="5"> <date-created>2004-01-13T16:35:39.517-08:00</date-created> </row> <row slide="2" views="8"> <date-created>2004-01-13T16:35:42.350-08:00</date-created> </row> <row slide="3" views="7"> <date-created>2004-01-13T16:35:44.933-08:00</date-created> </row> </report-sco-slides> report-sco-views Description Container tag; contains one or more tags, each indicating how many times and how recently the specified presentation has been viewed. Attributes None.

  • Page 207: Report-Training-Concurrent-Users

    Contained tags Returned by report-survey-question-response Example <report-survey-question-response> <row principal-id="8" question-number="1"> <user-name>Enterprise Administrator</user-name> <question>how are you?</question> <response>fine</response> </row> <row principal-id="123" question-number="1"> <user-name>test1 laxmi</user-name> <question>how are you?</question> <response>ok</response> </row> </report-survey-question-response> report-training-concurrent-users Description Indicates the largest number of users who have used the system at the same time. Attributes The ID of the current account.

  • Page 208: Response

    response Description A user’s response to a survey question. Attributes None. Contained tags None (content only). Returned by report-survey-question-response Example <response>fine</response> results Description Container tag; contains all results returned by any API. Attributes None. Contained tags Any. Returned by All APIs. Example <results>...

  • Page 209: Sco

    Contained tags The tags contained in the tag vary widely depending on which API the tag is responding to and may include custom tags. Returned by report-bulk-consolidated-transactions report-bulk-content-quiz report-bulk- content-quiz-results report-bulk-content-slide-views report-bulk-course-quiz report-bulk-course-results report-bulk-meeting report-bulk-meeting-attendance report-bulk-objects report-bulk-questions report-bulk-slide-views report-bulk- users report-course-takers report-meeting-attendance report-meeting-session-...

  • Page 210: Sco-Author

    <date-end>2003-07-10T13:05:42.180+00:00</date-end> <date-modified>2003-06-30T19:33:38.317+00:00</date-modified> <name>another - 06/30/2003 12:33 PM</name> <url-path>/p62559548/</url-path> </sco> The following example is returned by the API: report-active-meetings <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path> <date-created>2005-02-28T16:09:28.510-08:00</date-created> </sco> sco-author Description Container tag; contains information about the author of a SCO. Attributes None.

  • Page 211: Sco-Name

    The number of slides in the SCO. A value of -1 indicates that the slide count slide-count doesn’t apply; for example, if the SCO is a meeting rather than a presentation, the slide count is The version number of the SCO. version The width of the SCO, in pixels.

  • Page 212: Sco-Search-Info

    Returned by sco-nav Example <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>User Meetings</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>tennant@example.com</name> </sco> </sco-nav> sco-search-info Description Container tag; contains one or more tags, each containing information about a SCO that matches the specified search text. Attributes None.

  • Page 213: Scos

    scos Description Container tag; contains one or more tags, each containing information about a SCO inside the specified folder. Attributes None. Contained tags Returned by sco-contents Example <scos> <sco sco-id="505677" status="no-content" type="folder" is-folder="1"> <name>PPT meeting tests</name> <date-modified>2004-01-29T06:22:49.157-08:00</date-modified> </sco> <sco sco-id="193496" status="active" type="meeting" is-folder="0"> <name>My Name</name>...

  • Page 214: Source-Sco

    Example <shortcuts> <sco tree-id="181230" sco-id="181576" type="my-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181227" sco-id="181412" type="my-content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> [Other sco tags here.] <sco tree-id="181230" sco-id="181230" type="user-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> </shortcuts> source-sco Description Container tag; contains information about the SCO for the content of a course. Attributes None.

  • Page 215: Status

    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 The status of the API. The following values are possible for this attribute: code Value Description...

  • Page 216: Time-Slot-Begin

    Contained tags invalid Returned by All APIs. Example <status code="ok" /> 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 <time-slot-begin>2004-02-14T06:50:00.000-08:00</time-slot-begin> time-slot-end Description The end date and time for a meeting session, in ISO 8601 date format.

  • Page 217: Time-Taken

    time-taken Description The time a course was taken. Attributes None. Contained tags None (content only). Returned by report-bulk-course-results Example <time-taken>00:34:23.011</time-taken> Description A URL. Attributes None. Contained tags None (content only). Returned by common-info report-my-courses Example <url>/api/xml?action=common-info</url> url-path Description The path on the Breeze server to the specified SCO. Attributes None.

  • Page 218: User (Common-Info)

    Example <url-path>/r99718924/<url-path> user (common-info) Description Container tag; contains information about a user. Attributes The ID of the user. user-id Contained tags login name Returned by common-info Example <user user-id="503562"> <name>Greg Erweck</name> <login>gerweck@example.com</login> </user> user (user-accounts) Description Container tag; contains information about a user and an account. Attributes The ID of the user.

  • Page 219: User-Agent

    user-agent Description The host browser information. Attributes None. Contained tags None. Returned by common-info Example <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> user-first-name Description A user’s first name. Attributes None. Contained tags None. Returned by report-bulk-content-slide-views Example <user-first-name>Enterprise</user-first-name>...

  • Page 220: User-Login

    Example <user-last-name>Administrator</user-last-name> user-login Description The login of a user. Attributes None. Contained tags None. Returned by report-bulk-content-quiz-results Example <user-login>lraj@macromedia.com</user-login> user-name Description A user name. Attributes None. Contained tags None (content only). Returned by report-survey-question-response Example <user-name>Enterprise Administrator</user-name> Chapter 5: XML Results Reference...

  • Page 221: Users

    users Description Container tag; contains one or more tags, each containing information about a user and an user account. Attributes None. Contained tags user (user-accounts) Returned by user-accounts Example <users> <user user-id="211729" account-id="211655"> <name>james@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="212988" account-id="212928"> <name>smith@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired>...

  • Page 222: Version

    version Description The Breeze version number. Attributes None. Contained tags None (content only). Returned by common-info Example <version>breeze_402_r116</version> 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 <view-date-time>2004-06-30T11:46:12.500-07:00</view-date-time> Chapter 5: XML Results Reference...

  • Page 223: Index

    INDEX custom-field-update 60 custom-fields 61 access control lists (ACLs) 18 custom-fields-delete 62 access keys defined 9 acquiring 51 group-membership-update 31, 63 special 146, 148 learning-path-info 33, 63 access-key tag 146 learning-path-update 33, 65 access-key-group tag 147 login 33, 66 access-keys tag 148 logout 68 accesskey-exec action 50 names 150...
  • Page 224 report-disk-usage 96 answers to quiz questions report-meeting-attendance 97 answered correctly 112 report-meeting-concurrent-users 98 distribution 111 report-meeting-session 98 interactions 110 report-meeting-session-slots 100 text of 152 report-meeting-sessions 99 See also quizzes report-meeting-summary 101 API entry, sample 41 report-my-courses 31, 37, 101 APIs. See actions report-my-events 31 architecture overview 13 report-my-meetings 31, 37, 103, 104...
  • Page 225 code samples date-closed tag 156 overview 27 date-created tag 157 parsing returned XML code 34 date-end tag 157 use of CFML 15 date-expired tag 158 ColdFusion Markup Language. See CFML date-last-taken tag 158 comma-separated values (CSV) 39 date-modified tag 158 comment tag 152 date-taken tag 159 common tag 153...
  • Page 226 my-content 37 permissions 19 last-name tag 166 relevant to current user 130 last-viewed tag 167 See also SCOs last-viewed-date tag 167 launching content 19 LDAP 33 generate reports 39 learning paths, creating and managing 33 GET and POST requests (HTTP) 15, 34 learning-path tag 167 group-id parameters 17 learning-path-info action 63...
  • Page 227 scheduled 103, 104 permissions schedules for meetings 98 about 18 sessions 99 assigning 131 See also SCOs See also SCOs meetings, attendance permissions tag 173 attendees in ten-minute period 100 permissions-info action 68 list of users 97 permissions-reset action 70 maximum 98 permissions-update action 70 number of attendees 98...
  • Page 228 report-bulk-course-results action 86 report-bulk-meeting action 87 query strings, building 15 report-bulk-meeting tag 189 question tag 180 report-bulk-meeting-attendance action 88 question-text tag 180 report-bulk-meeting-attendance tag 190 questions in quizzes report-bulk-objects action 89 IDs, determining 113 report-bulk-objects tag 190 listing 108 report-bulk-questions action 90 See also quizzes report-bulk-questions tag 191 quiz-definition-answers tag 181...
  • Page 229 report-quiz-summary tag 203 sco-search action 128 report-quiz-takers action 39, 116 sco-search-info tag 212 report-quiz-takers tag 204 sco-shortcuts action 37, 130 report-quotas action 117 sco-update action 131 report-quotas tag 205 sco-upload action 135 report-sco-slides action 118 scores on quizzes 110 report-sco-slides tag 205 SCOs report-sco-views action 119 about 17...
  • Page 230 status codes field 163 invalid 165 file 163 overview 215 files 164 XML results 29 first-name 164 status tag 34, 139, 215 hit 165 students, enrolled in course 95 host 165 students, listing 95 invalid 165 subfolders, listing 122 last-name 166 summaries of quiz results 115 last-viewed 167 synchronizing with directory services 33...
  • Page 231 report-bulk-users 193 value 221 report-course-status 194 version 222 report-disk-usage 194 view-date-time 222 report-meeting-attendance 195 tasks, common 27 report-meeting-concurrent-users 195 text, finding in SCOs 50, 128 report-meeting-session 196 time, formatting 11 report-meeting-session-slots 197 time-slot-begin tag 216 report-meeting-sessions 196 time-slot-end tag 216 report-meeting-summary 197 transaction 80 report-principal-list 198...
  • Page 232 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 value tag 221 verifying identity 66 version number, Breeze 222...

Table of Contents