User manual MACROMEDIA BREEZE 5 INTEGRATION GUIDE

[. . . ] Breeze Integration Guide Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp 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. [. . . ] Provides a list of the SCOs in a specified folder. report-quiz-question-totals report-quiz-summary report-quiz-takers report-quotas report-sco-slides report-sco-views report-survey-question-response sco-build sco-contents Alphabetical API listing 49 API sco-delete sco-expanded-contents Description Deletes one or more SCOs. Provides IDs for a set of folders that contain content relevant to the logged-in user: a folder for the user to place meetings, a folder for the user to place content, and so on. Uploads a file to the Breeze server when creating a presentation using the XML API. Resets a user's transcript for a learning object or marks it as complete. Changes a user's password. sco-info sco-move sco-nav sco-search sco-shortcuts sco-update sco-upload user-accounts user-transcript-update user-update-pwd API reference entries The following section lists the Breeze XML APIs alphabetically accesskey-exec Availability Breeze 4. This API is not supported in Breeze 5. Note: An updated API is not available because the self-registration feature no longer exists in Breeze 5. Description Executes special functions associated with special access keys. You can call this API to do the following: · Allow users to self-register for meetings and courses · Create a new user 50 Chapter 4: XML API Reference To call the accesskey-exec API, you need a special access key associated with a meeting or course. Someone who isn't a Breeze user can be given the special access key and can then use an interface to register for the meeting or course, creating a Breeze user account in the process. This API automatically adds the selfregistering user to the self-registration group associated with the course or meeting, if the group exists. The difference between using accesskey-exec and principal-update to create a new user is that you can call accesskey-exec without being logged in or being an administrator. Also, 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 API. Parameters access-key first-name has-children last-name login The special access key that lets the user self-register. The new user's password. The new user's login name, which is usually the user's e-mail address. Always set this parameter to user when registering a new user. password type Filters Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </results> accesskey-info Availability Breeze 4. This API is not supported in Breeze 5. Note: The accesskey feature no longer exists in Breeze 5, so there is no updated API. Description Provides a special access key, if such a key is associated with the specified SCO. For more information, see the accesskey-exec API. accesskey-info 51 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 does not exist, there is no additional access-key-group element. Parameters acl-id Filters The ID of a SCO. Results cannot be filtered or sorted. Returned elements access-keys, access-key-group Sample results The following sample XML is returned when a group doesn't exist and therefore does not include an access-key-group element: <results> <status code="ok" /> <access-keys> <access-key acl-id="622847" action="action-self-reg-meeting" parent-acl-id="503265"> <access-key>3hzvnifcfmphn3id</access-key> <date-created>2004-03-05T10:28:14. 750-08:00</date-created> </access-key> </access-keys> </results> The following sample results are returned when a group exists and therefore includes an accesskey-group element: <results> <status code="ok" /> <access-key-group account-id="7" has-children="true" is-primary="false" principal-id="630" type="group"> <login>COURSE-test1-self-reg-group</login> <name>COURSE-test1-self-reg-group</name> </access-key-group> <access-keys> <access-key acl-id="126" action="action-self-reg-course" parent-aclid="630"> <access-key>2cw6np2kx2dtdop2</access-key> <date-created>2004-07-07T12:27:04. 590-07:00</date-created> </access-key> </access-keys> </results> 52 Chapter 4: XML API Reference acl-field-info Availability Breeze 5. Description Returns field-ids and values for an ACL. You can call principal-list to determine the account-id or principal-ids. An ACL is a securable Breeze object, for example, a principal, SCO, or account. For more information, see "About principals, SCOs, and IDs" on page 17. Parameters acl-id The ID of the ACL whose field information you want to return. [. . . ] The ID of the SCO's data file. sco-data-id 210 Chapter 5: XML Results Reference slide-count The number of slides in the SCO. A value of -1 indicates that the slide count doesn't apply; for example, if the SCO is a meeting rather than a presentation, the slide count is -1. The width of the SCO, in pixels. Contained tags date-created, date-modified, physical-path Returned by sco-info Example <sco-data byte-count="3993" height="252" length="-1" sco-data-id="95654" slide-count="-1" version="1" width="380"> <date-created>2004-01-26T20:47:05. 653-07:00</date-created> <date-modified>2004-01-26T20:47:05. 653-07:00</date-modified> <physical-path>222914/503227/</physical-path> </sco-data> sco-name Description The name of a particular SCO, such as the name of a meeting. Attributes None. Contained tags None (content only). Returned by report-meeting-attendance Example <sco-name>My Meeting</sco-name> sco-nav Description Container tag; contains information about the folder hierarchy that contains the specified SCO. Attributes None. Contained tags sco sco-nav 211 Returned by sco-nav Example <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>User Meetings</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>tennant@example. com</name> </sco> </sco-nav> sco-search-info Description Container tag; contains one or more sco tags, each containing information about a SCO that matches the specified search text. Attributes None. Contained tags sco Returned by sco-search Example <sco-search-info> <sco sco-id="5393671" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>/p68431203/</name> <url-path>/p68431203/</url-path> <date-created>2005-03-30T16:32:42. 280-08:00</date-created> <date-modified>2005-03-30T16:32:42. 280-08:00</date-modified> <hit>2</hit> <hit-type>slide</hit-type> <hit-url>/Viewer. swf?slide=2</hit-url> <thumbnail-path /> </sco> </sco-search-info> 212 Chapter 5: XML Results Reference scos Description Container tag; contains one or more sco tags, each containing information about a SCO inside the specified folder. Attributes None. Contained tags sco Returned by sco-contents Example <scos> <sco sco-id="505677" status="no-content" type="folder" is-folder="1"> <name>PPT meeting tests</name> <date-modified>2004-01-29T06:22:49. 157-08:00</date-modified> </sco> <sco sco-id="193496" status="active" type="meeting" is-folder="0"> <name>My Name</name> <date-begin>2003-08-27T00:00:00. 000-07:00</date-begin> <date-end>2003-08-27T01:00:00. 000-07:00</date-end> <date-modified>2003-08-26T23:33:20. 300-07:00</date-modified> <duration>1900-01-02T/+:00:00. 000+00:00</duration> </sco> </scos> shortcuts Description Container tag; contains one or more sco tags, each containing information about a folder that contains content relevant to the logged-in user. For more information, see the sco-shortcuts API. Attributes None. Contained tags sco Returned by sco-shortcuts shortcuts 213 Example <shortcuts> <sco tree-id="181230" sco-id="181576" type="my-meetings"> <domain-name>http://admin. breeze. example. com</domain-name> </sco> <sco tree-id="181227" sco-id="181412" type="my-content"> <domain-name>http://admin. breeze. example. com</domain-name> </sco> . . . [. . . ]