User manual MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES

[. . . ] 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. [. . . ] Breeze currently supports the following 75 time zones: Parameter value 0 1 2 3 Time zone setting (GMT-12:00) International Date Line West (GMT-11:00) Midway Island, Samoa (GMT-10:00) Hawaii (GMT-09:00) Alaska acl-preference-update 43 Time zone setting (GMT-08:00) Pacific Time (US and Canada); Tijuana (GMT-07:00) Mountain Time (US and Canada) (GMT-07:00) Chihuahua, La Paz, Mazatlan (GMT-07:00) Arizona (GMT-06:00) Central Time (US and Canada) (GMT-06:00) Saskatchewan (GMT-06:00) Guadalajara, Mexico City, Monterrey (GMT-06:00) Central America (GMT-05:00) Eastern Time (US and Canada) (GMT-05:00) Indiana (East) (GMT-05:00) Bogota, Lima, Quito (GMT-04:00) Atlantic Time (Canada) (GMT-04:00) Caracas, La Paz (GMT-04:00) Santiago (GMT-03:30) Newfoundland (GMT-03:00) Brasilia (GMT-03:00) Buenos Aires, Georgetown (GMT-03:00) Greenland (GMT-02:00) Mid-Atlantic (GMT-01:00) Azores (GMT-01:00) Cape Verde Islands (GMT) Greenwich Mean Time Dublin, Edinburgh, Lisbon, London (GMT) Casablanca, Monrovia (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague (GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) Brussels, Copenhagen, Madrid, Paris (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (GMT+01:00) West Central Africa (GMT+02:00) Bucharest (GMT+02:00) Cairo (GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) Athens, Istanbul, Minsk (GMT+02:00) Jerusalem Parameter value 4 10 13 15 20 25 30 33 35 40 45 50 55 56 60 65 70 73 75 80 83 85 90 95 100 105 110 113 115 120 125 130 135 44 Chapter 4: Action Reference Time zone setting (GMT+02:00) Harare, Pretoria (GMT+03:00) Moscow, St. Petersburg, Volgograd (GMT+03:00) Kuwait, Riyadh (GMT+03:00) Nairobi (GMT+03:00) Baghdad (GMT+03:30) Tehran (GMT+04:00) Abu Dhabi, Muscat (GMT+04:00) Baku, Tbilisi, Yerevan (GMT+04:30) Kabul (GMT+05:00) Ekaterinburg (GMT+05:00) Islamabad, Karachi, Tashkent (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi (GMT+05:45) Kathmandu (GMT+06:00) Astana, Dhaka (GMT+06:00) Sri Jayawardenepura (GMT+06:00) Almaty, Novosibirsk (GMT+06:30) Rangoon (GMT+07:00) Bangkok, Hanoi, Jakarta (GMT+07:00) Krasnoyarsk (GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi (GMT+08:00) Kuala Lumpur, Singapore (GMT+08:00) Taipei (GMT+08:00) Perth (GMT+08:00) Irkutsk, Ulaan Bataar (GMT+09:00) Seoul (GMT+09:00) Osaka, Sapporo, Tokyo (GMT+09:00) Yakutsk (GMT+09:30) Darwin (GMT+09:30) Adelaide (GMT+10:00) Canberra, Melbourne, Sydney (GMT+10:00) Brisbane (GMT+10:00) Hobart (GMT+10:00) Vladivostok Parameter value 140 145 150 155 158 160 165 170 175 180 185 190 193 195 200 201 203 205 207 210 215 220 225 227 230 235 240 245 250 255 260 265 270 acl-preference-update 45 Time zone setting (GMT+10:00) Guam, Port Moresby (GMT+11:00) Magadan, Solomon Islands, New Caledonia (GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands (GMT+12:00) Auckland, Wellington (GMT+13:00) Nuku'alofa Filters Parameter value 275 280 285 290 300 Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </results> action-list Description Returns a list of web service actions. Caution: Not all actions in this list are documented, and not all documented actions are in this list. Parameters 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. Filters Results cannot be filtered or sorted. Returned elements actions Sample results <results> <status code="ok" /> <actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action> . . . <action>user-accounts</action> 46 Chapter 4: Action Reference <action>user-update-pwd</action> </actions> </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. Filters Results cannot be filtered or sorted. Returned elements common Sample results <results> <status code="ok" /> <common locale="en"> <cookie>breezm5qtgnye46zpckbf. MARIANNE</cookie> <date>2004-02-12T15:53:19. 797-07:00</date> <host>http://admin. breeze. example. com</host> <url>/api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info</url> <version>breeze_402_r116</version> <account account-id="222914" /> <user user-id="503562"> <login>gerweck@example. com</login> </user> </common> </results> 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. This parameter The name of the custom field (may be 1 to 60 characters long). comments is optional. type Value required optional optional-no-self-reg The type of the custom field. Must be one of the following: Description Required account custom field Optional and show during self-registration Optional and hide during self-registration custom-seq 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). Returned elements When updating an existing custom field: no elements are returned. When creating a new custom field: field. Sample Results: When creating a new custom field: <results> <status code="ok" /> <field field-id="1562" account-id="7" custom-seq="4" type="optional"> <comments>none</comments> <name>Manager</name> </field> </results> When updating an existing custom field: <results> <status code="ok" /> </results> custom-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. The default sort is by ascending field-id. Returned elements custom-fields, field Sample results <results> <status code="ok" /> <custom-fields> <field field-id="1329" custom-seq="1" account-id="7" type="optional"> <name>Department</name> <comments>this is optional</comments> </field> <field field-id="1330" custom-seq="2" account-id="7" type="required"> <name>SSN</name> </field> </custom-fields> </results> custom-fields-delete Description Deletes the specified account custom field. 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. 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 <results> <status code="ok" /> </results> 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 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. group-id The ID of the group for which you're updating the membership. Indicates whether the principal is added to (true) or deleted from (false) the principal-id is-member group. Filters Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </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. [. . . ] 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. sco-name 173 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 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 174 Chapter 5: XML Results Reference Example <sco-search-info> <sco sco-id="202014" folder-id="202008" type="presentation" slide-count="4" length="20000"> <name>Quiz 1</name> <url-path>/p92628681/</url-path> <date-created>2003-11-26T22:52:28. 973-08:00</date-created> <date-modified>2003-11-26T22:52:37. 867-08:00</date-modified> <first-name>Pat</first-name> <last-name>Tennant</last-name> <hit>1</hit> <hit>4</hit> </sco> </sco-search-info> 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> scos 175 shortcuts Description Container tag; contains one or more sco tags, each containing information about a folder that contains content relevant to the logged-in user. For more information, see the sco-shortcuts action. Attributes None. Contained tags sco Returned by sco-shortcuts 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> . . . <sco tree-id="181230" sco-id="181230" type="user-meetings"> <domain-name>http://admin. breeze. example. com</domain-name> </sco> </shortcuts> source-sco Description Container tag; contains information about the SCO for the content of a course. Attributes None. Contained tags source-sco Returned by sco-info 176 Chapter 5: XML Results Reference Example <source-sco> <source-sco author-contact-id="586761" folder-id="506334" host-id="" learning-time="" sco-data-id="586762" sco-id="586760" source-sco-id="" status="active" tree-id="181225" type="presentation"> <date-created>2004-02-27T10:31:06. 717-08:00</date-created> <date-modified>2004-02-27T10:52:58. 217-08:00</date-modified> <description>Simple test presentation</description> <name>Math Test</name> <url-path>/p60802018/</url-path> </source-sco> </source-sco> status Description A status code returned by the Breeze server whenever an action is called. This section provides information about all the status codes and subcodes that Breeze can return. Attributes code Value invalid The status of the action. [. . . ]