Summary of BREEZE-USING THE BREEZE XML WEB SERVICES

  • Page 1

    Using the breeze xml web services.

  • Page 2

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

  • Page 3: Contents

    3 contents introduction: before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 guide to instructional media. . . . . . . . . . . . . . . . ....

  • Page 4

    4 contents common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-field-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-fields . . . . . . . . . . . . . . . . . . . ...

  • Page 5

    Contents 5 report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . ...

  • Page 6

    6 contents expired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 first-name . . . . . . . . . . . . . ....

  • Page 7

    Contents 7 report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 report-quiz-interactions . . . . . . . . . . . . . . . . ...

  • Page 8

    8 contents.

  • 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 guide provides information on how to call xml web services (actions) on the breeze server from your external system and how to interpr...

  • Page 10

    10 introduction: before you begin • 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 ...

  • Page 11

    Typographical conventions 11 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...

  • Page 12

    12 introduction: before you begin.

  • Page 13: Chapter 1

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

  • Page 14

    14 chapter 1: architecture overview 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 macrome...

  • Page 15

    About parameters 15 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...

  • Page 16

    16 chapter 1: architecture overview 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 a...

  • Page 17

    About security 17 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 a file shared using the file-sharing pod within a meeting. Pod a plug-in for a meeting. Logos an image (such ...

  • Page 18

    18 chapter 1: architecture overview 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 pe...

  • Page 19

    About security 19 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 ...

  • Page 20

    20 chapter 1: architecture overview about public access permissions there is a special principal id which, instead of being a number, has the value "public- access" . This id sets the default access setting for everyone, whether they are logged in or not. You can assign any of the following permissi...

  • 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 you are enrolled in. This same api used with a filter on the course name, for example report-my-co...

  • 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 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 lis...

  • Page 25

    Where to go from here 25 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.750...

  • Page 26

    26 chapter 2: working with filters.

  • 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 actions on the breeze server and then parse the xml tags ...

  • Page 28

    28 chapter 3: common tasks • 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 “...

  • Page 29

    Integrating breeze with a directory service 29 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 co...

  • Page 30

    30 chapter 3: common tasks 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 ...

  • Page 31

    Integrating breeze with a directory service 31 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 32

    32 chapter 3: common tasks 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 las...

  • Page 33

    Integrating breeze with a portal 33 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 pas...

  • Page 34

    34 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 action, using the folder’s sco id. The following action provides a list of the cont...

  • Page 35

    Generating reports 35 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 o...

  • Page 36

    36 chapter 3: common tasks.

  • Page 37: Chapter 4

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

  • Page 38

    38 chapter 4: action reference 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...

  • Page 39

    Alphabetical action listing 39 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-dis...

  • Page 40

    40 chapter 4: action reference 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...

  • Page 41

    Accesskey-exec 41 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 speci...

  • Page 42

    42 chapter 4: action reference 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-...

  • Page 43

    Acl-preference-update 43 the following sample results are returned when a group exists and includes an accesskey-group element: principal-id="630" type="group"> course-test1-self-reg-group course-test1-self-reg-group principal-id="630" type="group"> course-test1-self-reg-group course-test1-self-reg-...

  • Page 44

    44 chapter 4: action reference (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 ci...

  • Page 45

    Acl-preference-update 45 (gmt+02:00) harare, pretoria 140 (gmt+03:00) moscow, st. Petersburg, volgograd 145 (gmt+03:00) kuwait, riyadh 150 (gmt+03:00) nairobi 155 (gmt+03:00) baghdad 158 (gmt+03:30) tehran 160 (gmt+04:00) abu dhabi, muscat 165 (gmt+04:00) baku, tbilisi, yerevan 170 (gmt+04:30) kabul...

  • Page 46

    46 chapter 4: action reference filters results cannot be filtered or sorted. Returned elements none. Sample results action-list description returns a list of web service actions. Caution: not all actions in this list are documented, and not all documented actions are in this list. Parameters accessk...

  • Page 47

    Custom-field-update 47 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. Para...

  • Page 48

    48 chapter 4: action reference field-id the id of the field to be updated (can be obtained by calling action custom- fields ). This parameter needs to be specified only when updating an existing field. Name the name of the custom field (may be 1 to 60 characters long). Comments any comments on the c...

  • Page 49

    Custom-fields-delete 49 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 this is optional type="re...

  • Page 50

    50 chapter 4: action reference 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...

  • Page 51

    Login 51 url loginurl = new url(baseurl + "api/xml?Accesskey=" + accesskey + "&action=login&login=" + login + "&password=" + password); urlconnection conn=loginurl.Openconnection(); conn.Connect(); inputstream resultstream=conn.Getinputstream(); document doc=new saxbuilder(false).Build(resultstream)...

  • Page 52

    52 chapter 4: action reference 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 ...

  • Page 53

    Permissions-info 53 filters the following table lists the fields that the data can be filtered and sorted on: note: principals’ logged-in-access and public-access are always returned in the data set, irrespective of the filter restrictions. For more information about filtering and sorting, see chapt...

  • Page 54

    54 chapter 4: action reference 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 acc...

  • Page 55

    Principal-info 55 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 t...

  • Page 56

    56 chapter 4: action reference 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.Com test4 laxmi principal-id="653" typ...

  • Page 57

    Principal-update 57 for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements principal-list sample results children="false" is-primary="false" is-hidden="0"> enterprise administrator lnagaraj@macromedia.Com lnagaraj@macromedia.Com childr...

  • Page 58

    58 chapter 4: action reference 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...

  • Page 59

    Report-account-meeting-attendance 59 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 . Paramet...

  • Page 60

    60 chapter 4: action reference returned elements report-account-meeting-attendance sample results contact-id="3"> lnagaraj@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="...

  • Page 61

    Report-active-meetings 61 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 inc...

  • Page 62

    62 chapter 4: action reference returned elements report-active-meetings sample results qt load 2003-09-02t14:00:58.330-07:00 take 2 2003-09-02t14:45:25.273-07:00 report-bandwidth description indicates the total bandwidth consumed in the current account since the account was created, in bytes. Parame...

  • Page 63

    Report-bulk-content-quiz 63 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 ret...

  • Page 64

    64 chapter 4: action reference 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-resu...

  • Page 65

    Report-bulk-content-slide-views 65 lnagaraj@macromedia.Com 2004-07-13t10:52:23.780-07:00 attempted> 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 ...

  • Page 66

    66 chapter 4: action reference slide-number="2"> lnagaraj@macromedia.Com enterprise administrator test-slide 2004-06-30t11:46:12.500-07:00 slide-number="2"> lnagaraj@macromedia.Com enterprise administrator test-slide 2004-06-30t11:46:12.500-07:00 report-bulk-course-quiz description returns informati...

  • Page 67

    Report-bulk-course-results 67 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...

  • Page 68

    68 chapter 4: action reference 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 . Repor...

  • Page 69

    Report-bulk-meeting-attendance 69 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 ...

  • Page 70

    70 chapter 4: action reference 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...

  • Page 71

    Report-course-takers 71 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...

  • Page 72

    72 chapter 4: action reference sample results percentage-score="" time-taken="" certificate="" answered-survey="0"> lnagaraj@macromedia.Com enterprise administrator percentage-score="" time-taken="" certificate="" answered-survey="0"> lnagaraj@macromedia.Com enterprise administrator percentage-score...

  • Page 73

    Report-meeting-attendance 73 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 accesske...

  • Page 74

    74 chapter 4: action reference sample results answered-survey="0"> lnagaraj@macromedia.Com enterprise administrator test-mtg-2 2004-07-09t14:29:49.217-07:00 2004-07-09t14:33:45.827-07:00 enterprise administrator answered-survey="0"> lnagaraj@macromedia.Com enterprise administrator test-mtg-2 2004-07...

  • Page 75

    Report-meeting-sessions 75 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 s...

  • Page 76

    76 chapter 4: action reference filters the following table lists the fields that the data can be filtered and sorted on: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-meeting-sessions sample results my meeting 2004-03-0...

  • Page 77

    Report-meeting-summary 77 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.000-08:...

  • Page 78

    78 chapter 4: action reference 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 in...

  • Page 79

    Report-my-meetings 79 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; ...

  • Page 80

    80 chapter 4: action reference 2003-07-14t23:00:00.000-07:00 2003-07-15t09:00:00.000-07:00 true permission-id="presenter" active-participants="0"> new skipper admin.Breeze.Example.Com /p50473388/ 2004-01-29t05:30:00.000-08:00 2004-01-29t05:30:00.000-08:00 true permission-id="presenter" active-partic...

  • Page 81

    Report-quiz-answer-distribution 81 sample results primary="false"> enterprise administrator lnagaraj@macromedia.Com /> primary="false"> enterprise administrator lnagaraj@macromedia.Com /> /> primary="true"> account administrators account administrators primary="true"> account administrators account ...

  • Page 82

    82 chapter 4: action reference 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: a5="0" a6="0" a7="0" a8="0" total="2"> who is randy johnson ? A5="0" a6="0" a7="...

  • Page 83

    Report-quiz-definition-questions 83 sample results iso-9000 report-quiz-definition-questions description provides information about each question in a quiz. When the specified sco doesn’t contain a quiz, an empty quiz-definition-questions element is returned. Parameters accesskey the access key for ...

  • Page 84

    84 chapter 4: action reference filters the following table lists the fields that the data can be filtered and sorted on: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements quiz-definition-questions sample results 2004-01-13t17:09:4...

  • Page 85

    Report-quiz-interactions 85 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. Filters...

  • Page 86

    86 chapter 4: action reference 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 deter...

  • Page 87

    Report-quiz-question-distribution 87 iso-9000 percentage-responded="30"> which international standard defines ecmascript? Rfc 821 percentage-responded="30"> which international standard defines ecmascript? Rfc 821 percentage-responded="20"> which international standard defines ecmascript? Ecma-976 p...

  • Page 88

    88 chapter 4: action reference for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-quiz-question-distribution sample results num-incorrect="0" percentage-correct="100" score="20"> what is 2+2? Num-incorrect="0" percentage-cor...

  • Page 89

    Report-quiz-question-totals 89 for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-quiz-question-response sample results 5 5 4 report-quiz-question-totals description indicates, for the specified quiz question, the total numb...

  • Page 90

    90 chapter 4: action reference sample results num-correct-answers="5" /> 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...

  • Page 91

    Report-quiz-takers 91 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 i...

  • Page 92

    92 chapter 4: action reference status="user-failed" score="0" percentage-score="0" time-taken="4656" certificate="" answered-survey="0"> quiz-course lnagaraj@macromedia.Com 2004-07-13t10:55:28.763-07:00 enterprise administrator status="user-failed" score="0" percentage-score="0" time-taken="4656" ce...

  • Page 93

    Report-sco-slides 93 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 i...

  • Page 94

    94 chapter 4: action reference 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. I...

  • Page 95

    Report-training-concurrent-users 95 filters the following table lists the fields that the data can be filtered and sorted on: for more information about filtering and sorting, see chapter 2, “working with filters,” on page 21 . Returned elements report-survey-question-response sample results enterpr...

  • Page 96

    96 chapter 4: action reference sample results limit="1000000000"> professor test account limit="1000000000"> 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-...

  • Page 97

    Sco-contents 97 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 acces...

  • Page 98

    98 chapter 4: action reference 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.000-08:00 2004-01-29t01:35:26.433-08:00 1900-01-02t/*:00:00.000+00:00 sco-delete ...

  • Page 99

    Sco-info 99 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 ...

  • Page 100

    100 chapter 4: action reference l 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 200...

  • Page 101

    Sco-nav 101 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 102

    102 chapter 4: action reference 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 ...

  • Page 103

    Sco-shortcuts 103 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 t...

  • Page 104

    104 chapter 4: action reference 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 el...

  • Page 105

    Sco-update 105 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 “ab...

  • Page 106

    106 chapter 4: action reference 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 dat...

  • Page 107

    Sco-update 107 the following sample xml is returned when a presentation sco is created: content" tree-id="11" sco-data-id="2154"> sw macr /p74161709/ testxmlapipreso-new laxmi n testapi-preso-new to update the title, summary, speaker name, title, language, and company, replace the parameter folder-i...

  • Page 108

    108 chapter 4: action reference 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-up...

  • Page 109

    Trees-info 109 note: call the action sco-info to obtain the latest sco status. The sco status will initially be in- progress, which means the content is being built. When the status becomes active, the content has finished building and is now accessible. Parameters accesskey the access key for your ...

  • Page 110

    110 chapter 4: action reference returned elements trees sample results nagarajan.Macromedia.Com nagarajan.Macromedia.Com nagarajan.Macromedia.Com nagarajan.Macromedia.Com nagarajan.Macromedia.Com user-accounts description provides a list of the accounts to which the specified user belongs. In an ent...

  • Page 111

    User-update-pwd 111 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.000-07:00 user-update-pwd description changes a user’s password. Parameters accesskey the access key for your account. Note: the ac...

  • Page 112

    112 chapter 4: action reference.

  • Page 113: Chapter 5

    113 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 whe...

  • Page 114

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

  • Page 115

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

  • Page 116

    116 chapter 5: xml results reference 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 prefere...

  • Page 117

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

  • Page 118

    118 chapter 5: xml results reference 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 th...

  • Page 119

    Access-key (container) 119 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. Action i...

  • Page 120

    120 chapter 5: xml results reference 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 vb7gmg6ohtz4y7k...

  • Page 121

    Account 121 example principal-id="630" type="group"> course-test1-self-reg-group course-test1-self-reg-group principal-id="630" type="group"> course-test1-self-reg-group course-test1-self-reg-group access-keys description container tag; contains one or more access keys. Attributes none. Contained ta...

  • Page 122

    122 chapter 5: xml results reference 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-l...

  • Page 123

    Body 123 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 non...

  • Page 124

    124 chapter 5: xml results reference returned by report-quiz-answer-distribution , report-quiz-definition-answers , report-quiz-definition-questions , report-quiz-question-distribution , report-quiz-question-response example comment description any comments on the custom field (may be 0 to 60 charac...

  • Page 125

    Cookie 125 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.Com test4 laxmi cookie descrip...

  • Page 126

    126 chapter 5: xml results reference example breezm5qtgnye46zpckbf.Marianne course description container tag; contains information about a course. Attributes sco-id the id of the course. Status indicates whether a course is active. The possible values are "no-content" , which indicates that the cour...

  • Page 127

    Date-begin 127 example department this is optional type="required"> ssn type="required"> 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.797-07:00 date-begi...

  • Page 128

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

  • Page 129

    Date-modified 129 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...

  • Page 130

    130 chapter 5: xml results reference contained tags none (content only). 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 is...

  • Page 131

    Duration 131 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...

  • Page 132

    132 chapter 5: xml results reference 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 sc...

  • Page 133

    First-name 133 custom-seq the custom field number. Type the type of the custom field. It must be one of the following values: contained tags comment , name , value note: not all tags are returned by all actions. Returned by custom-field-update example type="optional"> none manager 411 type="optional...

  • Page 134

    134 chapter 5: xml results reference 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 tag...

  • Page 135

    Last-name 135 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 none (empty tag). Retur...

  • Page 136

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

  • Page 137

    My-courses 137 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. Attributes active-participants the...

  • Page 138

    138 chapter 5: xml results reference 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.000-08:00 /p38547860/ true my-meetings descriptio...

  • Page 139

    Permission 139 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). Returned by permissions-info , prin...

  • Page 140

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

  • Page 141

    Preferences 141 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 acl-id the id of the user for whom the preferenc...

  • Page 142

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

  • Page 143

    Preferences 143 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, kolk...

  • Page 144

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

  • Page 145

    Principal-custom-field-values 145 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. Contact-id the id for the contact information associated with the user. This value is nu...

  • Page 146

    146 chapter 5: xml results reference principal-list description container tag; contains one or more principal tags. Attributes none. Contained tags principal returned by principal-list example is-primary="true" is-hidden="0"> account administrators account administrators account administrators group...

  • Page 147

    Quiz-name 147 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...

  • Page 148

    148 chapter 5: xml results reference 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. Contained tags row returned by report-quiz-defin...

  • Page 149

    Quota 149 example 2004-01-13t17:09:40.230-08:00 2004-01-13t17:09:40.230-08:00 quiz-name description the name of a quiz. Attributes none. Contained tags none (content only). Returned by report-bulk-content-quiz example quiz test 1 quota description container tag; contains information on the account q...

  • Page 150

    150 chapter 5: xml results reference contained tags date-begin , date-end returned by report-quotas example limit="1000000000"> 1999-12-31t16:00:00.000-08:00 2999-12-31t16:00:00.000-08:00 limit="1000000000"> 1999-12-31t16:00:00.000-08:00 2999-12-31t16:00:00.000-08:00 report-account-meeting-attendanc...

  • Page 151

    Report-active-meetings 151 2004-07-09t14:33:43.547-07:00 closed> enterprise administrator name> 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-presen...

  • Page 152

    152 chapter 5: xml results reference 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. Attributes total the total amount of bandwidth, in bytes. Containe...

  • Page 153

    Report-bulk-content-quiz-results 153 a baseball pitcher with the arizona diamondbacks text> yes number="1" question-value="10" answer-id="2"> test-quiz quiz test 1 who is randy johnson ? A basketball player with the new jersey nets no number="1" question-value="10" answer-id="2"> test-quiz quiz test...

  • Page 154

    154 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 155

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

  • Page 156

    156 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 157

    Report-course-status 157 example number="1"> lnagaraj@macromedia.Com enterprise administrator test-slide 2004-06-30t11:46:10.280-07:00 number="1"> lnagaraj@macromedia.Com enterprise administrator test-slide 2004-06-30t11:46:10.280-07:00 number="2"> lnagaraj@macromedia.Com enterprise administrator te...

  • Page 158

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

  • Page 159

    Report-meeting-session 159 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 exa...

  • Page 160

    160 chapter 5: xml results reference example num-participants="0" num-guests="0"> mymeeting 2004-01-29t00:30:00.000-08:00 2004-01-29t00:30:00.000-08:00 num-participants="0" num-guests="0"> mymeeting 2004-01-29t00:30:00.000-08:00 2004-01-29t00:30:00.000-08:00 report-meeting-sessions description conta...

  • Page 161

    Report-principal-list 161 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.000-08:00 report-meeting-summary description indicates how many users were invited to the specified meeting and how many invitees and guests actually attend...

  • Page 162

    162 chapter 5: xml results reference example enterprise administrator lnagaraj@macromedia.Com account administrators account administrators test1 laxmi test1-laxmi@test.Enang.Com engg 100-07-7777 report-quiz-answer-distribution description container tag; contains one or more row tags, each indicatin...

  • Page 163

    Report-quiz-question-answer-distribution 163 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. Attri...

  • Page 164

    164 chapter 5: xml results reference example percentage-responded="10"> which international standard defines ecmascript? Iso-9000 percentage-responded="10"> which international standard defines ecmascript? Iso-9000 percentage-responded="30"> which international standard defines ecmascript? Rfc 821 p...

  • Page 165

    Report-quiz-question-totals 165 percentage-correct="40" score="20"> which international standard defines ecmascript? Percentage-correct="40" score="20"> report-quiz-question-response description container tag; contains one or more row tags, each describing an answer that a user gave to a particular ...

  • Page 166

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

  • Page 167

    Report-quiz-takers 167 contained tags none (empty tag). Returned by report-quiz-summary example passingscore="0" /> 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. Conta...

  • Page 168

    168 chapter 5: xml results reference report-quotas description container tag; contains information about the account quotas. Attributes none. Contained tags quota returned by report-quotas example limit="1000000000"> 1999-12-31t16:00:00.000-08:00 2999-12-31t16:00:00.000-08:00 limit="1000000000"> 199...

  • Page 169

    Report-survey-question-response 169 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 ex...

  • Page 170

    170 chapter 5: xml results reference 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. Limit the maximum number of users who can use the s...

  • Page 171

    Row 171 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 contain...

  • Page 172

    172 chapter 5: xml results reference 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 documentati...

  • Page 173

    Sco-name 173 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 s...

  • Page 174

    174 chapter 5: xml results reference 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-na...

  • Page 175

    Scos 175 example length="20000"> quiz 1 /p92628681/ 2003-11-26t22:52:28.973-08:00 2003-11-26t22:52:37.867-08:00 pat tennant 1 4 length="20000"> quiz 1 /p92628681/ 2003-11-26t22:52:28.973-08:00 2003-11-26t22:52:37.867-08:00 pat tennant 1 4 scos description container tag; contains one or more sco tags...

  • Page 176

    176 chapter 5: xml results reference 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 b...

  • Page 177

    Status 177 example learning-time="" sco-data-id="586762" sco-id="586760" source-sco-id="" status="active" tree-id="181225" type="presentation"> 2004-02-27t10:31:06.717-08:00 2004-02-27t10:52:58.217-08:00 simple test presentation math test /p60802018/ learning-time="" sco-data-id="586762" sco-id="586...

  • Page 178

    178 chapter 5: xml results reference subcode sometimes used to provide more detail of the status of the action. For example, subcode values are used to differentiate between different situations in which code is set to no-access . The following values are possible for this attribute: contained tags ...

  • Page 179

    Tree 179 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 ...

  • Page 180

    180 chapter 5: xml results reference 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.Macr...

  • Page 181

    User (common-info) 181 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. Cont...

  • Page 182

    182 chapter 5: xml results reference 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 exam...

  • Page 183

    User-name 183 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-r...

  • Page 184

    184 chapter 5: xml results reference 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 200...

  • Page 185

    View-date-time 185 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-c...

  • Page 186

    186 chapter 5: xml results reference.

  • Page 187: Index

    187 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-preferen...

  • Page 188

    188 index 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...

  • Page 189

    Index 189 cookies. See breezesession cookies course tag 126 course-admins primary group 16 courses about 16 enrolled students 71 launching 20 listing 33, 35, 78 see also scos creating administrative users 29 meetings 35 principals 57 query strings 15 scos 104 users 31 credentials, security 17, 50 cs...

  • Page 190

    190 index 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 ...

  • Page 191

    Index 191 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 i...

  • Page 192

    192 index 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-acc...

  • Page 193

    Index 193 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...

  • Page 194

    194 index 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-m...

  • Page 195

    Index 195 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...

  • Page 196

    196 index.