Using the Breeze XML Web Services
Trademarks ActiveEdit, ActiveTest, Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Blue Sky Software, Blue Sky, Breeze, Bright Tiger, Clustercats, ColdFusion, Contents Tab Composer, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, Help To Source, Ho
CONTENTS INTRODUCTION: Before You Begin ................................... 9 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Guide to instructional media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . .
common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-field-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 custom-fields-delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 group-membership-update . . . . .
report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 sco-delete . . . . . . . . . . . . . . . .
expired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 hit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 host . . .
report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-distribution . . . . . . . . . . . .
Contents
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 guide provides information on how to call XML web services (actions) on the Breeze server from your external system and how to interpret the XML results that Breeze returns. This guide also provides reference material explaining what each action does and what the parameters for each action are.
• Breeze Live User Guide for Meeting Presenters includes information about using the Breeze Live web application to host online real-time meetings. The documentation includes procedures that demonstrate the simplicity of adding slides, Flash SWF files, images, live audio, and video to your presentation.
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). • Code font indicates code. It also indicates names of actions, names of parameters, names of tags, and names of attributes. • Bold font indicates a verbatim entry.
Introduction: Before You Begin
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. You can use the web services to add Breeze management and reporting capabilities to your external system. Note: Breeze doesn’t currently support Simple Object Access Protocol (SOAP).
Data flow The following diagram shows an example of the flow of data in a web application that interacts with the Breeze server: Step 1: Web browser requests page. Step 2: Web server finds page and passes it to application server. Step 3: Application server executes code. Step 4: Application server calls action on Breeze server. Step 7: Web server sends finished page to requesting browser. Step 6: Application server inserts data in page and then passes the page to the web server.
Calling an action on the server To call an action on the Breeze server, pass the relevant parameters to the web services servlet at http://server_name/api/xml. In Breeze 4.0, there are two parameters that are required for all actions: the parameter named action specifies the name of the action, and the parameter named accesskey specifies the account’s access key. In Breeze 4.1, you do not need to pass the accesskey parameter. Passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored.
For some actions, you can provide multiple parameters with the same name. For example, the principals-delete action takes a parameter named principal-id; you can specify multiple principal-id name-value pairs (each with the name principal-id) when you call the action on the Breeze server. The following CFML code example shows how to delete two specified users in a single action call, by specifying two principal-id parameters.
session A session of a meeting. A session begins when someone enters an empty meeting and ends when all attendees leave the meeting. archive An archived meeting. attachment pod A file shared using the file-sharing pod within a meeting. A plug-in for a meeting. An image (such as a corporate logo) that can be attached to content such as presentations. logos Each principal and SCO has a unique ID number.
To successfully call an action, you must supply both an access key and the cookie for a logged-in user who has the permissions to call that action. If you don’t supply both credentials (for example, if you supply the cookie for a user who doesn’t have the right permissions), the action fails. Your application can log in multiple users and can call actions for any of those users.
To find out what permissions a logged-in user has for a particular item, call the permissions-info action. To change a principal’s permissions, call the 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. You can specify the following permissions on a SCO: view The principal can view the SCO but not modify it. For a course, the view permission lets the principal enroll in the course.
About public access permissions There is a special principal ID which, instead of being a number, has the value "publicaccess". This ID sets the default access setting for everyone, whether they are logged in or not. You can assign any of the following permissions on a SCO for the public-access principal: Nobody can view, access, or manage the SCO. denied view Anyone can view the SCO, even if not logged in. view-only (For presentations only) Anyone can view the presentation, even if not logged in.
CHAPTER 2 Working with Filters The data and information in your company’s Macromedia Breeze content repository can grow significantly over time. When this occurs, you might not want to list every item in the repository for all users. For example, you could list the most recently created courses and the latest quarterly financial results presentation on your company’s intranet. You need to sort and organize your growing repository to make sure users find the information they are looking for quickly.
Filter examples The following is a simple example to help illustrate the general concept of filters. The web service API report-my-courses returns the list of courses you are enrolled in. This same API used with a filter on the course name, for example report-my-courses&filter-like-name=Java, retrieves your courses with the specified text in the name, in this case “Java”.
About sort filters You can use a filter of the type sort to sort data in ascending and descending order. For example, the following filter sorts the name field in ascending order: sort-name=asc The following code sorts the name field in descending order: sort-name=desc You can also perform primary and secondary sorts.
Filter reference Filters are comprised of a type (either filter or sort) with an optional modifier, the name of the 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 filter (none) Field must match value exactly. filter like Field must contain value. filter out Field cannot contain value.
The result in the browser should look similar to the following: Understanding Filters Part 2 Second course in the series, covering important topics such as date and range filtering. admin.ibreeze.macromedia.com/p40583853/ 2004-05-26T17:51:40.840-07:00 2004-05-26T17:51:47.
Chapter 2: Working with Filters
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. In some cases, you use returned information as parameter values for the next action.
• In Breeze 4.0, the access key for your Breeze account. In Breeze 4.1, you do not need an access key, but it’s not harmful if you use it. For information about where to locate your access key, see “Access keys for Macromedia Breeze hosted (ASP) customers” on page 18 and “Access keys for Macromedia Breeze Enterprise (licensed) customers” on page 18. To call a Breeze action in a browser: 1. Open a browser. 2. Enter the address of the breeze server in the browser’s address bar.
To synchronize Breeze with the directory service: 1. Log in by calling the login action on the Breeze server, specifying the login name and password 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.
3. Request a list of Breeze users from the Breeze server by calling the principal-list action. 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 principal-list action. The cookie value from the previous step is included as an HTTP parameter.
8. For each user listed in the directory service but not in Breeze, add the user to Breeze, as follows: a Obtain the user’s first name, last name, and login name from the directory service. The Breeze login name is usually the user’s e-mail address. b Call the principal-update action, setting the type parameter equal to user. Don’t specify a principal-id parameter; leaving out principal-id indicates that you are adding a new user rather than updating an existing user.
10. For each user whose information in Breeze must be updated, obtain the user’s ID, as follows: a Examine the data returned by the principal-list action in steps 2 through 4 and search for the ID associated with the user’s login. b Obtain the user’s old first name and last name by calling the principal-info action. c Change the values as needed to match the name given by the directory service. d Call the principal-update action. e Check the returned XML to ensure the status code returned is "ok".
To determine a user’s ID, given their login name and password: 1. Log in as the user. 2. Call the common-info action. 3. Parse the returned XML to find the value of the user-id attribute of the user tag. That value is the user’s ID. To check whether an entered password is correct: 1. Log in as the user. 2. If the status code returned is "ok", the password is correct.
4. If you want to provide links to content items in the form of absolute URLs, determine the domain name of the folder: 5. Call the sco-contents action, using the folder’s SCO ID.
To create a new meeting: 1. Log in as the user. 2. (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. You can determine the ID of the my-meetings folder by calling the sco-shortcuts action. 3. Call the sco-update action, using the folder’s ID for the folder-id parameter. Don’t specify a sco-id parameter. 4.
Chapter 3: Common Tasks
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. Every action returns a results tag that contains one or more other tags, including a status tag. The “Returned elements” section of each action’s documentation lists only the other elements returned; results and status are assumed.
Action Description custom-field-update Updates the specified account custom field. Creates a new one if none exists. custom-fields Lists the custom fields of an account and the details of the fields. custom-fields-delete Deletes the specified account custom field. group-membership-update Adds one or more principals to a group, or removes one or more principals from a group. login Logs in a user.
Action Description report-bulk-meeting-attendance Returns meeting attendance data. report-course-status Returns course status for either a principal or a SCO, based on the parameters passed in. report-course-takers Provides a list of the users enrolled in the specified course. report-disk-usage Provides information about how much hard disk space the Breeze content for the current account uses, in bytes. report-meeting-attendance Provides a list of users who have attended the specified meeting.
Action Description report-quiz-takers Provides information about everyone who has taken a particular quiz. report-quotas Returns information on the account quotas. report-sco-slides Indicates how many times, and how recently, each slide in a presentation has been viewed. report-sco-views Indicates how many times, and how recently, the specified presentation has been viewed. report-survey-question-response Returns the list of all users who answered the specified question and their answer.
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 accesskey-exec, you need the normal access key for the account and a special access key associated with a meeting or course.
Returned elements None. Sample 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 Reference action. To find out which group the user will automatically join by self-registering using the special access key, look in the access-key-group XML element. If the group exists, this element is included in the returned XML.
The following sample results are returned when a group exists and includes an accesskey-group element: COURSE-test1-self-reg-group COURSE-test1-self-reg-group 2cw6np2kx2dtdop2 2004-07-07T12:27:04.
Time zone setting Parameter value (GMT-08:00) Pacific Time (US and Canada); Tijuana 4 (GMT-07:00) Mountain Time (US and Canada) 10 (GMT-07:00) Chihuahua, La Paz, Mazatlan 13 (GMT-07:00) Arizona 15 (GMT-06:00) Central Time (US and Canada) 20 (GMT-06:00) Saskatchewan 25 (GMT-06:00) Guadalajara, Mexico City, Monterrey 30 (GMT-06:00) Central America 33 (GMT-05:00) Eastern Time (US and Canada) 35 (GMT-05:00) Indiana (East) 40 (GMT-05:00) Bogota, Lima, Quito 45 (GMT-04:00) Atlantic Tim
Time zone setting Parameter value (GMT+02:00) Harare, Pretoria 140 (GMT+03:00) Moscow, St.
Time zone setting Parameter value (GMT+10:00) Guam, Port Moresby 275 (GMT+11:00) Magadan, Solomon Islands, New Caledonia 280 (GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands 285 (GMT+12:00) Auckland, Wellington 290 (GMT+13:00) Nuku’alofa 300 Filters Results cannot be filtered or sorted. Returned elements None. Sample results action-list Description Returns a list of web service actions.
user-update-pwd common-info Description Provides basic information about the current user and server. If you call common-info without logging in first, the same information is returned, except that the user tag is not included, and the account-id value might be different. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.
field-id fields). name The ID of the field to be updated (can be obtained by calling action customThis parameter needs to be specified only when updating an existing field. The name of the custom field (may be 1 to 60 characters long). comments Any comments on the custom field (may be 0 to 60 characters long). This parameter is optional. type The type of the custom field.
Filters Results can be filtered only on field-id. You can also use the filter-out modifier on the type parameter. Results cannot be sorted. The default sort is by ascending field-id.
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, and is-member parameters. For more information, see “About parameters” on page 15. Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.
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.
logout Description Logs out a user, invalidating the cookie that the application received when the user logged in. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements None.
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort is-primary Filter and sort type Filter and sort has-children Filter and sort permission-id Filter and sort name Filter and sort login Filter and sort description Filter and sort Note: Principals’ logged-in-access and public-access are always returned in the data set, irrespective of the filter restrictions.
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 18. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. acl-id The ID of a SCO. Filters Results cannot be filtered or sorted.
Returned elements None. Sample 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 principal-id parameter, call the principal-list action (possibly with a filter to limit the returned data) to return an ID for the principal. For information about principals, see “About principals, SCOs, and IDs” on page 16.
When the type attribute of the principal element is user, additional data about the user contact information, user profile, and custom fields for the user is returned, as shown in the following XML data: test4-lnagaraj@test.enang.
Field Filter/Sort has-children Filter and sort is-primary Filter and sort is-hidden Filter and sort name Filter and sort login Filter and sort description Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
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 field-id values from the data returned by the custom-fields action. Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored.
See also principal-info, principal-update, principals-delete principals-delete Description Deletes one or more principals. To delete multiple principals, specify multiple principal-id parameters. For more information, see “About parameters” on page 15. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored.
Field Filter/Sort login Filter and sort sco-name Sort date-created Filter and sort date-closed Filter and sort participant-name Sort Returned elements report-account-meeting-attendance Sample results lnagaraj@macromedia.
report-active-meeting-presenters Description Provides a list of the users who are currently presenting meetings. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The ID of a meeting; if specified, the report returns information about that meeting only. This parameter is optional. sco-id Filters Results cannot be filtered or sorted.
Returned elements report-active-meetings Sample results QT load 2003-09-02T14:00:58.330-07:00 Take 2 2003-09-02T14:45:25.
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 accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.
report-bulk-content-quiz-results Description Returns results for a content quiz, including information on each user and quiz question. The returned information is similar to the “Content quiz responses and results” download report, except that the report-bulk-quiz-results action returns XML data instead of CSV formatted data. Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater.
lnagaraj@macromedia.com 2004-07-13T10:52:23.780-07:00 00:00:45.046 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 accesskey The access key for the account.
lnagaraj@macromedia.com Enterprise Administrator test-slide 2004-06-30T11:46:12.
report-bulk-course-results Description Returns results for a course quiz, including information on each user and quiz question. The returned data is similar to the “Course Quiz Responses and Results” report, except that the action returns XML data and the report returns downloadable CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze required only in Breeze 4.0; it is not required for Breeze 4.1.
00:00:34.017 Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center. report-bulk-meeting Description Returns information about all meetings.
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 accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored.
report-course-status Description Returns course status for either a principal or a SCO, based on the parameters passed in. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. principal-id sco-id The ID of the principal for whom the courses status is requested. The ID of the SCO for which the course status is requested.
report-course-takers Description Provides a list of the users enrolled in the specified course. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a course.
Sample results lnagaraj@macromedia.com Enterprise Administrator
test1-laxmi@test.enang.
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 accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a meeting.
Sample results lnagaraj@macromedia.com Enterprise Administrator test-mtg-2 2004-07-09T14:29:49.217-07:00 2004-07-09T14:33:45.
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. If someone subsequently enters the now-empty meeting, a new session starts. Parameters accesskey The access key for your account.
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Filter and sort num-participants Sort num-guests Sort num-polls Sort name Filter and sort date-begin Filter and sort date-end Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
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 2004-02-14T06:30:00.000-08:00 2004-02-14T06:40:00.000-08:00
2004-02-14T06:40:00.000-08:00 2004-02-14T06:50:00.
report-my-courses Description Provides information about each course that the logged-in user is enrolled in. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored.
2004-02-16T21:00:00.000-08:00 /p81997938/ false report-my-meetings Description Provides information about each meeting the logged-in user is scheduled to attend. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored.
2003-07-14T23:00:00.000-07:00 2003-07-15T09:00:00.000-07:00 true new skipper admin.breeze.example.com /p50473388/ 2004-01-29T05:30:00.000-08:00 2004-01-29T05:30:00.
Sample results Enterprise Administrator lnagaraj@macromedia.
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: Who is Randy Johnson ?
|
Sample results 22
0
4
150,000,000 kilometers
1 parsec
<
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-number Filter and sort question-id Filter and sort score Filter and sort chapter-id Filter and sort body Filter and sort date-modified Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz.
2004-07-13T10:55:28.763-07:00 Who is Allan Iverson ? report-quiz-question-answer-distribution Description Indicates how many users selected a particular answer to a specified quiz question. Use report-quiz-definition-answers or report-quiz-definition-questions to determine the ID of a question (to specify as the question-id parameter).
ISO-9000 Which international standard defines ECMAScript? RFC 821
Which international standard defines ECMAScript? ECMA-976
|
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
Sample results report-quiz-summary Description Provides information about the results of a quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz.
If a type parameter is not specified, the list of all courses, content, and meetings attended by the user is returned. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz.
quiz-course lnagaraj@macromedia.com 2004-07-13T10:55:28.763-07:00 Enterprise Administrator
Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.
report-sco-slides Description Indicates how many times, and how recently, each slide in a presentation has been viewed. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation.
report-sco-views Description Indicates how many times, and how recently, the specified presentation has been viewed. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation. Filters Results cannot be filtered or sorted.
Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort principal-id Sort user-name Sort response Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21.
Sample results Professor Test Account sco-build Description Causes the Breeze server to build the specified SCO when you create presentations with the XML API. (For more information, see sco-update and sco-upload). No one can view a SCO until it has been built.
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 accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a folder.
My Name 2003-08-27T00:00:00.000-07:00 2003-08-27T01:00:00.000-07:00 2003-08-26T23:33:20.300-07:00 1900-01-02T/+:00:00.000+00:00 My Name 2 2004-01-29T01:30:00.000-08:00 2004-01-29T01:30:00.
sco-info Description Provides information about a SCO. For information about SCOs, see “About principals, SCOs, and IDs” on page 16. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements The returned tags depend on the specified item’s SCO type.
l n 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.250-07:00 test-slide /p27916084/ 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.
l 2004-07-13T10:46:48.000-07:00 2004-07-13T10:47:23.810-07:00 test-quiz /p67601053/ sco-move Description Moves a SCO from one folder to another.
Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements sco-nav Sample results User Meetings tennant@example.
Note: The filter-rows parameter indicates the number of rows to be returned, and filter-start indicates where the row count should begin. For more information about filters, see Chapter 2, “Working with Filters,” on page 21. You can also use the filter-type parameter to restrict the returned data based on the type attribute of the SCO.
Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements shortcuts Sample results http://admin.breeze.example.
You must provide only one of the following two parameters: folder-id or sco-id. After you call this action, you must call the permissions-update action to assign permissions. For information about permissions, see “About security” on page 17. For more information about SCOs, see “About principals, SCOs, and IDs” on page 16. The following examples show uses for the sco-update action. To use sco-update with a Breeze presentation: 1. Call sco-update with the folder-id parameter to create a SCO.
Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. date-begin The scheduled beginning date and time. The date format is ISO 8601. (Used only for meetings and courses.) The scheduled ending date and time. The date format is ISO 8601. (Used only for meetings and courses.) date-end A description of the SCO to be read by users.
The following sample XML is returned when a presentation SCO is created: sw macr /p74161709/ testXMLAPIpreso-New laxmi n testAPI-preso-New To update the title, summary, speaker name, title, l
2004-07-22T21:51:58.330-07:00 /r54578750/ testXMLAPI-mtg testAPI-mtg You can update meeting start and end times, name, and description by replacing the parameter folder-id with the parameter sco-id. The following sample XML is returned when updating a meeting: sco-upload Description Uploads a file to the Breeze server when creating a presentation using the XML API.
Note: Call the action sco-info to obtain the latest SCO status. The sco status will initially be inprogress, which means the content is being built. When the status becomes active, the content has finished building and is now accessible. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The file that you want to upload.
Returned elements trees Sample results nagarajan.macromedia.com nagarajan.macromedia.com nagarajan.macromedia.
Sample results james@example.com 2004-01-24T00:59:59.000-07:00 smith@example.com 2004-01-24T00:59:59.000-07:00 jones@example.com 2004-01-24T00:59:59.
Chapter 4: Action 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 37. About returned XML code When you call an action on the Breeze server, the server returns a block of XML code. The parent tag of the XML code is always a results tag.
If there is no data available for a tag that would normally be returned in response to an 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 user tag in the returned results. When your web application receives the returned XML code, it must parse the code to determine what the returned values are. For examples, see Chapter 3, “Common Tasks,” on page 27.
Tag Description date-created The date and time that a SCO was created, in ISO 8601 date format. date-end The date and time that a SCO is, or was, scheduled to end, in ISO 8601 date format. date-expired The date that an account is, or was, scheduled to expire, in ISO 8601 date format. date-last-taken The date that a course was last taken, in ISO 8601 date format. date-modified The date that something was most recently modified, in ISO 8601 date format.
Tag Description permission Contains information about a specific principal and its permissions. permissions Contains information about one or more principals and their permissions. physical-path The path on the server to a SCO. preferences Contains information about user preferences. presentation-name The name of a Breeze presentation. principal Contains information about a principal. principal-custom-field-values Contains information about the values of a custom field in a principal.
Tag Description report-course-status Contains information about the status of a course. report-disk-usage Indicates how much hard disk space the Breeze content uses, in bytes. report-meeting-attendance Contains one or more row tags, each containing information about a user who attended a particular meeting. report-meeting-concurrent-users The maximum number of users who participated simultaneously in the specified meeting. report-meeting-session Contains information about a meeting.
Tag Description report-sco-views Contains one or more row tags, each indicating how many times and how recently the specified presentation has been viewed. report-survey-question-response Contains information about the list of all users who answered the specified question and their answer. report-training-concurrent-users Indicates the largest number of users who have used the system at the same time. response A user’s response to a survey question.
Tag Description user (common-info) Contains information about a user. user (user-accounts) Contains information about a user and an account. user-first-name A user’s first name. user-last-name A user’s last name. user-login A user’s login (usually an e-mail address). user-name A user name. users Contains one or more user tags, each containing information about a user and an account. value The value of a custom field. version The Breeze version number.
access-key (key) There are two tags named access-key; they are described in different sections. Description A special access key for use in self-registration. Attributes None. Contained tags None (content only). Returned by accesskey-info Example vb7gmg6ohtz4y7k6 See also access-key (container), access-keys access-key-group Description Container tag; contains information about which group the user automatically joins by selfregistering using the special access key.
Example COURSE-test1-self-reg-group COURSE-test1-self-reg-group access-keys Description Container tag; contains one or more access keys. Attributes None.
action Description The name of an action. Attributes None. Contained tags None (content only). Returned by action-list Example user-accounts actions Description Container tag; contains a list of actions. Attributes None. Contained tags action Returned by action-list Example accesskey-exec accesskey-info action-list ... [other actions listed here] ...
answer-correct Description The text for a correct answer. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz Example YES answer-text Description The text of an answer to a quiz question as part of the results returned by a report action. Attributes None. Contained tags None (content only).
Returned by report-quiz-answer-distribution, report-quiz-definition-answers, report-quiz-definition-questions, report-quiz-question-distribution, report-quiz-question-response Example
What is 2+2? comment Description Any comments on the custom field (may be 0 to 60 characters long). Attributes None. Contained tags None (content only).breeze_402_r116 gerweck@example.com contact Description Container tag; contains information about a contact. Attributes contact-id The ID of a contact. Contained tags email, first-name, last-name Returned by principal-info Example test4-lnagaraj@test.enang.
Example breezm5qtgnye46zpckbf.MARIANNE 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 "no-content", which indicates that the course has just been created but has no content, and "active". status type Indicates that this SCO is a course. The value is always "course".
Example Department this is optional SSN date Description The current date and time on the server, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by common-info Example 2004-02-12T15:53:19.
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 2004-01-29T00:59:41.470-08:00 date-created Description The date and time that a SCO was created, in ISO 8601 date format. Attributes None. Contained tags None (content only).
Returned by report-meeting-session, report-my-courses, report-my-meetings, sco-contents Example 2004-02-09T14:30:00.000-08:00 date-expired Description The date that an account is, or was, scheduled to expire, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by user-accounts Example 2004-01-24T00:59:59.000-07:00 date-last-taken Description The date that a course was last taken, in ISO 8601 date format.
Contained tags None (content only). Returned by report-my-courses, report-quiz-definition-questions, sco-contents, sco-info, scosearch Example 2004-02-09T14:40:44.623-08:00 date-taken Description The date that a particular user took a particular quiz, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-quiz-takers Example 2004-01-13T01:33:49.
description Description The description of a principal. Attributes None. Contained tags None (content only). Returned by principal-info, principal-list Example Account administrators group domain-name Description The fully qualified domain name of the location of a SCO. Attributes None. Contained tags None (content only). Returned by report-my-meetings, sco-shortcuts Example admin.breeze.example.com duration Description The duration of a SCO.
Example 1900-01-02T/+:00:00.000+00:00 email Description A user’s e-mail address. Attributes None. Contained tags None (content only). Returned by principal-list, sco-info Example tennant@example.com 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. Contained tags None (content only).
custom-seq type The custom field number. The type of the custom field. It must be one of the following values: Value Description required Required account custom field optional Optional and show during self-registration optional-no-self-reg Optional and hide during self-registration Contained tags comment, name, value Note: Not all tags are returned by all actions.
hit Description A number indicating which slide contains a search term. Attributes None. Contained tags None (content only). Returned by sco-search Example 5 host Description The URL of the host that the Breeze server is running on. Attributes None. Contained tags None (content only). Returned by common-info Example http://admin.breeze.example.com invalid Description Container tag; contains information about why a particular call to an action is invalid.
Attributes The name of the parameter that was invalid. field subcode The reason that the parameter was invalid. The following table shows the possible values for this attribute: Value Description duplicate The call attempted to add a duplicate item in a context where uniqueness is required. format A passed parameter had the wrong format. illegal-operation The requested operation violates integrity rules (for example, moving a folder into itself is an illegal operation).
last-viewed Description The date and time of the most recent time that a SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-slides Example 2004-01-13T16:35:39.517-08:00 last-viewed-date Description The most recent date and time that the SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-views Example 2004-01-13T17:11:47.
Returned by common-info, permissions-info, principal-info, principal-list, report-coursetakers, report-meeting-attendance, report-quiz-takers Example tennant@example.com meeting Description Container tag; contains information about a meeting. Attributes active-participants The number of current participants. The permissions the user has for the meeting. For more information, see “About security” on page 17. permission-id The ID of the meeting. sco-id Indicates the meeting’s status.
Contained tags course Returned by report-my-courses Example My Name admin.breeze.example.com/p38547860/ 2004-02-09T14:40:38.497-08:00 2004-02-09T14:40:44.623-08:00 2004-02-09T14:30:00.000-08:00 2004-02-09T14:30:00.
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).
Attributes acl-id The ID of a specific SCO. permission-id The permissions that the principal has for the specified SCO. This attribute is returned only by the permissions-info action. principal-id The ID of the principal. Contained tags None (empty tag). Returned by permissions-info Example permissions Description Container tag; contains information about one or more principals and their permissions.
physical-path Description The path on the server to a SCO. Attributes None. Contained tags None (content only). Returned by sco-info Example 222914/503227/ preferences Description Contains information about user preferences. Attributes The ID of the user for whom the preferences are updated. acl-id lang The language setting.
Time zone setting Parameter value Chihuahua, La Paz, Mazatlan (GMT-07:00) 13 Arizona (GMT-07:00) 15 Central Time (US and Canada) (GMT-06:00) 20 Saskatchewan (GMT-06:00) 25 Guadalajara, Mexico City, Monterrey (GMT-06:00) 30 Central America (GMT-06:00) 33 Eastern Time (US and Canada) (GMT-05:00) 35 Indiana (East) (GMT-05:00) 40 Bogota, Lima, Quito (GMT-05:00) 45 Atlantic Time (Canada) (GMT-04:00) 50 Caracas, La Paz (GMT-04:00) 55 Santiago (GMT-04:00) 56 Newfoundland (GMT-03:30)
Time zone setting Parameter value Kuwait, Riyadh (GMT+03:00) 150 Nairobi (GMT+03:00) 155 Baghdad (GMT+03:00) 158 Tehran (GMT+03:30) 160 Abu Dhabi, Muscat (GMT+04:00) 165 Baku, Tbilisi, Yerevan (GMT+04:00) 170 Kabul (GMT+04:30) 175 Ekaterinburg (GMT+05:00) 180 Islamabad, Karachi, Tashkent (GMT+05:00) 185 Chennai, Kolkata, Mumbai, New Delhi (GMT+05:30) 190 Kathmandu (GMT+05:45) 193 Astana, Dhaka (GMT+06:00) 195 Sri Jayawardenepura (GMT+06:00) 200 Almaty, Novosibirsk (GMT+06:00) 20
Time zone setting Parameter value Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) 285 Auckland, Wellington (GMT+12:00) 290 Nuku’alofa (GMT+13:00) 300 Contained tags None. Returned by principal-info Example presentation-name Description The name of a Breeze presentation. Attributes None. Contained tags None (content only).
permission-id The permissions that the principal has for the specified SCO. This attribute is returned only by the permissions-info action. The ID of the principal. principal-id contact-id The ID for the contact information associated with the user. This value is null for groups. type The type of principal. Possible values include "user", "group", and various kinds of primary groups: "admins", "authors", "live-admins", and "course-admins".
principal-list Description Container tag; contains one or more principal tags. Attributes None. Contained tags principal Returned by principal-list Example Account Administrators Account Administrators Account administrators group principal-name Description The name of a principal.
question Description The text of a quiz question. Attributes None. Contained tags None (content only). Returned by report-quiz-interactions, report-survey-question-response Example What is 2+2? question-text Description The text of a quiz question. Attributes None. Contained tags None (content only). Returned by report-quiz-question-answer-distribution, report-bulk-content-quiz Example What is 2+2? quiz-name Description The name of a quiz.
Example Who is Randy Johnson ? quiz-definition-answers Description Container tag; contains one or more row tags, each containing information about a particular answer to a particular quiz question. Attributes None.
Example What is 2+2? 2004-01-13T17:09:40.230-08:00
How far is it from Earth to the sun? 2004-01-13T17:09:40.230-08:00
quiz-name Description The name of a quiz. Attributes None.
Contained tags date-begin, date-end Returned by report-quotas Example 1999-12-31T16:00:00.000-08:00 2999-12-31T16:00:00.000-08:00 report-account-meeting-attendance Description Container tag; contains rows tags that contain information about the meeting attendance log for the account. Attributes None.
2004-07-09T14:33:43.547-07:00 Enterprise Administrator report-active-meeting-presenters Description Container tag; contains a list of the users who are currently presenting meetings. Attributes None. Contained tags sco Returned by report-active-meeting-presenters Example Jack Monson 2004-02-17T17:06:23.
QT load 2003-09-02T21:41:58.330-07:00 Take 2 2003-07-29T17:48:25.273-07:00 report-bandwidth Description The total bandwidth consumed in the current account since the account was created, in bytes.
A baseball pitcher with the Arizona Diamondbacks YES test-quiz Quiz test 1 Who is Randy Johnson ? A basketball player with the New Jersey Nets NO
report-bulk-course-quiz Description Container tag; contains rows that contain information about all course quizzes, including a list of quizzes. Attributes None.
Returned by report-bulk-course-results Example lnagaraj@macromedia.com 2004-07-13T10:54:09.030-07:00 00:00:43.017
lnagaraj@macromedia.
report-bulk-meeting-attendance Description Container tag; contains information about all meeting attendees. Attributes None. Contained tags row Returned by report-bulk-meeting-attendance Example test-mtg-1 Enterprise Administrator 2004-07-09T13:00:28.920-07:00 2004-07-09T13:02:55.
Example lnagaraj@macromedia.com Enterprise Administrator test-slide 2004-06-30T11:46:10.280-07:00
lnagaraj@macromedia.
report-disk-usage Description Indicates how much hard disk space the Breeze content uses, in bytes. Includes all content and archives. Attributes total The total amount of disk usage, in bytes. Contained tags None (empty tag). Returned by report-disk-usage Example report-meeting-attendance Description Container tag; contains one or more row tags, each containing information about a user who attended a particular meeting. Attributes None.
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. Attributes max-participants-freq The number of times in the current month that the maximum number of users has been reached.
Example MyMeeting 2004-01-29T00:30:00.000-08:00 2004-01-29T00:30:00.000-08:00 report-meeting-sessions Description Container tag; contains information about all the sessions of a meeting. Attributes None.
Example 2004-02-14T06:30:00.000-08:00 2004-02-14T06:40:00.000-08:00
2004-02-14T06:40:00.000-08:00 2004-02-14T06:50:00.
Example Enterprise Administrator lnagaraj@macromedia.
report-quiz-interactions Description Container tag; contains one or more row tags, each containing information about an interaction a user had with the specified quiz. For more information about interactions, see the report-quiz-interactions action. Attributes None. Contained tags row Returned by report-quiz-interactions Example 2004-01-13T02:00:46.
Example Which international standard defines ECMAScript? ISO-9000
Which international standard defines ECMAScript? RFC 821
|
Which international standard defines ECMAScript?
report-quiz-question-response Description Container tag; contains one or more row tags, each describing an answer that a user gave to a particular quiz question. Attributes None.
Contained tags None (empty tag). Returned by report-quiz-question-totals Example report-quiz-results Description The number of users who took a specified quiz and their range of scores. Attributes The average of the scores of the users who took the quiz. average-score The highest score. high-score The lowest score low-score numdistincttaken The number of distinct users who have taken the quiz.
Contained tags None (empty tag). Returned by report-quiz-summary Example report-quiz-takers Description Container tag; contains one or more row tags, each containing information about a user who has taken the specified course or quiz. Attributes None.
report-quotas Description Container tag; contains information about the account quotas. Attributes None. Contained tags quota Returned by report-quotas Example 1999-12-31T16:00:00.000-08:00 2999-12-31T16:00:00.000-08:00 1999-12-31T16:00:00.
2004-01-13T16:35:44.933-08:00
report-sco-views Description Container tag; contains one or more row tags, each indicating how many times and how recently the specified presentation has been viewed. Attributes None. Contained tags row Returned by report-sco-views Example Quiz test 1 2004-01-13T17:11:47.
fine test1 laxmi how are you? ok
report-training-concurrent-users Description Indicates the largest number of users who have used the system at the same time. Attributes account-id The ID of the current account. The maximum number of users who can use the system at the same time, as specified by your account license.
results Description Container tag; all results returned by any action are contained in a results tag. Attributes None. Contained tags Any. Returned by All actions. Example row 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.
Example My Meeting 2004-03-05T10:33:09.030-08:00
sco 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.
Example tennant@example.com Pat Tennant 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 byte-count The file size of the SCO’s data file, in bytes. height The height of the SCO, in pixels. length The duration of a presentation, in milliseconds. sco-data-id The ID of the SCO’s data file.
Contained tags None (content only). Returned by report-meeting-attendance Example My Meeting sco-nav Description Container tag; contains information about the folder hierarchy that contains the specified SCO. Attributes None. Contained tags sco Returned by sco-nav Example User Meetings tennant@example.
Example Quiz 1 /p92628681/ 2003-11-26T22:52:28.973-08:00 2003-11-26T22:52:37.
shortcuts Description Container tag; contains one or more sco 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 sco Returned by sco-shortcuts Example http://admin.breeze.example.com http://admin.
Example 2004-02-27T10:31:06.717-08:00 2004-02-27T10:52:58.
Sometimes used to provide more detail of the status of the action. For example, values are used to differentiate between different situations in which code is set to no-access. The following values are possible for this attribute: subcode subcode Value Description account-expired The customer account has expired. denied Based on the supplied credentials, you don’t have access to perform the action. no-login You haven’t logged in.
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 2004-02-14T07:00:00.000-08:00 time-taken Description The time a course was taken. Attributes None. Contained tags None (content only). Returned by report-bulk-course-results Example 00:34:23.
Contained tags domain-name Returned by trees-info Example nagarajan.macromedia.com 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 nagarajan.macromedia.
url Description A URL. Attributes None. Contained tags None (content only). Returned by common-info, report-my-courses Example /api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info url-path Description The path on the Breeze server to the specified SCO. Attributes None. Contained tags None (content only).
Example gerweck@example.com user (user-accounts) Description Container tag; contains information about a user and an account. Attributes user-id The ID of the user. account-id The ID of an account. Contained tags date-expired, name Returned by user-accounts Example james@example.com 2004-01-24T00:59:59.000-07:00 user-first-name Description A user’s first name.
user-last-name Description A user’s last name. Attributes None. Contained tags None (content only). Returned by report-bulk-content-slide-views Example Administrator user-login Description The login of a user. Attributes None. Contained tags None. Returned by report-bulk-content-quiz-results Example lnagaraj@macromedia.com user-name Description A user name. Attributes None. Contained tags None (content only).
Example Enterprise Administrator users Description Container tag; contains one or more user tags, each containing information about a user and an account. Attributes None. Contained tags user (user-accounts) Returned by user-accounts Example james@example.com 2004-01-24T00:59:59.000-07:00 smith@example.
version Description The Breeze version number. Attributes None. Contained tags None (content only). Returned by common-info Example breeze_402_r116 view-date-time Description The time and date that a slide was viewed. Attributes None. Contained tags None. Returned by report-bulk-content-slide-views Example 2004-06-30T11:46:12.
Chapter 5: XML Results Reference
INDEX A access keys acquiring 42 Breeze Enterprise customers 18 hosted customers 18 overview 17 special 41, 119, 120, 121 access-key tag 119, 120 access-keys tag 121 accesskey-exec action 41 accesskey-info action 42 account tag 121 accounts limits 74 listing 110 acl-id parameters 17 acl-preference-update action 43 ACLs 18 action tag 122 action-list action 46 actions accesskey-exec 41 accesskey-info 42 acl-preference-update 43 action-list 46 alphabetical listing 41 calling 15 common-info 33, 47 completed su
report-quiz-question-totals 89 report-quiz-summary 90 report-quiz-takers 90 report-quotas 92 report-sco-slides 93 report-sco-views 94 report-survey-question-response 94 report-training-concurrent-users 95 report-quiz-answer-distribution 81 sco-build 96 sco-contents 34, 97 sco-delete 98 sco-info 34, 99 sco-move 101 sco-nav 101 sco-search 102 sco-shortcuts 33, 103 sco-update 104 sco-upload 108 trees-info 109 user-accounts 110 user-update-pwd 111 See also web services actions tag 122 active meetings listing 61
cookies.
H help systems 9 hierarchies of folders 101 hit tag 134 host tag 134 hosted accounts, access keys for 18 HTTP GET and POST requests 15 parameters 30 I identity verification 50 IDs about 16 account 121 permissions 18 quiz questions 88 user’s, determining 33 image files 16 information about principals 55 about SCOs 99 about servers, obtaining 47 displaying 34 inserting a user into Breeze 31 instructional media 9 integrating a portal with Breeze 32 interacting with the Breeze server 14 interactions with quizze
multiple parameters, specifying overview 15 permissions update 54 principals, deleting 59 SCOs, deleting 98 my-content folder 33 my-courses tag 137 my-meetings tag 138 N name tag 139 names of actions 122 new information 9 O online resources 10 optional parameters 15 P parameters about 15 ID 17 multiple, specifying 15, 54, 59, 98 optional 15 session 20 specifying 15 parent folders 101 parent-acl-id parameters 17 parsing returned XML code 29 participant-name tag 139 passwords changing 111 checking 33 paths to
scoring 84 summaries of results 90 users who took a quiz 90 See also SCOs quota tag 149 R rebuilding SCOs 96 recent updates to documentation 9 registering a user 41 removing principals from a group 50 principals from Breeze 59 users 31 report-account-meeting-attendance action 59 report-account-meeting-attendance tag 150 report-active-meeting-presenters action 61 report-active-meeting-presenters tag 151 report-active-meetings action 61 report-active-meetings tag 151 report-bandwidth action 62 report-bandwidt
results tag 113, 171 returned XML elements 37, 113 row tag 35, 171 S sample code 27 scenarios, common 27 scheduled meetings 79 sco tag 172 sco-author tag 172 sco-build action 96 sco-contents action 34, 97 sco-data tag 173 sco-delete action 98 sco-id parameters 17 sco-info action 34, 99 sco-move action 101 sco-name tag 173 sco-nav action 101 sco-nav tag 174 sco-search action 102 sco-search-info tag 174 sco-shortcuts action 33, 103 sco-update action 104 sco-upload action 108 scores on quizzes 84 SCOs about 16
date-last-taken 129 date-modified 129 date-taken 130 date-time-attempted 130 description 131 domain-name 131 duration 131 email 132 expired 132 field 132 first-name 133 hit 134 host 134 invalid 134 last-name 135 last-viewed 136 last-viewed-date 136 login 136 meeting 137 my-courses 137 my-meetings 138 name 139 overview 113 participant-name 139 permissions 139, 140 physical-path 141 principal 144 principal-list 146 principal-name 146 question 147 question-text 147 quiz-definition-answers 148 quiz-definition-q
times and dates 10 tree tag 179 trees 16 trees tag 180 trees-info action 109 troubleshooting 177 typographical conventions 11 U updates to the documentation 9 updating group membership 50 passwords 111 permissions 54 principals 57 SCOs 104 user information 32 uploading SCOs 96, 108 url tag 181 url-path tag 181 URLs, determining 34, 103 use cases, common 27 user tag 181, 182 user-accounts action 110 user-first-name tag 182 user-id parameters 17 user-last-name tag 183 user-login tag 183 user-name tag 183 user
Index
