MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Скачать руководство пользователя страница 38

Страница: 38 / 196

Chapter 4: Action Reference

custom-field-update

Updates the specified account custom field. Creates a new
one if none exists.

custom-fields

Lists the custom fields of an account and the details of the
fields.

custom-fields-delete

Deletes the specified account custom field.

group-membership-update

Adds one or more principals to a group, or removes one or
more principals from a group.

Logs in a user.

logout

Logs out a user, invalidating the cookie that the application
received when the user logged in.

permissions-info

Provides information about principals and the permissions
they have for a specified SCO.

permissions-reset

Resets all principals’ permissions for the specified SCO, so
the permissions of the SCO’s parent apply to all principals.

permissions-update

Updates one or more principals’ permissions for one or more
SCOs.

principal-info

Provides information about the specified principal. The
specified principal can be a user or a group.

principal-list

Provides a complete list of users and groups, including
primary groups.

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.

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-bandwidth

Indicates the total bandwidth consumed in the current
account since the account was created, in bytes.

report-bulk-content-quiz

Returns information about all content quizzes, including a list
of quizzes, and the questions and answers for each quiz.

report-bulk-content-quiz-results

Returns results for a content quiz, including information on
each user and quiz question.

report-bulk-content-slide-views

Returns slide view data for content.

report-bulk-course-quiz

Returns information about all course quizzes, including a list
of quizzes, and the questions and answers for each quiz.

report-bulk-course-results

Returns results for course quiz, including information on each
user and quiz question.

report-bulk-meeting

Returns information about all meetings.

Action

Description

Содержание BREEZE-USING THE BREEZE XML WEB SERVICES

Страница 1: ...Using the Breeze XML Web Services...

Страница 2: ...cs Locator WinHelp Hyperviewer WinHelp Inspector and Xtra are either registered trademarks or trademarks of Macromedia Inc and may be registered in the United States or in other jurisdictions includin...

Страница 3: ...ER 2 Working with Filters 21 About filters 21 About sort filters 23 Special filter scenarios 23 Filter reference 24 Testing code in the browser 24 Where to go from here 25 CHAPTER 3 Common Tasks 27 Ca...

Страница 4: ...report bulk meeting 68 report bulk meeting attendance 69 report course status 70 report course takers 71 report disk usage 72 report meeting attendance 73 report meeting concurrent users 74 report me...

Страница 5: ...bout returned XML code 113 Alphabetical list of XML tags 114 access key container 119 access key key 120 access key group 120 access keys 121 account 121 action 122 actions 122 answer correct 123 answ...

Страница 6: ...ition answers 148 quiz definition questions 148 quiz name 149 quota 149 report account meeting attendance 150 report active meeting presenters 151 report active meetings 151 report bandwidth 152 repor...

Страница 7: ...port sco slides 168 report sco views 169 report survey question response 169 report training concurrent users 170 response 170 results 171 row 171 sco 172 sco author 172 sco data 173 sco name 173 sco...

Страница 8: ...8 Contents...

Страница 9: ...who want to integrate the Breeze XML web services into their external systems such as web applications Before you use this book you should understand the basics of XML and of using HTTP requests to co...

Страница 10: ...includes procedures for publishing Breeze presentations created in PowerPoint to your Breeze server You can access Using the Breeze Publish Wizard from the Breeze Manager Home page and from the Help b...

Страница 11: ...hical conventions are used in this book Italic font indicates a value that should be replaced for example in a folder path Code font indicates code It also indicates names of actions names of paramete...

Страница 12: ...12 Introduction Before You Begin...

Страница 13: ...erver using HTTP or HTTPS to call actions on the server and to receive results formatted as XML code You can use the web services to add Breeze management and reporting capabilities to your external s...

Страница 14: ...tion on the company s Breeze server requesting the list of courses The action call takes the form of an HTTP POST request with appropriate security credentials included in the request 5 The Breeze ser...

Страница 15: ...action_name accesskey access_key with the action s other parameters appended as additional query parameters separated by ampersands Create an XML object containing the parameter data as param tags con...

Страница 16: ...d and is member to make multiple updates in a single call specify each of those parameters for principal and group and then specify them using the same parameter names again for another and so on Abou...

Страница 17: ...uthorized to do so Almost every action call must include a cookie that represents a specific logged in user In Breeze 4 0 almost every action call must also include an access key In Breeze 4 1 you do...

Страница 18: ...s for Macromedia Breeze Enterprise licensed customers Note In Breeze 4 1 you no longer need an access key to call actions However passing the accesskey parameter in Breeze 4 1 is not harmful it is ign...

Страница 19: ...new folders You cannot specify this permission on meetings or courses denied The principal cannot view access or manage the SCO You cannot specify this permission on meetings or courses presenter For...

Страница 20: ...al principals About security and launching content When you launch a SCO you must provide authentication You can do so using any of the following approaches When you open the URL of the content add a...

Страница 21: ...atch 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 r...

Страница 22: ...O 8601 format For example May 28 2004 is expressed as 2004 05 28 and 4 23pm on May 28 2004 is expressed 2004 05 28T16 23 00 000 Starting with the year you may use as much of the date as you need to fi...

Страница 23: ...age 37 To filter 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 presenta...

Страница 24: ...e the following URL and filter to find all courses with the word filter in the name and the word date in the course description This example URL uses breezedev mycompany com as the server name and myf...

Страница 25: ...nt with filters and APIs in the browser you might get an unexpected response For example if you enter the wrong filter field name which matches some other item in the database you could receive an XML...

Страница 26: ...26 Chapter 2 Working with Filters...

Страница 27: ...me you call an action on the Breeze server you must include an access key and credentials indicating which logged in user is performing the action For more information about the Breeze security model...

Страница 28: ...e ok actions action accesskey exec action action accesskey info action action acl preference update action action action list action action custom field update action action custom fields action actio...

Страница 29: ...ams accesskey accesskey action login login login password password cfhttp url baseurl api xml params method get cfset loginHeaders cfhttp ResponseHeader cfloop collection loginHeaders item httpHeader...

Страница 30: ...o ok If your code must be robust you should check the status tag in the returned XML after every action 5 If the status code is ok search the returned list of principals to find all principals that ha...

Страница 31: ...e cfhttp url baseurl api xml action principal update accesskey accesskey first name newfirst last name newlast has children 0 login newlogin type user method post cfhttpparam type Cookie name BREEZESE...

Страница 32: ...SESSION value loginCookie cfhttp Add code here to check for an ok status code cfset xml XmlParse cfhttp FileContent cfset firstElement XmlSearch xml results contact first name cfset firstName firstEle...

Страница 33: ...the report my meetings action 3 Parse the returned XML and display the results For more information about the returned XML see my meetings on page 138 To display the contents of the user s content fol...

Страница 34: ...nd display relevant information to the user cfset response cfhttp FileContent cfset contentXml XmlParse response cfset contents XmlSearch contentXml sco cfset contentCount ArrayLen contents cfoutput t...

Страница 35: ...dentify the users who registered for a given meeting The Breeze XML web services include a variety of reports each of which provides data on Breeze use Report data is returned in XML form You can use...

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

Страница 37: ...ious common tasks see Chapter 3 Common Tasks on page 27 For more information about specifying parameters see About parameters on page 15 For more information about principals and SCOs see About princi...

Страница 38: ...primary groups 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...

Страница 39: ...nded report my courses Provides information about each course that the logged in user is enrolled in report my meetings Provides information about each meeting the logged in user is scheduled to atten...

Страница 40: ...ts Provides a list of the SCOs in a specified folder sco delete Deletes one or more SCOs sco info Provides information about a SCO sco move Moves a SCO from one folder to another sco nav Describes the...

Страница 41: ...ically adds the self registering user to the self registration group associated with the course or meeting if the group exists For more information see accesskey info Additionally you can specify cust...

Страница 42: ...no additional access key group element Parameters accesskey The access key for your account Note The accesskey parameter is required only in Breeze 4 0 it is not required for Breeze 4 1 If you includ...

Страница 43: ...update Description Updates the user profile to the specified language and time zone settings Parameters accesskey The access key for your account Note The accesskey parameter is required only in Breez...

Страница 44: ...T 03 30 Newfoundland 60 GMT 03 00 Brasilia 65 GMT 03 00 Buenos Aires Georgetown 70 GMT 03 00 Greenland 73 GMT 02 00 Mid Atlantic 75 GMT 01 00 Azores 80 GMT 01 00 Cape Verde Islands 83 GMT Greenwich Me...

Страница 45: ...193 GMT 06 00 Astana Dhaka 195 GMT 06 00 Sri Jayawardenepura 200 GMT 06 00 Almaty Novosibirsk 201 GMT 06 30 Rangoon 203 GMT 07 00 Bangkok Hanoi Jakarta 205 GMT 07 00 Krasnoyarsk 207 GMT 08 00 Beijing...

Страница 46: ...d only in Breeze 4 0 it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored Filters Results cannot be filtered or sorted Returned elements actions Sample results r...

Страница 47: ...s cannot be filtered or sorted Returned elements common Sample results results status code ok common locale en cookie breezm5qtgnye46zpckbf MARIANNE cookie date 2004 02 12T15 53 19 797 07 00 date host...

Страница 48: ...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...

Страница 49: ...comments field field field id 1330 custom seq 2 account id 7 type required name SSN name field custom fields results custom fields delete Description Deletes the specified account custom field Paramet...

Страница 50: ...you want to update is member Indicates whether the principal is added to true or deleted from false the group Filters Results cannot be filtered or sorted Returned elements None Sample results result...

Страница 51: ...or all subsequent requests use the following code URLConnection conn url openConnection conn setRequestProperty Cookie BREEZESESSION cookie conn connect Parameters accesskey The access key for your ac...

Страница 52: ...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 principal id parameter call the pri...

Страница 53: ...rimary false type user has children false permission id view name Englesberg Ari name login englesberg example com login principal principal principal id 181249 is primary false type user has children...

Страница 54: ...esults permissions update Description Updates one or more principals permissions for one or more SCOs For information about principals see About principals SCOs and IDs on page 16 For information abou...

Страница 55: ...eze 4 0 it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored principal id The ID of a specific principal Filters Results cannot be filtered or sorted Returned el...

Страница 56: ...login name test4 laxmi name principal principal custom field values field field id 652 custom seq 1 account id 7 type optional principal id 653 name Phone number name value 408 1111 111 value field pr...

Страница 57: ...rs group description principal principal list results principal update Description Updates information for a principal in the current account or creates a new principal For information about principal...

Страница 58: ...only when creating or updating a user login The principal s new login name which is usually the principal s e mail address This parameter must be specified only when creating or updating a user name...

Страница 59: ...1 it is ignored principal id The ID of a principal to delete Filters Results cannot be filtered or sorted Returned elements None Sample results results status code ok results report account meeting a...

Страница 60: ...2 55 810 07 00 date closed participant name Enterprise Administrator participant name row row account id 7 transcript id 685 sco id 623 principal id 8 contact id 3 login lnagaraj macromedia com login...

Страница 61: ...ed 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 17T17 06 23 92...

Страница 62: ...2T14 45 25 273 07 00 date begin sco report active meetings results report bandwidth Description Indicates the total bandwidth consumed in the current account since the account was created in bytes Par...

Страница 63: ...eport bulk content quiz Sample results results status code ok report bulk content quiz row presentation id 720 quiz id 1 quiz passing score 10 question number 1 question value 10 answer id 1 presentat...

Страница 64: ...it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored Filters The following table lists the fields that the data can be filtered and sorted on Returned elements r...

Страница 65: ...required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored Filters The following table lists the fields that the data can be filtered and sorted on Returned elements report bulk...

Страница 66: ...required only in Breeze 4 0 it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored Filters Results cannot be filtered or sorted Returned elements report bulk cours...

Страница 67: ...that the data can be filtered and sorted on 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...

Страница 68: ...ownloadable CSV data Parameters accesskey The access key for the account Note The accesskey parameter is required only in Breeze 4 0 it is not required for Breeze 4 1 If you include this parameter in...

Страница 69: ...d elements report bulk meeting attendance Sample results results status code ok report bulk meeting attendance row meeting id 623 meeting attendee 8 meeting name test mtg 1 meeting name attendee Enter...

Страница 70: ...be passed in based on the type of information needed Filters Results cannot be filtered or sorted Returned elements report course status Sample results When the sco id parameter is passed in the follo...

Страница 71: ...lowing table lists the fields that the data can be filtered and sorted on You cannot filter on any custom field For more information about filtering and sorting see Chapter 2 Working with Filters on p...

Страница 72: ...core 0 percentage score time taken 5360 certificate 634 answered survey 0 login testcourse laxmi test enang com login date taken 2004 07 07T12 37 29 623 07 00 date taken principal name courseTest1 lax...

Страница 73: ...Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored sco id The ID of a meeting Filters The following table lists the fields that the data can be filtered and sorted on For more inform...

Страница 74: ...o name date created 2004 07 09T14 35 59 170 07 00 date created date closed 2004 07 09T15 03 05 263 07 00 date closed participant name Enterprise Administrator participant name row report meeting atten...

Страница 75: ...ssociated sco ids can be obtained by invoking the report meeting sessions action Filters Results cannot be filtered or sorted Returned elements report meeting session Sample results results status cod...

Страница 76: ...lls 0 name My Meeting name date begin 2004 03 05T11 00 09 030 08 00 date begin row report meeting sessions results report meeting session slots Description Provides information about the number of att...

Страница 77: ...slot begin 2004 02 14T06 50 00 000 08 00 time slot begin time slot end 2004 02 14T07 00 00 000 08 00 time slot end row report meeting session slots results report meeting summary Description Indicate...

Страница 78: ...y 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 09T1...

Страница 79: ...r in Breeze 4 1 it is ignored Filters The following table lists the fields that the data can be filtered and sorted on For more information about filtering and sorting see Chapter 2 Working with Filte...

Страница 80: ...the principal list action but returns additional user custom field information This is the only report where you can filter users on the account custom fields Parameters accesskey The access key for...

Страница 81: ...login custom0 ENGG custom0 custom1 100 07 7777 custom1 row report principal list results report quiz answer distribution Description Indicates how many users selected a specific answer for all questio...

Страница 82: ...ution element is returned as shown in the following example results status code ok report quiz answer distribution results report quiz definition answers Description Provides information about each of...

Страница 83: ...00 kilometers body 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...

Страница 84: ...e 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 13T17 09 40 240 08 00 date modified row quiz...

Страница 85: ...e Enterprise Administrator name sco name quiz course sco name date created 2004 07 13T10 54 09 030 07 00 date created question Who is Randy Johnson question row row question number 2 transcript id 730...

Страница 86: ...in Breeze 4 0 it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored question id The ID of a specific question in the quiz sco id The ID of a presentation that con...

Страница 87: ...l standard defines ECMAScript question text answer text ECMA 262 answer text row report quiz question answer distribution results report quiz question distribution Description Indicates how many users...

Страница 88: ...AScript body row report quiz question distribution results report quiz question response Description Provides a list of all answers that users have given to a particular quiz question Use report quiz...

Страница 89: ...on totals Description Indicates for the specified quiz question the total number of users who answered the question and the number of users who answered the question correctly Use report quiz definiti...

Страница 90: ...report quiz results report quiz summary Sample results results status code ok report quiz results average score 95 low score 90 high score 100 numtaken 8 numdistincttaken 1 report quiz summary sco id...

Страница 91: ...ting see Chapter 2 Working with Filters on page 21 Returned elements report quiz takers Sample results results status code ok report quiz takers row transcript id 730 sco id 727 principal id 8 contact...

Страница 92: ...censed Support Center report quotas Description Returns information on the account quotas Parameters accesskey The access key for the account Note The accesskey parameter is required only in Breeze 4...

Страница 93: ...n For more information about filtering and sorting see Chapter 2 Working with Filters on page 21 Returned elements report sco slides Sample results results status code ok report sco slides row slide 1...

Страница 94: ...ents report sco views Sample results results status code ok report sco views row sco id 217706 type presentation is folder 0 views 24 name Quiz test 1 name last viewed date 2004 01 13T17 11 47 923 08...

Страница 95: ...row row principal id 123 question number 1 user name test1 laxmi user name question how are you question response ok response row report survey question response results report training concurrent us...

Страница 96: ...n existing SCO you must rebuild the SCO using the sco build action otherwise a user viewing the SCO continues to see the old version You can call the sco info action to obtain the current build status...

Страница 97: ...at the data can be filtered and sorted on For more information about filtering and sorting see Chapter 2 Working with Filters on page 21 Returned elements scos Sample results The name and date modifie...

Страница 98: ...2004 01 29T01 35 26 433 08 00 date modified duration 1900 01 02T 00 00 000 00 00 duration sco scos results sco delete Description Deletes one or more SCOs If the specified sco id is a folder all the...

Страница 99: ...e ok sco folder id 15 host id lang en learning time sco data id 625 sco id 623 source sco id status active tree id 14 type meeting date begin 2004 07 07T10 00 00 000 07 00 date begin date created 2004...

Страница 100: ...3 340 07 00 date 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...

Страница 101: ...for your account Note The accesskey parameter is required only in Breeze 4 0 it is not required for Breeze 4 1 If you include this parameter in Breeze 4 1 it is ignored folder id The ID of the destina...

Страница 102: ...ults sco search Description Provides a list of all SCOs that match the search text For every type of SCO the title and summary are searched For presentations and other SCOs that contain text the conte...

Страница 103: ...rl path p92628681 url path date created 2003 11 26T22 52 28 973 08 00 date created date modified 2003 11 26T22 52 37 867 08 00 date modified author info 1 lnagaraj macromedia com author info 1 hit 1 h...

Страница 104: ...http admin breeze example com domain name sco sco tree id 181226 sco id 181226 type courses domain name http admin breeze example com domain name sco sco tree id 181227 sco id 181227 type user conten...

Страница 105: ...sco build to build the SCO 4 Call the permissions update action to assign permissions to the SCO To use sco update with a Breeze course 1 Call sco update to create a course and associate pre existing...

Страница 106: ...be specified with sco id last name The last name of the contact person for the SCO Used only for presentations name The name of the SCO sco id The ID of a SCO to update This parameter is optional and...

Страница 107: ...atus code ok results The following sample XML is returned when a course is created results status code ok sco folder id 954 lang 1 type course sco id 1520 source sco id 720 status active tree id 10 sc...

Страница 108: ...file in a form on a web page After you upload a file call the sco build action to build it The following sample HTML is a form for associating content with a presentation created with the XML API FORM...

Страница 109: ...e already set a type for the SCO for example by using sco update summary A brief summary of general information about the SCO The summary appears in content listings and is returned by the sco info ac...

Страница 110: ...14 sco id 14 type user meetings domain name nagarajan macromedia com domain name tree trees results user accounts Description Provides a list of the accounts to which the specified user belongs In an...

Страница 111: ...2004 01 24T00 59 59 000 07 00 date expired user users results user update pwd Description Changes a user s password Parameters accesskey The access key for your account Note The accesskey parameter i...

Страница 112: ...112 Chapter 4 Action Reference...

Страница 113: ...he results tag also contains other tags that contain the data returned by the action For example a common info action might return the following results results status code ok common locale en cookie...

Страница 114: ...registering using the special access key access keys Contains one or more access keys account The account ID action The name of an action answer correct The text for a correct answer answer text The...

Страница 115: ...n The duration of a SCO email A user s e mail address expired A Boolean value indicating whether a SCO has expired field Contains information about custom fields first name A user s first name hit A n...

Страница 116: ...of a quiz quota Contains information on the account quotas report account meeting attendance Contains row tags that contain information about the meeting attendance log for the account report active m...

Страница 117: ...t quiz interactions Contains one or more row tags each containing information about an interaction a user had with the specified quiz report quiz question answer distribution Contains one or more row...

Страница 118: ...a particular SCO such as the name of a meeting sco nav Contains tags that contain information about the folder hierarchy that contains the specified SCO sco search info Contains one or more sco tags...

Страница 119: ...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 key...

Страница 120: ...ins a login and name tag Attributes account id The ID of the account of which the principal is a member This attribute is returned only by the principal info action has children Indicates whether the...

Страница 121: ...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 vb7gmg6ohtz4y7k...

Страница 122: ...Example action user accounts action actions Description Container tag contains a list of actions Attributes None Contained tags action Returned by action list Example actions action accesskey exec act...

Страница 123: ...ion The text of an answer to a quiz question as part of the results returned by a report action Attributes None Contained tags None content only Returned by report quiz answer distribution report quiz...

Страница 124: ...ts any comment goes here comments common Description Container tag contains tags that provide information about the server and the logged in user If you call common info without logging in first the s...

Страница 125: ...Description The value of the Java servlet session cookie named BREEZESESSION This is the same cookie that you send with every action call to indicate which user is making the call If you call common...

Страница 126: ...begin date created date end date modified expired name url url path Returned by report my courses Example course sco id 555038 status active type course name My Name name url admin breeze example com...

Страница 127: ...he server in ISO 8601 date format Attributes None Contained tags None content only Returned by common info Example date 2004 02 12T15 53 19 797 07 00 date date begin Description The date and time that...

Страница 128: ...00 date closed date created Description The date and time that a SCO was created in ISO 8601 date format Attributes None Contained tags None content only Returned by accesskey info report active meeti...

Страница 129: ...ontained tags None content only Returned by user accounts Example date expired 2004 01 24T00 59 59 000 07 00 date expired date last taken Description The date that a course was last taken in ISO 8601...

Страница 130: ...k a particular quiz in ISO 8601 date format Attributes None Contained tags None content only Returned by report quiz takers Example date taken 2004 01 13T01 33 49 460 08 00 date taken date time attemp...

Страница 131: ...nt 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...

Страница 132: ...le com email expired Description A Boolean value that indicates whether a SCO has expired A SCO has expired when its end date has passed and it is no longer available Attributes None Contained tags No...

Страница 133: ...field id 1562 account id 7 custom seq 4 type optional comments none comments name Manager name value 411 value field first name Description A user s first name Attributes None Contained tags None con...

Страница 134: ...reeze example com host invalid Description Container tag contains information about why a particular call to an action is invalid This element appears only inside a status tag and only when the code a...

Страница 135: ...n 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 duplic...

Страница 136: ...t viewed 2004 01 13T16 35 39 517 08 00 last viewed last viewed date Description The most recent date and time that the SCO was viewed in ISO 8601 date format Attributes None Contained tags None conten...

Страница 137: ...tes 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 alway...

Страница 138: ...000 08 00 date end url path p38547860 url path expired true expired course my courses my meetings Description Container tag contains information about one or more meetings Attributes None Contained ta...

Страница 139: ...session report meeting sessions report my courses report my meetings report quiz takers report sco views report training concurrent users sco contents sco info sco nav sco search user accounts Exampl...

Страница 140: ...sion id manage principal id 8 permissions Description Container tag contains information about one or more principals and their permissions For information about principals see About principals SCOs a...

Страница 141: ...the preferences are updated lang The language setting Breeze currently supports the following five languages time zone id The time zone setting Breeze currently supports the following 75 time zones La...

Страница 142: ...GMT 03 00 70 Greenland GMT 03 00 73 Mid Atlantic GMT 02 00 75 Azores GMT 01 00 80 Cape Verde Islands GMT 01 00 83 Dublin Edinburgh Lisbon London GMT 85 Casablanca Monrovia GMT 90 Belgrade Bratislava...

Страница 143: ...GMT 06 00 201 Rangoon GMT 06 30 203 Bangkok Hanoi Jakarta GMT 07 00 205 Krasnoyarsk GMT 07 00 207 Beijing Chongqing Hong Kong SAR Urumqi GMT 08 00 210 Kuala Lumpur Singapore GMT 08 00 215 Taipei GMT...

Страница 144: ...general information about principals see About principals SCOs and IDs on page 16 Attributes account id The ID of the account of which the principal is a member This attribute is returned only by the...

Страница 145: ...s field name Returned by permissions info principal update Example principal custom field values field field id 652 custom seq 1 account id 7 type optional principal id 653 name Phone number name valu...

Страница 146: ...children true is primary true is hidden 0 name Account Administrators name login Account Administrators login description Account administrators group description principal principal list principal n...

Страница 147: ...e 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...

Страница 148: ...ion 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...

Страница 149: ...e quota Description Container tag contains information on the account quotas Attributes acl id The ID of the SCO associated with the access key quota id The ID of a quota Breeze enforces different quo...

Страница 150: ...eport account meeting attendance Example report account meeting attendance row account id 7 transcript id 670 sco id 623 principal id 8 contact id 3 login lnagaraj macromedia com login session name En...

Страница 151: ...gs sco Returned by report active meeting presenters Example report active meeting presenters sco sco id 190298 name Jack Monson name date created 2004 02 17T17 06 23 920 08 00 date created sco sco sco...

Страница 152: ...n bytes Attributes total The total amount of bandwidth in bytes Contained tags None empty tag Returned by report bandwidth Example report bandwidth total 71000000 report bulk content quiz Description...

Страница 153: ...n 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 r...

Страница 154: ...on 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 ques...

Страница 155: ...login date time attempted 2004 07 13T10 54 09 030 07 00 date time attempted time taken 00 00 67 017 time taken row report bulk course quiz results report bulk meeting Description Container tag contain...

Страница 156: ...strator 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 m...

Страница 157: ...resentation name test slide presentation name view date time 2004 06 30T11 46 12 500 07 00 view date time row report bulk slide views report course status Description Container tag contains informatio...

Страница 158: ...ription Container tag contains one or more row tags each containing information about a user who attended a particular meeting Attributes None Contained tags row Returned by report meeting attendance...

Страница 159: ...f users Contained tags None empty tag Returned by report meeting concurrent users Example results status code ok report meeting concurrent users max users 2 max participants freq 5 report meeting sess...

Страница 160: ...information about all the sessions of a meeting Attributes None Contained tags row Returned by report meeting sessions Example report meeting sessions row sco id 622852 num participants 1 num guests...

Страница 161: ...re invited to the specified meeting and how many invitees and guests actually attended Attributes num guests attended The number of participants who entered the meeting as guests rather than registere...

Страница 162: ...ustom0 custom1 100 07 7777 custom1 row report principal list report quiz answer distribution Description Container tag contains one or more row tags each indicating how many users selected each answer...

Страница 163: ...reated question What is 2 2 question row row transcript id 459350 question id 258 sco id 217706 score 0 date created 2004 01 13T02 00 46 163 08 00 date created question How far is it from Earth to the...

Страница 164: ...swer text ECMA 976 answer text row row question id 259 answer id 4 correct 1 total responses 4 percentage responded 40 question text Which international standard defines ECMAScript question text answe...

Страница 165: ...pal id 506299 question id 257 answer id 2 body What is 2 2 body answer text 5 answer text row row principal id 557527 question id 257 answer id 2 body What is 2 2 body answer text 5 answer text row ro...

Страница 166: ...t 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 Return...

Страница 167: ...s Example report quiz takers row transcript id 586821 sco id 586760 principal id 506385 status not attempted score 0 percentage score 0 time taken certificate name Math Test name login benedict exampl...

Страница 168: ...id 7 quota id download quota used 0 limit 50000 soft limit 50000 date begin 1999 12 31T16 00 00 000 08 00 date begin date end 2999 12 31T16 00 00 000 08 00 date end quota report quotas report sco sli...

Страница 169: ...report sco views row sco id 217706 type presentation is folder 0 views 24 name Quiz test 1 name last viewed date 2004 01 13T17 11 47 923 08 00 last viewed date row report sco views report survey quest...

Страница 170: ...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 simultaneously Contai...

Страница 171: ...g on which action the tag is in response to and may include custom tags Returned by report course takers report meeting attendance report meeting sessions report meeting session slots report quiz answ...

Страница 172: ...dely depending on what action the tag is in response to Returned by report active meeting presenters report active meetings sco contents sco info sco nav sco search sco shortcuts sco update Example sc...

Страница 173: ...The number of slides in the SCO A value of 1 indicates that the slide count doesn t apply for example if the SCO is a meeting rather than a presentation the slide count is 1 version The version number...

Страница 174: ...Attributes None Contained tags sco Returned by sco nav Example sco nav sco sco id 181230 tree id 181230 type folder depth 2 name User Meetings name sco sco sco id 181576 tree id 181230 type folder de...

Страница 175: ...ns one or more sco tags each containing information about a SCO inside the specified folder Attributes None Contained tags sco Returned by sco contents Example scos sco sco id 505677 status no content...

Страница 176: ...cuts sco tree id 181230 sco id 181576 type my meetings 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...

Страница 177: ...t to invalid the status tag contains an invalid tag that provides more detail about what s wrong no access Indicates that you don t have permission to perform the action This can happen in several sit...

Страница 178: ...lot begin 2004 02 14T06 50 00 000 08 00 time slot begin Value Description account expired The customer account has expired denied Based on the supplied credentials you don t have access to perform the...

Страница 179: ...None Contained tags None content only Returned by report bulk course results Example time taken 00 34 23 011 time taken tree Description Container tag contains a tree that belongs to a specified accou...

Страница 180: ...Example trees tree account id 7 tree id 9 sco id 9 type content domain name nagarajan macromedia com domain name tree tree account id 7 tree id 10 sco id 10 type courses domain name nagarajan macrome...

Страница 181: ...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 E...

Страница 182: ...D 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 01...

Страница 183: ...ample user last name Administrator user last name user login Description The login of a user Attributes None Contained tags None Returned by report bulk content quiz results Example user login lnagara...

Страница 184: ...s Returned by user accounts Example users user user id 211729 account id 211655 name james example com name date expired 2004 01 24T00 59 59 000 07 00 date expired user user user id 212988 account id...

Страница 185: ...one 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 re...

Страница 186: ...186 Chapter 5 XML Results Reference...

Страница 187: ...incipal info 32 55 principal list 30 56 principal update 31 57 principals delete 31 59 reference entries 41 report account meeting attendance 59 report active meeting presenters 61 report active meeti...

Страница 188: ...74 attributes searching 30 authors primary group 16 B bandwidth reporting 62 basics of web services 10 body tag 123 bold text convention 11 Breeze displaying relevant content 33 documentation 9 integ...

Страница 189: ...sion 19 description tag 131 descriptions of principals 55 directory services synchronizing 28 disk space used 72 displaying returned information in a table 34 documentation and updates 9 domain names...

Страница 190: ...e tag 135 last viewed tag 136 last viewed date tag 136 late breaking news 9 launching content 20 LDAP 28 licensed customers access keys for 18 Lightweight Directory Access Protocol LDAP 28 limits on a...

Страница 191: ...uests HTTP 15 30 prerequisites 9 presentations about 16 number of slides 173 number of times viewed 93 94 searching 35 See also SCOs presenters of meetings 61 permissions 19 primary groups defined 16...

Страница 192: ...s action 76 report meeting session slots tag 160 report meeting sessions action 75 report meeting sessions tag 160 report meeting summary action 77 report meeting summary tag 161 report my courses act...

Страница 193: ...etting 54 permissions updating 54 searching 35 102 updating 104 uploading 108 URLs determining 103 See also courses folders meetings presentations quizzes scos tag 175 searching for content 35 SCOs 10...

Страница 194: ...s 157 report disk usage 158 report meeting attendance 158 report meeting concurrent users 159 report meeting session 159 report meeting session slots 160 report meeting sessions 160 report meeting sum...

Страница 195: ...ing 71 deleting 31 folders relevant 103 groups changing membership 50 IDs determining 33 information obtaining 47 55 listing 30 logging in 32 50 logging out 52 maximum concurrent 95 meeting attendance...

Страница 196: ...196 Index...

Результаты поиска

Содержание BREEZE-USING THE BREEZE XML WEB SERVICES

Отзывы:

MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES, Руководство пользователя, Страница: 38 / 196

Результаты поиска

Содержание BREEZE-USING THE BREEZE XML WEB SERVICES

Отзывы: