manualshive.com logo in svg

MACROMEDIA BREEZE 5, Руководство по интеграции

"MACROMEDIA BREEZE 5" - это программное обеспечение для онлайн-вебинаров и виртуальных конференций. Здесь вы можете бесплатно скачать руководство пользователя, чтобы получить полное понимание всех функций и возможностей продукта. Скачать мануал можно на manualshive.com. Не упустите возможность ознакомиться с этим удивительным инструментом!

Поделиться
Скачать
background image

3

CONTENTS

INTRODUCTION: 

Before You Begin

 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
What’s new in the Breeze XML APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
What’s changed in the Breeze XML APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Guide to instructional media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Additional resources  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Typographical conventions  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

CHAPTER 1: 

Using the Breeze XML APIs

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Data flow  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Calling an API on the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
About parameters  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
About principals, SCOs, and IDs  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CHAPTER 2: 

Working with Filters

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

About filters  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About sort filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Special filter scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Filter reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Testing code in the browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Where to go from here  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CHAPTER 3: 

Common Tasks

 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Calling your first API  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Logging in to Breeze . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Creating a new user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding a user to a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Displaying a user’s meetings, courses, and events   . . . . . . . . . . . . . . . . . . . . . . . . . 31
Creating a meeting  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creating a meeting from a template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creating and managing learning paths  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Integrating Breeze with a directory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Integrating Breeze with a portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Generating reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Содержание BREEZE 5

Страница 1: ...Breeze Integration Guide ...

Страница 2: ...e links only as a convenience and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third party sites Copyright 1997 2005 Macromedia Inc All rights reserved This manual may not be copied photocopied reproduced translated or converted to any electronic or machine readable form in whole or in part without written approval from Ma...

Страница 3: ...ity 18 CHAPTER 2 Working with Filters 21 About filters 21 About sort filters 23 Special filter scenarios 23 Filter reference 24 Testing code in the browser 25 Where to go from here 26 CHAPTER 3 Common Tasks 27 Calling your first API 28 Logging in to Breeze 29 Creating a new user 31 Adding a user to a group 31 Displaying a user s meetings courses and events 31 Creating a meeting 32 Creating a meeti...

Страница 4: ...rmissions update 70 principal info 71 principal list 73 principal list by field 74 principal update 75 principals delete 76 report account meeting attendance 77 report active meeting presenters 78 report active meetings 79 report bandwidth 79 report bulk consolidated transactions 80 report bulk content quiz 81 report bulk content quiz results 82 report bulk content slide views 83 report bulk cours...

Страница 5: ...iz question response 113 report quiz question totals 115 report quiz summary 115 report quiz takers 116 report quotas 117 report sco slides 118 report sco views 119 report survey question response 120 sco build 121 sco contents 122 sco delete 123 sco expanded contents 124 sco info 125 sco move 127 sco nav 127 sco search 128 sco shortcuts 130 sco update 131 sco upload 135 user accounts 136 user tra...

Страница 6: ...e last taken 158 date modified 158 date taken 159 date time attempted 159 description 160 domain name 160 duration 160 email 161 event 161 expanded scos 162 expired 162 field 163 file 163 files 164 first name 164 hit 165 host 165 invalid 165 last name 166 last viewed 167 last viewed date 167 learning path 167 learning paths 168 login 168 meeting 169 most recent session 170 my courses 170 my events...

Страница 7: ... quiz results 188 report bulk meeting 189 report bulk meeting attendance 190 report bulk objects 190 report bulk questions 191 report bulk slide views 192 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 sessions 196 report meeting session slots 197 report meeting summary...

Страница 8: ... data 210 sco name 211 sco nav 211 sco search info 212 scos 213 shortcuts 213 source sco 214 status 215 time slot begin 216 time slot end 216 time taken 217 url 217 url path 217 user common info 218 user user accounts 218 user agent 219 user first name 219 user last name 219 user login 220 user name 220 users 221 value 221 version 222 view date time 222 INDEX 223 ...

Страница 9: ...program using a server language such as Macromedia ColdFusion Markup Language CFML What s new in the Breeze XML APIs Custom field APIs let you add update and get information about custom fields acl field info acl field list acl field update New Report APIs let you gather data from the Breeze server report bulk consolidated transactions report bulk objects report bulk questions report bulk slide vi...

Страница 10: ...ort meeting session report meeting session slots report principal list report quiz answer distribution report quiz definition answers report quiz definition questions report quiz question totals Guide to instructional media Breeze contains a variety of media to help you quickly learn how to use the product In addition to this manual the following electronic manuals and online help systems are avai...

Страница 11: ...PowerPoint by selecting Breeze Help Note The relevance of these guides to users depends on the applications installed on the Breeze Presentation platform the type of user such as meeting content manager information technology engineer or course presenter and the user s Breeze account permissions Additional resources The following list contains some useful resources that are available on the web Th...

Страница 12: ...phical 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 names of tags and names of attributes Boldface font indicates a verbatim entry ...

Страница 13: ... HTTPS to call APIs on the server and to receive results formatted as XML code You can use the web services to add Breeze management and reporting capabilities to your external system To call the Breeze XML APIs you can use any language that can use XML over HTTP Note Breeze doesn t currently support Simple Object Access Protocol SOAP This chapter describes the flow of data between the Breeze serv...

Страница 14: ... web server finds the relevant page and passes it to the application server 3 The application server parses and executes the ColdFusion code contained in the page Step 2 Web server finds page and passes it to application server Step 4 Application server calls API on Breeze server Step 5 Breeze server returns XML data to application server Step 6 Application server inserts data in page and then pas...

Страница 15: ... about additional parameters for a given API see the documentation for that API in Chapter 4 XML API Reference on page 41 You can send the parameters to the server in either of the following ways Create a query string a URL that includes query parameters and send it to the server as an HTTP GET or POST request with the HTTP content type set to application x www form urlencoded When you use this ap...

Страница 16: ...plication you may want to authenticate as that user and call APIs using that user s credentials while also keeping an administrative user logged in to perform tasks that require higher levels of permissions For more information about security in Breeze see About security on page 18 About parameters For most APIs you can specify one or more additional parameters The action parameter is required For...

Страница 17: ... User Guide A SCO is a Breeze document such as a meeting or an event folders are also SCOs Breeze includes the following SCO types Each principal and SCO has a unique ID number When you call an API that uses an entity s ID as a parameter the parameter name indicates what kind of entity the ID belongs to but the ID remains the same regardless of the parameter name Parameter names for IDs include ac...

Страница 18: ...al has for a particular SCO is called an access control list or ACL An ACL is an object that is capable of having permission mappings between the object and a principal but it may not have any mappings at all An ACL consists of three pieces of information the ID of a SCO principal or account usually referred to in this context as an ACL ID the ID of a principal and a keyword that indicates what th...

Страница 19: ... are giving access to their account which presents a security risk Permission Description Denied The principal cannot view access or manage the SCO You cannot specify this permission on meetings or courses Host For meetings only The host of a meeting This permission lets the principal create or present the meeting even if the principal doesn t have View permission on the parent folder of the meeti...

Страница 20: ... name as the Breeze server Also if your application server is a J2EE servlet environment such as Macromedia ColdFusion or Java the application server might also use a cookie named BREEZESESSION which results in potential conflicts between Breeze and the application server You can simply open the URL and require the user to log in again This approach is more secure than the others but can result in...

Страница 21: ...at match Filters work with action calls to modify or organize the data that the Breeze server returns Filters help you select data exclude data and even sort the data you need to see For example you can request all your courses or use a filter to select only courses that include the word Java you can list all users or select only users with the last name Smith and sort by their login name To use a...

Страница 22: ... 8601 format For example May 28 2004 is expressed as 2004 05 28 and 4 23 pm on May 28 2004 is expressed 2004 05 28T16 23 00 000 Starting with the year you can use as much of the date as you need to filter the best result Using a value of 2004 returns all items that match the same year which is probably not a good use of filters You can retrieve everything that happened in a month by specifying the...

Страница 23: ...For specific information about sort and filter options for individual actions see their entries in Chapter 4 XML API Reference on page 41 Filtering data that has a type field You can filter out or display only entries with a combination of matching types For example the following filter displays only the types folder and meeting filter type folder filter type meeting The following example shows al...

Страница 24: ...se 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 the following example shows Type Modifier FieldName Value The following table lists all the filter types and modifiers that you can use with Breeze Type Modifier Description filter none Field must match value exactly filter like Field must contain value filter out Fi...

Страница 25: ...mycompany com http breezedev mycompany com api xml action report my courses filter like name filter filter like description date The result in the browser should look similar to the following xml version 1 0 encoding utf 8 results status code ok my courses course sco id 2649026 status active type course name Understanding Filters Part 2 name description Second course in the series covering importa...

Страница 26: ...ource Center has an article called Working with Filters that describes how to build a sample application that uses filters to search and sort a list of courses In the article you learn how to use filters with Breeze web services by working through a simple example that retrieves the list of enrolled courses for a user and lets the user search and sort the list It also explains the different ways t...

Страница 27: ...e task descriptions include sample code The syntax for calling an API is consistent for all APIs so you can use the sample code from tasks that include it as models for code to perform other tasks For detailed information about each API and each XML tag see Chapter 4 XML API Reference on page 41 and Chapter 5 XML Results Reference on page 139 The following tasks are covered in this chapter Calling...

Страница 28: ...e account For example breeze yourcompany com The name of the API you want to call For a complete list of APIs see XML API Reference on page 41 To call a Breeze API in a browser 1 Open a browser 2 Enter the address of the Breeze server in the browser s address bar Append the action parameter in a query string http breeze example com api xml action action_name 3 Press Enter Windows or Return Macinto...

Страница 29: ... api xml action login login FORM username password FORM password method GET dump the response into a variable and then into an XML object cfset response CFHTTP FileContent cfset xml XMLParse response get the BREEZESESSION id from the header cfset loginHeader CFHTTP header cfset loginCookie ListLast ListFirst loginHeader cfif xml XmlRoot status XMLAttributes code EQ OK Login succeeded cfhttp url ba...

Страница 30: ...mps the header information from the cfhttp call into the loginHeader variable The second line parses the header to pull out the value of the BREEZESESSION cookie and store it in the loginCookie variable cfif xml XmlRoot status XMLAttributes code EQ OK Login succeeded Checks whether the status code attribute in the XML response is ok cfhttp url baseurl api xml action report my meetings session logi...

Страница 31: ...new user or a current user and grab the value of principal id 3 Call group membership update and pass it the principal id of the user you want to add to the group as in the following example http breezeserveraddress api xml action group membership update group id 1222 principal id 1822 is member true Note the following Pass in the principal id for the user you want to add to this group Get the gro...

Страница 32: ...code ok shortcuts sco tree id 181230 sco id 181576 type my meetings domain name http admin breeze example com domain name sco sco tree id 181230 sco id 181577 type my meeting templates domain name http admin breeze example com domain name sco sco tree id 181227 sco id 181412 type my content domain name http admin breeze example com domain name sco sco tree id 181225 sco id 181225 type content doma...

Страница 33: ... the information from the directory service is correct and up to date To synchronize Breeze with the directory service 1 Log in by calling the login API on the Breeze server specifying the login name and password of an account administrator Examine the returned HTTP headers to find the value of the BREEZESESSION cookie which you need when calling subsequent APIs Note Consider creating an administr...

Страница 34: ...he query parameters remain the same as if you were using GET however 4 Make sure that the API completed successfully by parsing the returned XML to ensure that the value of the status tag s code attribute is set to ok If your code must be robust you should check the status tag in the returned XML after every API 5 If the status code is ok search the returned list of principals to find all principa...

Страница 35: ...wlast Doe cfhttp url baseurl api xml action principal update first name newfirst last name newlast has children 0 login newlogin type user method post cfhttpparam type Cookie name BREEZESESSION value loginCookie cfhttp Check for an okay status result cfset xml XmlParse cfhttp FileContent cfset resultsElement XmlSearch xml status code ok cfif ArrayLen resultsElement neq 1 No status code ok found Ch...

Страница 36: ...l XmlParse cfhttp FileContent cfset firstElement XmlSearch xml results contact first name cfset firstName firstElement 1 XmlText cfset lastElement XmlSearch xml results contact last name cfset lastName lastElement 1 XmlText Add code here to set the new values for first name and last name call principal update and check for an ok status code Integrating Breeze with a portal Suppose you have a porta...

Страница 37: ...all the meetings the user has signed up to attend 1 Log in as the user 2 Call the report my meetings API 3 Parse the returned XML and display the results For more information about the returned XML see my meetings on page 171 To display the contents of the user s content folder 1 Log in as the user 2 Call the sco shortcuts API This API provides the location of the root folder of the current accoun...

Страница 38: ...rayLen contents cfoutput table tr th SCO ID th th Name th th Type th tr cfloop index i from 1 to contentCount cfset item contents i tr td item XmlAttributes sco id td td item name XmlText td td item XmlAttributes type td tr cfloop table cfoutput 7 To provide links to launch content items call the sco info API for each item and determine the item s full absolute URL by appending the returned url pa...

Страница 39: ...riety of reports each of which provides data on Breeze use Report data is returned in XML form You can use the results in your system such as a web application or you can convert the data into other file formats such as comma separated value CSV files To generate a learner status report as a CSV file 1 Log in as an administrator 2 Call the sco contents API to determine the ID of a course 3 Call th...

Страница 40: ...40 Chapter 3 Common Tasks ...

Страница 41: ... by the Breeze server see Chapter 5 XML Results Reference on page 139 For examples of how to perform various common tasks see Chapter 3 Common Tasks on page 27 For information about specifying parameters see About parameters on page 16 For information about principals and Shareable Content Objects SCOs see About principals SCOs and IDs on page 17 Sample API entry The following sample entry explain...

Страница 42: ...services For example you can upload content from an external portal application into Breeze You can also create new meeting or collaboration sessions from a portal application The following table lists the content and meeting management APIs supported in Breeze 5 API Description sco build Causes the Breeze server to build the specified SCO when you create presentations with the XML API sco content...

Страница 43: ...ild API Description 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 single learning object in a curriculum user transcript update Resets a user s transcript for a learning object or marks it as complete API Description acl field info Returns field ids and values for an ACL acl field list Ret...

Страница 44: ...ply to all principals permissions update Updates one or more principal s permissions for one or more SCOs API Description report active meeting presenters Provides a list of the users who are currently presenting meetings report active meetings Provides a list of meetings that are currently in progress report bulk consolidated transactions Returns information about all the transactions in an accou...

Страница 45: ...s Provides information about each meeting the logged in user is scheduled to attend report quiz interactions Provides information about all the interactions that users have had with the specified quiz report quiz question answer distribution Indicates how many users selected a specific answer for all questions on a quiz associated with the specified SCO report quiz question distribution Indicates ...

Страница 46: ...h the specified user belongs user update pwd Changes a user s password API Description accesskey exec Executes special functions associated with special access keys This API is not supported in Breeze 5 accesskey info Provides a special access key if such a key is associated with the specified SCO This API is not supported in Breeze 5 acl field info Returns field ids and values for an ACL acl fiel...

Страница 47: ... by field Allows you to list principals that have a given field value principal update Updates information for a principal in the current account or creates a new principal principals delete Deletes one or more principals report account meeting attendance Returns the meeting attendance log for the account This API is not supported in Breeze 5 report active meeting presenters Provides a list of the...

Страница 48: ...rns information about all users in an account 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 This API is not supported in Breeze 5 report disk usage Provides information about how much hard disk space the Breeze content for the current account uses in byt...

Страница 49: ...ndicates how many users selected a specific answer for all questions on a quiz associated with the specified SCO report quiz question distribution Indicates how many users answered each question in the specified quiz correctly report quiz question response Provides a list of all answers that users have given to a particular quiz question report quiz question totals Indicates for the specified quiz...

Страница 50: ...es information about a SCO sco move Moves a SCO from one folder to another sco nav Describes the folder hierarchy that contains the specified SCO sco search Provides a list of all SCOs that match the search text sco shortcuts Provides IDs for a set of folders that contain content relevant to the logged in user a folder for the user to place meetings a folder for the user to place content and so on...

Страница 51: ...eters in name and value pairs as shown in the following example field id xx value xxx customfield id xx value xxx The field id parameters can be determined from the data returned by the custom fields API Parameters access key The special access key that lets the user self register first name The new user s first name has children Always set this parameter to 0 when registering a new user last name...

Страница 52: ...element results status code ok access keys access key acl id 622847 action action self reg meeting parent acl id 503265 access key 3hzvnifcfmphn3id access key date created 2004 03 05T10 28 14 750 08 00 date created access key access keys results The following sample results are returned when a group exists and therefore includes an accesskey group element results status code ok access key group ac...

Страница 53: ...results were returned when the acl id parameter was an account id Some fields in the account ACL list the main account contact in this case Mike Brown The other fields identify the company associated with the account The fields are specified at account creation time and stored in an ACL field results status code ok acl fields field acl id 38181499 field id email value dblack macromedia com value f...

Страница 54: ...nistrator permission on the logged in account Call acl field info to determine the possible fields for an ACL An ACL is a securable Breeze object for example a principal SCO or account For more information see About principals SCOs and IDs on page 17 Parameters field id The ID of the field whose values you want to list Filters Results cannot be filtered or sorted Returned elements acl field list S...

Страница 55: ...nt to set for the field specified by the field id parameter Filters Results cannot be sorted or filtered Returned elements None Sample results The following call updates the first name of the user with ACL ID 38140560 call acl field list to determine the ACL ID http server_name api xml action acl field update acl id 38140560 field id first name value Mary 20Sue The results are as follows results s...

Страница 56: ...eeze currently supports the following five languages time zone id The time zone setting Breeze currently supports the following 75 time zones Language Parameter value English en French fr German de Japanese ja Korean ko Time zone setting Parameter value GMT 12 00 International Date Line West 0 GMT 11 00 Midway Island Samoa 1 GMT 10 00 Hawaii 2 GMT 09 00 Alaska 3 GMT 08 00 Pacific Time US and Canad...

Страница 57: ...wich Mean Time Dublin Edinburgh Lisbon London 85 GMT Casablanca Monrovia 90 GMT 01 00 Belgrade Bratislava Budapest Ljubljana Prague 95 GMT 01 00 Sarajevo Skopje Warsaw Zagreb 100 GMT 01 00 Brussels Copenhagen Madrid Paris 105 GMT 01 00 Amsterdam Berlin Bern Rome Stockholm Vienna 110 GMT 01 00 West Central Africa 113 GMT 02 00 Bucharest 115 GMT 02 00 Cairo 120 GMT 02 00 Helsinki Kiev Riga Sofia Tal...

Страница 58: ... 207 GMT 08 00 Beijing Chongqing Hong Kong SAR Urumqi 210 GMT 08 00 Kuala Lumpur Singapore 215 GMT 08 00 Taipei 220 GMT 08 00 Perth 225 GMT 08 00 Irkutsk Ulaan Bataar 227 GMT 09 00 Seoul 230 GMT 09 00 Osaka Sapporo Tokyo 235 GMT 09 00 Yakutsk 240 GMT 09 30 Darwin 245 GMT 09 30 Adelaide 250 GMT 10 00 Canberra Melbourne Sydney 255 GMT 10 00 Brisbane 260 GMT 10 00 Hobart 265 GMT 10 00 Vladivostok 270...

Страница 59: ...red to as actions Caution Not all APIs in this list are documented and not all documented APIs are in this list Parameters None Filters Results cannot be filtered or sorted Returned elements actions Sample results results status code ok actions action accesskey exec action action accesskey info action action action list action other actions listed here action user accounts action action user updat...

Страница 60: ...en cookie breezm5qtgnye46zpckbf MARIANNE cookie date 2004 02 12T15 53 19 797 07 00 date host http admin breeze example com host url api xml action common info url version breeze_402_r116 version account account id 222914 user user id 503562 name Greg Erweck name login gerweck example com login user user agent Mozilla 5 0 Windows U Windows NT 5 1 en US rv 1 7 5 Gecko 20041107 Firefox 1 0 user agent...

Страница 61: ...e of custom seq Returned elements When updating an existing custom field No elements are returned When creating a new custom field field Sample Results When creating a new custom field results status code ok field field id 1562 account id 7 custom seq 4 type optional comments none comments name Manager name field results When updating an existing custom field results status code ok results custom ...

Страница 62: ...eld id 1329 custom seq 1 account id 7 type optional name Department name comments this is optional comments field field field id 1330 custom seq 2 account id 7 type required name SSN name field custom fields results custom fields delete Availability Breeze 4 Description Deletes the specified account custom field Parameters field id The ID of the field to be deleted call the custom fields API to ob...

Страница 63: ...ted from false the group Filters Results cannot be filtered or sorted Returned elements None Sample results results status code ok results learning path info Availability Breeze 5 Description Returns a list of learning paths for a learning object that belongs to a curriculum A learning object is any SCO that has been added to a curriculum A learning path is determined by rules that establish wheth...

Страница 64: ...d has the following possible values completion none completion required preass blocked preass hidden preass none prereq hidden prereq none preass optional prereq required prereq suggested Returned elements learning paths Sample results To understand the XML results consider the following reading of the first learning path tag The current SCO 5400246 has a completion requirement The completion requ...

Страница 65: ...ggested name Beginning Electronics name learning path learning path curriculum id 5400246 current sco id 5400413 target sco id 5400248 path type prereq required name Beginning Electronics name learning path learning path curriculum id 5400246 current sco id 5400414 target sco id 5400413 path type prereq required name Electronics 2 name learning path learning paths results See also learning path up...

Страница 66: ...et sco id would be Intro to Programming path type The path type field has the following possible values completion none completion required preass blocked preass hidden preass none prereq hidden prereq none preass optional prereq required prereq suggested Filters The results cannot be sorted or filtered Returned elements None Sample results results status code ok results See also learning path inf...

Страница 67: ...row new RuntimeException Couldn t find the Breeze cookie To pass the BREEZESESSION cookie for all subsequent requests use the following code URLConnection conn url openConnection conn setRequestProperty Cookie BREEZESESSION cookie conn connect The preceding example sets the password and username variables manually In a real application you would probably create a form that collected the password a...

Страница 68: ...e filtered or sorted Returned elements None Sample results results status code ok results See also login permissions info Availability Breeze 4 Description Provides information about principals and the permissions they have for a specified SCO You can also pass an optional principal id parameter to retrieve permission information about a specific principal To determine the ID to use as the princip...

Страница 69: ...with Filters on page 21 Returned elements permissions Sample results The following XML data is returned when the principal id parameter is not passed and contains information about all principals results status code ok permissions principal principal id 181248 is primary false type user has children false permission id view name Englesberg Ari name login englesberg example com login principal prin...

Страница 70: ...ription Resets all principals permissions for the specified SCO so the permissions of the SCO s parent apply to all principals For information about permissions see About permissions on page 18 Parameters acl id The ID of a SCO Filters Results cannot be filtered or sorted Returned elements None Sample results results status code ok results See also permissions info permissions update permissions u...

Страница 71: ...ed elements None Sample results results status code ok results See also permissions info permissions reset principal info Availability Breeze 4 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 API possibly with a filter to limit the returned data to return...

Страница 72: ...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 results status code ok contact contact id 654 email test4 lnagaraj test enang com email first name test4 first name last name laxmi last name contact preferences acl id 653 lang en time zone id 4 principal account id 7 has children false is p...

Страница 73: ...incipal id 8 contact id 3 type user has children false is primary false is hidden 0 name Enterprise Administrator name login lraj macromedia com login email lraj macromedia com email principal principal principal id 18 contact id type authors has children true is primary true is hidden 0 name Account Authors name login Account Authors login description Account authors group description Field Filte...

Страница 74: ... and sorted For more information about filtering and sorting see Chapter 2 Working with Filters on page 21 Returned elements principal list Sample results results status code ok principal list principal account id 7 principal id 10018 type user has children false is primary false is hidden false name John Doe name login jdoe macromedia com login description Example User description Field Filter So...

Страница 75: ...scription The new group s description Use only when creating a new group first name The new first name to assign to the user Use only when creating or updating a user has children Indicates whether the principal has children If the principal is a group set this parameter to 1 If the principal is a user set this parameter to 0 last name The new last name to assign to the user Use only when creating...

Страница 76: ...d 181224 login jake3 example com login name doe jake name principal results See also principal info principals delete principal list principal list by field 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 16 Parameters principal id The ID of a principal to delete Fi...

Страница 77: ...eting attendance row account id 7 transcript id 670 sco id 623 principal id 8 contact id 3 login lraj macromedia com login session name Enterprise Administrator session name sco name test mtg 1 sco name date created 2004 07 09T13 00 28 920 07 00 date created date closed 2004 07 09T13 02 55 810 07 00 date closed participant name Enterprise Administrator participant name row row account id 7 transcr...

Страница 78: ... who are currently presenting meetings Parameters sco id The ID of a meeting if specified the report returns information about that meeting only This parameter is optional Filters Results cannot be filtered or sorted Returned elements report active meeting presenters Sample results results status code ok report active meeting presenters sco sco id 190298 name Jack Monson name date created 2004 02 ...

Страница 79: ...022305 Stephanie Test name url path r27873068 url path date created 2005 02 28T16 09 28 510 08 00 date created sco sco sco id 38345152 active participants 1 length minutes 1 name Status Meeting name url path status url path date created 2005 02 28T16 10 21 353 08 00 date created sco report active meetings results report bandwidth Availability Breeze 4 This API is not supported in Breeze 5 Descript...

Страница 80: ... five people attend a meeting there are five transactions for that meeting SCO one for each user who attended the meeting If a principal takes two courses three times and passes each only on the third try there are six transactions for the principal between the two courses one for each attempt on each course Parameters None Filters The following table lists the fields on which the data can be filt...

Страница 81: ...ate created 2005 01 04T10 10 09 077 08 00 date created row report bulk consolidated transactions results See also report bulk objects report bulk questions report bulk slide views report bulk users report bulk content quiz Availability Breeze 4 This API is not supported in Breeze 5 This API was replaced by the following APIs report bulk questions and report quiz interactions Description Returns in...

Страница 82: ...ew Jersey Nets answer text answer correct NO answer correct row report bulk content quiz results report bulk content quiz results Availability Breeze 4 This API is not supported in Breeze 5 This API was replaced by the following APIs report quiz interactions report quiz question distribution report quiz question response report quiz summary report quiz takers Description Returns results for a cont...

Страница 83: ...mber 2 user response 3 user login lraj macromedia com user login date time attempted 2004 07 13T10 52 23 780 07 00 date time attempted time taken 00 00 45 046 time taken row report bulk content quiz results results report bulk content slide views Availability Breeze 4 This API is not supported in Breeze 5 This API was replaced by the report bulk slide views API Description Returns slide view data ...

Страница 84: ... last name presentation name test slide presentation name view date time 2004 06 30T11 46 10 280 07 00 view date time row row session id 10000022 viewing session 32 presentation id 27 slide number 2 user login lraj macromedia com user login user first name Enterprise user first name user last name Administrator user last name presentation name test slide presentation name view date time 2004 06 30...

Страница 85: ...ode ok report bulk course quiz row course id 727 quiz id 1 quiz passing score 10 question number 1 question value 10 answer id 1 presentation name quiz course ln presentation name quiz name Quiz test 1 quiz name question text Who is Randy Johnson question text answer text A baseball pitcher with the Arizona Diamondbacks answer text answer correct YES answer correct row row course id 727 quiz id 1 ...

Страница 86: ...iltered and sorted Returned elements report bulk course quiz results Sample results results status code ok report bulk course quiz results row user id 8 course attempt id 730 course id 727 quiz id 1 question number 1 user response 2 user login lraj macromedia com user login date time attempted 2004 07 13T10 54 09 030 07 00 date time attempted time taken 00 00 14 017 time taken row row user id 8 co...

Страница 87: ...following example http breezeserver api xml action report bulk objects filter like type meeting Description Returns information about all meetings Similar to the Meeting Information report except that the API returns XML data and the report returns CSV formatted data Parameters None Filters Results cannot be filtered or sorted Returned elements report bulk meeting Sample results results status cod...

Страница 88: ...lts status code ok report bulk meeting attendance row meeting id 623 meeting attendee 8 meeting name test mtg 1 meeting name attendee Enterprise Administrator attendee attendee join 2004 07 09T13 00 28 920 07 00 attendee join attendee exit 2004 07 09T13 02 55 810 07 00 attendee exit row row meeting id 623 meeting attendee 8 meeting name test mtg 1 meeting name attendee Enterprise Administrator att...

Страница 89: ...nd sorted Caution In Breeze 5 you can t filter the type field for a specific value you must use the like modifier For example in the following code the first line throws an exception but the second line executes correctly http breezeserver api xml action report bulk objects filter type meeting http breezeserver api xml action report bulk objects filter like type meeting Returned elements report bu...

Страница 90: ...ulk users report bulk questions Availability Breeze 5 Description Returns information about every quiz question in a particular account Parameters None Filters The following table lists the fields on which the data can be filtered and sorted Returned elements report bulk questions Sample results results status code ok report bulk questions row transaction id 38484112 score 10 principal id 38181502...

Страница 91: ...ed row row transaction id 5335144 score 10 principal id 4954032 question Apples can be 1 or 2 The name of the grocery store is 3 question response red green Bob s response date created 2005 03 24T11 46 53 950 08 00 date created row report bulk questions results See also report bulk objects report bulk consolidated transactions report bulk slide views report bulk users report bulk slide views Avail...

Страница 92: ...4T16 38 09 070 08 00 date created row row transaction id 38484112 principal id 38181502 page 1 page date created 2005 03 24T16 36 47 663 08 00 date created row row transaction id 38484112 principal id 38181502 page 2 page date created 2005 03 24T16 37 04 303 08 00 date created row row transaction id 38484112 principal id 38181502 page 3 page date created 2005 03 24T16 37 15 710 08 00 date created ...

Страница 93: ...ype field for a specific value you must use the like modifier For example in the following code the first line throws an exception but the second line executes correctly http breezeserver api xml action report bulk objects filter type presentation http breezeserver api xml action report bulk objects filter like type presentation Returned elements report bulk users Sample results results status cod...

Страница 94: ...iption Returns course status for either a principal or a SCO based on the parameters passed in Parameters principal id The ID of the principal for whom the course status is requested sco id The ID of the SCO for which the course status is requested Note Only one of the principal id or sco id parameters needs to be passed in based on the type of information needed Filters Results cannot be filtered...

Страница 95: ... quiz takers Description Provides a list of the users enrolled in the specified course Parameters sco id The ID of a course 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 Field Filter Sort answered survey Sort date taken Filter and sort certificate Sort login So...

Страница 96: ...50 08 00 date taken principal name George Best principal name row row transcript id 14102 sco id 13105 principal id 12029 status user passed score 2 certificate 14102 attempts 4 login bart1cassaly yahoo com login date taken 2005 03 04T16 37 31 077 08 00 date taken principal name Finbarr Cassidy principal name row report quiz takers results report disk usage Availability Breeze 4 This API is not su...

Страница 97: ... Chapter 2 Working with Filters on page 21 Returned elements report meeting attendance Sample results results status code ok report meeting attendance row transcript id 18308 sco id 18302 principal id 10021 answered survey 0 login bcassaly macromedia com login session name Bart Cassaly session name sco name 8th Meeting sco name date created 2005 03 15T10 11 00 700 08 00 date created Field Filter S...

Страница 98: ...le results results status code ok report meeting concurrent users max users 426 max participants freq 1 results report meeting session Availability Breeze 4 This API is not supported in Breeze 5 In Breeze 5 you can call the report meeting sessions API and filter on the asset id field to return data for a specific meeting session Description Provides information about a specific meeting session suc...

Страница 99: ...7 09T13 00 32 153 07 00 date begin date end 2004 07 09T13 08 57 483 07 00 date end report meeting session results See also report meeting sessions report meeting sessions Availability Breeze 4 Description Provides information about all the sessions of a meeting Each time someone enters an otherwise empty meeting a new session starts The session ends when all attendees leave the meeting If someone ...

Страница 100: ... 2005 03 15T10 21 07 733 08 00 date end row report meeting sessions results report meeting session slots Availability Breeze 4 This API is not supported in Breeze 5 Description Provides information about the number of attendees in every ten minute time slot of the specified meeting session Parameters sco id The ID of a valid meeting session You can obtain this ID by calling the report meeting sess...

Страница 101: ...t meeting summary Availability Breeze 4 Description Indicates how many users were invited to the specified meeting and how many invitees and guests attended Parameters sco id The ID of a meeting Filters Results cannot be filtered or sorted Returned elements report meeting summary Sample results results status code ok report meeting summary num unique meetings 2 peak users num invitees 4 num invite...

Страница 102: ...egin 2004 02 09T06 30 00 000 08 00 date begin date end 2006 02 09T06 30 00 000 08 00 date end url path p38547860 url path expired false expired completed true completed course course sco id 558906 type content icon course permission id view name 1234test name url professor ibreeze macromedia com p50984837 url date created 2004 02 10T19 26 13 840 08 00 date created date modified 2004 02 10T19 33 51...

Страница 103: ...ned elements my events Sample results results status code ok my events event sco id 13923 type event icon event permission id host name 1st Event name domain name bcassidy02 domain name url path e95598585 url path date begin 2005 03 05T13 00 00 000 08 00 date begin date end 2005 03 10T13 00 00 000 08 00 date end expired true expired duration 5d 00 00 00 000 duration event Field Filter Sort date be...

Страница 104: ...orking with Filters on page 21 Returned elements my meetings Sample results results status code ok my meetings meeting sco id 10801 type meeting icon meeting permission id host active participants 3 name 1st Seminar name domain name bcassidy02 domain name url path r21331159 url path date begin 2005 02 25T10 00 00 000 08 00 date begin date end 2005 02 25T11 00 00 000 08 00 date end expired true exp...

Страница 105: ...r custom field information This is the only report in which you can filter users on the account custom fields 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 report principal list Sample results results status code ok report prin...

Страница 106: ...e 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 distribution report quiz question distribution and report quiz question response API entries Description Indicates how many users selected a specific answer for all questions on a quiz associated with the specified SCO ...

Страница 107: ...tus code ok report quiz answer distribution results report quiz definition answers 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 distribution report quiz question distribution and report quiz question response API entries Description Provides info...

Страница 108: ...y row answer text ISO 9000 answer text row row answer id 1 question id 259 correct 1 body ECMA 262 body row row answer id 2 question id 259 correct 0 body RFC 821 body row row answer id 3 question id 259 correct 0 body ECMA 976 body row quiz definition answers results report quiz definition questions Availability Breeze 4 This API is not supported in Breeze 5 This API was replaced by APIs that sup...

Страница 109: ... id 1 body What is 2 2 body date modified 2004 01 13T17 09 40 230 08 00 date modified row row question number 2 question id 258 score 20 chapter id 1 body How far is it from Earth to the sun body date modified 2004 01 13T17 09 40 230 08 00 date modified row row question number 3 question id 259 score 20 chapter id 1 body Which international standard defines ECMAScript body date modified 2004 01 13...

Страница 110: ... 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 Returned elements report quiz interactions Sample results results status code ok report quiz interactions row display seq 1 transcript id 17452 interaction id 17442 sco id 17438 score 10 name Barry Cassidy n...

Страница 111: ...uestion IDs do not necessarily correspond to the question numbers in a quiz Parameters interaction id The ID of a specific question in the quiz 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 Returned elements ...

Страница 112: ...display seq 2 interaction id 17813 score 1 num selected 1 response 2 response row report quiz question answer distribution results report quiz question distribution Availability Breeze 4 Description Indicates how many users answered each question in the specified quiz correctly Parameters sco id The ID of a presentation that contains a quiz Filters The following table lists the fields on which the...

Страница 113: ... quiz question response Availability Breeze 4 Description Provides a list of all answers that users have given to a particular quiz question Use report quiz definition answers or report quiz definition questions to determine the ID of a question to use as the question id parameter Note Question IDs do not necessarily correspond to the question numbers in the quiz Parameters interaction id The ID o...

Страница 114: ...created row row principal id 10021 interaction id 17810 user name Barry Cassidy user name response 2 response date created 2005 03 14T14 20 43 967 08 00 date created row row principal id 10021 interaction id 17811 user name Barry Cassidy user name response C11101BA001B 2Eo4E 7E 24KQ 2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E response date created 2005 03 14T14 20 43 967 08 00 date created row row ...

Страница 115: ...rameter Note Question IDs do not necessarily correspond to the question numbers in the quiz Parameters question id The ID of a specific question in the quiz sco id The ID of a presentation that contains a quiz Filters Results cannot be filtered or sorted Returned elements report quiz question totals Sample results results status code ok report quiz question totals question id 260 total responses 8...

Страница 116: ...pal id parameter instead of the sco id parameter In addition you can restrict the list of the SCOs to a specific type by passing an optional type parameter as shown in the following table If a type parameter is not specified the list of all courses content and meetings attended by the user is returned Parameters sco id The ID of a presentation that contains a quiz Filters The following table lists...

Страница 117: ...ipal name Barry Cassaly principal name row row transcript id 17619 sco id 17438 principal id 11211 status user passed score 60 attempts 1 time taken 89360 certificate 17619 answered survey 1 name All Question Types Quiz name login gbest macromedia com login date created 2005 03 11T14 52 34 903 08 00 date created principal name George Best principal name row report quiz takers results report quotas...

Страница 118: ...0 date begin date end 2999 12 31T16 00 00 077 08 00 date end quota quota acl id 181224 quota id user quota used 6545516 limit unlimited soft limit 1000000000 date begin 2003 08 15T13 12 33 260 07 00 date begin date end 2999 12 31T16 00 00 000 08 00 date end quota quota acl id 181224 quota id course quota used 6545516 limit unlimited soft limit 1000000000 date begin 2003 08 15T13 12 33 260 07 00 da...

Страница 119: ... 20 46 733 08 00 date created row row slide 1 asset id 17805 views 1 date created 2005 03 14T14 20 51 827 08 00 date created row row slide 2 asset id 17805 views 1 date created 2005 03 14T14 21 01 937 08 00 date created row report sco slides results report sco views Availability Breeze 4 Description Indicates how many times and how recently the specified presentation was viewed Parameters sco id T...

Страница 120: ...uestion response Description Returns the list of all users who answered the specified question and their answer Parameters question id The ID of the question sco id The ID of the SCO 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 survey ...

Страница 121: ...API after you use the sco upload API to upload a SCO If you upload a new version of an existing SCO you must use the sco build API to rebuild the SCO otherwise users viewing the SCO continue to see the old version You can call the sco info API to obtain the current build status of the SCO The SCO status is initially in progress which means that the content is being built When the status becomes ac...

Страница 122: ...FLV file an HTML file an image a pod and so on curriculum A Breeze curriculum event A Breeze event folder A folder on the server s hard disk that contains Breeze content link A reference to another SCO These links are used by curriculums to link to other SCOs When content is added to a curriculum a link is created from the curriculum to the content meeting A Breeze meeting tree The root of a folde...

Страница 123: ...07 00 date begin date end 2003 08 27T01 00 00 000 07 00 date end date modified 2003 08 26T23 33 20 300 07 00 date modified duration 1900 01 02T 00 00 000 00 00 duration sco sco sco id 505323 status active type meeting is folder 0 name My Name 2 name date begin 2004 01 29T01 30 00 000 08 00 date begin date end 2004 01 29T01 30 00 000 08 00 date end date modified 2004 01 29T01 35 26 433 08 00 date m...

Страница 124: ...co id The ID of a folder Filters Results cannot be sorted or filtered Returned elements expanded scos Sample results results status code ok expanded scos sco depth 0 sco id 5400248 folder id 5400246 type link icon producer lang en source sco id 5413507 display seq 1 source sco type 0 name Beginning Electronics name url path l47843877 url path date created 2005 03 31T12 16 54 840 08 00 date created...

Страница 125: ...us active tree id 14 type meeting date begin 2004 07 07T10 00 00 000 07 00 date begin date created 2004 07 07T10 05 33 200 07 00 date created date end 2004 07 07T11 00 00 000 07 00 date end date modified 2004 07 09T15 09 41 390 07 00 date modified name test mtg 1 name url path r66599952 url path sco sco data byte count height length sco data id 625 slide count version 0 width date created 2004 07 ...

Страница 126: ...te modified name test2 name url path p33526645 url path sco sco data byte count height length sco data id 746 slide count version 0 width date created 2004 07 14T12 19 23 340 07 00 date created date modified 2004 07 14T12 19 23 340 07 00 date modified physical path 7 744 physical path sco data source sco results The following is sample XML from a SCO whose type attribute is course results status c...

Страница 127: ...rl path source sco source sco results sco move Availability Breeze 4 Description Moves a SCO from one folder to another For information about rules regarding moves and their necessary permissions see Breeze Help Parameters folder id The ID of the destination folder sco id The ID of the SCO to move Filters Results cannot be filtered or sorted Returned elements status Sample results results status c...

Страница 128: ... 181230 tree id 181230 type folder depth 2 name User Meetings name sco sco sco id 181576 tree id 181230 type folder depth 1 name tennant example com name sco sco sco id 503545 tree id 181230 type meeting depth 0 name created with 402 name sco sco nav results See also sco move sco search Availability Breeze 4 Description Provides a list of all SCOs that match the search text For every type of SCO t...

Страница 129: ... modified 2005 03 30T16 32 31 043 08 00 date modified hit 1 hit hit type slide hit type hit url Viewer swf slide 1 hit url thumbnail path sco sco sco id 5352494 folder id 5393514 type content icon producer byte count 1575 name quiz ppt name url path p21028797 url path date created 2005 03 30T16 32 30 840 08 00 date created date modified 2005 03 30T16 32 31 043 08 00 date modified hit 2 hit hit typ...

Страница 130: ... by this API with the URL returned by the sco info API in the url path tag Parameters None Filters Results cannot be filtered or sorted Returned elements shortcuts Sample results results status code ok shortcuts sco tree id 181230 sco id 181576 type my meetings SCO shortcut Description user courses The folder that holds all the user course folders events The shared events folder user events The fo...

Страница 131: ...81230 type user meetings domain name http admin breeze example com domain name sco shortcuts results See also sco info sco expanded contents sco update Availability Breeze 4 Description Creates or updates presentations courses and meetings If you provide a sco id parameter this API updates the specified SCO If you provide a folder id parameter this API creates a new SCO If you create a new SCO the...

Страница 132: ...ate to add enrollees to the course To use sco update with a Breeze meeting 1 Call sco update to create the meeting Pass the following parameters folder id date begin date end description name and type meeting Note You must use Breeze Manager to associate content with a meeting that was created using the XML API 2 Call permissions update with the following parameter values to set public or private ...

Страница 133: ...filtered or sorted Returned elements If you update an existing SCO no elements are returned If you create a new SCO sco Sample results The following sample XML is returned when a new SCO is created results status code ok sco folder id 181412 type folder sco id 2501961 status active author contact id 2501962 tree id 181227 sco data id 2501963 url path p54135747 url path name Test SCO name sco resul...

Страница 134: ...rting date ending date course ID summary description name and content associated with a course replace the folder id parameter with the sco id parameter The following sample XML is returned when updating a course results status code ok results The following sample XML is returned when creating a meeting results status code ok sco folder id 1426 lang en type meeting sco id 1429 status active tree i...

Страница 135: ... multiple files for example a PPT and a PPC file you must pass an additional file parameter FORM action http domain name api xml action sco upload sco id xxx summary xxx title xxxx enctype multipart form data method post P PPT files you are sending INPUT type file name file BR PPC files you are sending INPUT type file name file BR INPUT type submit value Send INPUT type reset FORM Note Call the sc...

Страница 136: ...n enterprise nonhosted Breeze system usually has only one account if you have an enterprise Breeze system you are unlikely to need this API Parameters login The user s login name which is usually the user s e mail address password The user s password Filters Results cannot be filtered or sorted Default sorting is by account name Returned elements users Sample results results status code ok users u...

Страница 137: ...g that you know the user has taken This API works only in the context of a curriculum and manage permissions for the curriculum are required Parameters curriculum id The ID of the curriculum sco id The item within the curriculum whose score will be overridden status One of the following values completed incomplete user passed user failed or not attempted score An integer value that represents the ...

Страница 138: ... 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 Results cannot be filtered or sorted Returned elements None Sample results results status code ok results ...

Страница 139: ... returned by the API For example a common info API might return the following results results status code ok common locale en cookie breezcywdihbvipp9kcrg P01BRZPR36 cookie date 2005 02 24T17 10 05 190 08 00 date host http admin breezecentral com host url api xml action common info url version breeze_500_r271 version account account id 38181499 user user id 38181502 type user name Joan Beckworth n...

Страница 140: ...e data that the tag contains Attributes This section lists attributes of the tag Contained tags This section lists any tags that are nested inside the main tag Returned by This section lists which API returns this XML tag Example This section provides a sample of the data contained by this XML tag See also This section identifies tags that are related to this tag Alphabetical list of XML tags The ...

Страница 141: ...ormation about a course custom fields Contains information about the custom fields of an account date The current date and time on the server in ISO 8601 date format date begin The date and time that a SCO is or was scheduled to begin in ISO 8601 date format date closed The time at which the user closed the window that contains the meeting thereby leaving the meeting in ISO 8601 date format date c...

Страница 142: ...ll to an API is invalid last name A user s last name last viewed The date and time of the most recent time that a SCO was viewed in ISO 8601 date format last viewed date The most recent date and time that the SCO was viewed in ISO 8601 date format learning path Contains information about a learning path in a curriculum learning paths Contains information about learning paths in a curriculum login ...

Страница 143: ...ing presenters Contains a list of the users who are currently presenting meetings report active meetings Contains a list of meetings that are currently in progress report bandwidth The total bandwidth consumed in the current account since the account was created in bytes report bulk content quiz Contains rows that contain information about all content quizzes including a list of quizzes report bul...

Страница 144: ...ser had with the specified quiz report quiz question answer distribution Contains one or more row tags each indicating how many users selected a particular answer to a particular quiz question report quiz question distribution Contains one or more row tags each indicating how many users answered a question in the specified quiz correctly report quiz question response Contains one or more row tags ...

Страница 145: ...e folder hierarchy that contains the specified SCO sco search info Contains one or more sco tags each containing information about a SCO that matches the specified search text scos Contains one or more sco tags each containing information about a folder that contains content relevant to the logged in user shortcuts Contains one or more sco tags each containing information about a folder that conta...

Страница 146: ... acl id 622847 action action self reg meeting parent acl id 503265 access key 3hzvnifcfmphn3id access key date created 2004 03 05T10 28 14 750 08 00 date created access key See also access key key access keys 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 user last name A user s last name use...

Страница 147: ...the principal is a member This attribute is returned only by the principal info API has children Indicates whether the principal has children Groups have children and users don t so this attribute indicates whether the principal is a group is primary Indicates whether the principal is a primary group also called a Built in group for more information see the type attribute principal id The ID of th...

Страница 148: ...login name COURSE test1 self reg group name access key group access keys Description Container tag contains one or more access keys Attributes None Contained tags access key container Returned by accesskey info Example access keys access key acl id 619605 action 1 parent acl id 619605 access key vb7gmg6ohtz4y7k6 access key date created 2004 03 05T00 30 38 483 08 00 date created access key access k...

Страница 149: ...s control list ACL Attributes acl id The ID of an ACL Contained tags value Returned by acl field list Example acl acl id 38140560 value Mary value acl acl field list Description Container tag contains information about ACLs Attributes None Contained tags acl Returned by acl field list Example acl field list acl acl id 38122317 value Stephanie value acl acl acl id 38130237 ...

Страница 150: ...utes None Contained tags field Returned by acl field info Example acl fields field acl id 38351541 field id x tel conference number field acl id 38351541 field id x tel participant code field acl id 38351541 field id x tel moderator code acl fields action Description The name of an API Attributes None Contained tags None content only Returned by action list Example action user accounts action ...

Страница 151: ...action accesskey exec action action accesskey info action action action list action other APIs listed here action user accounts action action user update pwd action actions answer correct Description The text for a correct answer Attributes None Contained tags None content only Returned by report bulk content quiz Example answer correct YES answer correct ...

Страница 152: ... answer text body Description The text of a returned item such as the text of a quiz question in a quiz related report Attributes None Contained tags None content only Returned by report quiz answer distribution report quiz definition answers report quiz definition questions report quiz question distribution report quiz question response Example body What is 2 2 body comment Description Any commen...

Страница 153: ... url user common info version Returned by common info Example common locale en cookie breezcywdihbvipp9kcrg P01BRZPR36 cookie date 2005 02 24T17 10 05 190 08 00 date host http admin breezecentral com host url api xml action common info url version breeze_500_r271 version account account id 38181499 user user id 38181502 type user name Sonya Blye name login sblye macromedia com login user user agen...

Страница 154: ...ou create a new browser window or launch a SCO Depending on the way your external system is implemented it may be more convenient to acquire the cookie from the server using common info than for that layer of your code to determine what cookie you re sending when you call an API Attributes None Contained tags None content only Returned by common info Example cookie breezm5qtgnye46zpckbf MARIANNE c...

Страница 155: ...ified date begin 2004 02 09T14 30 00 000 08 00 date begin date end 2004 02 09T14 30 00 000 08 00 date end url path p38547860 url path expired true expired course custom fields Description Container tag contains information about the custom fields of an account Attributes None Contained tags field Returned by custom fields Example custom fields field field id 1329 custom seq 1 account id 7 type opt...

Страница 156: ...O is or was scheduled to begin in ISO 8601 date format Attributes None Contained tags None content only Returned by report active meetings report meeting session report meeting sessions report my courses report my meetings sco contents Example date begin 2003 09 02T21 41 58 330 07 00 date begin date closed Description The time at which the user closed the window that contains the meeting thereby l...

Страница 157: ...o report active meeting presenters report meeting attendance report my courses report quiz interactions sco info sco search Example date created 2004 02 09T14 40 38 497 08 00 date created date end Description The date and time that a SCO is or was scheduled to end in ISO 8601 date format Attributes None Contained tags None content only Returned by report meeting session report my courses report my...

Страница 158: ...d 2004 01 24T00 59 59 000 07 00 date expired date last taken Description The date that a course was last taken in ISO 8601 date format Attributes None Contained tags None content only Returned by report course status Example date last taken 2004 07 13T10 55 28 763 07 00 date last taken date modified Description The date that something was most recently modified in ISO 8601 date format Attributes N...

Страница 159: ...n ISO 8601 date format Attributes None Contained tags None content only Returned by report quiz takers Example date taken 2004 01 13T01 33 49 460 08 00 date taken date time attempted Description The date that a particular user took a particular quiz in ISO 8601 format Attributes None Contained tags None content only Returned by report bulk content quiz results report bulk course results Example da...

Страница 160: ...on Account administrators group description domain name Description The fully qualified domain name of the location of a SCO Attributes None Contained tags None content only Returned by report my meetings sco shortcuts Example domain name admin breeze example com domain name duration Description The duration of a SCO Attributes None Contained tags None content only Returned by sco contents meeting...

Страница 161: ... contains information about an event Attributes None Contained tags name domain name url path date begin date end expired duration Returned by my events Example event sco id 13923 type event icon event permission id host name 1st Event name domain name bcassidy02 domain name url path e95598585 url path date begin 2005 03 05T13 00 00 000 08 00 date begin date end 2005 03 10T13 00 00 000 08 00 date ...

Страница 162: ...13507 display seq 1 source sco type 0 name Beginning Electronics name url path l47843877 url path date created 2005 03 31T12 16 54 840 08 00 date created date modified 2005 03 31T12 17 39 437 08 00 date modified sco expanded scos expired Description A Boolean value that indicates whether a SCO has expired A SCO has expired when its end date has passed and it is no longer available Attributes None ...

Страница 163: ...gistration feature is obsolete in Breeze 5 Contained tags comment name value Note Not all tags are returned by all APIs Returned by acl field info custom field update Example field field id 1562 account id 7 custom seq 4 type optional comments none comments name Manager name value 411 value field file Description Container contains information about uploaded SCO files Attributes None Value Descrip...

Страница 164: ...iption Container contains information about uploaded SCO files Attributes None Contained tags file Returned by sco upload Example files file path 38181499 38111519 1 input Test ppt path file files first name Description A user s first name Attributes None Contained tags None content only Returned by sco info sco search Example first name Pat first name ...

Страница 165: ...xample com host invalid Description Container tag contains information about why a particular call to an API is invalid This element appears only inside a status tag and only when the code attribute of that tag is set to invalid The server returns only one invalid tag for a given request even if you leave out multiple required parameters To resolve a missing parameter error add the required parame...

Страница 166: ...Description A user s last name Attributes None Contained tags None content only Returned by sco info sco search Example last name Tennant last name Value Description duplicate The call attempted to add a duplicate item in a context where uniqueness is required format A passed parameter had the wrong format illegal operation The requested operation violates integrity rules for example moving a fold...

Страница 167: ...5 39 517 08 00 last viewed last viewed date Description The most recent date and time that the SCO was viewed in ISO 8601 date format Attributes None Contained tags None content only Returned by report sco views Example last viewed date 2004 01 13T17 11 47 923 08 00 last viewed date learning path Description Container tag contains information about learning paths in a curriculum Attributes curricu...

Страница 168: ...arning path info Example learning paths learning path curriculum id 38184158 current sco id 38184158 target sco id 38345286 path type completion required name Tester name learning path learning path curriculum id 38184158 current sco id 38184158 target sco id 39477240 path type completion required name Slides Test name learning path learning path curriculum id 38184158 current sco id 38184158 targ...

Страница 169: ...eeting s status The possible values are no content which indicates that the meeting has just been created but has no content in progress which indicates a meeting that s currently in progress and active type Indicates that this SCO is a meeting The value is always meeting Contained tags date begin date end domain name duration expired name url path Returned by report my meetings Example meeting sc...

Страница 170: ...ains information about one or more courses Attributes None Contained tags course Returned by report my courses Example my courses course sco id 555038 status active type course name My Name name url admin breeze example com p38547860 url date created 2004 02 09T14 40 38 497 08 00 date created date modified 2004 02 09T14 40 44 623 08 00 date modified date begin 2004 02 09T14 30 00 000 08 00 date be...

Страница 171: ...begin date end 2005 03 10T13 00 00 000 08 00 date end expired true expired duration 5d 00 00 00 000 duration event my events my meetings Description Container tag contains information about one or more meetings Attributes None Contained tags meeting Returned by report my meetings Example my meetings meeting sco id 10801 type meeting icon meeting permission id host active participants 3 name 1st Se...

Страница 172: ...info principal info principal list report active meeting presenters report active meetings report meeting session report meeting sessions report my courses report my meetings report quiz takers report sco views sco build sco contents sco info sco nav sco search user accounts Example name Math Test name participant name Description The name of a participant in a meeting The name is presented in the...

Страница 173: ...ions that the principal has for the specified SCO This attribute is returned only by the permissions info API principal id The ID of the principal Contained tags None empty tag Returned by permissions info Example permission acl id 27 permission id manage principal id 8 permissions Description Container tag contains information about one or more principals and their permissions For information abo...

Страница 174: ...pal permissions physical path Description The path on the server to a SCO Attributes None Contained tags None content only Returned by sco info Example physical path 222914 503227 physical path preferences Description Contains information about user preferences Attributes acl id The ID of the user for whom the preferences are updated lang The language setting Breeze currently supports the followin...

Страница 175: ...d Canada GMT 06 00 20 Saskatchewan GMT 06 00 25 Guadalajara Mexico City Monterrey GMT 06 00 30 Central America GMT 06 00 33 Eastern Time US and Canada GMT 05 00 35 Indiana East GMT 05 00 40 Bogota Lima Quito GMT 05 00 45 Atlantic Time Canada GMT 04 00 50 Caracas La Paz GMT 04 00 55 Santiago GMT 04 00 56 Newfoundland GMT 03 30 60 Brasilia GMT 03 00 65 Buenos Aires Georgetown GMT 03 00 70 Greenland ...

Страница 176: ... 00 150 Nairobi GMT 03 00 155 Baghdad GMT 03 00 158 Tehran GMT 03 30 160 Abu Dhabi Muscat GMT 04 00 165 Baku Tbilisi Yerevan GMT 04 00 170 Kabul GMT 04 30 175 Ekaterinburg GMT 05 00 180 Islamabad Karachi Tashkent GMT 05 00 185 Chennai Kolkata Mumbai New Delhi GMT 05 30 190 Kathmandu GMT 05 45 193 Astana Dhaka GMT 06 00 195 Sri Jayawardenepura GMT 06 00 200 Almaty Novosibirsk GMT 06 00 201 Rangoon ...

Страница 177: ...presentation name test quiz presentation name Seoul GMT 09 00 230 Osaka Sapporo Tokyo GMT 09 00 235 Yakutsk GMT 09 00 240 Darwin GMT 09 30 245 Adelaide GMT 09 30 250 Canberra Melbourne Sydney GMT 10 00 255 Brisbane GMT 10 00 260 Hobart GMT 10 00 265 Vladivostok GMT 10 00 270 Guam Port Moresby GMT 10 00 275 Magadan Solomon Islands New Caledonia GMT 11 00 280 Fiji Islands Kamchatka Marshall Islands ...

Страница 178: ...he principal is a group is primary Indicates whether the principal is a primary Built in group for more information see the type attribute permission id The permissions that the principal has for the specified SCO This attribute is returned only by the permissions info API principal id The ID of the principal type The type of principal Possible values include the following admins authors course ad...

Страница 179: ...irst name last name Blye last name principal principal list Description Container tag contains one or more principal tags Attributes None Contained tags principal Returned by principal list Example principal list principal principal id 222917 type admins has children true is primary true is hidden 0 name Account Administrators name login Account Administrators login description Account administrat...

Страница 180: ...f a quiz question Attributes None Contained tags None content only Returned by report quiz interactions report survey question response Example question What is 2 2 question question text Description The text of a quiz question Attributes None Contained tags None content only Returned by report quiz question answer distribution report bulk content quiz Example question text What is 2 2 question te...

Страница 181: ... 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 definition answers Example quiz definition answers row answer id 1 question id 257 correct 0 body 1 body row row answer id 2 question id 257 correct 1 body 2 body row row answer id 1 question id 258 correct 1 body 1 body row row answer...

Страница 182: ...uestion number 1 question id 257 score 20 chapter id 1 body What is 2 2 body date modified 2004 01 13T17 09 40 230 08 00 date modified row row question number 2 question id 258 score 20 chapter id 1 body How far is it from Earth to the sun body date modified 2004 01 13T17 09 40 230 08 00 date modified row quiz definition questions quiz name Description The name of a quiz Attributes None Contained ...

Страница 183: ... The original limit for the quota This value is used for load balancing soft limit The elevated limit for the quota This value is used for the Breeze pricing models that allow customers to quickly scale their license beyond their limit Contained tags date begin date end Returned by report quotas Example quota acl id 181224 quota id 2 used 6545516 limit unlimited soft limit 1000000000 date begin 20...

Страница 184: ...id 3 login lraj macromedia com login session name Enterprise Administrator session name sco name test mtg 1 sco name date created 2004 07 09T14 33 06 577 07 00 date created date closed 2004 07 09T14 33 43 547 07 00 date closed participant name Enterprise Administrator participant name row report account meeting attendance report active meeting presenters Description Container tag contains a list o...

Страница 185: ...ame 022305 Stephanie Test name url path r27873068 url path date created 2005 02 28T16 09 28 510 08 00 date created sco sco sco id 38345152 active participants 1 length minutes 1 name Status Meeting name url path status url path date created 2005 02 28T16 10 21 353 08 00 date created sco report active meetings report bandwidth Description The total bandwidth consumed in the current account since th...

Страница 186: ...com login user name Ben Harm user name status completed status date created 2005 01 29T14 02 04 733 08 00 date created row row transaction id 4832819 principal id 181271 score 0 name Default Meeting Template name url r 182228 url login gho macromedia com login user name Gung Ho user name status completed status date created 2005 01 04T10 10 09 077 08 00 date created row report bulk consolidated tr...

Страница 187: ...the New Jersey Nets answer text answer correct NO answer correct row report bulk content quiz report bulk content quiz results Description Container tag contains row information about the results for a content quiz Attributes None Contained tags row Returned by report bulk content quiz results Example report bulk content quiz results row user id 8 presentation attempt id 725 presentation id 720 qu...

Страница 188: ...son question text answer text A baseball pitcher with the Arizona Diamondbacks answer text answer correct YES answer correct row row course id 727 quiz id 1 quiz passing score 10 question number 1 question value 10 answer id 2 presentation name quiz course ln presentation name quiz name Quiz test 1 quiz name question text Who is Randy Johnson question text answer text A basketball player with the ...

Страница 189: ...in date time attempted 2004 07 13T10 54 09 030 07 00 date time attempted time taken 00 00 67 017 time taken row report bulk course quiz results report bulk meeting Description Container tag contains information about all meetings Attributes None Contained tags row Returned by report bulk meeting Example report bulk meeting row meeting id 623 invited participants 3 meeting name test mtg 1 meeting n...

Страница 190: ...09T13 00 28 920 07 00 attendee join attendee exit 2004 07 09T13 02 55 810 07 00 attendee exit row row meeting id 623 meeting attendee 8 meeting name test mtg 1 meeting name attendee Enterprise Administrator attendee attendee join 2004 07 09T14 33 06 577 07 00 attendee join attendee exit 2004 07 09T14 33 43 547 07 00 attendee exit row report bulk meeting attendance report bulk objects Description C...

Страница 191: ...dified 2003 07 14T14 54 16 757 07 00 date modified row row url p39862939 url type presentation type name Animated name date modified 2003 07 14T14 55 15 160 07 00 date modified row report bulk objects report bulk questions Description Container tag contains information about all the quiz questions in an account Attributes None Contained tags row Returned by report bulk questions Example report bul...

Страница 192: ...46 53 950 08 00 date created row report bulk questions report bulk slide views Description Container tag contains slide view data Attributes None Contained tags row Returned by report bulk slide views report bulk content slide views Example The following data was returned by the report bulk slide views API report bulk slide views row transaction id 38484112 principal id 38181502 page 0 page date c...

Страница 193: ...Container tag contains data about all the users in an account Attributes None Contained tags row Returned by report bulk users Example report bulk users row principal id 181231 login nson macromedia com login name Nathan Son name email nson macromedia com email manager abenedict macromedia com manager type user type row row principal id 182532 login vish_laxmi yahoo com login name laxmi vish name ...

Страница 194: ...f enrollees in a course Contained tag date last taken Returned by report course status Example report course status total course completions 2 total unique course completions 1 num passed 1 num failed 1 num enrollees 3 date last taken 2004 07 13T10 55 28 763 07 00 date last taken report course status report disk usage Description Indicates how much hard disk space the Breeze content uses in bytes ...

Страница 195: ...e created date closed 2005 03 15T10 13 12 810 08 00 date closed participant name Bart Cassaly participant name row report meeting attendance report meeting concurrent users Description The maximum number of users who participated simultaneously in the specified meeting This is different from the number of users who can participate simultaneously in a meeting because the quota may not have been rea...

Страница 196: ...ion This value matches the value of the sco id that is passed as a parameter to the report meeting session API Contained tags date created date end Returned by report meeting session Example report meeting sessions row sco id 18302 asset id 18304 num participants 1 date created 2005 03 15T09 30 28 233 08 00 date created date end 2005 03 15T09 45 36 903 08 00 date end row row sco id 18302 asset id ...

Страница 197: ...eport meeting session slots row num attendees 0 time slot begin 2004 02 14T06 30 00 000 08 00 time slot begin time slot end 2004 02 14T06 40 00 000 08 00 time slot end row row num attendees 0 time slot begin 2004 02 14T06 40 00 000 08 00 time slot begin time slot end 2004 02 14T06 50 00 000 08 00 time slot end row report meeting session slots report meeting summary Description Container indicates ...

Страница 198: ...on 2005 03 15T10 11 00 700 08 00 most recent session report meeting summary report principal list Description Container tag contains information about the principals Attributes None Contained tags row Returned by report principal list Example report principal list row principal id 8 type user has children false is primary false name Enterprise Administrator name login lraj macromedia com login cus...

Страница 199: ...57 a1 0 a2 0 a3 5 a4 3 total 8 body What is 2 2 body row row question number 2 question id 258 a1 8 a2 0 a3 0 a4 0 total 8 body How far is it from Earth to the sun body row row question number 3 question id 259 a1 8 a2 0 a3 0 a4 0 total 8 body Which international standard defines ECMAScript body row report quiz answer distribution report quiz interactions Description Container tag contains one or ...

Страница 200: ...z question Attributes None Contained tags row Returned by report quiz question answer distribution Example report quiz question answer distribution row question id 259 answer id 1 correct 0 total responses 1 percentage responded 10 question text Which international standard defines ECMAScript question text answer text ISO 9000 answer text row row question id 259 answer id 2 correct 0 total respons...

Страница 201: ... question distribution row question id 257 question number 1 num correct 8 num incorrect 0 percentage correct 100 score 20 body What is 2 2 body row row question id 258 question number 2 num correct 8 num incorrect 0 percentage correct 100 score 20 body How far is it from Earth to the sun body row row question id 259 question number 3 num correct 4 num incorrect 6 percentage correct 40 score 20 bo...

Страница 202: ...onse C11101BA001B 2Eo4E 7E 24KQ 2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E response date created 2005 03 14T14 20 43 967 08 00 date created row row principal id 10021 interaction id 17812 user name Barry Cassidy user name response 1 response date created 2005 03 14T14 20 43 967 08 00 date created row row principal id 10021 interaction id 17813 user name Barry Cassidy user name response 2 response ...

Страница 203: ... scores of the users who took the quiz high score The highest score low score The lowest score numdistincttaken The number of distinct users who have taken the quiz numtaken The total number of times the quiz has been taken Contained tags None empty tag Returned by report quiz summary Example report quiz results average score 95 low score 90 high score 100 numtaken 8 numdistincttaken 1 report quiz...

Страница 204: ...ned by report course takers report quiz takers Example report quiz takers row transcript id 17466 sco id 17438 principal id 10021 status user failed score 0 attempts 2 time taken 152000 certificate answered survey 1 name All Question Types Quiz name login bcassaly macromedia com login date created 2005 03 11T12 07 04 890 08 00 date created principal name Bart Cassaly principal name row row transcr...

Страница 205: ...T13 13 18 467 08 00 date begin date end 2999 12 31T16 00 00 077 08 00 date end quota quota acl id 181224 quota id user quota used 6545516 limit unlimited soft limit 1000000000 date begin 2003 08 15T13 12 33 260 07 00 date begin date end 2999 12 31T16 00 00 000 08 00 date end quota quota acl id 181224 quota id course quota used 6545516 limit unlimited soft limit 1000000000 date begin 2003 08 15T13 ...

Страница 206: ...ch indicating how many times and how recently the specified presentation has been viewed Attributes None Contained tags row Returned by report sco views Example report sco views row sco id 17803 type content is folder 0 views 1 principal id 10021 transcript id 17808 asset id 17805 name One Question New name last viewed date 2005 03 14T14 20 43 967 08 00 last viewed date date created 2005 03 14T14 ...

Страница 207: ...port survey question response 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 system at the same time as specified by your account license max num sessions The largest number of sessions that have ever been open simultane...

Страница 208: ...ag contains all results returned by any API Attributes None Contained tags Any Returned by All APIs Example results status code ok results row Description Contains a single record of information in a report For examples of the possible attributes and contained tags examine the sample results provided in the documentation for the API you are calling Attributes The attributes for the row tag vary wi...

Страница 209: ... Example row sco id 17803 type content is folder 0 views 1 principal id 10021 transcript id 17808 asset id 17805 name One Question New name last viewed date 2005 03 14T14 20 43 967 08 00 last viewed date date created 2005 03 14T14 20 43 967 08 00 date created row sco Description Container tag contains information about a SCO which is a single Breeze document For examples of the possible attributes...

Страница 210: ...ate created sco sco author Description Container tag contains information about the author of a SCO Attributes None Contained tags email first name last name Returned by sco info Example sco author email tennant example com email first name Pat first name last name Tennant last name sco author sco data Description Container tag contains information about the underlying data file such as the file t...

Страница 211: ...ight 252 length 1 sco data id 95654 slide count 1 version 1 width 380 date created 2004 01 26T20 47 05 653 07 00 date created date modified 2004 01 26T20 47 05 653 07 00 date modified physical path 222914 503227 physical path sco data sco name Description The name of a particular SCO such as the name of a meeting Attributes None Contained tags None content only Returned by report meeting attendanc...

Страница 212: ...co tags each containing information about a SCO that matches the specified search text Attributes None Contained tags sco Returned by sco search Example sco search info sco sco id 5393671 folder id 5393514 type content icon producer byte count 1575 name p68431203 name url path p68431203 url path date created 2005 03 30T16 32 42 280 08 00 date created date modified 2005 03 30T16 32 42 280 08 00 dat...

Страница 213: ... sco sco sco id 193496 status active type meeting is folder 0 name My Name name date begin 2003 08 27T00 00 00 000 07 00 date begin date end 2003 08 27T01 00 00 000 07 00 date end date modified 2003 08 26T23 33 20 300 07 00 date modified duration 1900 01 02T 00 00 000 00 00 duration sco scos shortcuts Description Container tag contains one or more sco tags each containing information about a folde...

Страница 214: ...sco shortcuts source sco Description Container tag contains information about the SCO for the content of a course Attributes None Contained tags source sco Returned by sco info Example source sco source sco author contact id 586761 folder id 506334 host id learning time sco data id 586762 sco id 586760 source sco id status active tree id 181225 type presentation date created 2004 02 27T10 31 06 71...

Страница 215: ... returning data Usually indicates that there is no item with the ID you specified To resolve the error change the specified ID to that of an item that exists ok Indicates that the API has completed successfully too much data Indicates that the API should have returned a single result but is actually returning multiple results For example if there are multiple users with the same user name and pass...

Страница 216: ...ributes None Contained tags None content only Returned by report meeting session slots Example time slot begin 2004 02 14T06 50 00 000 08 00 time slot begin time slot end Description The end date and time for a meeting session in ISO 8601 date format Attributes None Contained tags None content only Returned by report meeting session slots Example time slot end 2004 02 14T07 00 00 000 08 00 time sl...

Страница 217: ...n 00 34 23 011 time taken url Description A URL Attributes None Contained tags None content only Returned by common info report my courses Example url api xml action common info url url path Description The path on the Breeze server to the specified SCO Attributes None Contained tags None content only Returned by report my courses report my meetings sco info sco search ...

Страница 218: ...mple user user id 503562 name Greg Erweck name login gerweck example com login user user user accounts Description Container tag contains information about a user and an account Attributes user id The ID of the user account id The ID of an account Contained tags date expired name Returned by user accounts Example user user id 211729 account id 211655 name james example com name date expired 2004 0...

Страница 219: ...a 5 0 Windows U Windows NT 5 1 en US rv 1 7 5 Gecko 20041107 Firefox 1 0 user agent user first name Description A user s first name Attributes None Contained tags None Returned by report bulk content slide views Example user first name Enterprise user first name user last name Description A user s last name Attributes None Contained tags None content only ...

Страница 220: ... Description The login of a user Attributes None Contained tags None Returned by report bulk content quiz results Example user login lraj macromedia com user login user name Description A user name Attributes None Contained tags None content only Returned by report survey question response Example user name Enterprise Administrator user name ...

Страница 221: ... user id 211729 account id 211655 name james example com name date expired 2004 01 24T00 59 59 000 07 00 date expired user user user id 212988 account id 212928 name smith example com name date expired 2004 01 24T00 59 59 000 07 00 date expired user users value Description The value of a custom field Attributes None Contained tags None content only Returned by acl field list principal info Example...

Страница 222: ...ed tags None content only Returned by common info Example version breeze_402_r116 version view date time Description The time and date that a slide was viewed Attributes None Contained tags None Returned by report bulk content slide views Example view date time 2004 06 30T11 46 12 500 07 00 view date time ...

Страница 223: ...ustom field update 60 custom fields 61 custom fields delete 62 defined 9 group membership update 31 63 learning path info 33 63 learning path update 33 65 login 33 66 logout 68 names 150 obsolete 10 permissions info 68 permissions reset 70 permissions update 70 principal info 36 71 principal list 34 73 principal list by field 74 principal update 31 35 75 principals delete 35 76 report account meet...

Страница 224: ...ve 127 sco nav 127 sco search 128 sco shortcuts 32 37 130 sco update 32 131 sco upload 135 user accounts 136 user transcript update 33 137 user update pwd 138 See also web services actions tag 151 active meetings listing 79 presenters 78 administrative users 33 answer correct tag 151 answer text tag 152 answers to quiz questions answered correctly 112 distribution 111 interactions 110 text of 152 ...

Страница 225: ...61 custom fields tag 155 custom fields delete action 62 D data flow 14 date formatting 11 22 date tag 156 date begin tag 156 date closed tag 156 date created tag 157 date end tag 157 date expired tag 158 date last taken tag 158 date modified tag 158 date taken tag 159 date time attempted tag 159 delete principals 76 SCOs 123 users 35 Denied permission 19 description tag 160 directory services sync...

Страница 226: ...tees number of 101 ISO 8601 date format 11 italic font convention 12 L last name tag 166 last viewed tag 167 last viewed date tag 167 launching content 19 LDAP 33 learning paths creating and managing 33 learning path tag 167 learning path info action 63 learning path update action 65 learning paths tag 168 Lightweight Directory Access Protocol LDAP 33 limits on accounts 98 links creating 38 lists ...

Страница 227: ...hecking 37 path tag 173 paths to content 38 permission tag 173 permissions about 18 assigning 131 See also SCOs permissions tag 173 permissions info action 68 permissions reset action 70 permissions update action 70 physical path tag 174 portals integrating Breeze with 36 POST requests HTTP 15 34 preferences tag 174 prerequisites 9 presentation name tag 177 presentations about 17 number of slides ...

Страница 228: ...eting attendance tag 190 report bulk objects action 89 report bulk objects tag 190 report bulk questions action 90 report bulk questions tag 191 report bulk slide views action 91 report bulk slide views tag 192 report bulk users action 93 report bulk users tag 193 report course status action 94 report course status tag 194 report course takers action 95 report disk usage action 96 report disk usag...

Страница 229: ...id parameters 17 sco info action 38 125 sco move action 127 sco name tag 211 sco nav action 127 sco nav tag 211 sco search action 128 sco search info tag 212 sco shortcuts action 37 130 sco update action 131 sco upload action 135 scores on quizzes 110 SCOs about 17 building 121 135 commonly used 130 creating 131 deleting 123 expiration defined 162 folder hierarchies 127 information about acquiring...

Страница 230: ...ld 163 file 163 files 164 first name 164 hit 165 host 165 invalid 165 last name 166 last viewed 167 last viewed date 167 learning path 167 learning paths 168 login 168 meeting 169 most recent session 170 my courses 170 my events 171 my meetings 171 name 172 overview 139 participant name 172 path 173 permission 173 permissions 173 physical path 174 preferences 174 presentation name 177 principal 17...

Страница 231: ...s 139 215 time slot begin 216 time slot end 216 url 217 url path 217 user 218 user agent 219 user first name 219 user last name 219 user login 220 user name 220 users 221 value 221 version 222 view date time 222 tasks common 27 text finding in SCOs 50 128 time formatting 11 time slot begin tag 216 time slot end tag 216 transaction 80 trees 17 122 troubleshooting 215 typographical conventions 12 U ...

Страница 232: ...pals groups users tag 221 V value tag 221 verifying identity 66 version number Breeze 222 version tag 222 view presentations 119 slides 118 View permission 19 view date time tag 222 W web services architecture overview 13 introduction 11 See also actions workflow 14 X XML creating with CFML 11 elements returned 41 tags alphabetical list 140 XML results overview 139 parsing 34 XML web services See ...

Отзывы:

Нет отзывов

Похожие инструкции для BREEZE 5

Garmin GPSMAP GPSMAP 196 Getting Started preview
GPSMAP GPSMAP 196
Бренд: Garmin Страницы: 4
Garmin MapSource Owner'S Manual preview
MapSource
Бренд: Garmin Страницы: 2
Altigen MaxACD Administrator Manual preview
MaxACD Administrator
Бренд: Altigen Страницы: 261
Xerox LaserWriter 8.x driver User Manual preview
LaserWriter 8.x driver
Бренд: Xerox Страницы: 12
Baracoda Manager J2ME Installation Manual preview
Manager J2ME
Бренд: Baracoda Страницы: 6
Juniper JUNOSE 11.3 Configuration Manual preview
JUNOSE 11.3
Бренд: Juniper Страницы: 632
Casio EMULATOR FX-ES User Manual preview
EMULATOR FX-ES
Бренд: Casio Страницы: 18
Bosch VIDOS Installation And Operating Manual preview
VIDOS
Бренд: Bosch Страницы: 40
Bosch Divar Archive Player Operation Manual preview
Divar Archive Player
Бренд: Bosch Страницы: 10
Bosch MBV-BPRO-40 Operator'S Manual preview
MBV-BPRO-40
Бренд: Bosch Страницы: 86
Bosch DINION IP 5000 MP Software Manual preview
DINION IP 5000 MP
Бренд: Bosch Страницы: 112
Paradyne 8922 Installation And User Manual preview
8922
Бренд: Paradyne Страницы: 24
Steinberg TOOLS for CMC Installation Manual preview
TOOLS for CMC
Бренд: Steinberg Страницы: 1
Red Hat CERTIFICATE 7.2 RELEASE NOTES Release Note preview
CERTIFICATE 7.2 RELEASE NOTES
Бренд: Red Hat Страницы: 24
Intel ITANIUM ARCHITECTURE Manual preview
ITANIUM ARCHITECTURE
Бренд: Intel Страницы: 604
Bay Networks FastLink II User Manual preview
FastLink II
Бренд: Bay Networks Страницы: 112
Livescribe Desktop 2.3.1 User Manual preview
Desktop 2.3.1
Бренд: Livescribe Страницы: 88
Baby Lock Ellisimo Gold II Instruction And Reference Manual preview
Ellisimo Gold II
Бренд: Baby Lock Страницы: 50

Бренды по названию

Популярные бренды

Загрузить еще бренды