1. DL manuals
  2. MACROMEDIA
  3. Server
  4. BREEZE 5
  5. Integration Manual

MACROMEDIA BREEZE 5 Integration Manual

Other manuals for BREEZE 5: Manual, Installation And Configuration Manual

Summary of BREEZE 5

  • Page 1

    Breeze integration guide.

  • Page 2

    Trademarks 1 step robopdf, activeedit, activetest, authorware, blue sky software, blue sky, breeze, breezo, captivate, central, coldfusion, contribute, database explorer, director, dreamweaver, fireworks, flash, flashcast, flashhelp, flash lite, flashpaper, flex, flex builder, fontographer, freehand...

  • Page 3: Contents

    3 contents introduction: before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 what’s new in the breeze xml apis . . . . . . . . . . . . . ....

  • Page 4

    4 contents chapter 4: xml api reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 sample api entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 api listing by function . . . . . . . . . . . . . . . . . . . . . ....

  • Page 5

    Contents 5 report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 report-meeting-sessions . . . . . . . . . . . . . . . . . . ....

  • Page 6

    6 contents acl-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 actions. . . . . . . . . . . . . . . . ...

  • Page 7

    Contents 7 permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 physical-path . . . . . . . . . . . . . . . ....

  • Page 8

    8 contents report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 report-training-concurrent-users . . . . . . . . . . . . . ...

  • Page 9: Introduction

    9 introduction before you begin the macromedia breeze xml web services enable your external system (such as a web application) to interact with a breeze server. This manual provides information on how to call xml web services (also called apis or actions) on the breeze server from your external syst...

  • Page 10

    10 introduction: before you begin what’s changed in the breeze xml apis some apis that were supported in breeze 4 are no longer supported in breeze 5. For information about alternate apis, where available, see the individual entries in chapter 4, “xml api reference,” on page 41 . The following apis ...

  • Page 11

    Additional resources 11 • breeze meeting user guide for hosts and presenters includes information about using the breeze meeting web application to host online real-time meetings. The documentation includes procedures that demonstrate the simplicity of adding slides, flash swf files, images, live au...

  • Page 12

    12 introduction: before you begin typographical conventions the following typographical conventions are used in this manual: • italic font indicates a value that should be replaced (for example, in a folder path). • code font indicates code. It also indicates names of apis, names of parameters, name...

  • Page 13: Chapter 1

    13 chapter 1 using the breeze xml apis the macromedia breeze xml application programming interface (api) model exposes interfaces as a set of xml web services. These services let your external system (such as a portal application) communicate with the breeze server, using http or https to call apis ...

  • Page 14

    14 chapter 1: using the breeze xml apis data flow the following diagram shows an example of the flow of data in a web application that interacts with the breeze server: the following example describes what might happen when a user connects to a training portal intranet site that was created with mac...

  • Page 15

    Calling an api on the server 15 4. As part of executing the code, the application server calls an api on the company’s breeze server, requesting the list of courses. The api call takes the form of an http post request. 5. The breeze server executes the api, returning the resulting xml data to the ap...

  • Page 16

    16 chapter 1: using the breeze xml apis note: the example code in this book uses the query parameters approach, both for readability and because of limitations in using macromedia coldfusion markup language (cfml) to send xml objects containing parameter data. Macromedia recommends using the post me...

  • Page 17

    About principals, scos, and ids 17 in some other apis, you can provide multiple sets of parameters. For example, the group- membership-update api takes parameters named group-id , principal-id, and is-member . To make multiple updates in a single call, you specify each of those parameters for princi...

  • Page 18

    18 chapter 1: using the breeze xml apis there are a few other kinds of ids that aren’t associated with a principal or a sco, such as account-id , answer-id , permission-id , and question-id . But in most cases, a parameter name that ends in -id indicates that the value of the parameter is the id of ...

  • Page 19

    About security 19 you can specify the following permissions on a sco: because a group is a principal, you can set these permissions on a sco for a custom group as well as for an individual user; if a group has a particular permission, all members of the group have that permission. Use the group-memb...

  • Page 20

    20 chapter 1: using the breeze xml apis • you can set a breezesession cookie on the user’s browser, using the value of the login cookie. However, this approach works only if your application is running on a server with the same domain name as the breeze server. Also, if your application server is a ...

  • Page 21: Chapter 2

    21 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 a...

  • Page 22

    22 chapter 2: working with filters filter examples the following is a simple example to help illustrate the general concept of filters. The web service api report-my-courses returns the list of courses that you enrolled in. This same api used with a filter on the course name, for example report-my-c...

  • Page 23

    Special filter scenarios 23 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 yo...

  • Page 24

    24 chapter 2: working with filters filtering a specific number of entries starting at a specific entry you can use the following technique to create pagination when there is too much data for one page. The following example shows 25 records starting at the 100th record: filter-rows=25&filter-start=1...

  • Page 25

    Testing code in the browser 25 testing code in the browser you can enter a test url in the address field of a browser window and see the xml response from the server. It is a good idea to become comfortable with filters in the browser before you write code. There are many nuances to filters that det...

  • Page 26

    26 chapter 2: working with filters to make your code production-ready, develop it to handle unexpected errors and situations. Make sure you check for unexpected status codes and inform your it team when you encounter such a situation. Where to go from here the macromedia breeze resource center has a...

  • Page 27: Chapter 3

    27 chapter 3 common tasks this chapter describes common scenarios for integrating macromedia breeze with external applications or systems. These scenarios show how to accomplish several common tasks. To perform each task, you call one or more apis on the breeze server and then parse the xml tags tha...

  • Page 28

    28 chapter 3: common tasks calling your first api you can enter a test url in the address field of a browser and see the xml response from the server displayed in the browser window. The returned xml is the same as the returned xml when you call the api in an application. You should be comfortable w...

  • Page 29

    Logging in to breeze 29 logging in to breeze to call most apis, you must be acting as a logged-in user, so you must call the login api before you can call most other apis. (the exceptions—apis you can call without logging in—are action-list , common-info , login , and user-accounts .) when you call ...

  • Page 30

    30 chapter 3: common tasks reviewing the code the following table describes the highlighted code and its function: code description checks whether the username variable is defined. If it is, the next block of code executes. If it isn’t, a form is displayed that allows a user to provide a user name (...

  • Page 31

    Displaying a user’s meetings, courses, and events 31 creating a new user to create a new user, call the principal-update api with the following parameters: first- name , last-name , login , password , has-children , and type (either user or group ). The following code creates a new user for the bree...

  • Page 32

    32 chapter 3: common tasks creating a meeting to create a meeting room, you must have appropriate permissions. When using the xml api, you should create an administrator account with account administrator privileges to perform administrator functions on a breeze account. To create a meeting, call th...

  • Page 33

    Integrating breeze with a directory service 33 creating and managing learning paths to create and manage learning paths, use the following apis: learning-path-info , learning- path-update , and user-transcript-update . Call learning-path-info to discover the restrictions on a particular learning obj...

  • Page 34

    34 chapter 3: common tasks 2. Check that the login api completed successfully by parsing the returned xml and examining the value of the status tag’s code attribute. If the status code isn’t ok , determine what the error was and handle it appropriately, as in the following: 3. Request a list of bree...

  • Page 35

    Integrating breeze with a directory service 35 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 c...

  • Page 36

    36 chapter 3: common tasks 11. For each user whose information in breeze must be updated, obtain the user’s id, as follows: a examine the data returned by the principal-list api in steps 2 through 4 and search for the id associated with the user’s login. B obtain the user’s old first name and last n...

  • Page 37

    Integrating breeze with a portal 37 to determine a user’s id, given their login name and password: 1. Log in as the user. 2. Call the common-info api. 3. Parse the returned xml to find the value of the user-id attribute of the user tag. That value is the user’s id. To check whether an entered passwo...

  • Page 38

    38 chapter 3: common tasks 4. If you want to provide links to content items in the form of absolute urls, determine the domain name of the folder: "//sco[@tree-id='#mytreeid#']/domain-name")> 5. Call the sco-contents api, using the folder’s sco id. The following api provides a list of the contents o...

  • Page 39

    Generating reports 39 3. Call the sco-update api, using the folder’s id for the folder-id parameter. Don’t specify a sco-id parameter. 4. Verify that the api completed successfully by checking the returned status tag. To search for content: 1. Obtain the string to search for from the user, using a w...

  • Page 40

    40 chapter 3: common tasks.

  • Page 41: Chapter 4

    41 chapter 4 xml api reference this chapter provides reference material for each application programming interface (api) that is exposed in the macromedia breeze xml api, including information about the parameters that you can pass with each api. The apis are listed in alphabetical order. Every api ...

  • Page 42

    42 chapter 4: xml api reference parameters this section describes any parameters listed in the syntax. All parameters are required unless they are marked “optional.” filters this section describes fields on which you can filter and sort the returned xml data. Returned elements this section identifie...

  • Page 43

    Api listing by function 43 curriculum and learning path management you can use the breeze web services to create and manage learning paths associated with a curriculum and a user. The following table lists the curriculum apis supported in breeze 5: custom fields you can use custom fields to add fiel...

  • Page 44

    44 chapter 4: xml api reference permissions the following table lists the permissions apis supported in breeze 5: reports you can use the detailed reporting capabilities of the breeze web services in external systems such as employee performance management solutions. The following breeze web service...

  • Page 45

    Api listing by function 45 user management breeze provides a complete set of web services that allow you to develop synchronization processes between your directory service and breeze. Additionally, these web services allow you to integrate user profiles, personalized breeze content, and reporting d...

  • Page 46

    46 chapter 4: xml api reference the following table lists the user management apis supported in breeze 5: alphabetical api listing the following list contains all of the apis that are documented in this reference chapter. Apis that breeze 5 does not support are indicated in the description column. A...

  • Page 47

    Alphabetical api listing 47 group-membership-update adds one or more principals to a group, or removes one or more principals from a group. Learning-path-info returns a list of learning paths for a learning object that belongs to a curriculum. Learning-path-update updates the learning path for a sin...

  • Page 48

    48 chapter 4: xml api reference report-bulk-content-slide-views returns slide view data for content. This api is not supported in breeze 5. Report-bulk-course-quiz returns information about all course quizzes, including a list of quizzes, and the questions and answers for each quiz. This api is not ...

  • Page 49

    Alphabetical api listing 49 report-my-courses provides information about each course in which the logged- in user is enrolled. Report-my-events provides information about each event that the logged-in user is scheduled to attend. Report-my-meetings provides information about each meeting that the lo...

  • Page 50

    50 chapter 4: xml api reference api reference entries the following section lists the breeze xml apis alphabetically accesskey-exec availability breeze 4. This api is not supported in breeze 5. Note: an updated api is not available because the self-registration feature no longer exists in breeze 5. ...

  • Page 51

    Accesskey-info 51 to call the accesskey-exec api, you need a special access key associated with a meeting or course. Someone who isn’t a breeze user can be given the special access key and can then use an interface to register for the meeting or course, creating a breeze user account in the process....

  • Page 52

    52 chapter 4: xml api reference to find out which group the user will automatically join by self-registering using the special access key, look in the access-key-group xml element. If the group exists, this element is included in the returned xml. If the group does not exist, there is no additional ...

  • Page 53

    Acl-field-info 53 acl-field-info availability breeze 5. Description returns field-ids and values for an acl. The caller must have view permission for the acl. You can call principal-list to determine the account-id or principal-ids . An acl is a securable breeze object, for example, a principal, sco...

  • Page 54

    54 chapter 4: xml api reference concurrent-attendee see also acl-field-list , acl-field-update acl-field-list availability breeze 5. Description returns the list of acl-ids and values in the logged-in account for the given field-id . For example, to list the first names of all users in an account, c...

  • Page 55

    Acl-field-update 55 acl-field-update availability breeze 5. Description updates the field value for the given acl and field. The caller requires modify permission on the acl. An acl is a securable breeze object, for example, a principal, sco, or account. For more information, see “about principals, ...

  • Page 56

    56 chapter 4: xml api reference mary sue see also acl-field-list , acl-field-info acl-preference-update availability breeze 4. Description updates the user profile to the specified language and time zone settings. Parameters acl-id the id of the user for whom the preferences need to be updated. Lang...

  • Page 57

    Acl-preference-update 57 (gmt-06:00) guadalajara, mexico city, monterrey 30 (gmt-06:00) central america 33 (gmt-05:00) eastern time (us and canada) 35 (gmt-05:00) indiana (east) 40 (gmt-05:00) bogota, lima, quito 45 (gmt-04:00) atlantic time (canada) 50 (gmt-04:00) caracas, la paz 55 (gmt-04:00) san...

  • Page 58

    58 chapter 4: xml api reference (gmt+04:00) abu dhabi, muscat 165 (gmt+04:00) baku, tbilisi, yerevan 170 (gmt+04:30) kabul 175 (gmt+05:00) ekaterinburg 180 (gmt+05:00) islamabad, karachi, tashkent 185 (gmt+05:30) chennai, kolkata, mumbai, new delhi 190 (gmt+05:45) kathmandu 193 (gmt+06:00) astana, d...

  • Page 59

    Action-list 59 filters results cannot be filtered or sorted. Returned elements none. Sample results action-list availability breeze 4. Description returns a list of breeze web service apis (also referred to as actions). Caution: not all apis in this list are documented, and not all documented apis a...

  • Page 60

    60 chapter 4: xml api reference common-info availability breeze 4. Description provides basic information about the current user and server. If you call common-info without logging in first, the same information is returned, except that the user tag is not included, and the account-id value may be d...

  • Page 61

    Custom-fields 61 parameters field-id the id of the field to be updated (can be obtained by calling the custom-fields api). This parameter needs to be specified only when updating an existing field. Name the name of the custom field (can be 1 to 60 characters long). Comments any comments on the custo...

  • Page 62

    62 chapter 4: xml api reference parameters none. Filters results can be filtered only on field-id . You can also use the filter-out modifier on the type parameter. Results cannot be sorted. The default sort is by ascending field-id . Returned elements custom-fields , field sample results department ...

  • Page 63

    Learning-path-info 63 see also acl-field-info , acl-field-list , acl-field-update group-membership-update availability breeze 4. Description adds one or more principals to a group, or removes one or more principals from a group. To update multiple principals and groups, specify multiple trios of gro...

  • Page 64

    64 chapter 4: xml api reference parameters curriculum-id the id of the curriculum to which this learning object belongs. Sco-id the id of the learning object. Filters the following table lists the fields on which the data can be filtered and sorted: the target-sco-id field contains the id of the lea...

  • Page 65

    Learning-path-update 65 sco-id="5400247" path-type="completion-required"> new hire safety sco-id="5400247" path-type="completion-required"> new hire safety sco-id="5400248" path-type="completion-required"> beginning electronics sco-id="5400248" path-type="completion-required"> beginning electronics ...

  • Page 66

    66 chapter 4: xml api reference target-sco-id the id of the learning object that restricts access to the current learning object. For example, if a learning object has a prerequisite requirement, the prerequisite sco is the target-sco-id . Consider the following scenario: a student must pass the “in...

  • Page 67

    Login 67 the following java example parses the http headers to store the cookie, and then indicates how it can be passed on for all subsequent requests: login="john@example.Com" password="abcdefg" baseurl="http://breeze.Example.Com/" url loginurl=new url(baseurl + "api/xml?Action=login&login=" + log...

  • Page 68

    68 chapter 4: xml api reference returned elements none. Sample results see also logout logout availability breeze 4. Description logs out a user, invalidating the cookie that the application received when the user logged in. Parameters none. Filters results cannot be filtered or sorted. Returned ele...

  • Page 69

    Permissions-info 69 for more information about permissions, see “about permissions” on page 18 . For more information about filters, see chapter 2, “working with filters,” on page 21 . Parameters acl-id the id of a specific sco. Principal-id the id of a specific principal. This parameter is optional...

  • Page 70

    70 chapter 4: xml api reference the following xml data is returned when the principal-id parameter is passed: if the principal was not assigned permissions to the sco, the status code no-data is returned. See also permissions-reset , permissions-update permissions-reset availability breeze 4. Descri...

  • Page 71

    Principal-info 71 for information about permissions, see “about permissions” on page 18 . To update multiple principals’ permissions, specify multiple trios of acl-id , permission-id , and principal-id parameters. For more information, see “about parameters” on page 16 . Parameters acl-id the id of ...

  • Page 72

    72 chapter 4: xml api reference sample results principal-id="222926" type="course-admins"> course managers group course managers course managers principal-id="222926" type="course-admins"> course managers group course managers course managers the following sample xml data is returned when the type a...

  • Page 73

    Principal-list 73 principal-list availability breeze 4. Description provides a complete list of users and groups, including primary groups. Parameters none. Filters the following table lists the fields on which the data can be filtered and sorted: for more information about filtering and sorting, se...

  • Page 74

    74 chapter 4: xml api reference see also principal-info , principal-update , principal-list-by-field , principals-delete . Principal-list-by-field availability breeze 5. Description allows you to list principals that have a given field value. Parameters value the field value on which you want to sea...

  • Page 75

    Principal-update 75 see also principal-info , principal-list , principal-update , principals-delete principal-update availability breeze 4. Description updates information for a principal in the current account or creates a new principal. For information about principals, see “about principals, scos...

  • Page 76

    76 chapter 4: xml api reference returned elements if you update an existing principal, no elements are returned. If you create a new principal, principal is returned (in the same format as the returned elements for principal-info ). Sample results the following sample results are for creating a new ...

  • Page 77

    Report-account-meeting-attendance 77 report-account-meeting-attendance availability breeze 4. This api is not supported in breeze 5. To discover which principals attended which meetings, use the report-meeting-attendance or the report-bulk-consolidated-transactions api. Description returns the meeti...

  • Page 78

    78 chapter 4: xml api reference name> test-mtg-1 2004-07-09t14:33:06.577-07:00 created> 2004-07-09t14:33:43.547-07:00 closed> enterprise administrator name> report-active-meeting-presenters availability breeze 4. Description provides a list of the users who are currently presenting meetings. Paramet...

  • Page 79

    Report-bandwidth 79 report-active-meetings availability breeze 4. Description provides a list of meetings that are currently in progress. Parameters none. Filters results cannot be filtered or sorted. Returned elements report-active-meetings sample results 022305 stephanie test /r27873068/ 2005-02-2...

  • Page 80

    80 chapter 4: xml api reference returned elements report-bandwidth sample results report-bulk-consolidated-transactions availability breeze 5 description returns information about all of the transactions in an account. A transaction is an instance of one principal visiting one sco. Consider the foll...

  • Page 81

    Report-bulk-content-quiz 81 sample results default meeting template /r-182228/ bharm@macromedia.Com ben harm completed 2005-01-29t14:02:04.733-08:00 default meeting template /r-182228/ gho@macromedia.Com gung ho completed 2005-01-04t10:10:09.077-08:00 see also report-bulk-objects , report-bulk-quest...

  • Page 82

    82 chapter 4: xml api reference sample results - number="1" question-value="10" answer-id="1"> test-quiz quiz test 1 who is randy johnson ? A baseball pitcher with the arizona diamondbacks text> yes number="1" question-value="10" answer-id="1"> test-quiz quiz test 1 who is randy johnson ? A baseball...

  • Page 83

    Report-bulk-content-slide-views 83 filters the following table lists the fields on which the data can be filtered and sorted: returned elements report-bulk-content-quiz-results sample results quiz-id="1" question-number="1" user-response="1"> lraj@macromedia.Com 2004-07-13t10:51:35.047-07:00 attempt...

  • Page 84

    84 chapter 4: xml api reference parameters none. Filters the following table lists the fields on which the data can be filtered and sorted: returned elements report-bulk-slide-views sample results slide-number="1"> lraj@macromedia.Com enterprise administrator test-slide 2004-06-30t11:46:10.280-07:00...

  • Page 85

    Report-bulk-course-quiz 85 report-bulk-course-quiz availability breeze 4. This api is not supported in breeze 5. Description returns information about all course quizzes, including a list of quizzes, and the questions and answers for each quiz. The returned results are similar to the “course quiz in...

  • Page 86

    86 chapter 4: xml api reference report-bulk-course-results availability breeze 4. This api is not supported in breeze 5. This api was replaced by the report-quiz-interactions api. Description returns results for a course quiz, including information on each user and quiz question. The returned data i...

  • Page 87

    Report-bulk-meeting 87 2004-07-13t10:54:09.030-07:00 attempted> 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 th...

  • Page 88

    88 chapter 4: xml api reference report-bulk-meeting-attendance availability breeze 4. This api is not supported in breeze 5. Description returns meeting attendance data. The results are similar to the “meeting attendance” report, except that the api returns xml data and the report returns downloadab...

  • Page 89

    Report-bulk-objects 89 report-bulk-objects availability breeze 5. Description returns information about every object on the breeze server. Object types include archive, attachment, authorware, captivate, course, curriculum, external-event, flv, image, meeting, presentation, and swf. Use filters to l...

  • Page 90

    90 chapter 4: xml api reference /p30542007/ presentation 181438 bullet animation test.Ppt 2003-07-14t14:54:16.757-07:00 2003-07-14t14:54:16.757-07:00 2003-07-14t14:52:32.327-07:00 see also report-bulk-consolidated-transactions , report-bulk-questions , report-bulk-slide- views , report-bulk-users re...

  • Page 91

    Report-bulk-slide-views 91 false 2005-03-24t16:36:36.100-08:00 apples can be or . The name of the grocery store is {green,red,bob's} 2005-03-24t15:16:39.030-08:00 apples can be or . The name of the grocery store is {j,k,bob's} 2005-03-24t11:52:14.280-08:00 apples can be or . The name of the grocery ...

  • Page 92

    92 chapter 4: xml api reference returned elements report-bulk-slide-views sample results 0 2005-03-24t16:36:41.820-08:00 4 2005-03-24t16:37:53.070-08:00 5 2005-03-24t16:38:09.070-08:00 1 2005-03-24t16:36:47.663-08:00 2 2005-03-24t16:37:04.303-08:00 3 2005-03-24t16:37:15.710-08:00 6 2005-03-24t16:38:...

  • Page 93

    Report-bulk-users 93 report-bulk-users availability breeze 5. Description returns information about all users in an account. Remember to use filters to limit your results. For example, the following call returns in ascending order all users who have the letters “jo” in their name: http://admin.Ibree...

  • Page 94

    94 chapter 4: xml api reference user vish_laxmi@yahoo.Com laxmi vish vish_laxmi@yahoo.Com user acobbler@macromedia.Com apple cobbler acobbler@macromedia.Com pangel@macromedia.Com user see also report-bulk-objects , report-bulk-questions , report-bulk-slide-views , report-bulk- consolidated-transacti...

  • Page 95

    Report-course-takers 95 when the principal-id parameter is passed in, the following xml may be returned: completions="4" num-passed="3" num-failed="1"> 2004-07-27t12:53:42.297-07:00 completions="4" num-passed="3" num-failed="1"> 2004-07-27t12:53:42.297-07:00 report-course-takers availability breeze ...

  • Page 96

    96 chapter 4: xml api reference returned elements report-quiz-takers sample results status="user-passed" score="2" certificate="13106" attempts="1"> bcassaly@macromedia.Com 2005-03-02t16:00:33.170-08:00 bart cassaly status="user-passed" score="2" certificate="13106" attempts="1"> bcassaly@macromedia...

  • Page 97

    Report-meeting-attendance 97 report-meeting-attendance availability breeze 4. Description provides a list of users who have attended the specified meeting. If the meeting hasn’t started, the returned data contains no rows. The data does not include users who were invited but did not attend the meeti...

  • Page 98

    98 chapter 4: xml api reference 2005-03-15t10:13:12.810-08:00 bart cassaly report-meeting-concurrent-users availability breeze 4. Description indicates the maximum number of users who can participate simultaneously in the specified meeting. This maximum is determined by the account license. Paramete...

  • Page 99

    Report-meeting-sessions 99 parameters sco-id the id of a meeting. This value must match the sco-id for a specific meeting session. To obtain the list of all sessions and their associated sco-ids, call the report-meeting- sessions api. Filters results cannot be filtered or sorted. Returned elements r...

  • Page 100

    100 chapter 4: xml api reference for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-meeting-sessions sample results 2005-03-15t09:30:28.233-08:00 2005-03-15t09:45:36.903-08:00 2005-03-15t10:11:00.700-08:00 2005-03-15t10:21:0...

  • Page 101

    Report-my-courses 101 2004-02-14t06:30:00.000-08:00 2004-02-14t06:40:00.000-08:00 2004-02-14t06:40:00.000-08:00 2004-02-14t06:50:00.000-08:00 2004-02-14t06:50:00.000-08:00 2004-02-14t07:00:00.000-08:00 report-meeting-summary availability breeze 4. Description indicates how many users were invited to...

  • Page 102

    102 chapter 4: xml api reference parameters none. Filters the following table lists the fields on which the data can be filtered and sorted: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements my-courses sample results id="view"> fo...

  • Page 103

    Report-my-events 103 report-my-events availability breeze 5. Description provides information about each event that the logged-in user is scheduled to attend. Parameters none. Filters the following table lists the fields on which the data can be filtered and sorted: for more information about filter...

  • Page 104

    104 chapter 4: xml api reference report-my-meetings availability breeze 4. Description provides information about each meeting the logged-in user is scheduled to attend. Parameters none. Filters the following table lists the fields on which the data can be filtered and sorted: for more information a...

  • Page 105

    Report-principal-list 105 01:00:00.000 report-principal-list availability breeze 4. This api is not supported in breeze 5. The custom field information that was returned by report-principal-list was moved to acls in breeze 5. For more information, see the acl-field-info , acl-field-list , and acl- f...

  • Page 106

    106 chapter 4: xml api reference enterprise administrator lraj@macromedia.Com /> primary="true"> account administrators account administrators primary="false"> test1 laxmi test1-laxmi@test.Enang.Com engg 100-07-7777 report-quiz-answer-distribution availability breeze 4. This api is not supported in ...

  • Page 107

    Report-quiz-definition-answers 107 sample results the following xml contains attributes for answer options 1 through 8, even if the quiz question has fewer possible answers: a5="0" a6="0" a7="0" a8="0" total="2"> who is randy johnson ? A5="0" a6="0" a7="0" a8="0" total="2"> a5="0" a6="0" a7="0" a8="...

  • Page 108

    108 chapter 4: xml api reference sample results iso-9000 report-quiz-definition-questions availability breeze 4. This api is not supported in breeze 5. This api was replaced by apis that support quiz metadata. For more information, see the report-quiz-interactions , report-quiz-question-answer-distr...

  • Page 109

    Report-quiz-definition-questions 109 parameters sco-id the id of a presentation that contains a quiz. Filters the following table lists the fields on which the data can be filtered and sorted: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Retur...

  • Page 110

    110 chapter 4: xml api reference report-quiz-interactions availability breeze 4. Description provides information about all the interactions that users have had with the specified quiz. An interaction consists of a user making a choice in a quiz, so this report provides information about every answe...

  • Page 111

    Report-quiz-question-answer-distribution 111 2005-03-11t12:04:29.200-08:00 a human being usually has fingers. 10 report-quiz-question-answer-distribution availability breeze 4. Description indicates how many users selected a particular answer to a specified quiz question (also called an interaction)...

  • Page 112

    112 chapter 4: xml api reference 0 2 c11101ba001b%2eo4e%7e%24kq%2awo2jj110bkebdb1b1ebcb0b0ebbb0b0ebab0 b0e 1 2 report-quiz-question-distribution availability breeze 4. Description indicates how many users answered each question in the specified quiz correctly. Parameters sco-id the id of a presentat...

  • Page 113

    Report-quiz-question-response 113 for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-quiz-question-distribution sample results incorrect="0" total-responses="1" percentage-correct="100" score="10"> interaction20008 which of ...

  • Page 114

    114 chapter 4: xml api reference for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-quiz-question-response sample results barry cassidy d 2005-03-14t14:20:43.967-08:00 barry cassidy 0 2005-03-14t14:20:43.967-08:00 barry cass...

  • Page 115

    Report-quiz-summary 115 report-quiz-question-totals availability breeze 4. This api is not supported in breeze 5. This api was replaced by the report-quiz-question-distribution api. Description for the specified quiz question, indicates the total number of users who answered the question and the num...

  • Page 116

    116 chapter 4: xml api reference sample results numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> 2005-03-14t14:20:43.967-08:00 80 numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> 2005-03-14t14:20:43.967-08:00...

  • Page 117

    Report-quotas 117 for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-quiz-takers sample results status="user-failed" score="0" attempts="2" time-taken="152000" certificate="" answered-survey="1"> all question types quiz bcas...

  • Page 118

    118 chapter 4: xml api reference parameters none. Filters results cannot be filtered or sorted. Returned elements report-quotas sample results limit="1000000000"> 2003-08-15t13:12:33.260-07:00 2999-12-31t16:00:00.000-08:00 limit="1000000000"> 2003-08-15t13:12:33.260-07:00 2999-12-31t16:00:00.000-08:...

  • Page 119

    Report-sco-views 119 filters the following table lists the fields on which the data can be filtered and sorted: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-sco-slides sample results 2005-03-14t14:20:46.733-08:00 2005-...

  • Page 120

    120 chapter 4: xml api reference sample results id="10021" transcript-id="17808" asset-id="17805"> one question - new 2005-03-14t14:20:43.967-08:00 2005-03-14t14:20:43.967-08:00 id="10021" transcript-id="17808" asset-id="17805"> one question - new 2005-03-14t14:20:43.967-08:00 2005-03-14t14:20:43.96...

  • Page 121

    Sco-build 121 test1 laxmi how are you? Ok sco-build availability breeze 4. Description causes the breeze server to build the specified sco when you create presentations with the xml api. (for more information, see sco-update and sco-upload ). No one can view a sco until it has been built. Call this ...

  • Page 122

    122 chapter 4: xml api reference sco-contents availability breeze 4. Description provides a list of the scos in a specified folder. Because folders are scos, the returned list includes the folders that are contained in the specified folder. The returned list does not include the contents of those su...

  • Page 123

    Sco-delete 123 for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements scos sample results the name and date-modified elements are always returned, but the date-begin , date-end , and duration elements are present only for scos whose ty...

  • Page 124

    124 chapter 4: xml api reference filters results cannot be filtered or sorted. Returned elements none. Sample results see also sco-info , sco-move , sco-nav sco-expanded-contents availability breeze 5. Description lists all of the scos in a folder. Parameters sco-id the id of a folder. Filters resul...

  • Page 125

    Sco-info 125 sco-info availability breeze 4. Description provides information about a sco. For information about scos, see “about principals, scos, and ids” on page 17 . Parameters sco-id the id of a sco. Filters results cannot be filtered or sorted. Returned elements the returned tags depend on the...

  • Page 126

    126 chapter 4: xml api reference n 2004-06-30t11:45:03.717-07:00 2004-06-30t11:53:33.250-07:00 test-slide /p27916084/ slide-count="2" version="0" width="720"> 2004-06-30t11:45:03.717-07:00 2004-06-30t11:53:33.090-07:00 7/27/ slide-count="2" version="0" width="720"> 2004-06-30t11:45:03.717-07:00 2004...

  • Page 127

    Sco-nav 127 id="722" sco-id="720" source-sco-id="" status="active" tree-id="11" type="presentation"> l 2004-07-13t10:46:48.000-07:00 2004-07-13t10:47:23.810-07:00 test-quiz /p67601053/ id="722" sco-id="720" source-sco-id="" status="active" tree-id="11" type="presentation"> l 2004-07-13t10:46:48.000-...

  • Page 128

    128 chapter 4: xml api reference in the returned results, the sco tag’s depth attribute indicates how many hierarchical levels away the folder is from the specified sco. That is, a depth attribute equal to 0 indicates the sco itself; a depth of 1 indicates the folder that contains the sco; and so on...

  • Page 129

    Sco-search 129 filters you can restrict the returned data to a specific number of rows by using the filter-rows and filter-start parameters. For example, the following code returns the first five rows of data: filter-rows=5&filter-start=0 note: the filter-rows parameter indicates the number of rows ...

  • Page 130

    130 chapter 4: xml api reference 2005-03-30t16:32:42.280-08:00 2005-03-30t16:32:42.280-08:00 2 slide /viewer.Swf?Slide=2 sco-shortcuts availability breeze 4. Description provides ids for a set of folders that contain content relevant to the logged-in user: a folder for the user to place meetings, a ...

  • Page 131

    Sco-update 131 http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com see also sco-info , sco-expanded-contents sco-update availabi...

  • Page 132

    132 chapter 4: xml api reference to use sco-update with a breeze presentation: 1. Call sco-update with the folder-id parameter to create a sco. Pass the following parameters: folder-id , description , name , author-info-1 (the author’s name), author-info-2 (the author’s title), author-info-3 (the co...

  • Page 133

    Sco-update 133 folder-id the id of the folder in which the server will create the new sco. This parameter is optional and cannot be specified with sco-id . Last-name the last name of the contact person for the sco. (used only for presentations.) name the name of the sco. Sco-id the id of a sco to up...

  • Page 134

    134 chapter 4: xml api reference to upload a different sco and rebuild the presentation, call sco-upload and sco-build in that order. The following sample results are returned when a presentation is updated: the following sample xml is returned when a course is created: id="720" status="active" tree...

  • Page 135

    Sco-upload 135 sco-upload availability breeze 4. Description uploads a file to the breeze server when creating a presentation using the xml api. (for more information, see sco-update and sco-build .) you must send the parameters for this api using the multipart/form-data media type. The easiest way ...

  • Page 136

    136 chapter 4: xml api reference filters results cannot be filtered or sorted. Returned elements files sample results 38181499/38111519-1/input/test.Ppt see also sco-build , sco-update user-accounts availability breeze 4. Description provides a list of the accounts to which the specified user belong...

  • Page 137

    User-transcript-update 137 smith@example.Com 2004-01-24t00:59:59.000-07:00 jones@example.Com 2004-01-24t00:59:59.000-07:00 user-transcript-update availability breeze 5. Description use this api to override the score on an item within a curriculum. For example, you could use this api to give the user...

  • Page 138

    138 chapter 4: xml api reference user-update-pwd availability breeze 4. Description changes a user’s password. Parameters password the new password. Password-old the user’s current password. Password-verify a second copy of the new password, for verification. User-id the id of the user. Filters resu...

  • Page 139: Chapter 5

    139 chapter 5 xml results reference this chapter describes the xml tags, data, and status codes returned by the macromedia breeze server in response to an api call. For information about the apis you can call on the server, see chapter 4, “xml api reference,” on page 41 . About returned xml code whe...

  • Page 140

    140 chapter 5: xml results reference if there is no data available for a tag that would normally be returned in response to an api, the tag isn’t returned. In the previous example, if the calling application didn’t specify a logged-in user, there would be no user tag in the returned results. When yo...

  • Page 141

    Alphabetical list of xml tags 141 acl contains information about an access control list. Acl-field-list contains a list of custom fields associated with an access control list. Acl-fields contains information about the custom fields of an access control list. Action the name of an api. Answer-correc...

  • Page 142

    142 chapter 5: xml results reference description a description of a principal. Domain-name the fully qualified domain name of the location of a sco. Duration the duration of a sco. Email a user’s e-mail address. Event contains information about an event. Expanded-scos contains information about the ...

  • Page 143

    Alphabetical list of xml tags 143 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 infor...

  • Page 144

    144 chapter 5: xml results reference 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 maximu...

  • Page 145

    Alphabetical list of xml tags 145 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...

  • Page 146

    146 chapter 5: xml results reference access-key (container) there are two tags named access-key ; they are described in different sections. Description container tag; contains information about a special access key provided by a sco. Attributes acl-id the id of the sco associated with the access key...

  • Page 147

    Access-key-group 147 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 self- registe...

  • Page 148

    148 chapter 5: xml results reference ■ hosted-support ■ learners ■ live-admins ■ seminar-admins ■ user contained tags login , name returned by accesskey-info example principal-id="630" type="group"> course-test1-self-reg-group course-test1-self-reg-group principal-id="630" type="group"> course-test1...

  • Page 149

    Acl-field-list 149 contained tags none (empty tag). Returned by common-info example acl description container tag; contains information about an access control list (acl). Attributes acl-id the id of an acl. Contained tags value returned by acl-field-list example mary acl-field-list description cont...

  • Page 150

    150 chapter 5: xml results reference mike mary acl-fields description container tag; contains information about acl fields. Attributes none. Contained tags field returned by acl-field-info example action description the name of an api. Attributes none. Contained tags none (content only). Returned by...

  • Page 151

    Answer-correct 151 actions description container tag; contains a list of apis. Attributes none. Contained tags action returned by action-list example accesskey-exec accesskey-info action-list ... [other apis listed here] ... User-accounts user-update-pwd answer-correct description the text for a cor...

  • Page 152

    152 chapter 5: xml results reference answer-text description the text of an answer to a quiz question as part of the results returned by a report api. Attributes none. Contained tags none (content only). Returned by report-quiz-answer-distribution , report-quiz-question-response example ecma-262 bod...

  • Page 153

    Contact 153 returned by custom-field-update example any comment goes here common description container tag; contains tags that provide information about the server and the logged-in user. If you call common-info without logging in first, the same information is returned except for the user tag. Attr...

  • Page 154

    154 chapter 5: xml results reference contained tags email , first-name , last-name returned by principal-info example test4-lnagaraj@test.Enang.Com test4 laxmi cookie description the value of the java servlet session cookie, named breezesession. This is the same cookie that you send with every api c...

  • Page 155

    Custom-fields 155 contained tags date-begin , date-created , date-end , date-modified , expired , name , url , url-path returned by report-my-courses example my name admin.Breeze.Example.Com/p38547860/ 2004-02-09t14:40:38.497-08:00 2004-02-09t14:40:44.623-08:00 2004-02-09t14:30:00.000-08:00 2004-02-...

  • Page 156

    156 chapter 5: xml results reference date description the current date and time on the server, in iso 8601 date format. Attributes none. Contained tags none (content only). Returned by common-info example 2004-02-12t15:53:19.797-07:00 date-begin description the date and time that a sco is, or was, s...

  • Page 157

    Date-end 157 returned by report-meeting-attendance example 2004-01-29t00:59:41.470-08:00 date-created description the date and time that a sco was created, in iso 8601 date format. Attributes none. Contained tags none (content only). Returned by accesskey-info , report-active-meeting-presenters , re...

  • Page 158

    158 chapter 5: xml results reference 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 t...

  • Page 159

    Date-time-attempted 159 returned by report-my-courses , report-quiz-definition-questions , sco-contents , sco-info , sco- search 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 ta...

  • Page 160

    160 chapter 5: xml results reference 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 o...

  • Page 161

    Event 161 example 1900-01-02t/+:00:00.000+00:00 email description a user’s e-mail address. Attributes none. Contained tags none (content only). Returned by principal-list , sco-info example tennant@example.Com event description container tag; contains information about an event. Attributes none. Con...

  • Page 162

    162 chapter 5: xml results reference expanded-scos description container tag; contains information about the contents of a sco. Attributes none. Contained tags sco returned by sco-expanded-contents example icon="producer" lang="en" source-sco-id="5413507" display-seq="1" source- sco-type="0"> beginn...

  • Page 163

    File 163 field description container tag; contains information about a new custom field. Attributes field-id the id of the field. Account-id the id of the account. Acl-id the id of the acl. Custom-seq the custom field number. Type the type of the custom field. It must be one of the following values:...

  • Page 164

    164 chapter 5: xml results reference contained tags path returned by sco-upload example 38181499/38111519-1/input/test.Ppt files description container; contains information about uploaded sco files. Attributes none. Contained tags file returned by sco-upload example 38181499/38111519-1/input/test.Pp...

  • Page 165

    Invalid 165 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). Re...

  • Page 166

    166 chapter 5: xml results reference attributes field the name of the parameter that was invalid. Subcode the reason that the parameter was invalid. The following table shows the possible values for this attribute: type the type of the parameter, such as "id" , "long" , or "string" . Contained tags ...

  • Page 167

    Learning-path 167 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 da...

  • Page 168

    168 chapter 5: xml results reference contained tags name returned by learning-path-info example id="38345286" path-type="completion-required"> tester id="38345286" path-type="completion-required"> tester learning-paths description container tag; contains information about learning paths in a curricu...

  • Page 169

    Meeting 169 contained tags none (content only). Returned by common-info , permissions-info , principal-info , principal-list , report-course- takers , report-meeting-attendance , report-quiz-takers example tennant@example.Com meeting description container tag; contains information about a meeting. A...

  • Page 170

    170 chapter 5: xml results reference most-recent-session description the starting time of the most recent session of a meeting. Attributes none. Contained tags none. Returned by report-meeting-summary example 2005-02-28t17:05:54.953-08:00 my-courses description container tag; contains information ab...

  • Page 171

    My-meetings 171 my-events description container tag; contains information about one or more events. Attributes none. Contained tags event returned by report-my-events example 1st event bcassidy02 /e95598585/ 2005-03-05t13:00:00.000-08:00 2005-03-10t13:00:00.000-08:00 true 5d 00:00:00.000 my-meetings...

  • Page 172

    172 chapter 5: xml results reference true 01:00:00.000 name description a user’s name. For example, depending on the context, the tag may contain the name of a person, the name of a group, the name of a sco, an e-mail address, or another kind of name. Attributes none. Contained tags none (content on...

  • Page 173

    Permissions 173 path description the path of an uploaded sco file. Attributes none. Contained tags none. Returned by sco-upload example 38181499/38111519-1/input/test.Ppt permission description contains information about a specific principal and its permissions. Attributes acl-id the id of a specifi...

  • Page 174

    174 chapter 5: xml results reference contained tags principal returned by permissions-info example has-children="false" permission-id="view"> englesberg, ari englesberg@example.Com has-children="false" permission-id="view"> englesberg, ari englesberg@example.Com physical-path description the path on...

  • Page 175

    Preferences 175 time-zone-id the time zone setting. Breeze currently supports the following 75 time zones: japanese ja korean ko time zone setting parameter value international date line west (gmt-12:00) 0 midway island, samoa (gmt-11:00) 1 hawaii (gmt-10:00) 2 alaska (gmt-09:00) 3 pacific time (us ...

  • Page 176

    176 chapter 5: xml results reference sarajevo, skopje, warsaw, zagreb (gmt+01:00) 100 brussels, copenhagen, madrid, paris (gmt+01:00) 105 amsterdam, berlin, bern, rome, stockholm, vienna (gmt+01:00) 110 west central africa (gmt+01:00) 113 bucharest (gmt+02:00) 115 cairo (gmt+02:00) 120 helsinki, kyi...

  • Page 177

    Presentation-name 177 contained tags none. Returned by principal-info example presentation-name description the name of a breeze presentation. Attributes none. Contained tags none (content only). Returned by report-bulk-content-quiz , report-bulk-slide-views example test-quiz seoul (gmt+09:00) 230 o...

  • Page 178

    178 chapter 5: xml results reference principal description contains information about a principal. For general information about principals, see “about principals, scos, and ids” on page 17 . Attributes account-id the id of the account of which the principal is a member. This attribute is returned o...

  • Page 179

    Principal-name 179 contained tags login , name , email , first-name , last-name returned by permissions-info , principal-update , principal-info example primary="false" principal-id="38181502" type="user"> sblye@macromedia.Com sonya blye sblye@macromedia.Com sonya blye primary="false" principal-id="...

  • Page 180

    180 chapter 5: xml results reference contained tags none (content only). Returned by report-course-takers , report-quiz-takers example chiang, ed question description the text of a quiz question. Attributes none. Contained tags none (content only). Returned by report-quiz-interactions , report-surve...

  • Page 181

    Quiz-definition-answers 181 quiz-name description the name of a quiz. Attributes none. Contained tags none (content only). Returned by report-bulk-content-quiz example who is randy johnson? Quiz-definition-answers description container tag; contains one or more row tags, each containing information ...

  • Page 182

    182 chapter 5: xml results reference quiz-definition-questions description container tag; contains one or more row tags, each containing information about a particular quiz question. Attributes none. Contained tags row returned by report-quiz-definition-questions example 2004-01-13t17:09:40.230-08:0...

  • Page 183

    Report-account-meeting-attendance 183 quota description container tag; contains information on the account quotas. Attributes acl-id the id of the account sco. Quota-id the id of a quota. Breeze enforces different quotas, for example, the training concurrent user peak, the download used, the authors...

  • Page 184

    184 chapter 5: xml results reference example contact-id="3"> lraj@macromedia.Com enterprise administrator name> test-mtg-1 2004-07-09t13:00:28.920-07:00 created> 2004-07-09t13:02:55.810-07:00 closed> enterprise administrator name> contact-id="3"> lraj@macromedia.Com enterprise administrator name> te...

  • Page 185

    Report-bandwidth 185 2004-02-17t16:50:00.327-08:00 report-active-meetings description container tag; contains a list of meetings that are currently in progress. Attributes none. Contained tags sco returned by report-active-meetings example 022305 stephanie test /r27873068/ 2005-02-28t16:09:28.510-08...

  • Page 186

    186 chapter 5: xml results reference report-bulk-consolidated-transactions description container tag; contains information about all the transactions in an account. Attributes none. Contained tags row returned by report-bulk-consolidated-transactions example default meeting template /r-182228/ bshar...

  • Page 187

    Report-bulk-content-quiz-results 187 example number="1" question-value="10" answer-id="1"> test-quiz quiz test 1 who is randy johnson? A baseball pitcher with the arizona diamondbacks text> yes number="1" question-value="10" answer-id="1"> test-quiz quiz test 1 who is randy johnson? A baseball pitch...

  • Page 188

    188 chapter 5: xml results reference 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 row returned by report-bulk-course-quiz example number="1" question-value="10" answer-...

  • Page 189

    Report-bulk-meeting 189 returned by report-bulk-course-results example question-number="1" user-response="2"> lraj@macromedia.Com 2004-07-13t10:54:09.030-07:00 00:00:43.017 question-number="1" user-response="2"> lraj@macromedia.Com 2004-07-13t10:54:09.030-07:00 00:00:43.017 question-number="2" user-...

  • Page 190

    190 chapter 5: xml results reference 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 20...

  • Page 191

    Report-bulk-questions 191 232654 2003-10-30t12:14:52.740-08:00 /p30542007/ presentation 181438 bullet animation test.Ppt 2003-07-14t14:52:32.327-07:00 /p77876740/ presentation background 2003-07-14t14:53:08.700-07:00 /p82537206/ presentation huge 2003-07-14t14:54:16.757-07:00 /p39862939/ presentatio...

  • Page 192

    192 chapter 5: xml results reference apples can be or . The name of the grocery store is question> {green,red,bob's} 2005-03-24t15:16:39.030-08:00 apples can be or . The name of the grocery store is question> {j,k,bob's} 2005-03-24t11:52:14.280-08:00 apples can be or . The name of the grocery store ...

  • Page 193

    Report-bulk-users 193 2 2005-03-24t16:37:04.303-08:00 3 2005-03-24t16:37:15.710-08:00 6 2005-03-24t16:38:29.833-08:00 report-bulk-users description container tag; contains data about all the users in an account. Attributes none. Contained tags row returned by report-bulk-users example nson@macromedi...

  • Page 194

    194 chapter 5: xml results reference report-course-status description container tag; contains information about the status of a course. Attributes total-course-completions the total number of courses completed. Total-unique-course-completions the total number of unique courses completed. Num-passed ...

  • Page 195

    Report-meeting-concurrent-users 195 report-meeting-attendance description container tag; contains one or more row tags, each containing information about a user who attended a particular meeting. Attributes none. Contained tags row returned by report-meeting-attendance example survey="0"> bcassaly@m...

  • Page 196

    196 chapter 5: xml results reference example report-meeting-session description container tag, contains information about a meeting. Attributes num-guests the number of participants who entered the meeting as guests rather than registered attendees. Num-participants the total number of participants ...

  • Page 197

    Report-meeting-summary 197 returned by report-meeting-sessions example my meeting 2004-03-05t10:33:09.030-08:00 report-meeting-session-slots description container tag; contains one or more row tags, each containing information about a particular session slot. Attributes none. Contained tags row retu...

  • Page 198

    198 chapter 5: xml results reference num-invitees-attended the number of invited users who attended. Is-public a boolean value indicating whether the room is public ( true ) or not ( false ). Num-guests-attended the number of participants who entered the meeting as guests rather than registered atte...

  • Page 199

    Report-quiz-interactions 199 100-07-7777 report-quiz-answer-distribution description container tag; contains one or more row tags, each indicating how many users selected each answer to the specified quiz question. Attributes none. Contained tags row returned by report-quiz-answer-distribution examp...

  • Page 200

    200 chapter 5: xml results reference returned by report-quiz-interactions example id="17438" score="10"> barry cassidy all question types quiz 2005-03-11t12:04:29.200-08:00 a human being usually has fingers. 10 id="17438" score="10"> barry cassidy all question types quiz 2005-03-11t12:04:29.200-08:0...

  • Page 201

    Report-quiz-question-response 201 percentage-responded="40"> which international standard defines ecmascript? Ecma-262 report-quiz-question-distribution description container tag; contains one or more row tags, each indicating how many users answered a question in the specified quiz correctly. Attri...

  • Page 202

    202 chapter 5: xml results reference returned by report-quiz-question-response example barry cassidy d 2005-03-14t14:20:43.967-08:00 barry cassidy 0 2005-03-14t14:20:43.967-08:00 barry cassidy 2 2005-03-14t14:20:43.967-08:00 barry cassidy c11101ba001b%2eo4e%7e%24kq%2awo2jj110bkebdb1b1ebcb0b0ebbb0b0e...

  • Page 203

    Report-quiz-summary 203 contained tags none (empty tag). Returned by report-quiz-question-totals example num-correct-answers="5" /> report-quiz-results description the number of users who took a specified quiz and their range of scores. Attributes average-score the average of the scores of the users...

  • Page 204

    204 chapter 5: xml results reference example numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> 2005-03-14t14:20:43.967-08:00 80 numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> 2005-03-14t14:20:43.967-08:00 80...

  • Page 205

    Report-sco-slides 205 report-quotas description container tag; contains information about the account quotas. Attributes none. Contained tags quota returned by report-quotas example limit="1000000000"> 2003-08-15t13:12:33.260-07:00 2999-12-31t16:00:00.000-08:00 limit="1000000000"> 2003-08-15t13:12:3...

  • Page 206

    206 chapter 5: xml results reference returned by report-sco-slides example 2004-01-13t16:35:39.517-08:00 2004-01-13t16:35:42.350-08:00 2004-01-13t16:35:44.933-08:00 report-sco-views description container tag; contains one or more row tags, each indicating how many times and how recently the specifie...

  • Page 207

    Report-training-concurrent-users 207 contained tags row returned by report-survey-question-response example enterprise administrator how are you? Fine test1 laxmi how are you? Ok report-training-concurrent-users description indicates the largest number of users who have used the system at the same t...

  • Page 208

    208 chapter 5: xml results reference response description a user’s response to a survey question. Attributes none. Contained tags none (content only). Returned by report-survey-question-response example fine results description container tag; contains all results returned by any api. Attributes none...

  • Page 209

    Sco 209 contained tags the tags contained in the row tag vary widely depending on which api the tag is responding to and may include custom tags. Returned by report-bulk-consolidated-transactions , report-bulk-content-quiz , report-bulk- content-quiz-results , report-bulk-content-slide-views , repor...

  • Page 210

    210 chapter 5: xml results reference 2003-07-10t13:05:42.180+00:00 2003-06-30t19:33:38.317+00:00 another - 06/30/2003 12:33 pm /p62559548/ the following example is returned by the report-active-meetings api: 022305 stephanie test /r27873068/ 2005-02-28t16:09:28.510-08:00 sco-author description conta...

  • Page 211

    Sco-nav 211 slide-count the number of slides in the sco. A value of -1 indicates that the slide count doesn’t apply; for example, if the sco is a meeting rather than a presentation, the slide count is -1. Version the version number of the sco. Width the width of the sco, in pixels. Contained tags da...

  • Page 212

    212 chapter 5: xml results reference returned by sco-nav example user meetings tennant@example.Com sco-search-info description container tag; contains one or more sco tags, each containing information about a sco that matches the specified search text. Attributes none. Contained tags sco returned by...

  • Page 213

    Shortcuts 213 scos description container tag; contains one or more sco tags, each containing information about a sco inside the specified folder. Attributes none. Contained tags sco returned by sco-contents example ppt meeting tests 2004-01-29t06:22:49.157-08:00 my name 2003-08-27t00:00:00.000-07:00...

  • Page 214

    214 chapter 5: xml results reference example http://admin.Breeze.Example.Com http://admin.Breeze.Example.Com ... [other sco tags here.] ... Http://admin.Breeze.Example.Com source-sco description container tag; contains information about the sco for the content of a course. Attributes none. Contained...

  • Page 215

    Status 215 status description a status code returned by the breeze server whenever an api is called. This section provides information about all the status codes and subcodes that breeze can return. Attributes code the status of the api. The following values are possible for this attribute: subcode ...

  • Page 216

    216 chapter 5: xml results reference contained tags invalid returned by all apis. Example time-slot-begin description the start date and time for a meeting session, in iso 8601 date format. Attributes none. Contained tags none (content only). Returned by report-meeting-session-slots example 2004-02-...

  • Page 217

    Url-path 217 time-taken description the time a course was taken. Attributes none. Contained tags none (content only). Returned by report-bulk-course-results example 00:34:23.011 url description a url. Attributes none. Contained tags none (content only). Returned by common-info , report-my-courses ex...

  • Page 218

    218 chapter 5: xml results reference example /r99718924/ user (common-info) description container tag; contains information about a user. Attributes user-id the id of the user. Contained tags login , name returned by common-info example greg erweck gerweck@example.Com user (user-accounts) descriptio...

  • Page 219

    User-last-name 219 user-agent description the host browser information. Attributes none. Contained tags none. Returned by common-info example mozilla/5.0 (windows; u; windows nt 5.1; en-us; rv:1.7.5) gecko/20041107 firefox/1.0 user-first-name description a user’s first name. Attributes none. Contain...

  • Page 220

    220 chapter 5: xml results reference returned by report-bulk-content-slide-views example administrator user-login description the login of a user. Attributes none. Contained tags none. Returned by report-bulk-content-quiz-results example lraj@macromedia.Com user-name description a user name. Attribu...

  • Page 221

    Value 221 users description container tag; contains one or more user tags, each containing information about a user and an account. Attributes none. Contained tags user (user-accounts) returned by user-accounts example james@example.Com 2004-01-24t00:59:59.000-07:00 smith@example.Com 2004-01-24t00:5...

  • Page 222

    222 chapter 5: xml results reference 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. Returne...

  • Page 223: Index

    223 index a access control lists (acls) 18 access keys acquiring 51 special 146, 148 access-key tag 146 access-key-group tag 147 access-keys tag 148 accesskey-exec action 50 accesskey-info action 51 account tag 148 accounts limits 98 listing 136 acl tag 149 acl-field-info action 53 acl-field-list ac...

  • Page 224

    224 index report-disk-usage 96 report-meeting-attendance 97 report-meeting-concurrent-users 98 report-meeting-session 98 report-meeting-session-slots 100 report-meeting-sessions 99 report-meeting-summary 101 report-my-courses 31, 37, 101 report-my-events 31 report-my-meetings 31, 37, 103, 104 report...

  • Page 225

    Index 225 code samples overview 27 parsing returned xml code 34 use of cfml 15 coldfusion markup language. See cfml comma-separated values (csv) 39 comment tag 152 common tag 153 common tasks 27 common-info action 37, 60 contact tag 153 content folder 122 launching 19 relevant, displaying 37 searchi...

  • Page 226

    226 index my-content 37 permissions 19 relevant to current user 130 see also scos g generate reports 39 get and post requests (http) 15, 34 group-id parameters 17 group-membership-update action 63 groups about 17 built-in 17 membership, updating 63 permissions 19 see also principals; users h help sy...

  • Page 227

    Index 227 scheduled 103, 104 schedules for meetings 98 sessions 99 see also scos meetings, attendance attendees in ten-minute period 100 list of users 97 maximum 98 number of attendees 98 summary 101 most-recent-session tag 170 moving scos 127 multiple parameters, specifying overview 16 permissions ...

  • Page 228

    228 index q query strings, building 15 question tag 180 question-text tag 180 questions in quizzes ids, determining 113 listing 108 see also quizzes quiz-definition-answers tag 181 quiz-definition-questions tag 182 quiz-name tag 181, 182 quizzes answers, distribution of 111 answers, text of 152 date...

  • Page 229

    Index 229 report-quiz-summary tag 203 report-quiz-takers action 39, 116 report-quiz-takers tag 204 report-quotas action 117 report-quotas tag 205 report-sco-slides action 118 report-sco-slides tag 205 report-sco-views action 119 report-sco-views tag 206 report-survey-question-response action 120 rep...

  • Page 230

    230 index status codes invalid 165 overview 215 xml results 29 status tag 34, 139, 215 students, enrolled in course 95 students, listing 95 subfolders, listing 122 summaries of quiz results 115 synchronizing with directory services 33 t tables, displaying 38 tags access-key 146 access-key-group 147 ...

  • Page 231

    Index 231 report-bulk-users 193 report-course-status 194 report-disk-usage 194 report-meeting-attendance 195 report-meeting-concurrent-users 195 report-meeting-session 196 report-meeting-session-slots 197 report-meeting-sessions 196 report-meeting-summary 197 report-principal-list 198 report-quiz-an...

  • Page 232

    232 index listing 34 logging in 36, 66 logging out 68 meeting attendance, maximum 98 meetings, attending 97 meetings, scheduled 37, 103, 104 passwords, changing 137, 138 permissions 68 quiz takers 116 updating information for 36 see also principals; groups users tag 221 v value tag 221 verifying ide...