Adobe Using The Breeze XML Web Services Macromedia 4 Breeze4 En
User Manual: adobe Macromedia Breeze - 4 - Using the Breeze XML Web Services Free User Guide for Macromedia Breeze Software, Manual
Open the PDF directly: View PDF 
.
Page Count: 196
| Download | |
| Open PDF In Browser | View PDF |
Using the Breeze XML Web Services Trademarks ActiveEdit, ActiveTest, Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Blue Sky Software, Blue Sky, Breeze, Bright Tiger, Clustercats, ColdFusion, Contents Tab Composer, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, Help To Source, HomeSite, Hotspot Studio, HTML Help Studio, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Central, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, RoboDemo, RoboEngine JFusion, RoboHelp, RoboHelp Office, RoboInfo, RoboInsight, RoboPDF, 1-Step RoboPDF, RoboFlash, RoboLinker, RoboScreenCapture, ReSize, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, Smart Publishing Wizard, Software Video Camera, SoundEdit, Titlemaker, UltraDev, Web Design 101, what the web can be, WinHelp, WinHelp 2000, WinHelp BugHunter, WinHelp Find+, WinHelp Graphics 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 including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. Third-Party Information This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these 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-2004 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 prior written approval of Macromedia, Inc. Acknowledgments Project Management: Stephanie Gowin Writing: Jody Bleyle Managing Editor: Rosana Francescato Editing: Mary Kraemer Production Management: Patrice O’Neill Media Design and Production: Adam Barnett, John Francis Second Edition: September 2004 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103 CONTENTS INTRODUCTION: Before You Begin ................................... 9 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Guide to instructional media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 CHAPTER 1: Architecture Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Calling an action on the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 About parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 About principals, SCOs, and IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 About security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 CHAPTER 2: Working with Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 About filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About sort filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Special filter scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filter reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing code in the browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Where to go from here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPTER 3: Common Tasks 21 23 23 24 24 25 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Calling your first action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integrating Breeze with a directory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integrating Breeze with a portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPTER 4: Action Reference . 27 28 32 35 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Alphabetical action listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Action reference entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . accesskey-exec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . accesskey-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . acl-preference-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . action-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 41 41 42 43 46 3 common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-field-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 custom-fields-delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 group-membership-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 permissions-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 permissions-reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 permissions-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 principal-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 principal-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 principals-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 report-account-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 report-active-meeting-presenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 report-bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 report-bulk-content-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 report-bulk-course-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 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-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 report-my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 report-my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 report-quiz-definition-answers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 report-quiz-definition-questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 report-quiz-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 4 Contents report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 sco-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 sco-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 sco-move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 sco-search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 sco-shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 sco-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 sco-upload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 trees-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 user-accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 user-update-pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 CHAPTER 5: XML Results Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 About 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 answer-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 comment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 course . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 date-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 date-closed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-created . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 date-expired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-last-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 date-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 date-time-attempted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 domain-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Contents 5 expired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 hit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 last-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 last-viewed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 last-viewed-date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 participant-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 physical-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 presentation-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 principal-custom-field-values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 principal-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 question-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 quiz-definition-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 report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 report-bulk-course-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 report-bulk-meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 report-bulk-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 report-bulk-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 report-disk-usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 report-meeting-attendance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 6 Contents report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 report-quiz-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 report-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 report-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-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 sco-search-info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 scos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 source-sco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 time-slot-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 time-slot-end. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 time-taken. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 trees. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 url-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 user (common-info) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 user (user-accounts). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 user-first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 user-last-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 user-login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 user-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 view-date-time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Contents 7 8 Contents INTRODUCTION Before You Begin The Macromedia Breeze XML web services enable your external system (such as a web application) to interact with a Breeze server. This guide provides information on how to call XML web services (actions) on the Breeze server from your external system and how to interpret the XML results that Breeze returns. This guide also provides reference material explaining what each action does and what the parameters for each action are. Note: To use the Breeze XML web services, you must have a valid access key. For more information, see “About security” on page 17. The web services discussed in this document are subject to change. Please see the updates page (www.macromedia.com/go/breeze_xmlapi_updates) for the latest updates and changes. Audience This book is intended for developers 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 communicate between an application and a server. You must also understand how to write code in a server language such as Macromedia ColdFusion Markup Language (CFML). Guide to instructional media Macromedia Breeze contains a variety of media to help you quickly learn how to use the product. In addition to this book, the following electronic manuals and online help systems are available: • Breeze Installation Guide describes how to install the Breeze modules. This guide is available as a DVD insert for enterprise users, and as a PDF on the DVD. • Using the Macromedia Breeze Manager describes how to use the administration, presentation, and training components of Breeze Live. You can access Using the Breeze Manager from the Breeze Manager Home page, and from the Help link in the Breeze Manager web application. 9 • Breeze Live User Guide for Meeting Presenters includes information about using the Breeze Live web application to host online real-time meetings. The documentation includes procedures that demonstrate the simplicity of adding slides, Flash SWF files, images, live audio, and video to your presentation. You can access Breeze Live User Guide for Meeting Presenters from the Breeze Manager Home page and from the Help menu within a Breeze Live meeting room (when you enter as a presenter) by selecting Meeting > Help. • Breeze Live User Guide for Meeting Participants includes information relevant to users participating in an online real-time meeting. Breeze Live offers meeting participants several options to make their experience truly participatory, including the ability to send messages and questions to presenters and to each other, and the ability to participate through live video and audio. You can access Breeze Live User Guide for Meeting Participants from the Breeze Manager Home page and from the Help menu within a Breeze Live meeting room (when you enter as a participant) by selecting Meeting > Help. • Using the Macromedia Breeze Plug-In for Microsoft PowerPoint describes use of the plug-in that allows users to create Breeze presentations from PowerPoint. You can access Using the Breeze Plug-In for PowerPoint from the Breeze Manager Home page and from the Breeze menu in PowerPoint by selecting Breeze > Help. • Using the Breeze Publish Wizard 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 button on the Publish Wizard. Note: The relevance of these guides to users depends on the modules 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: Note: For a list of Breeze resources, see “Guide to instructional media” on page 9. The Web Service Primer at xml.com (http://webservices.xml.com/pub/a/ws/2001/04/04/ webservices/) is a good introduction to web services. “Working with XML and ColdFusion” in the ColdFusion Developer’s Handbook (www.macromedia.com/devnet/mx/coldfusion/articles/cf_handbk_ch6.html) provides information about XML basics and creating XML code using CFML. “Leveraging XML with ColdFusion” (www.macromedia.com/devnet/mx/coldfusion/articles/ cf_handbk_ch7.html) discusses web services, Simple Object Access Protocol (SOAP), and how to call web services using CFML. The XSL Transformations (XSLT) specification (www.w3.org/TR/xslt) introduces XSLT, which you can use to convert formatted data to other formats. Numeric representation of dates and time (www.iso.ch/iso/en/prods-services/popstds/ datesandtime.html) provides information about the ISO 8601 standard date and time format. More specifically, the W3C note about dates and times (www.w3.org/TR/NOTE-datetime) provides information about the specific profile of ISO 8601 that Breeze uses. 10 Introduction: Before You Begin Typographical conventions The following typographical conventions are used in this book: • Italic font indicates a value that should be replaced (for example, in a folder path). • Code font indicates code. It also indicates names of actions, names of parameters, names of tags, and names of attributes. • Bold font indicates a verbatim entry. Typographical conventions 11 12 Introduction: Before You Begin CHAPTER 1 Architecture Overview The Macromedia Breeze XML API model exposes interfaces as a set of XML web services. These services let your external system (such as a portal application) communicate with the Breeze server, using HTTP or HTTPS to call actions on the server and to receive results formatted as XML code. You can use the web services to add Breeze management and reporting capabilities to your external system. Note: Breeze doesn’t currently support Simple Object Access Protocol (SOAP). This chapter describes the flow of data between the Breeze server and web applications and how you set parameters and security permissions. 13 Data flow The following diagram shows an example of the flow of data in a web application that interacts with the Breeze server: Step 1: Web browser requests page. Step 2: Web server finds page and passes it to application server. Step 3: Application server executes code. Step 4: Application server calls action on Breeze server. Step 7: Web server sends finished page to requesting browser. Step 6: Application server inserts data in page and then passes the page to the web server. Step 5: Breeze server returns XML data to application server. The following example describes what might happen when a user connects to a training portal intranet site that was created with Macromedia ColdFusion MX and that uses Breeze XML web services: 1. A logged-in user uses a web browser to request a page that shows a list of the courses that the user is signed up for. 2. The 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. 4. As part of executing the code, the application server calls an action 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 server executes the action, returning the resulting XML data to the application server. 6. The application code parses the returned XML and inserts data into the web page as appropriate, and then passes the finished page to the web server. 7. The web server passes the finished page to the browser to be displayed. 14 Chapter 1: Architecture Overview Calling an action on the server To call an action on the Breeze server, pass the relevant parameters to the web services servlet at http://server_name/api/xml. In Breeze 4.0, there are two parameters that are required for all actions: the parameter named action specifies the name of the action, and the parameter named accesskey specifies the account’s access key. In Breeze 4.1, you do not need to pass the accesskey parameter. Passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. Most actions also have other parameters. For more information about access keys, see “About security” on page 17. For more information about additional parameters for a given action, see the action’s documentation in Chapter 4, “Action Reference,” on page 37. 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". (In most cases, you don’t need to explicitly set the content type when you use this approach.) The URL to use for the query string has the form http://breeze.example.com/api/ xml?action=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 contained in a params tag, and then send an HTTP POST request to the server, with the HTTP content type set to "text/xml". For example code demonstrating how to call an action, see Chapter 3, “Common Tasks,” on page 27. Note: The example code in this book uses the query parameters approach, both for readability and because of limitations in using CFML to send XML objects containing parameter data. Macromedia recommends using the POST method when possible; because of the way HTTP implements GET and POST, using POST may provide higher security levels than passing parameters in the query string. For more information, see “About security” on page 17. About parameters For most actions, you can specify one or more additional parameters. (The accesskey and action parameters are required. For more information, see “Calling an action on the server” on page 15.) You usually specify parameters as name-value pairs, but the exact process depends on the details of the language you use to call the action on the Breeze server. For sample code in ColdFusion Markup Language (CFML), see Chapter 3, “Common Tasks,” on page 27. In the documentation for each action, all listed parameters are required except for those specifically marked as optional. About parameters 15 For some actions, you can provide multiple parameters with the same name. For example, the principals-delete action takes a parameter named principal-id; you can specify multiple principal-id name-value pairs (each with the name principal-id) when you call the action on the Breeze server. The following CFML code example shows how to delete two specified users in a single action call, by specifying two principal-id parameters. (This example relies on variables called baseurl, accesskey, and loginCookie that you set during the login process. For more information, see “Integrating Breeze with a directory service” on page 28.)In some other actions, you can provide multiple sets of parameters. For example, the groupmembership-update action takes parameters named group-id, principal-id, 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. About principals, SCOs, and IDs There are two basic kinds of entities in Breeze: principals and Shareable Content Objects (SCOs). A principal is any entity that can have permissions that control how it can interact with SCOs. The following are the most common types of principals: A specific user. user A group of users. group There are other types of principals, known as primary groups: admins, authors, live-admins, and course-admins. For information about primary groups, see Using the Breeze Manager. You can create and modify users and groups, but not primary groups. A SCO is a Breeze document, such as a meeting or a presentation. Folders are also SCOs. Breeze includes the following types of SCOs: The root of a folder hierarchy. A tree’s root is treated as an independent hierarchy; you can’t determine the parent folder of a tree from inside the tree. tree folder A folder on the server’s hard disk, containing Breeze content. presentation course meeting A course. A meeting. flv A Flash video file. swf A Flash SWF file. image 16 A presentation. An image file. Chapter 1: Architecture Overview session A session of a meeting. A session begins when someone enters an empty meeting and ends when all attendees leave the meeting. archive An archived meeting. attachment pod A file shared using the file-sharing pod within a meeting. A plug-in for a meeting. An image (such as a corporate logo) that can be attached to content such as presentations. logos Each principal and SCO has a unique ID number. When you call an action 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 acl-id, folder-id, group-id, parent-acl-id, principal-id, sco-id, and user-id. For example, to update a user’s password, call the user-update-pwd action, and give the user’s ID as the user-id parameter. To determine a user’s name, call the principal-info action, and give the user’s ID as the principal-id parameter. There are a few other kinds of IDs, such as account-id, answer-id, permission-id, and question-id. But in most cases, a parameter name that ends in -id indicates that the parameter’s value is either a principal’s ID or a SCO’s ID. About security The security model in Breeze ensures that any code calling a given action is authorized 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 not need to pass the accesskey parameter. However, passing the accesskey parameter in Breeze 4.1 is not harmful, it is ignored. In Breeze 4.0, the access key (also called a connection key) is a code that prevents unauthorized use of the server. Every action (including login) requires an access key, which you specify as a parameter named accesskey. Access keys are case-sensitive. To locate your access key, see “Access keys for Macromedia Breeze hosted (ASP) customers” on page 18 and “Access keys for Macromedia Breeze Enterprise (licensed) customers” on page 18. To call most actions, you must be acting as a particular logged-in user, so you must call the login action before you can perform most other actions. (The exceptions, which are the actions you can call without logging in, are Action Reference, action-list, common-info, login, and useraccounts.) When you log in, the Breeze server returns XML results, which indicate a successful login. The HTTP headers of those results include a cookie called BREEZESESSION. When you receive the results of a login call, you must save the value of that cookie for later use. You must include that cookie’s value in every subsequent request that you make as that logged-in user. For examples of how to do this, see Chapter 3, “Common Tasks,” on page 27. About security 17 To successfully call an action, you must supply both an access key and the cookie for a logged-in user who has the permissions to call that action. If you don’t supply both credentials (for example, if you supply the cookie for a user who doesn’t have the right permissions), the action fails. Your application can log in multiple users and can call actions for any of those users. For example, when an ordinary user is using your application, you may want to authenticate as that user and call actions using that user’s credentials, while also keeping an administrative user logged in to perform tasks that require higher levels of permissions. For information about the possible status codes that the server can return, see the status tag. Access keys for Macromedia Breeze hosted (ASP) 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 ignored. By default, your account is not enabled for XML web services. You must contact Macromedia technical support to obtain a valid XML access key to use with each action. To contact technical support, go to the Breeze support page (www.macromedia.com/support/ breeze/) and request that an XML access key be generated for your account. Access keys 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 ignored. Your server installation initially has no XML access key. You must add an access key before you can use the XML web services. To add an access key: 1. Locate the custom.ini file, in the breeze subdirectory of the installation directory. 2. Add a parameter at the end of the file by typing the following text on a new line: XML_API_KEY= 3. Immediately after the equal sign (=), on the same line, type an access key of your choice. The key should be 16 characters and should be a combination of numbers and letters. Access keys are case-sensitive. 4. Stop the Breeze server, and then restart it. About permissions Permissions define the ways in which a particular principal can interact with a given SCO. A permission mapping, indicating what permissions a particular principal has for a particular SCO, is called an ACL. An ACL consists of three pieces of information: the ID of a SCO (usually referred to in this context as an ACL ID), the ID of a principal, and a keyword that indicates what the permissions are (usually referred to as a permission ID). There are two kinds of permissions in Breeze: permissions associated with specific SCOs, and permissions that belong to all users who are members of special groups that are called primary groups. Permissions for primary groups take precedence over the permissions set on a SCO. 18 Chapter 1: Architecture Overview To find out what permissions a logged-in user has for a particular item, call the permissions-info action. To change a principal’s permissions, call the principal-update action. If a particular principal has no explicitly specified permissions on a particular SCO, that principal’s permissions on the SCO’s parent apply. You can specify the following permissions on a SCO: view The principal can view the SCO but not modify it. For a course, the view permission lets the principal enroll in the course. For a meeting, view lets the principal attend the meeting. For a folder, view lets the principal view the contents of the folder. publish The principal can publish the SCO to the server and can update the SCO. This permission includes the view permission. It also lets the principal view reports related to the SCO. For a folder, publish doesn’t let the principal create new folders within the folder or to set permissions for the folder. You cannot specify this permission on meetings or courses. The principal can view, delete, move, and edit the SCO. This permission also lets the principal set permissions for the SCO. For a folder, the manage permission lets the principal view reports for files in the folder and create new folders. You cannot specify this permission on meetings or courses. manage The principal cannot view, access, or manage the SCO. You cannot specify this permission on meetings or courses. denied presenter (For meetings only) The principal can create or present a meeting. This permission lets the principal create or present the meeting, even if the principal doesn’t have view permission on the meeting’s parent folder. Because a group is a principal, you can set these permissions on a SCO for a nonprimary group as well as for an individual user; if a group has a particular permission, all members of the group have that permission. Use the group-membership-update action to add a member to a group. Use the permissions-update action to set a group’s permissions for a particular SCO. The only way to obtain certain other kinds of permissions is to be a member of a primary group, as follows: The account authors primary group lets its members create or edit a presentation anywhere in the system, regardless of the ACL permissions. The account administrators primary group can manage users and groups. The account meeting administrators primary group can create and present meetings anywhere in the system, regardless of the ACL permissions. The course managers primary group can create and edit courses anywhere in the system, regardless of the ACL permissions. To have full access to the entire system, you must be a member of all four primary groups. About security 19 About public access permissions There is a special principal ID which, instead of being a number, has the value "publicaccess". This ID sets the default access setting for everyone, whether they are logged in or not. You can assign any of the following permissions on a SCO for the public-access principal: Nobody can view, access, or manage the SCO. denied view Anyone can view the SCO, even if not logged in. view-only (For presentations only) Anyone can view the presentation, even if not logged in. However, the permissions set on the presentation’s parent folder do not apply to the presentation. For example, even if a user has manage permission on the parent folder, the user can’t delete a presentation that has view-only permission. (Normal permissions still apply to the presentation; if the user has manage permission on the presentation, the user can delete it.) (For meetings only) Anyone can attend the meeting, even if not logged in. However, the permissions set on the meeting’s parent folder do not apply to the meeting. view-hidden Never assign manage, presenter, or publish permissions to the public-access principal. Never assign view-only or view-hidden permissions to normal 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 query parameter named session with a value equal to the value of the login cookie, as shown in the following example: http://breeze.example.com/p12345678/?session=breez3238uf298 This approach is a potential security problem because anyone who obtains the specified URL can act as the logged-in user. If you take this approach, use the cookie for an ordinary user rather than the cookie for an administrative user. Also, if a user gives the URL to someone else (for example, by copying it and pasting it into an e-mail message), they are giving access to their account, which presents a security risk. • You can set a BREEZESESSION cookie on the user’s browser, using the value of the login cookie. However, this approach works only if your application is running on a server with the same domain name as the Breeze server. Also, if your application server is a J2EE servlet environment (such as 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 some inconvenience for users. 20 Chapter 1: Architecture Overview CHAPTER 2 Working with Filters The data and information in your company’s Macromedia Breeze content repository can grow significantly over time. When this occurs, you might not want to list every item in the repository for all users. For example, you could list the most recently created courses and the latest quarterly financial results presentation on your company’s intranet. You need to sort and organize your growing repository to make sure users find the information they are looking for quickly. Filters are the mechanism within Macromedia Breeze XML web services that you can use to define the criteria for retrieving data from Breeze. You use one or more filters with a specific XML API to ensure the data your users see matches exactly what they are looking for. About filters You can filter for many (but not all) fields in the XML, and you can filter to include values for that field or exclude values for that field. You can also sort the results and filter the return set to include less results, for example, the first 25 rows that 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 filter, append it to an action call with an ampersand (&), as in the following: report-my-course&filter-like-name=Java You can string multiple filters together, each separated by an ampersand (&), as in the following: report-my-course&filter-like-name=Java&sort-date-begin=desc As you can see, filters are comprised of a type (either filter or sort) with an optional modifier (for example, like), the name of the field (for example, name), if needed, and finally, the value of the field name (for example, Java). The following is the filter format: Type-Modifier-FieldName=Value There are two types of filters, a basic filter, which begins with the word filter, and a sort filter, which begins with the word sort. You can combine sort filters and regular filters as needed to achieve your desired results. For more information about sort filters, see “About sort filters” on page 23. 21 Filter examples The following is a simple example to help illustrate the general concept of filters. The web service API report-my-courses returns the list of courses you are enrolled in. This same API used with a filter on the course name, for example report-my-courses&filter-like-name=Java, retrieves your courses with the specified text in the name, in this case “Java”. If you add a sort filter such as report-my-course&filter-like-name=Java&sort-date-begin=desc, Breeze sorts your Java courses and displays the course you started first. In these examples, there are two types of filters: filter and sort. The basic filter uses the like modifier on the name field with a value Java. If you omit the like modifier, Breeze would return courses with the exact name Java instead of courses with Java in the name. Using the sort filter without a modifier on the date-begin field with a value desc specifies a descending order. The following table lists a few more examples that are helpful for understanding filter basics: Filter Description filter-name=Goals Review Returns items from the server that have the specific name “Goals Review.” This may apply to meetings, courses, or any items with a name field. filter-like-name=Goals Returns all items with “Goals” in the name such as “Goals Review” or “Quarterly Goals.” filter-out-name=Status Filters out or excludes any items with the word “Status” in the name field. filter-like-name=Goals &filterout-status=active Returns all items with “Goals” in the name that are no longer active; for example, to find previous presentations on “Goals” from previous quarters. filter-gt-date-begin=2004-0501&sort-name=asc Returns all items with a begin date later than May 1, 2004, sorted by name in ascending order. filter-gt-date-begin=2004-05Returns all items started in the month of May, 2004. 01&filter-lt-date-begin=2004-05-31 About date formatting In Breeze, dates are a special type of field value that follow the ISO 8601 format. For example, May 28, 2004 is expressed as 2004-05-28 and 4:23pm on May 28, 2004 is expressed 2004-0528T16:23:00.000. Starting with the year, you may 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 year and month. You add as much of the date as you need to select the most accurate data from the server. 22 Chapter 2: Working with Filters About sort filters You can use a filter of the type sort to sort data in ascending and descending order. For example, the following filter sorts the name field in ascending order: sort-name=asc The following code sorts the name field in descending order: sort-name=desc You can also perform primary and secondary sorts. For example, when listing calling the principal-list action to list principals, you can do a primary sort on the type field and then a secondary sort on the name field (this way, all principals of a specific type are grouped together and sorted by name in each group). You can do this by specifying the following parameters: sort1-type=asc&sort2-name=desc Special filter scenarios The following scenarios for filtering data vary for each action, for specific information about sort and filter options for individual actions, see their entries in Chapter 4, “Action Reference,” on page 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 presentation: filter-type=folder&filter-type=presentation The following example shows all types except folder and presentation: filter-out-type=folder&filter-out-type=presentation If the type field allows a null value, you might want to filter out entries with null and non-null values. The following example shows only types that are null: filter-type=null The following example shows only types that are not null: filter-out-type=null To filter based on the length of a record: The following shows all records whose date modified is between July 1 and July 10: filter-lt-date-modified=2004-07-10T10:00:00.000-07:00&filter-gt-datemodified=2004-07-1T10:00:00.000-07:00 To filter a specific number of entries starting at a specific entry: You can use this technique to create pagination when there is too much data for one page. The following example shows 25 records starting at the 100th record: filter-rows=25&filter-start=100 Special filter scenarios 23 Filter reference Filters are comprised of a type (either filter or sort) with an optional modifier, the name of the field, if needed, and finally, the value of the field name, as shown in the following example: Type-Modifier-FieldName=Value The following table lists all the filter types and modifiers you can use with Breeze: Type Modifier Description filter (none) Field must match value exactly. filter like Field must contain value. filter out Field cannot contain value. filter rows Limits the return result to number of rows specified in value. Does not use the field name. filter start Limits the return result to number of rows specified in value. Does not use the field name. filter gt Selects all items greater than the value. Works only with dates. filter lt Selects all items greater than the value. Works only with dates. filter gte Selects all items greater than or equal to the value. Works only with dates. filter lte Selects all items less than or equal to the value. Works only with dates. sort (none) Sorts results. Value must be asc or desc. Testing code in the browser You can enter a test URL in the address field of a browser window and see the XML response from the server. It is a good idea to become comfortable with filters in the browser before you write code. There are many nuances to filters that determine which types of filters you can use with certain API calls. The browser approach lets you quickly try combinations to see what works and what doesn’t. If you try this outside the browser, you add the extra time of compiling, loading the result in your application server, and debugging to see if a filter works as you expect. Using a browser, on the other hand, is much faster and gives you immediate feedback. For example, you could use 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 myf1rst@pp^ for the API access key. Make sure you log on to the server first, and then enter the following URL, substituting your server name for breezedev.mycompany.com and your API access key for myf1rst@pp^: http://breezedev.mycompany.com/api/xml?accesskey= myf1rst@pp^&action=reportmy-courses&filter-like-name=filter&filter-like-description=date 24 Chapter 2: Working with Filters The result in the browser should look similar to the following: If your filters are too stringent and no courses meet your criteria, the output looks like this: Understanding Filters Part 2 Second course in the series, covering important topics such as date and range filtering. admin.ibreeze.macromedia.com/p40583853/ 2004-05-26T17:51:40.840-07:00 2004-05-26T17:51:47.750-07:00 2004-05-24T14:00:00.000-07:00 /p40583853/ false Finally, as you experiment 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 response that starts with the following: To be production-ready, develop your code to handle unexpected errors and situations. Make sure you check for unexpected status codes and inform your IT team when you encounter such a situation. Where to go from here The Macromedia Breeze Resource Center has 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 allows the user to search and sort the list. It also explains the different ways that filters help you optimize retrieved data for use in other enterprise systems. Where to go from here 25 26 Chapter 2: Working with Filters CHAPTER 3 Common Tasks This chapter describes common scenarios for integrating Macromedia Breeze with external applications or systems. These scenarios show how to accomplish several common tasks. To perform each task, you call one or more actions on the Breeze server and then parse the XML tags that the server returns. In some cases, you use returned information as parameter values for the next action. This chapter also provides sample code demonstrating how to perform some of the tasks using Macromedia ColdFusion Markup Language (CFML). Note: Not all the task descriptions include sample code. The syntax for calling an action is consistent for all actions, so you can use the sample code from tasks that include it as models for code to perform other tasks. Each time 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, including information about access keys, see “About security” on page 17. For detailed information about each action and each XML tag, see Chapter 4, “Action Reference,” on page 37 and Chapter 5, “XML Results Reference,” on page 113. Calling your first action You can enter a test URL in the address field of a browser window and see the XML response from the server. You should be comfortable with actions in the browser before you write code. A good action to call is action-list because it returns a list of all the other actions you can call. To call an action in a browser, you need to know the following: • The domain of your breeze account. For example, breeze.yourcompany.com. • The name of the action you want to call. For a complete list of actions, see “Action Reference” on page 37. 27 • In Breeze 4.0, the access key for your Breeze account. In Breeze 4.1, you do not need an access key, but it’s not harmful if you use it. For information about where to locate your access key, see “Access keys for Macromedia Breeze hosted (ASP) customers” on page 18 and “Access keys for Macromedia Breeze Enterprise (licensed) customers” on page 18. To call a Breeze action in a browser: 1. Open a browser. 2. Enter the address of the breeze server in the browser’s address bar. Append the following action and accesskey parameters in a query string: http://breeze.example.com/api/xml?action=action_name&accesskey=access_key Note: You do not need to append the accesskey parameter in Breeze 4.1. 3. Press Enter (Windows) or Return (Macintosh). The action returns its XML results in the browser window. A call to action-list returns the following example: This is the same XML that returns when you call the action in an application. You can also test filters in the browser. For more information, see “Testing code in the browser” on page 24. Integrating Breeze with a directory service Suppose your organization uses a central repository of user information, such as Lightweight Directory Access Protocol (LDAP). Breeze lets you import or synchronize user information from such a directory service. The following procedure describes the steps that your application should follow to perform this task. This procedure assumes that if the information provided by the directory service doesn’t match the information provided by the Breeze server, the information from the directory service is correct and up-to-date. 28 Chapter 3: Common Tasks To synchronize Breeze with the directory service: 1. Log in by calling the login action on the Breeze server, specifying the login name and password of an account administrator. Examine the returned HTTP headers to find the value of the BREEZESESSION cookie, which you need when calling subsequent actions. Note: Consider creating an administrative user specifically for performing synchronizations. If you create such a user, you should exclude it from the list of users to synchronize when you perform the synchronization. The following code example logs in a user and obtains the cookie value: accesskey-exec accesskey-info acl-preference-update action-list custom-field-update custom-fields custom-fields-delete custom-fields-order-update ...the list of actions continues here...password="abcdefg"> accesskey="0123456789101112"> baseurl="http://breeze.example.com/"> 2. Check that the login action completed successfully by parsing the returned XML and examining the value of the status tag’s code attribute. If the status code isn’t "ok", determine what the error was and handle it appropriately. Integrating Breeze with a directory service 29 3. Request a list of Breeze users from the Breeze server by calling the principal-list action. The server returns a complete list of all principals, including principals that aren’t users. (For information about principals, see “About principals, SCOs, and IDs” on page 16.) The following code calls the principal-list action. The cookie value from the previous step is included as an HTTP parameter. Note: This HTTP request uses the "post" method rather than "get" because the only way to specify an HTTP parameter in CFML is by using "post". The URL and the query parameters remain the same as if you were using "get", however. 4. Ensure that the action 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 action. 5. If the status code is "ok", search the returned list of principals to find all principals that have a type attribute set to user. The following example places a list of all Breeze users into the array allUsers: 6. Obtain a list of all the users listed in the directory service. The procedure for obtaining this list depends on the directory service. 7. Compare the values contained in the login tags for the Breeze users with the e-mail addresses from the directory service, using a list-comparison algorithm of your choice. Determine which users are in the directory service but not in Breeze; these are new users to be added to Breeze. Also determine which users are in Breeze but not in the directory service; these users should be removed from Breeze. Finally, determine which users are in both Breeze and the directory service, but have different names in the two places; these users’ names should be changed in Breeze. 30 Chapter 3: Common Tasks 8. For each user listed in the directory service but not in Breeze, add the user to Breeze, as follows: a Obtain the user’s first name, last name, and login name from the directory service. The Breeze login name is usually the user’s e-mail address. b Call the principal-update action, setting the type parameter equal to user. Don’t specify a principal-id parameter; leaving out principal-id indicates that you are adding a new user rather than updating an existing user. c Check the returned XML to ensure that the status code returned is "ok". The following code demonstrates how to add a user to Breeze. It uses variables set up in previous steps of this procedure, such as baseurl. To keep the example clear and simple, this code specifies the user’s information in the first few lines, rather than acquiring that information from a directory service. 9. For each user listed in Breeze but not in the directory service, delete the user from Breeze by calling the principals-delete action and specifying the user’s ID. Check the returned XML to ensure that the status code returned is "ok". The following code demonstrates how to delete a specified user: Integrating Breeze with a directory service 31 10. For each user whose information in Breeze must be updated, obtain the user’s ID, as follows: a Examine the data returned by the principal-list action in steps 2 through 4 and search for the ID associated with the user’s login. b Obtain the user’s old first name and last name by calling the principal-info action. c Change the values as needed to match the name given by the directory service. d Call the principal-update action. e Check the returned XML to ensure the status code returned is "ok". The following code doesn’t include code for calling principal-update or checking the status code because those procedures were described in earlier steps: ... ... ... Integrating Breeze with a portal Suppose you have a portal application, such as a company’s intranet portal. You can integrate Breeze into the portal to let users view and modify Breeze-related information from within the context of the portal. For example, users can view upcoming Breeze meetings and see which courses they are enrolled in. The procedures in this section describe how to perform various tasks for a portal application integrated with Breeze. To log in as a particular user: 1. Obtain the user’s login name and password, using a web-based form. 2. Call the login action on the Breeze server, using the specified login name and password. 3. Check the returned XML to ensure the status code returned is "ok". 32 Chapter 3: Common Tasks To determine a user’s ID, given their login name and password: 1. Log in as the user. 2. Call the common-info action. 3. Parse the returned XML to find the value of the user-id attribute of the user tag. That value is the user’s ID. To check whether an entered password is correct: 1. Log in as the user. 2. If the status code returned is "ok", the password is correct. This procedure is the only way to check a password; for security reasons, Breeze doesn’t let you request a user’s password from the server. To list all the courses the user is enrolled in: 1. Log in as the user. 2. Call the report-my-courses action. 3. Parse the returned XML and display the results. For more information about the returned XML, see my-courses on page 137. To list all the meetings the user has signed up to attend: 1. Log in as the user. 2. Call 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 folder: 1. Log in as the user. 2. Call the sco-shortcuts action. This action provides the location of the root folder of the current account as well as the locations of other folders, such as the current user’s meetings and other content. The following code uses the same baseurl, accesskey, and loginCookie variables that are set in the login code in “Integrating Breeze with a directory service” on page 28: 3. Determine the ID of the my-content folder, by searching for the appropriate type attribute in the returned sco tags: xml= XmlParse(response)> contentScoElement= XmlSearch(xml, "//sco[@type='my-content']")> contentSco= contentScoElement[1].XmlAttributes["sco-id"]> Integrating Breeze with a portal 33 4. If you want to provide links to content items in the form of absolute URLs, determine the domain name of the folder: 5. Call the sco-contents action, using the folder’s SCO ID. The following action provides a list of the contents of the specified folder: 6. Parse the returned XML and display relevant information to the user: 7. To provide links to launch content items, call the sco-info action for each item, and determine the item’s full absolute URL by appending the returned url-path tag to the domain name you acquired. This results in a URL such as http://breeze.example.com/p12345678/. For more information about launching content, see “About security and launching content” on page 20. 34 Chapter 3: Common Tasks To create a new meeting: 1. Log in as the user. 2. (Optional) Let the user determine the ID of the folder in which to create the new meeting, using a web-based interface. If you don’t specify a folder, the meeting is created in the my-meetings folder. You can determine the ID of the my-meetings folder by calling the sco-shortcuts action. 3. Call the sco-update action, using the folder’s ID for the folder-id parameter. Don’t specify a sco-id parameter. 4. Verify that the action completed successfully by checking the returned status tag. To search for content: 1. Obtain the string to search for from the user, using a web-based form. 2. Log in as the user. 3. Call the sco-search action, using the specified string as the value of the query parameter. 4. Parse the returned XML to find information about the SCOs that contain the string; display the relevant information to the user. Generating reports Suppose you want your application to provide information about all the courses a user is registered for or to identify 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 the results in your system, such as a web application, or you can convert the data into other file formats, such as comma-separated-values (CSV) files. To generate a learner status report as a CSV file: 1. Log in as an administrator. 2. Determine the ID of a course. In most cases, you are presenting a list of courses (obtained by calling the sco-contents action, which also gives the IDs for the courses) in the application’s UI, and the user selects a course. 3. Call the report-course-takers action. This action returns a set of row tags, each providing information about a user who is signed up for the course. 4. Parse the XML and write the data as text, with commas separating the fields, to a CSV file. The most common approach shows the resulting CSV file as text in the user’s browser, which lets the user save the file to their local disk. You can use a server language such as CFML to translate the file to CSV, or you can use a transformation language such as XSLT. For information about XSLT, see “Additional resources” on page 10. Generating reports 35 36 Chapter 3: Common Tasks CHAPTER 4 Action Reference This chapter provides reference material for each action that is exposed in the Macromedia Breeze XML API, including information about the parameters that you can pass with each action. This chapter lists the actions in alphabetical order. Every action returns a results tag that contains one or more other tags, including a status tag. The “Returned elements” section of each action’s documentation lists only the other elements returned; results and status are assumed. For information about the XML tags, data, and status codes returned by the Breeze server, see Chapter 5, “XML Results Reference,” on page 113. For examples of how to perform various 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 principals, SCOs, and IDs” on page 16. You must provide security credentials every time you call an action. For more information, see “About security” on page 17. Alphabetical action listing The following list is all the actions documented in this reference chapter: Action Description accesskey-exec Executes special functions associated with special access keys. accesskey-info Provides a special access key, if such a key is associated with the specified SCO. acl-preference-update Updates the user profile to the specified language and time zone settings. action-list Returns a list of web service actions. common-info Provides basic information about the current user and server. 37 Action Description custom-field-update Updates the specified account custom field. Creates a new one if none exists. custom-fields Lists the custom fields of an account and the details of the fields. custom-fields-delete Deletes the specified account custom field. group-membership-update Adds one or more principals to a group, or removes one or more principals from a group. login Logs in a user. 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. 38 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. Chapter 4: Action Reference Action Description report-bulk-meeting-attendance Returns meeting attendance data. report-course-status Returns course status for either a principal or a SCO, based on the parameters passed in. report-course-takers Provides a list of the users enrolled in the specified course. report-disk-usage Provides information about how much hard disk space the Breeze content for the current account uses, in bytes. report-meeting-attendance Provides a list of users who have attended the specified meeting. report-meeting-concurrent-users Indicates the maximum number of users who can participate simultaneously in the specified meeting. report-meeting-session Provides information about a specific meeting session, such as the session name, session start and end times, and the number of participants and guests who attended the session. report-meeting-sessions Provides information about all the sessions of a meeting. report-meeting-session-slots Provides information about the number of attendees in every ten-minute time slot of the specified meeting session. report-meeting-summary Indicates how many users were invited to the specified meeting and how many invitees and guests attended. 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 attend. report-principal-list Returns the list of all principals in the account. report-quiz-answer-distribution Indicates how many users selected a particular answer to a particular quiz question. report-quiz-definition-answers Provides information about each of the allowed answers (both correct and incorrect) for the specified quiz. report-quiz-definition-questions Provides information about each question in a quiz. report-quiz-interactions Provides information about all the interactions that users have had with the specified quiz. report-quiz-question-answerdistribution Indicates 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 question, the total number of users who answered the question and the number of users who answered the question correctly. report-quiz-summary Provides information about the results of a quiz. Alphabetical action listing 39 40 Action Description report-quiz-takers Provides information about everyone who has taken a particular quiz. report-quotas Returns information on the account quotas. report-sco-slides Indicates how many times, and how recently, each slide in a presentation has been viewed. report-sco-views Indicates how many times, and how recently, the specified presentation has been viewed. report-survey-question-response Returns the list of all users who answered the specified question and their answer. report-training-concurrent-users Indicates the maximum number of concurrent course users for the specified account. sco-build Causes the Breeze server to build the specified SCO when you create presentations with the XML API. sco-contents 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 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 containing 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. sco-update Creates or updates presentations, courses, and meetings. sco-upload Uploads a file to the Breeze server when creating a presentation using the XML API. (For more information, see sco-update and sco-build). trees-info Returns the list of trees that belong to the specified account. user-accounts Provides a list of the accounts to which the specified user belongs. user-update-pwd Changes a user’s password. Chapter 4: Action Reference Action reference entries The following section lists the Breeze web service actions alphabetically. accesskey-exec Description Executes special functions associated with special access keys. Currently, letting users self-register for meetings and courses is the only supported special function. The documentation for this action covers only the self-registration function. To call this accesskey-exec, you need the normal access key for the account and a special access key associated with a meeting or course. Someone who isn’t a Breeze user can be given the special access key and can then use a UI to register for the meeting or course, creating a Breeze user account for themselves in the process. To obtain the special access key, call the accesskey-info action. The difference between using accesskey-exec to create a new user and using principalupdate is that you can call accesskey-exec without being logged in or being an administrator. This action automatically 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 custom fields for new users when you call accesskey-exec. To do so, pass the custom fields to accesskey-exec as additional parameters 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 action. 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 version 4.1. If you include this parameter in Breeze 4.1, it is ignored. access-key The special access key that lets the user self-register. first-name The new user’s first name. has-children last-name login The new user’s last name. The new user’s login name, which is usually the user’s e-mail address. password type Always set this parameter to 0 when registering a new user. The new user’s password. Always set this parameter to "user" when registering a new user. Filters Results cannot be filtered or sorted. accesskey-exec 41 Returned elements None. Sample results
SCO ID Name Type #item.XmlAttributes["sco-id"]# #item.name.XmlText# #item.XmlAttributes["type"]# accesskey-info Description Provides a special access key, if such a key is associated with the specified SCO. For more information, see the Action Reference action. To find out which group the user will automatically join by self-registering using the special access key, look in the access-key-group XML element. If the group exists, this element is included in the returned XML. If the group does not exist, there is 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 include this parameter in Breeze 4.1, it is ignored. acl-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements access-keys Sample results The following sample XML is returned when a group doesn’t exist and does not include an access-key-group element: 42 Chapter 4: Action Reference The following sample results are returned when a group exists and includes an accesskey-group element: 3hzvnifcfmphn3id 2004-03-05T10:28:14.750-08:00 acl-preference-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 Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The ID of the user for whom the preferences need to be updated. acl-id lang The language setting. Breeze currently supports the following five languages: Language Parameter value English en French fr German de Japanese ja Korean ko time-zone-id The time zone setting. Breeze currently supports the following 75 time zones: 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 acl-preference-update 43 44 Time zone setting Parameter value (GMT-08:00) Pacific Time (US and Canada); Tijuana 4 (GMT-07:00) Mountain Time (US and Canada) 10 (GMT-07:00) Chihuahua, La Paz, Mazatlan 13 (GMT-07:00) Arizona 15 (GMT-06:00) Central Time (US and Canada) 20 (GMT-06:00) Saskatchewan 25 (GMT-06:00) Guadalajara, Mexico City, Monterrey 30 (GMT-06:00) Central America 33 (GMT-05:00) Eastern Time (US and Canada) 35 (GMT-05:00) Indiana (East) 40 (GMT-05:00) Bogota, Lima, Quito 45 (GMT-04:00) Atlantic Time (Canada) 50 (GMT-04:00) Caracas, La Paz 55 (GMT-04:00) Santiago 56 (GMT-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 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, Kyiv, Riga, Sofia, Tallinn, Vilnius 125 (GMT+02:00) Athens, Istanbul, Minsk 130 (GMT+02:00) Jerusalem 135 Chapter 4: Action Reference Time zone setting Parameter value (GMT+02:00) Harare, Pretoria 140 (GMT+03:00) Moscow, St. Petersburg, Volgograd 145 (GMT+03:00) Kuwait, Riyadh 150 (GMT+03:00) Nairobi 155 (GMT+03:00) Baghdad 158 (GMT+03:30) Tehran 160 (GMT+04:00) Abu Dhabi, Muscat 165 (GMT+04:00) Baku, Tbilisi, Yerevan 170 (GMT+04:30) Kabul 175 (GMT+05:00) Ekaterinburg 180 (GMT+05:00) Islamabad, Karachi, Tashkent 185 (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi 190 (GMT+05:45) Kathmandu 193 (GMT+06:00) Astana, 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, 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 acl-preference-update 45 Time zone setting Parameter value (GMT+10:00) Guam, Port Moresby 275 (GMT+11:00) Magadan, Solomon Islands, New Caledonia 280 (GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands 285 (GMT+12:00) Auckland, Wellington 290 (GMT+13:00) Nuku’alofa 300 Filters Results cannot be filtered or sorted. Returned elements None. Sample results COURSE-test1-self-reg-group COURSE-test1-self-reg-group 2cw6np2kx2dtdop2 2004-07-07T12:27:04.590-07:00 action-list Description Returns a list of web service actions. Caution: Not all actions in this list are documented, and not all documented actions are in this list. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements actions Sample results common-info Description Provides basic information about the current user and server. If you call common-info without logging in first, the same information is returned, except that the user tag is not included, and the account-id value might be different. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements common Sample results accesskey-exec accesskey-info action-list ... [other actions listed here] ...user-accounts 46 Chapter 4: Action Referenceuser-update-pwd custom-field-update Description Updates the specified account custom field. Creates a new one if none exists. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. custom-field-update 47 field-id fields). name The ID of the field to be updated (can be obtained by calling action customThis parameter needs to be specified only when updating an existing field. The name of the custom field (may be 1 to 60 characters long). comments Any comments on the custom field (may be 0 to 60 characters long). This parameter is optional. type The type of the custom field. Must be one of the following: Value Description required Required account custom field optional Optional and show during self-registration optional-no-self-reg Optional and hide during self-registration The custom field number. Specify this parameter only when creating a new custom field (should be one more than the current maximum value of custom-seq). 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: breezm5qtgnye46zpckbf.MARIANNE 2004-02-12T15:53:19.797-07:00 http://admin.breeze.example.com /api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info breeze_402_r116 gerweck@example.com When updating an existing custom field: none Manager custom-fields Description Lists the custom fields of an account and the details of the fields. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. 48 Chapter 4: Action Reference Filters Results can be filtered only on field-id. You can also use the filter-out modifier on the type parameter. Results cannot be sorted. The default sort is by ascending field-id. Returned elements custom-fields, field Sample results custom-fields-delete Description Deletes the specified account custom field. Parameters The access key for the account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. field-id The ID of the field to be deleted (call the custom-fields action to obtain the ID). Returned elements None. Filters Results cannot be filtered or sorted. Sample results Department this is optional SSN custom-fields-delete 49 group-membership-update Description Adds one or more principals to a group, or removes one or more principals from a group. To update multiple principals and groups, specify multiple trios of group-id, principal-id, and is-member parameters. For more information, see “About parameters” on page 15. Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. group-id The ID of the group for which you’re updating the membership. principal-id is-member The ID of the principal whose membership status you want to update. 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 login Description Logs in a user. After logging in, you must read and store the cookie called BREEZESESSION, which can be found in the HTTP headers of the XML results. You must then include that cookie’s value in every subsequent request that you make as that logged-in user. For more information, see “About security” on page 17. The following example parses the HTTP headers to store the cookie and then indicates how it can be passed on for all subsequent requests. To log in to Breeze and save the session cookie, use the following code: login="john@example.com" password="abcdefg" accesskey="0123456789101112" baseurl="http://breeze.example.com/" 50 Chapter 4: Action Reference URL loginUrl = new URL(baseUrl + "api/xml?accesskey=" + accessKey + "&action=login&login=" + login + "&password=" + password); URLConnection conn=loginUrl.openConnection(); conn.connect(); InputStream resultStream=conn.getInputStream(); Document doc=new SAXBuilder(false).build(resultStream); String cookieString=(String) (conn.getHeaderField("Set-Cookie")); StringTokenizer st=new StringTokenizer(cookieString, "="); if (st.countTokens() > 1 && st.nextToken().equals("BREEZESESSION")) { String cookieNext= st.nextToken(); int semiIndex= cookieNext.indexOf(';'); cookie= cookieNext.substring(0, semiIndex); } if (cookie == null){ throw 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(); Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. account-id The ID of the account that the user is associated with. This parameter is optional. If your organization has only one account, don’t specify an account-id. login The user’s login name, which is usually the user’s e-mail address. password The user’s password. Note: If the login or password is missing or incorrect, the Breeze server returns a status code of "no-data". Filters Results cannot be filtered or sorted. Returned elements None. Sample results login 51 logout Description Logs out a user, invalidating the cookie that the application received when the user logged in. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements None. Sample results permissions-info 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 principal-id parameter, call the principal-list action (possibly with a filter to limit the returned data) to return an ID for the principal. For more information about permissions, see “About permissions” on page 18. For more information about filters, see Chapter 2, “Working with Filters,” on page 21. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. acl-id The ID of a specific SCO. principal-id 52 The ID of a specific principal. This parameter is optional. Chapter 4: Action Reference Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort is-primary Filter and sort type Filter and sort has-children Filter and sort permission-id Filter and sort name Filter and sort login Filter and sort description Filter and sort Note: Principals’ logged-in-access and public-access are always returned in the data set, irrespective of the filter restrictions. For more information about filtering and sorting, see Chapter 2, “Working 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: The following XML data is returned when the principal-id parameter is passed: Englesberg, Ari englesberg@example.com Milligan, Susan milligan@example.com If the principal has not been assigned permissions to the SCO, the status code no-data is returned. permissions-info 53 permissions-reset Description Resets all principals’ permissions for the specified SCO, so the permissions of the SCO’s parent apply to all principals. For information on permissions, see “About permissions” on page 18. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. acl-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements None. Sample results 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 about permissions, see “About permissions” on page 18. To update multiple principals’ permissions, specify multiple trios of acl-id, permission-id, and principal-id parameters. For more information, see “About parameters” on page 15. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. acl-id The ID of a SCO. permission-id principal-id The ID of a permission. The ID of a principal (a user or group). Filters Results cannot be filtered or sorted. 54 Chapter 4: Action Reference Returned elements None. Sample results principal-info Description Provides information about the specified principal. The specified principal can be a user or a group. To determine the ID to use as the principal-id parameter, call the principal-list action (possibly with a filter to limit the returned data) to return an ID for the principal. For information about principals, see “About principals, SCOs, and IDs” on page 16. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. principal-id The ID of a specific principal. Filters Results cannot be filtered or sorted. Returned elements principal, contact, preferences, principal-custom-field-values Sample results The following sample XML data is returned when the type attribute of the principal element is group: Course managers group Course Managers Course Managers When the type attribute of the principal element is user, additional data about the user contact information, user profile, and custom fields for the user is returned, as shown in the following XML data: test-1 test-1 principal-info 55See also principal-list, principal-update principal-list Description Provides a complete list of users and groups, including primary groups. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: 56 Field Filter/Sort principal-list Filter and sort contact-id Filter and sort type Filter and sort Chapter 4: Action Reference Field Filter/Sort has-children Filter and sort is-primary Filter and sort is-hidden Filter and sort name Filter and sort login Filter and sort description Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements principal-list Sample results test4-lnagaraj@test.enang.com test4 laxmi test4-lnagaraj@test.enang.com test4 laxmi Phone number 408-1111-111 principal-update Description Updates information for a principal in the current account or creates a new principal. For information about principals, see “About principals, SCOs, and IDs” on page 16. In most cases, you must acquire the original version of the principal’s information (using principal-info) before calling the principal-update action. To create a new principal, call the principal-update action without specifying a principal-id parameter. If you create a new principal, the returned XML provides information about the new principal, including the principal’s ID. principal-update 57 To specify custom field values when creating or updating a user, pass the custom field values as name, value pairs, as shown in the following example: field-id=xx&value=xxx&field-id=xx&value=xxx You can determine the field-id values from the data returned by the custom-fields action. Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The new group’s description. Use only when creating a new group. description The new first name to assign to the user. Use only when creating or updating a first-name user. 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. has-children The new last name to assign to the user. Use only when creating or updating a user. last-name 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. login name The new group’s name. Use only when creating a new group. password The new user’s password. Use only when creating a new user. The ID of the principal for which you’re changing data. If you omit this parameter, the principal-update action creates a new principal. principal-id The type of the new principal. Use only when creating a new principal. For information about the available types, see “About principals, SCOs, and IDs” on page 16. type Filters Results cannot be filtered or sorted. Returned elements If you update an existing principal, no elements are returned. If you create a new principal, principal (in the same format as the returned elements for principal-info). Sample results The following sample results are for creating a new principal: Enterprise Administrator lnagaraj@macromedia.com lnagaraj@macromedia.com Account Authors Account Authors Account authors group 58 Chapter 4: Action Reference See also principal-info, principal-update, principals-delete principals-delete Description Deletes one or more principals. To delete multiple principals, specify multiple principal-id parameters. For more information, see “About parameters” on page 15. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. principal-id The ID of a principal to delete. Filters Results cannot be filtered or sorted. Returned elements None. Sample results jake3@example.com doe, jake report-account-meeting-attendance Description Returns the meeting attendance log for the account. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort tr.sco_id Filter and sort transcript-id Filter and sort principal-id Filter and sort report-account-meeting-attendance 59 Field Filter/Sort login Filter and sort sco-name Sort date-created Filter and sort date-closed Filter and sort participant-name Sort Returned elements report-account-meeting-attendance Sample results 60 Chapter 4: Action Reference report-active-meeting-presenters Description Provides a list of the users who are currently presenting meetings. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The ID of a meeting; if specified, the report returns information about that meeting only. This parameter is optional. sco-id Filters Results cannot be filtered or sorted. Returned elements report-active-meeting-presenters Sample results |
lnagaraj@macromedia.com Enterprise Administrator test-mtg-1 2004-07-09T13:00:28.920-07:00 2004-07-09T13:02:55.810-07:00 Enterprise Administrator |
lnagaraj@macromedia.com Enterprise Administrator test-mtg-1 2004-07-09T14:33:06.577-07:00 2004-07-09T14:33:43.547-07:00 Enterprise Administrator report-active-meetings Description Provides a list of meetings that are currently in progress. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. report-active-meetings 61 Returned elements report-active-meetings Sample results Jack Monson 2004-02-17T17:06:23.920-08:00 Hans Gay 2004-02-17T16:50:00.327-08:00 report-bandwidth Description Indicates the total bandwidth consumed in the current account since the account was created, in bytes. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-bandwidth Sample results QT load 2003-09-02T14:00:58.330-07:00 Take 2 2003-09-02T14:45:25.273-07:00 62 Chapter 4: Action Reference report-bulk-content-quiz Description Returns information about all content quizzes, including a list of quizzes, and the questions and answers for each quiz. The information returned is similar to the “Content quiz Information” download report, except that XML data is returned instead of CSV formatted data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-bulk-content-quiz Sample results report-bulk-content-quiz 63 report-bulk-content-quiz-results Description Returns results for a content quiz, including information on each user and quiz question. The returned information is similar to the “Content quiz responses and results” download report, except that the report-bulk-quiz-results action returns XML data instead of CSV formatted data. Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort user-id Filter and sort presentation-attempt-id Filter only presentation-id Filter only quiz-id Filter only question-number Filter and sort user-response Filter only user-login Filter only date-time-attempted Filter only Returned elements report-bulk-content-quiz-results Sample results - |
test-quiz Quiz test 1 Who is Randy Johnson ? A baseball pitcher with the Arizona Diamondbacks YES |
test-quiz Quiz test 1 Who is Randy Johnson ? A basketball player with the New Jersey Nets NO report-bulk-content-slide-views Description Returns slide view data for content. This is similar to the “Content Slide Views” download report, except that the action returns XML data and the report returns CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort presentation-id Sort slide-number Filter and sort user-login Sort user-first-name Sort user-last-name Sort presentation-name Sort view-date-time Sort Returned elements report-bulk-slide-views Sample results |
lnagaraj@macromedia.com 2004-07-13T10:51:35.047-07:00 00:00:28.017 64 Chapter 4: Action Reference
lnagaraj@macromedia.com 2004-07-13T10:52:23.780-07:00 00:00:45.046 report-bulk-course-quiz Description Returns information about all course quizzes, including a list of quizzes, and the questions and answers for each quiz. The returned results are similar to the “Course Quiz Information” report, except that the action returns XML data and the report contains downloadable CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-bulk-course-quiz Sample results report-bulk-content-slide-views 65
lnagaraj@macromedia.com Enterprise Administrator test-slide 2004-06-30T11:46:10.280-07:00 |
lnagaraj@macromedia.com Enterprise Administrator test-slide 2004-06-30T11:46:12.500-07:00 66 Chapter 4: Action Reference report-bulk-course-results Description Returns results for a course quiz, including information on each user and quiz question. The returned data is similar to the “Course Quiz Responses and Results” report, except that the action returns XML data and the report returns downloadable CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze required only in Breeze 4.0; it is not required for Breeze 4.1. 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: Fields Filter/Sort user-id Filter and sort course-attempt-id Sort course-id Sort quiz-id Sort question-number Filter and sort user-response Sort user-login Sort date-time-attempted Sort time-taken Sort Returned elements report-bulk-course-quiz-results Sample results |
quiz-course-ln Quiz test 1 Who is Randy Johnson ? A baseball pitcher with the Arizona Diamondbacks YES |
quiz-course-ln Quiz test 1 Who is Randy Johnson ? A basketball player with the New Jersey Nets NO Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center. report-bulk-meeting Description Returns information about all meetings. Similar to the Meeting Information report, except that the action returns XML data and the report returns downloadable CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-bulk-meeting Sample results |
lnagaraj@macromedia.com 2004-07-13T10:54:09.030-07:00 00:00:14.017 |
lnagaraj@macromedia.com 2004-07-13T10:54:09.030-07:00 report-bulk-course-results 67 00:00:34.017 68 Chapter 4: Action Reference report-bulk-meeting-attendance Description Returns meeting attendance data. The results are similar to the “Meeting Attendance” report, except that the action returns XML data and the report returns downloadable CSV data. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort meeting-id Sort meeting-attendee Sort meeting-name Sort attendee Sort attendee-join Sort attendee-exit Sort Returned elements report-bulk-meeting-attendance Sample results |
test-mtg-1 2004-07-07T10:00:00.000-07:00 |
test-mtg-2 2004-07-09T14:00:00.000-07:00 report-bulk-meeting-attendance 69 report-course-status Description Returns course status for either a principal or a SCO, based on the parameters passed in. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. principal-id sco-id The ID of the principal for whom the courses status is requested. The ID of the SCO for which the course status is requested. 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 or sorted. Returned elements report-course-status Sample results When the sco-id parameter is passed in, the following XML may be returned: |
test-mtg-1 Enterprise Administrator 2004-07-09T13:00:28.920-07:00 2004-07-09T13:02:55.810-07:00 |
test-mtg-1 Enterprise Administrator 2004-07-09T14:33:06.577-07:00 2004-07-09T14:33:43.547-07:00 When the principal-id parameter is passed in, the following XML may be returned: 2004-07-13T10:55:28.763-07:00 70 Chapter 4: Action Reference report-course-takers Description Provides a list of the users enrolled in the specified course. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a course. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort transcript-id Filter and sort sco-id Filter and sort status Filter and sort percentage-score Filter and sort time-taken Sort certificate Sort answered-survey Sort login Sort date-taken Filter and sort principal-name Sort The data can be sorted on any of the custom fields that exist for the account. Sort You cannot filter on any custom field. For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-takers report-course-takers 71 Sample results 2004-07-27T12:53:42.297-07:00 report-disk-usage Description Provides information about how much hard disk space the Breeze content for the current account uses, in bytes. Includes all content and archives. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-disk-usage Sample results |
lnagaraj@macromedia.com Enterprise Administrator |
test1-laxmi@test.enang.com test1 laxmi 408-123-1234 |
testcourse-laxmi@test.enang.com 2004-07-07T12:37:29.623-07:00 courseTest1 laxmi 72 Chapter 4: Action Reference report-meeting-attendance Description Provides a list of users who have attended the specified meeting. If the meeting hasn’t started, the returned data contains no rows. The data does not include users who were invited but did not attend the meeting. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a meeting. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort transcript-id Filter and sort tr.sco-id Filter and sort principal-id Filter and sort contact-id Filter and sort answered-survey Sort login Filter and sort session-name Sort sco-name Sort tr.date-created Filter and sort tr.date-closed Filter and sort participant-name Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-meeting-attendance report-meeting-attendance 73 Sample results report-meeting-concurrent-users Description Indicates the maximum number of users who can participate simultaneously in the specified meeting. This maximum is determined by the account’s license. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a meeting. Filters Results cannot be filtered or sorted. Returned elements report-meeting-concurrent-users Sample results |
lnagaraj@macromedia.com Enterprise Administrator test-mtg-2 2004-07-09T14:29:49.217-07:00 2004-07-09T14:33:45.827-07:00 Enterprise Administrator |
lnagaraj@macromedia.com Enterprise Administrator test-mtg-2 2004-07-09T14:35:59.170-07:00 2004-07-09T15:03:05.263-07:00 Enterprise Administrator 74 Chapter 4: Action Reference report-meeting-session Description Provides information about a specific meeting session, such as the session name, session start and end times, and the number of participants and guests who attended the session. Each time someone enters an otherwise empty meeting, a new session starts. The session ends when all attendees leave the meeting. If someone subsequently enters the now-empty meeting, a new session starts. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The ID of a meeting. This value must match the sco-id for a specific meeting session. The list of all sessions and their associated sco-ids can be obtained by invoking the reportmeeting-sessions action. sco-id Filters Results cannot be filtered or sorted. Returned elements report-meeting-session Sample results report-meeting-sessions 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 subsequently enters the now-empty meeting, a new session starts. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a meeting. report-meeting-sessions 75 Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Filter and sort num-participants Sort num-guests Sort num-polls Sort name Filter and sort date-begin Filter and sort date-end Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-meeting-sessions Sample results test-mtg-1 - 1 2004-07-09T13:00:32.153-07:00 2004-07-09T13:08:57.483-07:00 report-meeting-session-slots Description Provides information about the number of attendees in every ten-minute time slot of the specified meeting session. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a valid meeting session. You can be obtained this ID by calling the reportaction. meeting-session-slots 76 Chapter 4: Action Reference Filters Results cannot be sorted or filtered. The default sort is by the time slot start time. Returned elements report-meeting-session-slots Sample results |
My Meeting 2004-03-05T10:33:09.030-08:00 2004-03-05T10:54:09.030-08:00 |
My Meeting 2004-03-05T11:00:09.030-08:00 report-meeting-summary Description Indicates how many users were invited to the specified meeting and how many invitees and guests attended. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a meeting. Filters Results cannot be filtered or sorted. Returned elements report-meeting-summary Sample results |
2004-02-14T06:30:00.000-08:00 2004-02-14T06:40:00.000-08:00 |
2004-02-14T06:40:00.000-08:00 2004-02-14T06:50:00.000-08:00 |
2004-02-14T06:50:00.000-08:00 2004-02-14T07:00:00.000-08:00 report-meeting-summary 77 report-my-courses Description Provides information about each course that the logged-in user is enrolled in. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Filter and sort status Filter and sort name Filter and sort date-created Filter and sort date-modified Filter and sort date-begin Filter and sort expired Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements my-courses Sample results report-my-meetings Description Provides information about each meeting the logged-in user is scheduled to attend. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Sort status Sort permission-id Sort active-participants Sort name Sort date-begin Sort date-end Sort expired Sort duration Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements my-meetings Sample results My Name admin.breeze.example.com/p38547860/ 2004-02-09T14:40:38.497-08:00 2004-02-09T14:40:44.623-08:00 2004-02-09T14:30:00.000-08:00 2004-02-09T14:30:00.000-08:00 /p38547860/ true quiz 100 admin.breeze.example.com/p81997938/ 2004-02-16T21:04:48.750-08:00 2004-02-16T21:33:17.560-08:00 78 Chapter 4: Action Reference2004-02-16T21:00:00.000-08:00 /p81997938/ false report-principal-list Description Returns the list of all principals in the account. Similar to 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 the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort principal-id Filter and sort type Filter and sort has-children Filter and sort is-primary Filter and sort name Filter and sort login Filter and sort all account custom fields Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-principal-list 80 Chapter 4: Action Reference Sample results morris shared admin.breeze.example.com /r99718924/ report-my-meetings 792003-07-14T23:00:00.000-07:00 2003-07-15T09:00:00.000-07:00 true new skipper admin.breeze.example.com /p50473388/ 2004-01-29T05:30:00.000-08:00 2004-01-29T05:30:00.000-08:00 true report-quiz-answer-distribution Description Indicates how many users selected a specific answer for all questions on a quiz associated with the specified SCO. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-number Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. report-quiz-answer-distribution 81 Returned elements report-quiz-answer-distribution Sample results The following XML contains attributes for answer options 1 through 8, even if the quiz question has fewer possible answers: |
Enterprise Administrator lnagaraj@macromedia.com |
Account Administrators Account Administrators |
test1 laxmi test1-laxmi@test.enang.com ENGG 100-07-7777 When the SCO doesn’t have a quiz, an empty report-quiz-answer-distribution element is returned, as shown in the following example: Who is Randy Johnson ?
Who is Allan Iverson ?
report-quiz-definition-answers Description Provides information about each of the allowed answers (both correct and incorrect) for the specified quiz. An empty quiz-definition-answers element is returned when the specified SCO does not have a quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters Results cannot be filtered or sorted. The default primary sort is by ascending question ID, and the default secondary sort is by ascending answer ID. Returned elements quiz-definition-answers 82 Chapter 4: Action Reference Sample results report-quiz-definition-questions Description Provides information about each question in a quiz. When the specified SCO doesn’t contain a quiz, an empty quiz-definition-questions element is returned. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. report-quiz-definition-questions 83 Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-number Filter and sort question-id Filter and sort score Filter and sort chapter-id Filter and sort body Filter and sort date-modified Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements quiz-definition-questions Sample results 22
0
4
150,000,000 kilometers
1 parsec
100 kilometers
300,000 kilometers
ISO-9000 ECMA-262
RFC 821
ECMA-976
report-quiz-interactions Description Provides information about all the interactions that users have had with the specified quiz. An interaction consists of a user making a choice in a quiz, so this report provides information about every answer every user has ever given to questions in the quiz. In the results for this action, the score attribute indicates the score that the quiz-taker received on that question. 84 Chapter 4: Action Reference Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-number Filter and sort name Sort question Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-interactions Sample results What is 2+2?
2004-01-13T17:09:40.230-08:00 How far is it from Earth to the sun?
2004-01-13T17:09:40.230-08:00 Which international standard defines ECMAScript?
2004-01-13T17:09:40.240-08:00 report-quiz-question-answer-distribution Description Indicates how many users selected a particular answer to a specified quiz question. Use report-quiz-definition-answers or report-quiz-definition-questions to determine the ID of a question (to specify as the question-id parameter). Note: Question IDs do not necessarily correspond to question numbers given in a quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. question-id sco-id The ID of a specific question in the quiz. The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort answer-id Filter and sort correct Filter and sort total-responses Sort percentage-responded Sort answer-text Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-question-answer-distribution Sample results |
Enterprise Administrator quiz-course 2004-07-13T10:54:09.030-07:00 Who is Randy Johnson ? |
Enterprise Administrator quiz-course 2004-07-13T10:54:09.030-07:00 Who is Allan Iverson ? |
Enterprise Administrator quiz-course 2004-07-13T10:55:28.763-07:00 Who is Randy Johnson ? |
Enterprise Administrator quiz-course sco- sco- sco- sco- report-quiz-interactions 852004-07-13T10:55:28.763-07:00 Who is Allan Iverson ? report-quiz-question-distribution Description Indicates how many users answered each question in the specified quiz correctly. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort question-id Filter and sort question-number Filter and sort num-correct Sort num-incorrect Sort percentage-correct Sort score Filter and sort body Filter and sort report-quiz-question-distribution 87 For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-question-distribution Sample results |
Which international standard defines ECMAScript? 86 Chapter 4: Action ReferenceISO-9000 |
Which international standard defines ECMAScript? RFC 821 |
Which international standard defines ECMAScript? ECMA-976 |
Which international standard defines ECMAScript? ECMA-262 report-quiz-question-response 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 question numbers indicated in the quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. question-id sco-id The ID of a specific question in the quiz. The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: 88 Field Filter/Sort principal-id Sort answer-text Sort Chapter 4: Action Reference For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-question-response Sample results What is 2+2?
How far is it from Earth to the sun?
Which international standard defines ECMAScript?
report-quiz-question-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-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 question numbers indicated in the quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. question-id sco-id The ID of a specific question in the quiz. The ID of a presentation that contains a quiz. Filters Results cannot be filtered or sorted. Returned elements report-quiz-question-totals report-quiz-question-totals 89 Sample results What is 2+2?
5 What is 2+2?
5 What is 2+2?
4 report-quiz-summary Description Provides information about the results of a quiz. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters Results cannot be filtered or sorted. Returned elements report-quiz-results, report-quiz-summary Sample results report-quiz-takers Description Provides information about everyone who has taken a particular quiz. To get a listing of SCOs that a specified principal viewed, pass the principal-id parameter instead of the sco-id parameter. In addition, the list of the SCOs can be restricted to a specific type by passing an optional parameter type. 90 Type Description type=course Lists all courses the user took. type=presentation Lists all content the user viewed. type= meeting Lists all meetings the user attended. Chapter 4: Action Reference If a type parameter is not specified, the list of all courses, content, and meetings attended by the user is returned. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation that contains a quiz. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort transcript-id Filter and sort principal-id Filter and sort contact-id Filter and sort status Sort score Filter and sort percentage-score Sort time-taken Sort answered-survey Sort login Filter and sort date-taken Sort principal-name Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-quiz-takers Sample results Caution: There was an issue with the formatting of the time-taken XML tag, which has been fixed in the Breeze 4.1 updater. If you see incorrect formatting in the content of a time-taken XML tag, download the updater from the Licensed Support Center. report-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.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-quotas Sample results report-quiz-takers 91
quiz-course lnagaraj@macromedia.com 2004-07-13T10:54:09.030-07:00 Enterprise Administrator |
quiz-course lnagaraj@macromedia.com 2004-07-13T10:55:28.763-07:00 Enterprise Administrator 92 Chapter 4: Action Reference report-sco-slides Description Indicates how many times, and how recently, each slide in a presentation has been viewed. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort slide Sort views Sort last-viewed Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-sco-slides Sample results 1999-12-31T16:00:00.000-08:00 2999-12-31T16:00:00.000-08:00 1999-12-31T16:00:00.000-08:00 2999-12-31T16:00:00.000-08:00 report-sco-slides 93 report-sco-views Description Indicates how many times, and how recently, the specified presentation has been viewed. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a presentation. Filters Results cannot be filtered or sorted. Returned elements report-sco-views Sample results |
2004-01-13T16:35:39.517-08:00 |
2004-01-13T16:35:42.350-08:00 |
2004-01-13T16:35:44.933-08:00 |
2004-01-13T16:35:47.640-08:00 |
2004-01-13T16:35:51.723-08:00 report-survey-question-response Description Returns the list of all users who answered the specified question and their answer. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. question-id sco-id 94 The ID of the question. The ID of the SCO. Chapter 4: Action Reference Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort principal-id Sort user-name Sort response Filter and sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements report-survey-question-response Sample results |
Quiz test 1 2004-01-13T17:11:47.923-08:00 report-training-concurrent-users Description Indicates the maximum number of concurrent course users for the specified account. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements report-training-concurrent-users report-training-concurrent-users 95 Sample results |
Enterprise Administrator how are you? fine |
test1 laxmi how are you? ok sco-build Description Causes the Breeze server to build the specified SCO when you create presentations with the XML API. (For more information, see sco-update and sco-upload). No one can view a SCO until it has been built. Call this action after you upload a SCO using the sco-upload action. If you upload a new version of an 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 of the SCO. The SCO status is initially be in-progress, which means the content is being built. When the status becomes active, the content has finished building and is accessible. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO to build. Filters Results cannot be filtered or sorted. Returned elements None. Sample results Professor Test Account See also sco-upload 96 Chapter 4: Action Reference sco-contents Description Provides a list of the SCOs in a specified folder. Because folders are SCOs, the returned list includes the folders that are contained in the specified folder. The returned list does not include the contents of those subfolders. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a folder. Filters The following table lists the fields that the data can be filtered and sorted on: Field Filter/Sort sco-id Filter and sort status Filter and sort type Filter and sort is-folder Sort name Filter and sort date-begin Filter and sort date-end Filter and sort date-modified Filter and sort duration Sort For more information about filtering and sorting, see Chapter 2, “Working with Filters,” on page 21. Returned elements scos Sample results The name and date-modified elements are always returned, but the date-begin, date-end and duration elements are present only for SCOs whose type attribute is course or meeting. sco-delete Description Deletes one or more SCOs. If the specified sco-id is a folder, all the contents of the specified folder are also deleted. To delete multiple SCOs, specify multiple sco-id parameters. For more information, see “About parameters” on page 15. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements None. Sample results sco-contents 97 PPT meeting tests 2004-01-29T06:22:49.157-08:00 My Name 2003-08-27T00:00:00.000-07:00 2003-08-27T01:00:00.000-07:00 2003-08-26T23:33:20.300-07:00 1900-01-02T/+:00:00.000+00:00 My Name 2 2004-01-29T01:30:00.000-08:00 2004-01-29T01:30:00.000-08:00 2004-01-29T01:35:26.433-08:00 1900-01-02T/*:00:00.000+00:00 98 Chapter 4: Action Reference sco-info Description Provides information about a SCO. For information about SCOs, see “About principals, SCOs, and IDs” on page 16. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements The returned tags depend on the specified item’s SCO type. Some tags that might be returned include the following: sco, sco-author, sco-data, source-sco Sample results The following is sample XML from a SCO whose type attribute is sample: The following is sample XML from a SCO whose type attribute is presentation: 2004-07-07T10:00:00.000-07:00 2004-07-07T10:05:33.200-07:00 2004-07-07T11:00:00.000-07:00 2004-07-09T15:09:41.390-07:00 test-mtg-1 /r66599952/ 2004-07-07T10:05:33.200-07:00 2004-07-07T10:05:33.200-07:00 7/623/ The following is sample XML from a SCO whose type attribute is folder: sco-info 99 l n 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.250-07:00 test-slide /p27916084/ 2004-06-30T11:45:03.717-07:00 2004-06-30T11:53:33.090-07:00 7/27/ The following is sample XML from a SCO whose type attribute is course: 2004-07-14T12:19:23.340-07:00 2004-07-14T12:19:23.340-07:00 test2 /p33526645/ 2004-07-14T12:19:23.340-07:00 2004-07-14T12:19:23.340-07:00 7/744/ sco-move Description Moves a SCO from one folder to another. For information about rules regarding moves and their necessary permissions, see Breeze Help. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. folder-id sco-id The ID of the destination folder. The ID of the SCO to move. Filters Results cannot be filtered or sorted. Returned elements status Sample results 2004-07-13T10:30:00.000-07:00 2004-07-13T10:53:47.450-07:00 2004-07-13T10:53:51.763-07:00 quiz-course /p38917184/ 2004-07-13T10:46:48.000-07:00 2004-07-13T10:47:23.653-07:00 7/720/ 100 Chapter 4: Action Reference l 2004-07-13T10:46:48.000-07:00 2004-07-13T10:47:23.810-07:00 test-quiz /p67601053/ sco-nav Description Describes the folder hierarchy that contains the specified SCO. In the returned results, the sco tag’s depth attribute indicates how many hierarchical levels away the folder is from the specified SCO. That is, a depth attribute equal to 0 indicates the SCO itself; a depth of 1 indicates the folder that contains the SCO; and so on. Parameters accesskey The access key for your account. sco-nav 101 Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. sco-id The ID of a SCO. Filters Results cannot be filtered or sorted. Returned elements sco-nav Sample results 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 contents of the SCO are also searched. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. A string to search for. You can use the backslash (\) character before the following characters to escape them in the query string: query + - && || ! ( ) { } [ ] ^ " ~ * ? : \ Filters You can restrict the returned data to a specific number of rows using the filter-rows and filter-start parameters. For example, the following code returns the first five rows of data: filter-rows=5&filter-start=0 102 Chapter 4: Action Reference Note: The filter-rows parameter indicates the number of rows to be returned, and filter-start indicates where the row count should begin. For more information about filters, see Chapter 2, “Working with Filters,” on page 21. You can also use the filter-type parameter to restrict the returned data based on the type attribute of the SCO. For example, the following returns data of type presentation only: filter-type=0 The following returns data of type archives only: filter-type=8 Note: If the parameter is not specified, all matches are returned. Returned elements sco-search-info Sample results User Meetings tennant@example.com created with 402 sco-shortcuts Description Provides IDs for a set of folders containing 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. To determine the URL of a SCO, concatenate the domain name returned by this action with the URL returned by the sco-info action in the url-path tag. sco-shortcuts 103 Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. Filters Results cannot be filtered or sorted. Returned elements shortcuts Sample results Quiz 1 /p92628681/ 2003-11-26T22:52:28.973-08:00 2003-11-26T22:52:37.867-08:00 lnagaraj@macromedia.com 1 4 More broken quizzes /p49954414/ 2003-11-26T23:02:52.870-08:00 2003-11-26T23:03:23.313-08:00 foo-account@macromedia.com 1 4 5 7 See also sco-info sco-update Description Creates or updates presentations, courses, and meetings. If you provide a sco-id parameter, this action updates the specified SCO. If you provide a folder-id parameter, this action creates a new SCO. If you create a new SCO, the returned XML provides information about the new SCO, including the SCO’s ID. 104 Chapter 4: Action Reference You must provide only one of the following two parameters: folder-id or sco-id. After you call this action, you must call the permissions-update action to assign permissions. For information about permissions, see “About security” on page 17. For more information about SCOs, see “About principals, SCOs, and IDs” on page 16. The following examples show uses for the sco-update action. To use sco-update with a Breeze presentation: 1. Call sco-update with the folder-id parameter to create a SCO. Pass the following parameters: accesskey, folder-id, description, name, author-info-1 (the name of the author), author-info-2 (the author’s title), author-info-3 (the company name), type=presentation, and lang. 2. Call sco-upload to associate content with this SCO. Note: See sco-upload for a sample of an HTML form that associates content with a presentation created through the XML API. 3. Call 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 content with the course through the source-sco-id parameter. Pass the following parameters: accesskey, folder-id, date-begin, date-end, description, and sco-tag. name, type=course, source-sco-id, 2. Call the permissions-update action 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: accesskey, folder-id, date-begin, date-end, description, name, and type=meeting. Note: You must use the 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 access to the meeting: // private: principal-id=public-access&permission-id=denied // public: principal-id=public-access&permission-id=view-hidden 3. Call the permissions-update action to assign presenter or participant permissions to the meeting. sco-update 105 Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. date-begin The scheduled beginning date and time. The date format is ISO 8601. (Used only for meetings and courses.) The scheduled ending date and time. The date format is ISO 8601. (Used only for meetings and courses.) date-end A description of the SCO to be read by users. description email The e-mail address of the contact person for the SCO. (Used only for presentations.) first-name The first name of the contact person for the SCO. (Used only for presentations.) folder-id The ID of the folder in which the server will create the new SCO. This parameter is optional and cannot be specified with sco-id. last-name name sco-id The last name of the contact person for the SCO. (Used only for presentations.) The name of the SCO. The ID of a SCO to update. This parameter is optional and cannot be specified with folder-id. sco-tag A label for the SCO. Can contain any arbitrary data; for example, for an Economics 101 course, you might specify 101 for the sco-tag parameter. (Used only for courses.) source-sco-id The ID of the SCO’s content. (Used only for courses.) The type of the new SCO. For information about types, see “About principals, SCOs, and IDs” on page 16. type Filters Results cannot be 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: http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com http://admin.breeze.example.com 106 Chapter 4: Action Reference The following sample XML is returned when a presentation SCO is created: /p54135747/ Test SCO To update the title, summary, speaker name, title, language, and company, replace the parameter folder-id with the parameter sco-id. To upload a different SCO and rebuild the presentation, call sco-upload and sco-build in that order. The following sample results are returned when a presentation is updated: sw macr /p74161709/ testXMLAPIpreso-New laxmi n testAPI-preso-New The following sample XML is returned when a course is created: To update the start date, end date, course ID, summary, description, name, and content associated with a course, replace the parameter folder-id with the parameter sco-id. The following sample XML is returned when updating a course: 2004-07-26T24:41:58.330-07:00 2004-07-28T21:41:58.330-07:00 test-3 /p41607453/ testXMLAPIcourse-3 testAPI-course-3 The following sample XML is returned when creating a meeting: You can update meeting start and end times, name, and description by replacing the parameter folder-id with the parameter sco-id. The following sample XML is returned when updating a meeting: 2004-07-22T21:41:58.330-07:00 sco-update 1072004-07-22T21:51:58.330-07:00 /r54578750/ testXMLAPI-mtg testAPI-mtg sco-upload Description Uploads a file to the Breeze server when creating a presentation using the XML API. (For more information, see sco-update and sco-build). You must send the parameters for this action using the multipart/form-data media type. The easiest way to create the file parameter is to use a form control of type "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: This form uploads a single file. If you need to upload multiple files, for example, a PPT and a PPC file, you must pass an additional file parameter: 108 Chapter 4: Action Reference Note: Call the action sco-info to obtain the latest SCO status. The sco status will initially be inprogress, which means the content is being built. When the status becomes active, the content has finished building and is now accessible. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. The file that you want to upload. This should be the actual data for the file, not just a filename or path. file sco-id The ID of the new SCO. You must have 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 action. This parameter is optional. title The title of the new SCO. Filters Results cannot be filtered or sorted. Returned elements None. Sample results See also sco-build trees-info Description Returns the list of trees that belong to the specified account. Parameters accesskey The access key for the account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. account-id The ID of the account. Filters Results cannot be filtered or sorted. The default sort is by ascending tree-id. trees-info 109 Returned elements trees Sample results user-accounts Description Provides a list of the accounts to which the specified user belongs. In an enterprise (nonhosted) Breeze system, there is usually only one account; if you have an enterprise system, you are unlikely to need this action. Parameters accesskey The access key for your account. Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. 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 the account-name. Returned elements users 110 Chapter 4: Action Reference Sample results nagarajan.macromedia.com nagarajan.macromedia.com nagarajan.macromedia.com nagarajan.macromedia.com nagarajan.macromedia.com user-update-pwd Description Changes a user’s password. Parameters The access key for your account. accesskey Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you include this parameter in Breeze 4.1, it is ignored. password The new password. password-old The user’s current password. password-verify user-id A second copy of the new password, for verification. The ID of the user. Filters Results cannot be filtered or sorted. Returned elements None. Sample results james@example.com 2004-01-24T00:59:59.000-07:00 smith@example.com 2004-01-24T00:59:59.000-07:00 jones@example.com 2004-01-24T00:59:59.000-07:00 user-update-pwd 111 112 Chapter 4: Action Reference CHAPTER 5 XML Results Reference This chapter describes the XML tags, data, and status codes returned by the Macromedia Breeze server in response to an action. For information about the actions you can call on the server, see Chapter 4, “Action Reference,” on page 37. About returned XML code When you call an action on the Breeze server, the server returns a block of XML code. The parent tag of the XML code is always a results tag. The results tag contains a status tag, which indicates whether the action was completed successfully. In most cases, if the action was completed successfully, the 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: This chapter organizes the tags alphabetically; each tag has its own section. For information on possible status values, see status. For information about the tags returned for a particular action, see the documentation for that action in Chapter 4, “Action Reference,” on page 37. 113 If there is no data available for a tag that would normally be returned in response to an action, the tag isn’t returned. In the previous example, if the calling application didn’t specify a logged-in user, there would be no user tag in the returned results. When your web application receives the returned XML code, it must parse the code to determine what the returned values are. For examples, see Chapter 3, “Common Tasks,” on page 27. Alphabetical list of XML tags The following table is an alphabetical list of the XML tags documented in this reference: 114 Tag Description access-key (container) Contains information about a special access key provided by a SCO. access-key (key) Contains a special access key for use in self-registration. access-key-group Contains information about which group the user automatically joins by self-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 text of an answer to a quiz question as part of the results returned by a report action. body The text of a returned item, such as the text of a quiz question in a quiz-related report. comment Any comments on the custom field (may be 0 to 60 characters long). common Contains information about the server and the logged-in user. contact Contains information about a contact. cookie The value of the Java servlet session cookie, named BREEZESESSION. course Contains information 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. Chapter 5: XML Results Reference Tag Description date-created The date and time that a SCO was created, in ISO 8601 date format. date-end The date and time that a SCO is, or was, scheduled to end, in ISO 8601 date format. date-expired The date that an account is, or was, scheduled to expire, in ISO 8601 date format. date-last-taken The date that a course was last taken, in ISO 8601 date format. date-modified The date that something was most recently modified, in ISO 8601 date format. date-taken The date that a particular user took a particular quiz, in ISO 8601 date format. date-time-attempted The date that a particular user took a particular quiz. description A description of a principal. domain-name The fully qualified domain name of the location of a SCO. duration The duration of a SCO. email A user’s e-mail address. 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 number indicating which slide contains a search term. host The URL of the host that the Breeze server is running on. invalid Contains information about why a particular call to an action 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. login A user’s login name, which is usually the user’s e-mail address. meeting Contains information about a meeting. my-courses Contains information about one or more courses. my-meetings Contains information about one or more meetings. name A user’s name. participant-name The name of a participant in a meeting. Alphabetical list of XML tags 115 Tag Description permission Contains information about a specific principal and its permissions. permissions Contains information about one or more principals and their permissions. physical-path The path on the server to a SCO. preferences Contains information about user preferences. presentation-name The name of a Breeze presentation. principal Contains information about a principal. principal-custom-field-values Contains information about the values of a custom field in a principal. principal-list Contains one or more principal tags. principal-name The name of a principal. question The text of a quiz question. question-text The text of a quiz question. quiz-definition-answers Contains one or more row tags, each containing information about a particular answer to a particular quiz question. quiz-definition-questions Contains one or more row tags, each containing information about a particular quiz question. quiz-name The name 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. 116 report-active-meeting-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-bulk-content-quiz-results Contains row information about the results for a content quiz. report-bulk-course-quiz Contains rows that contain information about all course quizzes, including a list of quizzes. report-bulk-course-quiz-results Contains information about results for a course quiz, including information on each user and quiz question. report-bulk-meeting Contains information about all meetings. report-bulk-meeting-attendance Contains information about all meeting attendees. report-bulk-slide-views Contains slide view data. Chapter 5: XML Results Reference Tag Description report-course-status Contains information about the status of a course. report-disk-usage Indicates how much hard disk space the Breeze content uses, in bytes. report-meeting-attendance Contains one or more row tags, each containing information about a user who attended a particular meeting. report-meeting-concurrent-users The maximum number of users who participated simultaneously in the specified meeting. report-meeting-session Contains information about a meeting. report-meeting-sessions Contains information about all the sessions of a meeting. report-meeting-session-slots Contains one or more row tags, each containing information about a particular session slot. report-meeting-summary Indicates how many users were invited to the specified meeting and how many invitees and guests actually attended. report-principal-list Contains information about the principals. report-quiz-answer-distribution Contains one or more row tags, each indicating how many users selected each answer to the specified quiz question. report-quiz-interactions Contains one or more row tags, each containing information about an interaction a user had with the specified quiz. report-quiz-question-answerdistribution 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, each describing an answer that a user gave to a particular quiz question. report-quiz-question-totals 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. report-quiz-results The number of users who took a specified quiz and their range of scores. report-quiz-summary Contains information about a quiz. report-quiz-takers Contains one or more row tags, each containing information about a user who has taken the specified course or quiz. report-quotas Contains information about the account quotas. report-sco-slides Contains one or more row tags, each indicating how many times and how recently a slide in a presentation has been viewed. Alphabetical list of XML tags 117 118 Tag Description report-sco-views Contains one or more row tags, each indicating how many times and how recently the specified presentation has been viewed. report-survey-question-response Contains information about the list of all users who answered the specified question and their answer. report-training-concurrent-users Indicates the largest number of users who have used the system at the same time. response A user’s response to a survey question. results Contains all results returned by any action. row Contains a single record of information in a report. sco Contains tags that contain information about a SCO, which is a single Breeze document. sco-author Contains tags that provide information about the author of a SCO. sco-data Contains information about the underlying data file (such as the file that contains a presentation) used in a SCO. sco-name The name of 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, 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 contains content relevant to the logged-in user. source-sco Contains information about the SCO for the content inside a course. status A status code returned by the Breeze server whenever an action is called. time-slot-begin The beginning date and time for a meeting session. time-slot-end The ending date and time for a meeting session. time-taken The time a course was taken. tree Contains a tree that belongs to a specified account. trees Contains the list of trees that belong to the specified account. url A URL. url-path The path on the Breeze server to the specified SCO. Chapter 5: XML Results Reference Tag Description user (common-info) Contains information about a user. user (user-accounts) Contains information about a user and an account. user-first-name A user’s first name. user-last-name A user’s last name. user-login A user’s login (usually an e-mail address). user-name A user name. users Contains one or more user tags, each containing information about a user and an account. value The value of a custom field. version The Breeze version number. view-date-time The time and date that a slide was viewed. access-key (container) There are two tags named access-key; they are described in different sections. Description Container tag; contains information about a special access key provided by a SCO. Attributes acl-id The ID of the SCO associated with the access key. action Indicates the type of self-registration. The possible values are "action-self-regand "action-self-reg-course". meeting" Contained tags access-key (key), date-created Returned by accesskey-info Example breezm5qtgnye46zpckbf.MARIANNE 2004-02-12T15:53:19.797-07:00 http://admin.breeze.example.com /api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info breeze_402_r116 gerweck@example.com See also access-key (key), access-keys access-key (container) 119 access-key (key) There are two tags named access-key; they are described in different sections. Description A special access key for use in self-registration. Attributes None. Contained tags None (content only). Returned by accesskey-info Example 3hzvnifcfmphn3id 2004-03-05T10:28:14.750-08:00 vb7gmg6ohtz4y7k6 See also access-key (container), access-keys access-key-group Description Container tag; contains information about which group the user automatically joins by selfregistering using the special access key. Also contains 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. Indicates whether the principal has children. Groups have children and users don’t, so this attribute indicates whether the principal is a group. has-children is-primary type Indicates whether the principal is a primary group; for more information, see the attribute. principal-id The ID of the principal. type The type of principal. Possible values include "user", "group", and various kinds of primary groups: "admins", "authors", "live-admins", and "course-admins". You can create and modify users and groups, but not primary groups. Contained tags login, name Returned by accesskey-info 120 Chapter 5: XML Results Reference Exampleaccess-keys Description Container tag; contains one or more access keys. Attributes None. Contained tags access-key (container) Returned by accesskey-info Example COURSE-test1-self-reg-group COURSE-test1-self-reg-group account Description The account ID. Attributes account-id The ID of the account. Contained tags None (empty tag). Returned by common-info Example vb7gmg6ohtz4y7k6 2004-03-05T00:30:38.483-08:00 account 121 action Description The name of an action. Attributes None. Contained tags None (content only). Returned by action-list Example user-accounts actions Description Container tag; contains a list of actions. Attributes None. Contained tags action Returned by action-list Example122 Chapter 5: XML Results Reference answer-correct Description The text for a correct answer. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz Example accesskey-exec accesskey-info action-list ... [other actions listed here] ...user-accounts user-update-pwd YES answer-text Description The text of an answer to a quiz question as part of the results returned by a report action. Attributes None. Contained tags None (content only). Returned by report-quiz-answer-distribution, report-quiz-question-response ExampleECMA-262 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). body 123 Returned by report-quiz-answer-distribution, report-quiz-definition-answers, report-quiz-definition-questions, report-quiz-question-distribution, report-quiz-question-response Example What is 2+2? comment Description Any comments on the custom field (may be 0 to 60 characters long). Attributes None. Contained tags None (content only). Returned by custom-field-update Exampleany comment goes here common Description Container tag; contains tags that provide information about the server and the logged-in user. If you call common-info without logging in first, the same information is returned except for the user tag. Attributes locale The locale of the currently logged-in user. Contained tags account, cookie, date, host, url, user (common-info), version Returned by common-info Examplecontact Description Container tag; contains information about a contact. Attributes contact-id The ID of a contact. Contained tags email, first-name, last-name Returned by principal-info Example breezm5qtgnye46zpckbf.MARIANNE 2004-02-12T15:53:19.797-07:00 http://admin.breeze.example.com /api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info 124 Chapter 5: XML Results Referencebreeze_402_r116 gerweck@example.com cookie 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-info without logging in first, the server returns a new cookie. You need the cookie when, for example, you 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 action. Attributes None. Contained tags None (content only). Returned by common-info cookie 125 Example test4-lnagaraj@test.enang.com test4 laxmi breezm5qtgnye46zpckbf.MARIANNE course Description Container tag; contains information about a course. Attributes The ID of the course. sco-id Indicates whether a course is active. The possible values are "no-content", which indicates that the course has just been created but has no content, and "active". status type Indicates that this SCO is a course. The value is always "course". Contained tags date-begin, date-created, date-end, date-modified, expired, name, url, url-path Returned by report-my-courses Examplecustom-fields Description Container tag; contains information about the custom fields of an account. Attributes None. Contained tags field Returned by custom-fields 126 Chapter 5: XML Results Reference Example My Name admin.breeze.example.com/p38547860/ 2004-02-09T14:40:38.497-08:00 2004-02-09T14:40:44.623-08:00 2004-02-09T14:30:00.000-08:00 2004-02-09T14:30:00.000-08:00 /p38547860/ true date Description The current date and time on the server, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by common-info Example Department this is optional SSN 2004-02-12T15:53:19.797-07:00 date-begin Description The date and time that a SCO 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 Example2003-09-02T21:41:58.330-07:00 date-begin 127 date-closed Description The time at which the user closed the window that contains the meeting, thereby leaving the meeting, in ISO 8601date format. Attributes None. Contained tags None (content only). Returned by report-meeting-attendance Example2004-01-29T00:59:41.470-08:00 date-created Description The date and time that a SCO was created, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by accesskey-info, report-active-meeting-presenters, report-meeting-attendance, report-my-courses, report-quiz-interactions, sco-info, sco-search Example2004-02-09T14:40:38.497-08:00 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). 128 Chapter 5: XML Results Reference Returned by report-meeting-session, report-my-courses, report-my-meetings, sco-contents Example2004-02-09T14:30:00.000-08:00 date-expired Description The date that an account is, or was, scheduled to expire, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by user-accounts Example2004-01-24T00:59:59.000-07:00 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 Example2004-07-13T10:55:28.763-07:00 date-modified Description The date that something was most recently modified, in ISO 8601 date format. Attributes None. date-modified 129 Contained tags None (content only). Returned by report-my-courses, report-quiz-definition-questions, sco-contents, sco-info, scosearch Example2004-02-09T14:40:44.623-08:00 date-taken Description The date that a particular user took a particular quiz, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-quiz-takers Example2004-01-13T01:33:49.460-08:00 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 Example2004-07-13T10:52:23.780-07:00 130 Chapter 5: XML Results Reference description Description The description of a principal. Attributes None. Contained tags None (content only). Returned by principal-info, principal-list ExampleAccount administrators group domain-name Description The fully qualified domain name of the location of a SCO. Attributes None. Contained tags None (content only). Returned by report-my-meetings, sco-shortcuts Exampleadmin.breeze.example.com duration Description The duration of a SCO. Attributes None. Contained tags None (content only). Returned by sco-contents duration 131 Example1900-01-02T/+:00:00.000+00:00 email Description A user’s e-mail address. Attributes None. Contained tags None (content only). Returned by principal-list, sco-info Exampletennant@example.com expired Description A Boolean value that indicates whether a SCO has expired. A SCO has expired when its end date has passed, and it is no longer available. Attributes None. Contained tags None (content only). Returned by report-my-courses, report-my-meetings Exampletrue field Description Container tag; contains information about a new custom field. Attributes field-id account-id 132 The ID of the field. The ID of the account. Chapter 5: XML Results Reference custom-seq type The custom field number. The type of the custom field. It must be one of the following values: Value Description required Required account custom field optional Optional and show during self-registration optional-no-self-reg Optional and hide during self-registration Contained tags comment, name, value Note: Not all tags are returned by all actions. Returned by custom-field-update Examplefirst-name Description A user’s first name. Attributes None. Contained tags None (content only). Returned by sco-info, sco-search Example none Manager 411 Pat first-name 133 hit Description A number indicating which slide contains a search term. Attributes None. Contained tags None (content only). Returned by sco-search Example5 host Description The URL of the host that the Breeze server is running on. Attributes None. Contained tags None (content only). Returned by common-info Examplehttp://admin.breeze.example.com 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 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 parameter to the action. For information on which parameters are required, see the reference material for the specific action in Chapter 4, “Action Reference,” on page 37. 134 Chapter 5: XML Results Reference Attributes The name of the parameter that was invalid. field subcode The reason that the parameter was invalid. The following table shows the possible values for this attribute: Value Description duplicate The call attempted to add a duplicate item in a context where uniqueness is required. format A passed parameter had the wrong format. illegal-operation The requested operation violates integrity rules (for example, moving a folder into itself is an illegal operation). missing A required parameter was missing. no-such-item The requested information does not exist. range The value is outside the permitted range of values. type The type of the parameter, such as "id", "long", or "string". Contained tags None (empty tag). Returned by Any invalid action. Examplelast-name Description A user’s last name. Attributes None. Contained tags None (content only). Returned by sco-info, sco-search Example Tennant last-name 135 last-viewed Description The date and time of the most recent time that a SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-slides Example2004-01-13T16:35:39.517-08:00 last-viewed-date Description The most recent date and time that the SCO was viewed, in ISO 8601 date format. Attributes None. Contained tags None (content only). Returned by report-sco-views Example2004-01-13T17:11:47.923-08:00 login Description A user’s login name, which is usually the user’s e-mail address. Attributes None. Contained tags None (content only). 136 Chapter 5: XML Results Reference Returned by common-info, permissions-info, principal-info, principal-list, report-coursetakers, report-meeting-attendance, report-quiz-takers Exampletennant@example.com meeting Description Container tag; contains information about a meeting. Attributes active-participants The number of current participants. The permissions the user has for the meeting. For more information, see “About security” on page 17. permission-id The ID of the meeting. sco-id Indicates the meeting’s status. 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". status type Indicates that this SCO is a meeting. The value is always "meeting". Contained tags date-begin, date-end, domain-name, expired, name, url-path Returned by report-my-meetings Examplemy-courses Description Container tag; contains information about one or more courses. Attributes None. my-courses 137 Contained tags course Returned by report-my-courses Example morris shared admin.breeze.example.com /r99718924/ 2003-07-14T23:00:00.000-07:00 2003-07-15T09:00:00.000-07:00 true my-meetings Description Container tag; contains information about one or more meetings. Attributes None. Contained tags meeting Returned by report-my-meetings Example My Name admin.breeze.example.com/p38547860/ 2004-02-09T14:40:38.497-08:00 2004-02-09T14:40:44.623-08:00 2004-02-09T14:30:00.000-08:00 2004-02-09T14:30:00.000-08:00 /p38547860/ true 138 Chapter 5: XML Results Reference name Description A user’s name. For example, depending on the context, the tag may contain the name of a person, the name of a group, the name of a SCO, an e-mail address, or another kind of name. Attributes None. Contained tags None (content only). Returned by permissions-info, principal-info, principal-list, report-active-meetingpresenters, report-active-meetings, report-meeting-session, report-meetingsessions, report-my-courses, report-my-meetings, report-quiz-takers, report-sco-views, report-training-concurrent-users, sco-contents, sco-info, sconav, sco-search, user-accounts Example morris shared admin.breeze.example.com /r99718924/ 2003-07-14T23:00:00.000-07:00 2003-07-15T09:00:00.000-07:00 true Math Test participant-name Description The name of a participant in a meeting. The name is presented in the standard format for the locale. Attributes None. Contained tags None (content only). Returned by report-meeting-attendance ExampleTennant, Pat permission Description Contains information about a specific principal and its permissions. permission 139 Attributes acl-id The ID of a specific SCO. permission-id The permissions that the principal has for the specified SCO. This attribute is returned only by the permissions-info action. principal-id The ID of the principal. Contained tags None (empty tag). Returned by permissions-info Examplepermissions Description Container tag; contains information about one or more principals and their permissions. For information about principals, see “About principals, SCOs, and IDs” on page 16. For information about permissions, see “About security” on page 17. Attributes None. Contained tags principal Returned by permissions-info Example 140 Chapter 5: XML Results Reference physical-path Description The path on the server to a SCO. Attributes None. Contained tags None (content only). Returned by sco-info Example Englesberg, Ari englesberg@example.com 222914/503227/ preferences Description Contains information about user preferences. Attributes The ID of the user for whom the preferences are updated. acl-id lang The language setting. Breeze currently supports the following five languages: Language Parameter value English en French fr German de Japanese ja Korean ko time-zone-id The time zone setting. Breeze currently supports the following 75 time zones: Time zone setting Parameter value International Date Line West (GMT-12:00) 0 Midway Island, Samoa (GMT-11:00) 1 Hawaii (GMT-10:00) 2 Alaska (GMT-09:00) 3 Pacific Time (US and Canada); Tijuana (GMT-08:00) 4 Mountain Time (US and Canada) (GMT-07:00) 10 preferences 141 142 Time zone setting Parameter value Chihuahua, La Paz, Mazatlan (GMT-07:00) 13 Arizona (GMT-07:00) 15 Central Time (US and Canada) (GMT-06:00) 20 Saskatchewan (GMT-06:00) 25 Guadalajara, Mexico City, Monterrey (GMT-06:00) 30 Central America (GMT-06:00) 33 Eastern Time (US and Canada) (GMT-05:00) 35 Indiana (East) (GMT-05:00) 40 Bogota, Lima, Quito (GMT-05:00) 45 Atlantic Time (Canada) (GMT-04:00) 50 Caracas, La Paz (GMT-04:00) 55 Santiago (GMT-04:00) 56 Newfoundland (GMT-03:30) 60 Brasilia (GMT-03:00) 65 Buenos Aires, Georgetown (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, Budapest, Ljubljana, Prague (GMT+01:00) 95 Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) 100 Brussels, Copenhagen, Madrid, Paris (GMT+01:00) 105 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (GMT+01:00) 110 West Central Africa (GMT+01:00) 113 Bucharest (GMT+02:00) 115 Cairo(GMT+02:00) 120 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) 125 Athens, Istanbul, Minsk (GMT+02:00) 130 Jerusalem (GMT+02:00) 135 Harare, Pretoria (GMT+02:00) 140 Moscow, St. Petersburg, Volgograd (GMT+03:00) 145 Chapter 5: XML Results Reference Time zone setting Parameter value Kuwait, Riyadh (GMT+03:00) 150 Nairobi (GMT+03:00) 155 Baghdad (GMT+03:00) 158 Tehran (GMT+03:30) 160 Abu Dhabi, Muscat (GMT+04:00) 165 Baku, Tbilisi, Yerevan (GMT+04:00) 170 Kabul (GMT+04:30) 175 Ekaterinburg (GMT+05:00) 180 Islamabad, Karachi, Tashkent (GMT+05:00) 185 Chennai, Kolkata, Mumbai, New Delhi (GMT+05:30) 190 Kathmandu (GMT+05:45) 193 Astana, Dhaka (GMT+06:00) 195 Sri Jayawardenepura (GMT+06:00) 200 Almaty, Novosibirsk (GMT+06:00) 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+08:00) 220 Perth (GMT+08:00) 225 Irkutsk, Ulaan Bataar (GMT+08:00) 227 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 preferences 143 Time zone setting Parameter value Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) 285 Auckland, Wellington (GMT+12:00) 290 Nuku’alofa (GMT+13:00) 300 Contained tags None. Returned by principal-info Examplepresentation-name Description The name of a Breeze presentation. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz, report-bulk-slide-views Example test-quiz principal Description Contains information about a principal. For 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 principal-info action. Indicates whether the principal has children. Groups have children and users don’t, so this attribute indicates whether the principal is a group. has-children is-primary type 144 Indicates whether the principal is a primary group; for more information, see the attribute. Chapter 5: XML Results Reference permission-id The permissions that the principal has for the specified SCO. This attribute is returned only by the permissions-info action. The ID of the principal. principal-id contact-id The ID for the contact information associated with the user. This value is null for groups. type The type of principal. Possible values include "user", "group", and various kinds of primary groups: "admins", "authors", "live-admins", and "course-admins". You can create and modify users and groups, but not primary groups. Contained tags field, name, Returned by permissions-info, principal-update Exampleprincipal-custom-field-values Description Container tag; contains information about the values of a custom field in a principal. For general information about principals, see “About principals, SCOs, and IDs” on page 16. Attributes None. Contained tags field Returned by principal-info Example Phone number 408-1111-111 principal-custom-field-values 145 principal-list Description Container tag; contains one or more principal tags. Attributes None. Contained tags principal Returned by principal-list Example Phone number 408-1111-111 principal-name Description The name of a principal. The name is presented in the standard format for the locale. Attributes None. Contained tags None (content only). Returned by report-course-takers, report-quiz-takers Example Account Administrators Account Administrators Account administrators group Chiang, Ed 146 Chapter 5: XML Results Reference question Description The text of a quiz question. Attributes None. Contained tags None (content only). Returned by report-quiz-interactions, report-survey-question-response ExampleWhat is 2+2? question-text Description The text of a quiz question. Attributes None. Contained tags None (content only). Returned by report-quiz-question-answer-distribution, report-bulk-content-quiz ExampleWhat is 2+2? quiz-name Description The name of a quiz. Attributes None. Contained tags None (content only). Returned by report-bulk-content-quiz quiz-name 147 ExampleWho is Randy Johnson ? quiz-definition-answers Description Container tag; contains one or more row tags, each containing information about a particular answer to a particular quiz question. Attributes None. Contained tags row Returned by report-quiz-definition-answers Example1