Page 1 Using the Breeze XML Web Services...
Page 2 If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites.
Page 3: Table Of Contents
CONTENTS INTRODUCTION: Before You Begin ........9 Audience .
Page 4 common-info ........... . 47 custom-field-update.
Page 5 report-survey-question-response ........94 report-training-concurrent-users .
Page 6 expired ............132 field.
Page 7 report-principal-list ..........161 report-quiz-answer-distribution .
Page 8 Contents...
Page 9: Introduction Before You Begin
Macromedia ColdFusion Markup Language (CFML). Guide to instructional media Macromedia Breeze contains a variety of media to help you quickly learn how to use the product. In addition to this book, the following electronic manuals and online help systems are available: •...
Page 10: Additional Resources
Meeting > Help. • Using the Macromedia Breeze Plug-In for Microsoft PowerPoint describes use of the plug-in that allows users to create Breeze presentations from PowerPoint. You can access Using the Breeze Plug-In for PowerPoint from the Breeze Manager Home page and from the Breeze menu in PowerPoint by selecting Breeze >...
Page 11: Typographical Conventions
Typographical conventions The following typographical conventions are used in this book: • Italic font indicates a value that should be replaced (for example, in a folder path). • indicates code. It also indicates names of actions, names of parameters, names of Code font tags, and names of attributes.
Page 12 Introduction: Before You Begin...
Page 13: Chapter 1: Architecture Overview
CHAPTER 1 Architecture Overview The Macromedia Breeze XML 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 actions on the server and to receive results formatted as XML code.
Page 14: Data Flow
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 Action On The Server
Note: The example code in this book uses the query parameters approach, both for readability and because of limitations in using CFML to send XML objects containing parameter data. Macromedia recommends using the method when possible; because of the way HTTP implements...
Page 16: About Principals, Scos, And Ids
For some actions, you can provide multiple parameters with the same name. For example, the action takes a parameter named ; you can specify multiple principals-delete principal-id name-value pairs (each with the name ) when you call the action principal-id principal-id on the Breeze server.
Page 17: About Security
. Access keys are case-sensitive. To locate your access key, see “Access accesskey keys for Macromedia Breeze hosted (ASP) customers” on page 18 “Access keys for Macromedia Breeze Enterprise (licensed) customers” on page To call most actions, you must be acting as a particular logged-in user, so you must call the login action before you can perform most other actions.
Page 18 Breeze 4.1 is not harmful, it is ignored. accesskey By default, your account is not enabled for XML web services. You must contact Macromedia technical support to obtain a valid XML access key to use with each action.
Page 19 To find out what permissions a logged-in user has for a particular item, call the action. To change a principal’s permissions, call the permissions-info principal-update action. If a particular principal has no explicitly specified permissions on a particular SCO, that principal’s permissions on the SCO’s parent apply.
Page 20 About public access permissions There is a special principal ID which, instead of being a number, has the value "public- . This ID sets the default access setting for everyone, whether they are logged in or not. access" You can assign any of the following permissions on a SCO for the public-access principal: Nobody can view, access, or manage the SCO.
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 the data your users see matches exactly what they are looking for.
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 you are 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
Filter reference Filters are comprised of a type (either ) with an optional modifier, the name of the filter sort field, if needed, and finally, the value of the field name, as shown in the following example: Type-Modifier-FieldName=Value The following table lists all the filter types and modifiers you can use with Breeze: Type Modifier Description...
Page 25: Where To Go From Here
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 the article, you learn how to use filters with Breeze web services by working through a simple example that retrieves the list of enrolled courses for a user and allows the user to search and sort the list.
Page 26 Chapter 2: Working with Filters...
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 actions on the Breeze server and then parse the XML tags that the server returns.
Page 28: Integrating Breeze With A Directory Service
For information about where to locate your access key, see “Access keys for Macromedia Breeze hosted (ASP) customers” on page 18 “Access keys for Macromedia Breeze Enterprise (licensed) customers” on page To call a Breeze action in a browser: Open a browser.
Page 29 To synchronize Breeze with the directory service: Log in by calling the action on the Breeze server, specifying the login name and password login of an account administrator. Examine the returned HTTP headers to find the value of the BREEZESESSION cookie, which you need when calling subsequent actions. Note: Consider creating an administrative user specifically for performing synchronizations.
Page 30 Request a list of Breeze users from the Breeze server by calling the action. principal-list The server returns a complete list of all principals, including principals that aren’t users. (For information about principals, see “About principals, SCOs, and IDs” on page 16.) The following code calls the action.
Page 31 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 action, setting the parameter equal to...
Page 32: 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 action in steps 2 through 4 and search principal-list for the ID associated with the user’s login. Obtain the user’s old first name and last name by calling the action.
Page 33 To determine a user’s ID, given their login name and password: Log in as the user. Call the action. common-info Parse the returned XML to find the value of the attribute of the tag. That value user-id user is the user’s ID. To check whether an entered password is correct: Log in as the user.
Page 34 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 action, using the folder’s SCO ID. sco-contents The following action provides a list of the contents of the specified folder: <cfhttp url="#baseurl#api/xml? action=sco-contents&accesskey=#accesskey# &sco-id=#contentSco#"...
Page 35: Generating Reports
To create a new meeting: Log in as the user. (Optional) Let the user determine the ID of the folder in which to create the new meeting, using a web-based interface. If you don’t specify a folder, the meeting is created in the my-meetings folder.
Page 36 Chapter 3: Common Tasks...
Page 37: Chapter 4: Action Reference
CHAPTER 4 Action Reference This chapter provides reference material for each action that is exposed in the Macromedia Breeze XML API, including information about the parameters that you can pass with each action. This chapter lists the actions in alphabetical order.
Page 38 Action Description Updates the specified account custom field. Creates a new custom-field-update one if none exists. Lists the custom fields of an account and the details of the custom-fields fields. Deletes the specified account custom field. custom-fields-delete Adds one or more principals to a group, or removes one or group-membership-update more principals from a group.
Page 39 Action Description Returns meeting attendance data. report-bulk-meeting-attendance Returns course status for either a principal or a SCO, based report-course-status on the parameters passed in. Provides a list of the users enrolled in the specified course. report-course-takers Provides information about how much hard disk space the report-disk-usage Breeze content for the current account uses, in bytes.
Page 40 Action Description Provides information about everyone who has taken a report-quiz-takers particular quiz. Returns information on the account quotas. report-quotas Indicates how many times, and how recently, each slide in a report-sco-slides presentation has been viewed. Indicates how many times, and how recently, the specified report-sco-views presentation has been viewed.
Page 41: Action Reference Entries
Action reference entries The following section lists the Breeze web service actions alphabetically. accesskey-exec Description Executes special functions associated with special access keys. Currently, letting users self-register for meetings and courses is the only supported special function. The documentation for this action covers only the self-registration function. To call this , you need the normal access key for the account and a special access accesskey-exec...
Page 42: Accesskey-Info
Returned elements None. Sample results <results> <status code="ok" /> </results> accesskey-info Description Provides a special access key, if such a key is associated with the specified SCO. For more information, see the action. Action Reference To find out which group the user will automatically join by self-registering using the special access key, look in the XML element.
Page 43: Acl-Preference-Update
The following sample results are returned when a group exists and includes an accesskey-group element: <results> <status code="ok" /> <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> <access-key acl-id="126" action="action-self-reg-course" parent-acl- id="630"> <access-key>2cw6np2kx2dtdop2</access-key> <date-created>2004-07-07T12:27:04.590-07:00</date-created> </access-key> </access-keys> </results> acl-preference-update Description Updates the user profile to the specified language and time zone settings.
Page 44 Time zone setting Parameter value (GMT-08:00) Pacific Time (US and Canada); Tijuana (GMT-07:00) Mountain Time (US and Canada) (GMT-07:00) Chihuahua, La Paz, Mazatlan (GMT-07:00) Arizona (GMT-06:00) Central Time (US and Canada) (GMT-06:00) Saskatchewan (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...
Page 45 Time zone setting Parameter value (GMT+02:00) Harare, Pretoria (GMT+03:00) Moscow, St. Petersburg, Volgograd (GMT+03:00) Kuwait, Riyadh (GMT+03:00) Nairobi (GMT+03:00) Baghdad (GMT+03:30) Tehran (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...
Page 46: Action-List
Time zone setting Parameter value (GMT+10:00) Guam, Port Moresby (GMT+11:00) Magadan, Solomon Islands, New Caledonia (GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) Auckland, Wellington (GMT+13:00) Nuku’alofa Filters Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </results>...
Page 47: Common-Info
<action>user-update-pwd</action> </actions> </results> common-info 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 might be different. user account-id Parameters The access key for your account.
Page 48: Custom-Fields
The ID of the field to be updated (can be obtained by calling action field-id custom- ). This parameter needs to be specified only when updating an existing field. fields The name of the custom field (may be 1 to 60 characters long). name Any comments on the custom field (may be 0 to 60 characters long).
Page 49: Custom-Fields-Delete
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" /> <custom-fields>...
Page 50: Group-Membership-Update
group-membership-update 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” on page is-member Parameters The access key for your account.
Page 51 URL loginUrl = new URL(baseUrl + "api/xml?accesskey=" + accessKey + "&action=login&login=" + login + "&password=" + password); URLConnection conn=loginUrl.openConnection(); conn.connect(); InputStream resultStream=conn.getInputStream(); Document doc=new SAXBuilder(false).build(resultStream); String cookieString=(String) (conn.getHeaderField("Set-Cookie")); StringTokenizer st=new StringTokenizer(cookieString, "="); if (st.countTokens() > 1 && st.nextToken().equals("BREEZESESSION")) { String cookieNext= st.nextToken(); int semiIndex= cookieNext.indexOf(';');...
Page 52: Logout
logout Description Logs out a user, invalidating the cookie that the application received when the user logged in. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 53 Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort is-primary Filter and sort Filter and sort type Filter and sort has-children Filter and sort permission-id name Filter and sort Filter and sort login Filter and sort description...
Page 54: Permissions-Reset
permissions-reset Description Resets all principals’ permissions for the specified SCO, so the permissions of the SCO’s parent apply to all principals. For information on permissions, see “About permissions” on page Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0;...
Page 55: Principal-Info
Returned elements None. Sample results <results> <status code="ok" /> </results> principal-info Description Provides information about the specified principal. The specified principal can be a user or a group. To determine the ID to use as the parameter, call the action principal-id principal-list (possibly with a filter to limit the returned data) to return an ID for the principal.
Page 56: Principal-List
</principal> </results> When the attribute of the element is , additional data about the user type principal user contact information, user profile, and custom fields for the user is returned, as shown in the following XML data: <results> <status code="ok" /> <contact contact-id="654">...
Page 57: Principal-Update
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>lnagaraj@macromedia.com</login> <email>lnagaraj@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> </principal-list>...
Page 58 To specify custom field values when creating or updating a user, pass the custom field values as name, value pairs, as shown in the following example: field-id=xx&value=xxx&field-id=xx&value=xxx You can determine the values from the data returned by the action. field-id custom-fields Parameters The access key for your account.
Page 59: Principals-Delete
See also principal-info principal-update principals-delete principals-delete Description Deletes one or more principals. To delete multiple principals, specify multiple parameters. For more information, principal-id “About parameters” on page Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 60 Filter and sort participant-name 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>lnagaraj@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"...
Page 61: Report-Active-Meeting-Presenters
report-active-meeting-presenters Description Provides a list of the users who are currently presenting meetings. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 62: Report-Bandwidth
Returned elements report-active-meetings Sample results <results> <status code="ok" /> <report-active-meetings> <sco sco-id="196311" active-participants="1" length-minutes="60"> <name>QT load</name> <date-begin>2003-09-02T14:00:58.330-07:00</date-begin> </sco> <sco sco-id="184847" active-participants="5" length-minutes="30"> <name>Take 2</name> <date-begin>2003-09-02T14:45:25.273-07:00</date-begin> </sco> </report-active-meetings> </results> report-bandwidth Description Indicates the total bandwidth consumed in the current account since the account was created, in bytes.
Page 63: Report-Bulk-Content-Quiz
report-bulk-content-quiz Description Returns information about all content quizzes, including a list of quizzes, and the questions and answers for each quiz. The information returned is similar to the “Content quiz Information” download report, except that XML data is returned instead of CSV formatted data. Parameters The access key for the account.
Page 64: Report-Bulk-Content-Quiz-Results
Filter only user-login Filter only date-time-attempted 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>lnagaraj@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"> Chapter 4: Action Reference...
Page 65: Report-Bulk-Content-Slide-Views
<user-login>lnagaraj@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> </report-bulk-content-quiz-results> </results> report-bulk-content-slide-views Description Returns slide view data for content. This is similar to the “Content Slide Views” download report, except that the action returns XML data and the report returns CSV data. Parameters The access key for the account.
Page 66: Report-Bulk-Course-Quiz
<row session-id="10000022" viewing-session="32" presentation-id="27" slide-number="2"> <user-login>lnagaraj@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> </results> report-bulk-course-quiz 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 action returns XML data and the report contains downloadable CSV data.
Page 67: Report-Bulk-Course-Results
Sort user-login Sort date-time-attempted Sort time-taken 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>lnagaraj@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>lnagaraj@macromedia.com</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time- attempted> report-bulk-course-results...
Page 68: Report-Bulk-Meeting
<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 time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center.
Page 69: Report-Bulk-Meeting-Attendance
report-bulk-meeting-attendance Description Returns meeting attendance data. The results are similar to the “Meeting Attendance” report, except that the action returns XML data and the report returns downloadable CSV data. Parameters The access key for the account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 70: Report-Course-Status
report-course-status Description Returns course status for either a principal or a SCO, based on the parameters passed in. Parameters The access key for the account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 71: Report-Course-Takers
report-course-takers Description Provides a list of the users enrolled in the specified course. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 72: Report-Disk-Usage
Sample results <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="" sco-id="" principal-id="8" status="" score="" percentage-score="" time-taken="" certificate="" answered-survey="0"> <login>lnagaraj@macromedia.com</login> <principal-name>Enterprise Administrator</principal-name> <custom0 /> </row> <row transcript-id="" sco-id="" principal-id="123" status="" score="" percentage-score="" time-taken="" certificate="" answered-survey="0"> <login>test1-laxmi@test.enang.com</login> <principal-name>test1 laxmi</principal-name> <custom0>408-123-1234</custom0> </row> <row transcript-id="634" sco-id="126" principal-id="632"...
Page 73: Report-Meeting-Attendance
report-meeting-attendance Description Provides a list of users who have attended the specified meeting. If the meeting hasn’t started, the returned data contains no rows. The data does not include users who were invited but did not attend the meeting. Parameters The access key for your account.
Page 74: Report-Meeting-Concurrent-Users
Sample results <results> <status code="ok" /> <report-meeting-attendance> <row transcript-id="682" sco-id="679" principal-id="8" contact-id="3" answered-survey="0"> <login>lnagaraj@macromedia.com</login> <session-name>Enterprise Administrator</session-name> <sco-name>test-mtg-2</sco-name> <date-created>2004-07-09T14:29:49.217-07:00</date-created> <date-closed>2004-07-09T14:33:45.827-07:00</date-closed> <participant-name>Enterprise Administrator</participant-name> </row> <row transcript-id="689" sco-id="679" principal-id="8" contact-id="3" answered-survey="0"> <login>lnagaraj@macromedia.com</login> <session-name>Enterprise Administrator</session-name> <sco-name>test-mtg-2</sco-name> <date-created>2004-07-09T14:35:59.170-07:00</date-created> <date-closed>2004-07-09T15:03:05.263-07:00</date-closed> <participant-name>Enterprise Administrator</participant-name> </row> </report-meeting-attendance> </results> report-meeting-concurrent-users...
Page 75: Report-Meeting-Session
report-meeting-session Description Provides information about a specific meeting session, such as the session name, session start and end times, and the number of participants and guests who attended the session. Each time someone enters an otherwise empty meeting, a new session starts. The session ends when all attendees leave the meeting.
Page 76: Report-Meeting-Session-Slots
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Filter and sort Sort num-participants Sort num-guests Sort num-polls name Filter and sort Filter and sort date-begin Filter and sort date-end For more information about filtering and sorting, see Chapter 2, “Working with Filters,”...
Page 77: Report-Meeting-Summary
Filters Results cannot be sorted or filtered. The default sort is by the time slot start time. Returned elements report-meeting-session-slots Sample results <results> <status code="ok" /> <report-meeting-session-slots> <row num-attendees="0"> <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>...
Page 78: Report-My-Courses
report-my-courses Description Provides information about each course that the logged-in user is enrolled in. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 79: Report-My-Meetings
<date-begin>2004-02-16T21:00:00.000-08:00</date-begin> <url-path>/p81997938/</url-path> <expired>false</expired> </course> </my-courses> </results> report-my-meetings Description Provides information about each meeting the logged-in user is scheduled to attend. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 80: Report-Principal-List
<date-begin>2003-07-14T23:00:00.000-07:00</date-begin> <date-end>2003-07-15T09:00:00.000-07:00</date-end> <expired>true</expired> </meeting> <meeting sco-id="505659" type="meeting" status="active" permission-id="presenter" active-participants="0"> <name>new skipper</name> <domain-name>admin.breeze.example.com</domain-name> <url-path>/p50473388/</url-path> <date-begin>2004-01-29T05:30:00.000-08:00</date-begin> <date-end>2004-01-29T05:30:00.000-08:00</date-end> <expired>true</expired> </meeting> </my-meetings> </results> report-principal-list Description Returns the list of all principals in the account. Similar to the action but principal-list returns additional user custom field information. This is the only report where you can filter users on the account custom fields.
Page 81: Report-Quiz-Answer-Distribution
Sample results <results> <status code="ok" /> <report-principal-list> <row principal-id="8" type="user" has-children="false" is- primary="false"> <name>Enterprise Administrator</name> <login>lnagaraj@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">...
Page 82: Report-Quiz-Definition-Answers
Returned elements report-quiz-answer-distribution 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>...
Page 83: 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 84: Report-Quiz-Interactions
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-number Filter and sort Filter and sort question-id Filter and sort score Filter and sort chapter-id body Filter and sort Filter and sort date-modified For more information about filtering and sorting, see Chapter 2, “Working with Filters,”...
Page 85 Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored. The ID of a presentation that contains a quiz. sco-id Filters The following table lists the fields that the data can be filtered and sorted on:...
Page 86: Report-Quiz-Question-Answer-Distribution
<date-created>2004-07-13T10:55:28.763-07:00</date-created> <question>Who is Allan Iverson ?</question> </row> </report-quiz-interactions> </results> report-quiz-question-answer-distribution Description Indicates how many users selected a particular answer to a specified quiz question. report-quiz-definition-answers report-quiz-definition-questions determine the ID of a question (to specify as the parameter). question-id Note: Question IDs do not necessarily correspond to question numbers given in a quiz. Parameters The access key for your account.
Page 87: Report-Quiz-Question-Distribution
<answer-text>ISO-9000</answer-text> </row> <row question-id="259" answer-id="2" correct="0" total-responses="3" percentage-responded="30"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>RFC 821</answer-text> </row> <row question-id="259" answer-id="3" correct="0" total-responses="2" percentage-responded="20"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-976</answer-text> </row> <row question-id="259" answer-id="4" correct="1" total-responses="4" percentage-responded="40"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-262</answer-text>...
Page 88: 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 question-id="257" question-number="1" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> <body>What is 2+2?</body> </row> <row question-id="258" question-number="2" num-correct="8" num-incorrect="0"...
Page 89: Report-Quiz-Question-Totals
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="506299" question-id="257" answer-id="2"> <body>What is 2+2?</body> <answer-text>5</answer-text> </row> <row principal-id="557527" question-id="257" answer-id="2"> <body>What is 2+2?</body> <answer-text>5</answer-text>...
Page 90: Report-Quiz-Summary
Sample results <results> <status code="ok" /> <report-quiz-question-totals question-id="260" total-responses="8" num-correct-answers="5" /> </results> report-quiz-summary Description Provides information about the results of a quiz. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 91 For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-quiz-takers Sample results <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="730" sco-id="727" principal-id="8" contact-id="3" status="user-passed" score="10" percentage-score="50" time-taken="70076" certificate="730" answered-survey="0"> <name>quiz-course</name> <login>lnagaraj@macromedia.com</login> <date-taken>2004-07-13T10:54:09.030-07:00</date-taken> <principal-name>Enterprise Administrator</principal-name> </row> report-quiz-takers...
Page 92: Report-Quotas
<row transcript-id="731" sco-id="727" principal-id="8" contact-id="3" status="user-failed" score="0" percentage-score="0" time-taken="4656" certificate="" answered-survey="0"> <name>quiz-course</name> <login>lnagaraj@macromedia.com</login> <date-taken>2004-07-13T10:55:28.763-07:00</date-taken> <principal-name>Enterprise Administrator</principal-name> </row> <report-quiz-takers> </results> Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag,...
Page 93: Report-Sco-Slides
report-sco-slides Description Indicates how many times, and how recently, each slide in a presentation has been viewed. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 94: Report-Sco-Views
report-sco-views Description Indicates how many times, and how recently, the specified presentation has been viewed. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 95: Report-Training-Concurrent-Users
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort principal-id Sort Sort user-name Filter and sort response For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page Returned elements report-survey-question-response...
Page 96: Sco-Build
Sample results <results> <status code="ok" /> <report-training-concurrent-users account-id="181224" max-num-sessions="2" limit="1000000000"> <name>Professor Test Account</name> </report-training-concurrent-users> </results> sco-build 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 97: Sco-Contents
sco-contents 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. Parameters The access key for your account.
Page 98: Sco-Delete
<sco sco-id="193496" status="active" type="meeting" is-folder="0"> <name>My Name</name> <date-begin>2003-08-27T00:00:00.000-07:00</date-begin> <date-end>2003-08-27T01:00:00.000-07:00</date-end> <date-modified>2003-08-26T23:33:20.300-07:00</date-modified> <duration>1900-01-02T/+:00:00.000+00:00</duration> </sco> <sco sco-id="505323" status="active" type="meeting" is-folder="0"> <name>My Name 2</name> <date-begin>2004-01-29T01:30:00.000-08:00</date-begin> <date-end>2004-01-29T01:30:00.000-08:00</date-end> <date-modified>2004-01-29T01:35:26.433-08:00</date-modified> <duration>1900-01-02T/*:00:00.000+00:00</duration> </sco> </scos> </results> sco-delete Description Deletes one or more SCOs. If the specified is a folder, all the contents of the specified sco-id folder are also deleted.
Page 99: Sco-Info
sco-info Description Provides information about a SCO. For information about SCOs, see “About principals, SCOs, and IDs” on page Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored.
Page 100 <author-info-1>l</author-info-1> <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 type attribute is folder <results> <status code="ok" /> <sco folder-id="24" host-id="" lang="en" learning-time="" sco-data-id="746" sco-id="744"...
Page 101: 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 Description Moves a SCO from one folder to another. For information about rules regarding moves and their necessary permissions, see Breeze Help. Parameters The access key for your account.
Page 102: Sco-Search
Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored. The ID of a SCO. sco-id Filters Results cannot be filtered or sorted. Returned elements sco-nav Sample results...
Page 103: Sco-Shortcuts
Returned elements sco-search-info Sample results <results> <status code="ok" /> <sco-search-info> <sco sco-id="202014" folder-id="202008" type="presentation" slide-count="4" length="20000"> <name>Quiz 1</name> <url-path>/p92628681/</url-path> <date-created>2003-11-26T22:52:28.973-08:00</date-created> <date-modified>2003-11-26T22:52:37.867-08:00</date-modified> <author-info-1>lnagaraj@macromedia.com</author-info-1> <hit>1</hit> <hit>4</hit> </sco> <sco sco-id="202015" folder-id="202008" type="presentation" slide-count="7" length="35000"> <name>More broken quizzes</name> <url-path>/p49954414/</url-path> <date-created>2003-11-26T23:02:52.870-08:00</date-created> <date-modified>2003-11-26T23:03:23.313-08:00</date-modified> <author-info-1>foo-account@macromedia.com</author-info-1> <hit>1</hit> <hit>4</hit>...
Page 104: Sco-Update
Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements shortcuts Sample results...
Page 105 You must provide only one of the following two parameters: folder-id sco-id After you call this action, you must call the action to assign permissions. permissions-update For information about permissions, see “About security” on page For more information about SCOs, see “About principals, SCOs, and IDs”...
Page 106 Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you accesskey include this parameter in Breeze 4.1, it is ignored. The scheduled beginning date and time. The date format is ISO 8601. (Used only date-begin for meetings and courses.) The scheduled ending date and time.
Page 107 The following sample XML is returned when a presentation SCO is created: <results> <status code="ok" /> <sco folder-id="945" type="presentation" lang="en" sco-id="2152" status="no- content" tree-id="11" sco-data-id="2154"> <author-info-2>sw</author-info-2> <author-info-3>macr</author-info-3> <url-path>/p74161709/</url-path> <description>testXMLAPIpreso-New</description> <author-info-1>laxmi n</author-info-1> <name>testAPI-preso-New</name> </sco> </results> To update the title, summary, speaker name, title, language, and company, replace the parameter with the parameter folder-id sco-id...
Page 108: Sco-Upload
<date-end>2004-07-22T21:51:58.330-07:00</date-end> <url-path>/r54578750/</url-path> <description>testXMLAPI-mtg</description> <name>testAPI-mtg</name> </sco> </results> You can update meeting start and end times, name, and description by replacing the parameter with the parameter folder-id sco-id The following sample XML is returned when updating a meeting: <results> <status code="ok" /> </results>...
Page 109: Trees-Info
Note: Call the action sco-info to obtain the latest SCO status. The sco status will initially be in- progress, which means the content is being built. When the status becomes active, the content has finished building and is now accessible. Parameters The access key for your account.
Page 110: User-Accounts
Returned elements trees Sample results <results> <status code="ok" /> <trees> <tree account-id="7" tree-id="9" sco-id="9" type="content"> <domain-name>nagarajan.macromedia.com</domain-name> </tree> <tree account-id="7" tree-id="10" sco-id="10" type="courses"> <domain-name>nagarajan.macromedia.com</domain-name> </tree> <tree account-id="7" tree-id="11" sco-id="11" type="user-content"> <domain-name>nagarajan.macromedia.com</domain-name> </tree> <tree account-id="7" tree-id="13" sco-id="13" type="meetings"> <domain-name>nagarajan.macromedia.com</domain-name> </tree> <tree account-id="7" tree-id="14" sco-id="14" type="user-meetings">...
Page 111: User-Update-Pwd
Sample results <results> <status code="ok" /> <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> </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-update-pwd Description Changes a user’s password. Parameters The access key for your account. accesskey Note: The parameter is required only in Breeze 4.0;...
Page 112 Chapter 4: Action Reference...
Page 113: 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 action. For information about the actions you can call on the server, see Chapter 4, “Action Reference,” on page About returned XML code When you call an action on the Breeze server, the server returns a block of XML code.
Page 114: Alphabetical List Of Xml Tags
If there is no data available for a tag that would normally be returned in response to an action, 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 115 Description The date and time that a SCO was created, in ISO 8601 date date-created format. The date and time that a SCO is, or was, scheduled to end, in date-end ISO 8601 date format. The date that an account is, or was, scheduled to expire, in date-expired ISO 8601 date format.
Page 116 Description Contains information about a specific principal and its permission permissions. 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.
Page 117 Description Contains information about the status of a course. report-course-status 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.
Page 118 Description Contains one or more tags, each indicating how many report-sco-views times and how recently the specified presentation has been viewed. 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.
Page 119: Access-Key (Container)
Description Contains information about a user. user (common-info) Contains information about a user and an account. user (user-accounts) A user’s first name. user-first-name 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...
Page 120: Access-Key (Key)
access-key (key) There are two tags named ; they are described in different sections. access-key Description A special access key for use in self-registration. 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...
Page 121: Access-Keys
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> <access-key acl-id="619605" action="1" parent-acl-id="619605"> <access-key>vb7gmg6ohtz4y7k6</access-key> <date-created>2004-03-05T00:30:38.483-08:00</date-created> </access-key> </access-keys> account Description The account ID.
Page 122: Action
action Description The name of an action. Attributes None. Contained tags None (content only). Returned by action-list Example <action>user-accounts</action> actions Description Container tag; contains a list of actions. Attributes None. Contained tags action Returned by action-list Example <actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action>...
Page 123: Answer-Correct
answer-correct Description The text for a correct answer. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz Example <answer-correct>YES</answer-correct> answer-text Description The text of an answer to a quiz question as part of the results returned by a report action. Attributes None.
Page 124: Comment
Returned by report-quiz-answer-distribution report-quiz-definition-answers report-quiz-definition-questions report-quiz-question-distribution report-quiz-question-response Example <body>What is 2+2?</body> comment Description Any comments on the custom field (may be 0 to 60 characters long). Attributes None. Contained tags None (content only). Returned by custom-field-update Example <comments>any comment goes here</comments> common Description Container tag;...
Page 125: Contact
<version>breeze_402_r116</version> <account account-id="222914" /> <user user-id="503562"> <login>gerweck@example.com</login> </user> </common> contact Description Container tag; contains information about a contact. Attributes The ID of a contact. contact-id 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.
Page 126: Course
Example <cookie>breezm5qtgnye46zpckbf.MARIANNE</cookie> course Description Container tag; contains information about a course. Attributes The ID of the course. sco-id Indicates whether a course is active. The possible values are , which status "no-content" indicates that the course has just been created but has no content, and "active"...
Page 127: Date
Example <custom-fields> <field field-id="1329" custom-seq="1" account-id="7" type="optional"> <name>Department</name> <comments>this is optional</comments> </field> <field field-id="1330" custom-seq="2" account-id="7" type="required"> <name>SSN</name> </field> </custom-fields> 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...
Page 128: Date-Closed
date-closed Description The time at which the user closed the window that contains the meeting, thereby leaving the meeting, in ISO 8601date format. Attributes None. Contained tags None (content only). 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.
Page 129: Date-Expired
Returned by report-meeting-session report-my-courses report-my-meetings sco-contents Example <date-end>2004-02-09T14:30:00.000-08:00</date-end> 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.
Page 130: Date-Taken
Contained tags None (content only). 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>...
Page 131: 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 132: 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> expired Description A Boolean value that indicates whether a SCO has expired. A SCO has expired when its end date has passed, and it is no longer available. Attributes None.
Page 133: First-Name
The custom field number. custom-seq The type of the custom field. It must be one of the following values: type Value Description Required account custom field required Optional and show during self-registration optional optional-no-self-reg Optional and hide during self-registration Contained tags comment name value...
Page 134: 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 135: 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 136: 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 137: Meeting
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 138: My-Meetings
Contained tags course Returned by report-my-courses Example <my-courses> <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> </my-courses> my-meetings Description Container tag; contains information about one or more meetings. Attributes None. Contained tags meeting Returned by report-my-meetings Example <my-meetings>...
Page 139: Name
name Description A user’s name. For example, depending on the context, the tag may contain the name of a person, the name of a group, the name of a SCO, an e-mail address, or another kind of name. Attributes None. Contained tags None (content only).
Page 140: 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 action. permissions-info The ID of the principal. principal-id Contained tags None (empty tag). Returned by permissions-info Example <permission acl-id="27"...
Page 141: Physical-Path
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> preferences Description Contains information about user preferences. Attributes The ID of the user for whom the preferences are updated. acl-id The language setting.
Page 142 Time zone setting Parameter value Chihuahua, La Paz, Mazatlan (GMT-07:00) Arizona (GMT-07:00) Central Time (US and Canada) (GMT-06:00) Saskatchewan (GMT-06:00) Guadalajara, Mexico City, Monterrey (GMT-06:00) Central America (GMT-06:00) Eastern Time (US and Canada) (GMT-05:00) Indiana (East) (GMT-05:00) Bogota, Lima, Quito (GMT-05:00) Atlantic Time (Canada) (GMT-04:00)
Page 143 Time zone setting Parameter value Kuwait, Riyadh (GMT+03:00) Nairobi (GMT+03:00) Baghdad (GMT+03:00) Tehran (GMT+03:30) Abu Dhabi, Muscat (GMT+04:00) Baku, Tbilisi, Yerevan (GMT+04:00) Kabul (GMT+04:30) Ekaterinburg (GMT+05:00) Islamabad, Karachi, Tashkent (GMT+05:00) Chennai, Kolkata, Mumbai, New Delhi (GMT+05:30) Kathmandu (GMT+05:45) Astana, Dhaka (GMT+06:00) Sri Jayawardenepura (GMT+06:00)
Page 144: Presentation-Name
Time zone setting Parameter value Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) Auckland, Wellington (GMT+12:00) Nuku’alofa (GMT+13:00) Contained tags None. Returned by principal-info Example <preferences acl-id="653" lang="en" time-zone-id="4" /> presentation-name Description The name of a Breeze presentation. Attributes None. Contained tags None (content only).
Page 145: Principal-Custom-Field-Values
The permissions that the principal has for the specified SCO. This attribute is permission-id returned only by the action. permissions-info The ID of the principal. principal-id The ID for the contact information associated with the user. This value is contact-id null groups.
Page 146: Principal-List
principal-list Description Container tag; contains one or more principal tags. Attributes None. Contained tags principal Returned by principal-list Example <principal-list> <principal principal-id="222917" type="admins" has-children="true" is-primary="true" is-hidden="0"> <name>Account Administrators</name> <login>Account Administrators</login> <description>Account administrators group</description> </principal> </principal-list> principal-name Description The name of a principal. The name is presented in the standard format for the locale.
Page 147: Question
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. Contained tags None (content only). Returned by report-quiz-question-answer-distribution report-bulk-content-quiz Example...
Page 148: Quiz-Definition-Answers
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. Contained tags Returned by report-quiz-definition-answers Example <quiz-definition-answers> <row answer-id="1" question-id="257" correct="0"> <body>1</body>...
Page 149: Quiz-Name
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> <date-modified>2004-01-13T17:09:40.230-08:00</date-modified> </row> </quiz-definition-questions> quiz-name Description The name of a quiz. Attributes None. Contained tags None (content only).
Page 150: Report-Account-Meeting-Attendance
Container tag; contains rows tags that contain information about the meeting attendance log for the account. Attributes None. Contained tags Returned by report-account-meeting-attendance Example <report-account-meeting-attendance> <row account-id="7" transcript-id="670" sco-id="623" principal-id="8" contact-id="3"> <login>lnagaraj@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>...
Page 151: Report-Active-Meeting-Presenters
<date-closed>2004-07-09T14:33:43.547-07:00</date- closed> <participant-name>Enterprise Administrator</participant- name> </row> </report-account-meeting-attendance> report-active-meeting-presenters Description Container tag; contains a list of the users who are currently presenting meetings. Attributes None. Contained tags Returned by report-active-meeting-presenters Example <report-active-meeting-presenters> <sco sco-id="190298"> <name>Jack Monson</name> <date-created>2004-02-17T17:06:23.920-08:00</date-created> </sco> <sco sco-id="566058"> <name>Hans Gay</name> <date-created>2004-02-17T16:50:00.327-08:00</date-created>...
Page 152: Report-Bandwidth
<sco sco-id="196311" active-participants="1" length-minutes="241656"> <name>QT load</name> <date-begin>2003-09-02T21:41:58.330-07:00</date-begin> </sco> <sco sco-id="184847" active-participants="5" length-minutes="292290"> <name>Take 2</name> <date-begin>2003-07-29T17:48:25.273-07:00</date-begin> </sco> </report-active-meetings> report-bandwidth Description The total bandwidth consumed in the current account since the account was created, in bytes. Attributes The total amount of bandwidth, in bytes. total Contained tags None (empty tag).
Page 153: 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>lnagaraj@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>lnagaraj@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 154: 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 155: 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>lnagaraj@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>lnagaraj@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 156: 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-slide-views Description Container tag;...
Page 157: Report-Course-Status
Example <report-bulk-slide-views> <row session-id="10000022" viewing-session="32" presentation-id="27" slide- number="1"> <user-login>lnagaraj@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>lnagaraj@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> report-course-status Description Container tag; contains information about the status of a course. Attributes The total number of courses completed.
Page 158: Report-Disk-Usage
report-disk-usage Description Indicates how much hard disk space the Breeze content uses, in bytes. Includes all content and archives. Attributes The total amount of disk usage, in bytes. total Contained tags None (empty tag). Returned by report-disk-usage Example <report-disk-usage total="849327881" /> report-meeting-attendance Description Container tag;...
Page 159: Report-Meeting-Concurrent-Users
report-meeting-concurrent-users Description The maximum number of users who participated simultaneously in the specified meeting. This is different from the number of users who can participate simultaneously in a meeting because the quota may not have been reached. For example, an account may allow 125 simultaneous users for a meeting but only have 2.
Page 160: Report-Meeting-Sessions
Example <report-meeting-session session-sco-id="505267" sco-id="181576" num-participants="0" num-guests="0"> <name>MyMeeting</name> <date-begin>2004-01-29T00:30:00.000-08:00</date-begin> <date-end>2004-01-29T00:30:00.000-08:00</date-end> </report-meeting-session> report-meeting-sessions Description Container tag; contains information about all the sessions of a meeting. Attributes None. Contained tags 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>...
Page 161: Report-Meeting-Summary
Example <report-meeting-session-slots> <row num-attendees="0"> <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> </report-meeting-session-slots> report-meeting-summary Description Indicates how many users were invited to the specified meeting and how many invitees and guests actually attended. Attributes The number of participants who entered the meeting as guests rather num-guests-attended than registered attendees.
Page 162: Report-Quiz-Answer-Distribution
Example <report-principal-list> <row principal-id="8" type="user" has-children="false" is-primary="false"> <name>Enterprise Administrator</name> <login>lnagaraj@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>...
Page 163: Report-Quiz-Interactions
report-quiz-interactions Description Container tag; contains one or more tags, each containing information about an interaction a user had with the specified quiz. For more information about interactions, see the action. report-quiz-interactions Attributes None. Contained tags Returned by report-quiz-interactions Example <report-quiz-interactions> <row transcript-id="459350"...
Page 164: Report-Quiz-Question-Distribution
Example <report-quiz-question-answer-distribution> <row question-id="259" answer-id="1" correct="0" total-responses="1" percentage-responded="10"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ISO-9000</answer-text> </row> <row question-id="259" answer-id="2" correct="0" total-responses="3" percentage-responded="30"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>RFC 821</answer-text> </row> <row question-id="259" answer-id="3" correct="0" total-responses="2" percentage-responded="20"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-976</answer-text>...
Page 165: Report-Quiz-Question-Response
</row> <row question-id="259" question-number="3" num-correct="4" num-incorrect="6" percentage-correct="40" score="20"> <body>Which international standard defines ECMAScript?</body> </row> </report-quiz-question-distribution> report-quiz-question-response Description Container tag; contains one or more tags, each describing an answer that a user gave to a particular quiz question. Attributes None. Contained tags Returned by report-quiz-question-response Example...
Page 166: 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 167: Report-Quiz-Takers
Contained tags None (empty tag). Returned by report-quiz-summary Example <report-quiz-summary sco-id="217706" numquestions="5" maxpossiblescore="100" passingscore="0" /> report-quiz-takers Description Container tag; contains one or more tags, each containing information about a user who has taken the specified course or quiz. Attributes None. Contained tags Returned by report-course-takers...
Page 168: 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="7" quota-id="2" used="0" limit="unlimited" soft- limit="1000000000"> <date-begin>1999-12-31T16:00:00.000-08:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="7" quota-id="download-quota" used="0" limit="50000" soft-limit="50000"> <date-begin>1999-12-31T16:00:00.000-08:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> </report-quotas> report-sco-slides Description Container tag;...
Page 169: Report-Sco-Views
</row> <row slide="3" views="7"> <last-viewed>2004-01-13T16:35:44.933-08:00</last-viewed> </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. Contained tags Returned by report-sco-views Example <report-sco-views> <row sco-id="217706" type="presentation" is-folder="0" views="24"> <name>Quiz test 1</name>...
Page 170: Report-Training-Concurrent-Users
<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. account-id The maximum number of users who can use the system at the same time, as specified by limit your account license.
Page 171: Results
results Description Container tag; all results returned by any action are contained in a tag. results Attributes None. Contained tags Any. Returned by All actions. Example <results> <status code="ok" /> </results> Description Contains a single record of information in a report. For examples of the possible attributes and contained tags, examine the sample results provided in the documentation for the action you’re calling.
Page 172: Sco
Example <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> Description Container tag; contains information about a SCO, which is a single Breeze document. For examples of the possible attributes and contained tags, examine the sample results provided in the documentation for the action you’re calling. Attributes The attributes for the tag vary widely, depending on what action the tag is in response to.
Page 173: Sco-Data
Example <sco-author> <email>tennant@example.com</email> <first-name>Pat</first-name> <last-name>Tennant</last-name> </sco-author> sco-data Description Container tag; contains information about the underlying data file (such as the file that contains a presentation) used in a SCO. Attributes The file size of the SCO’s data file, in bytes. byte-count The height of the SCO, in pixels.
Page 174: Sco-Nav
Contained tags None (content only). Returned by report-meeting-attendance Example <sco-name>My Meeting</sco-name> sco-nav Description Container tag; contains information about the folder hierarchy that contains the specified SCO. Attributes None. Contained tags Returned by sco-nav Example <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>User Meetings</name>...
Page 175: Scos
Example <sco-search-info> <sco sco-id="202014" folder-id="202008" type="presentation" slide-count="4" length="20000"> <name>Quiz 1</name> <url-path>/p92628681/</url-path> <date-created>2003-11-26T22:52:28.973-08:00</date-created> <date-modified>2003-11-26T22:52:37.867-08:00</date-modified> <first-name>Pat</first-name> <last-name>Tennant</last-name> <hit>1</hit> <hit>4</hit> </sco> </sco-search-info> 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...
Page 176: Shortcuts
shortcuts Description Container tag; contains one or more tags, each containing information about a folder that contains content relevant to the logged-in user. For more information, see the sco-shortcuts action. Attributes None. Contained tags Returned by sco-shortcuts Example <shortcuts> <sco tree-id="181230" sco-id="181576" type="my-meetings"> <domain-name>http://admin.breeze.example.com</domain-name>...
Page 177: Status
Example <source-sco> <source-sco author-contact-id="586761" folder-id="506334" host-id="" learning-time="" sco-data-id="586762" sco-id="586760" source-sco-id="" status="active" tree-id="181225" type="presentation"> <date-created>2004-02-27T10:31:06.717-08:00</date-created> <date-modified>2004-02-27T10:52:58.217-08:00</date-modified> <description>Simple test presentation</description> <name>Math Test</name> <url-path>/p60802018/</url-path> </source-sco> </source-sco> status Description A status code returned by the Breeze server whenever an action is called. This section provides information about all the status codes and subcodes that Breeze can return.
Page 178: Time-Slot-Begin
Sometimes used to provide more detail of the status of the action. For example, subcode values are used to differentiate between different situations in which is set to subcode code . The following values are possible for this attribute: no-access Value Description account-expired...
Page 179: Time-Slot-End
time-slot-end Description The end date and time for a meeting session, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-meeting-session-slots Example <time-slot-end>2004-02-14T07:00:00.000-08:00</time-slot-end> time-taken Description The time a course was taken. Attributes None. Contained tags None (content only).
Page 180: Trees
Contained tags domain-name Returned by trees-info Example <tree account-id="7" tree-id="14" sco-id="14" type="user-meetings"> <domain-name>nagarajan.macromedia.com</domain-name> </tree> trees Description Container tag; contains the list of trees that belong to the specified account. Attributes None. Contained tags tree Returned by trees-info Example <trees> <tree account-id="7" tree-id="9" sco-id="9" type="content">...
Page 181: Url
Description A URL. Attributes None. Contained tags None (content only). Returned by common-info report-my-courses Example <url>/api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info</url> url-path Description The path on the Breeze server to the specified SCO. Attributes None. Contained tags None (content only). Returned by report-my-courses report-my-meetings sco-info sco-search Example <url-path>/r99718924/<url-path>...
Page 182: User (User-Accounts)
Example <user user-id="503562"> <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. user-id The ID of an account. account-id Contained tags date-expired name Returned by user-accounts Example <user user-id="211729" account-id="211655"> <name>james@example.com</name>...
Page 183: User-Last-Name
None (content only). Returned by report-bulk-content-slide-views 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>lnagaraj@macromedia.com</user-login> user-name Description A user name. Attributes None. Contained tags None (content only). Returned by report-survey-question-response user-name...
Page 184: Users
Example <user-name>Enterprise Administrator</user-name> 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>...
Page 185: 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> view-date-time...
Page 186 Chapter 5: XML Results Reference...
Page 187: Index
INDEX names 122 permissions-info 52 access keys permissions-reset 54 acquiring 42 permissions-update 54 Breeze Enterprise customers 18 principal-info 32, 55 hosted customers 18 principal-list 30, 56 overview 17 principal-update 31, 57 special 41, 119, 120, 121 principals-delete 31, 59 access-key tag 119, 120 reference entries 41 access-keys tag 121 report-account-meeting-attendance 59...
Page 188 report-quiz-question-totals 89 bold text convention 11 report-quiz-summary 90 Breeze report-quiz-takers 90 displaying relevant content 33 report-quotas 92 documentation 9 report-sco-slides 93 integrating with a portal 32 report-sco-views 94 interacting with the server 14 report-survey-question-response 94 users, adding 31, 41 report-training-concurrent-users 95 users, deleting 31 report-quiz-answer-distribution 81 users, updating 32...
Page 189 cookies. See BREEZESESSION cookies domain names, determining 34 course tag 126 domain-name tag 131 course-admins primary group 16 duration tag 131 courses about 16 enrolled students 71 e-mail addresses as login names 136 launching 20 email tag 132 listing 33, 35, 78 enrolled students in a course 71 See also SCOs error-checking 29...
Page 190 LDAP 28 licensed customers, access keys for 18 help systems 9 Lightweight Directory Access Protocol (LDAP) 28 hierarchies of folders 101 limits on accounts 74 hit tag 134 links, creating 34 host tag 134 listing hosted accounts, access keys for 18 accounts 110 HTTP courses 33, 78...
Page 191 multiple parameters, specifying presentations overview 15 about 16 permissions update 54 number of slides 173 principals, deleting 59 number of times viewed 93, 94 SCOs, deleting 98 searching 35 my-content folder 33 See also SCOs my-courses tag 137 presenters my-meetings tag 138 of meetings 61 permissions 19 primary groups...
Page 192 scoring 84 report-meeting-summary action 77 summaries of results 90 report-meeting-summary tag 161 users who took a quiz 90 report-my-courses action 33, 78 See also SCOs report-my-meetings action 33, 79 quota tag 149 report-principal-list action 80 report-principal-list tag 161 report-quiz-answer-distribution tag 162 report-quiz-definition-answers action 82 rebuilding SCOs 96 report-quiz-definition-questions action 83...
Page 193 results tag 113, 171 scos tag 175 returned XML elements 37, 113 searching row tag 35, 171 for content 35 SCOs 102 security overview 17 self-registering 41, 119, 120, 121 sample code 27 servers, information about 47 scenarios, common 27 session query parameter 20 scheduled meetings 79 sessions of meetings 75, 76...
Page 194 date-last-taken 129 report-meeting-session 159 date-modified 129 report-meeting-session-slots 160 date-taken 130 report-meeting-sessions 160 date-time-attempted 130 report-meeting-summary 161 description 131 report-principal-list 161 domain-name 131 report-quiz-answer-distribution 162 duration 131 report-quiz-interactions 163 email 132 report-quiz-question-answer-distribution 163 expired 132 report-quiz-question-distribution 164 field 132 report-quiz-question-response 165 first-name 133 report-quiz-question-totals 165 hit 134...
Page 195 times and dates 10 permissions 52 tree tag 179 quiz takers 90 trees 16 registering with Breeze 41 trees tag 180 updating information for 32 trees-info action 109 See also principals, groups troubleshooting 177 users tag 184 typographical conventions 11 value tag 184 updates to the documentation 9 verifying identity 50...
Page 196 Index...

This manual is also suitable for:

Breeze

MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Use Manual

INTRODUCTION before You Begin

CHAPTER 1: Architecture Overview

CHAPTER 2: Working with Filters

CHAPTER 3: Common Tasks

CHAPTER 4: Action Reference

CHAPTER 5: XML Results Reference

Index

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES

Summary of Contents for MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES