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. [. . . ] This parameter is optional. principal-id 52 Chapter 4: Action Reference Filters The following table lists the fields that the data can be filtered and sorted on: Field is-primary type has-children permission-id name login description Filter/Sort Filter and sort Filter and sort Filter and sort Filter and sort Filter and sort Filter and sort 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: <results> <status code="ok" /> <permissions> <principal principal-id="181248" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Englesberg, Ari</name> <login>englesberg@example. com</login> </principal> <principal principal-id="181249" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Milligan, Susan</name> <login>milligan@example. com</login> </principal> </permissions> </results> The following XML data is returned when the principal-id parameter is passed: <results> <status code="ok" /> <permission acl-id="27" permission-id="manage" principal-id="8" /> </results> 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 Filters The ID of a SCO. Results cannot be filtered or sorted. Returned elements None. Sample results <results> <status code="ok" /> </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. The ID of a principal (a user or group). permission-id principal-id Filters Results cannot be filtered or sorted. 54 Chapter 4: Action Reference Returned elements None. Sample results <results> <status code="ok" /> </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 Filters The ID of a specific principal. Results cannot be filtered or sorted. Returned elements principal, contact, preferences, principal-custom-field-values Sample results <results> <status code="ok" /> <principal account-id="222914" has-children="true" is-primary="true" principal-id="222926" type="course-admins"> <description>Course managers group</description> <login>Course Managers</login> <name>Course Managers</name> </principal> </results> The following sample XML data is returned when the type attribute of the principal element is group: <results> <status code="ok" /> <principal account-id="7" has-children="true" is-primary="false" principal-id="122" type="group"> <login>test-1</login> <name>test-1</name> principal-info 55 </principal> </results> 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: <results> <status code="ok" /> <contact contact-id="654"> <email>test4-lnagaraj@test. enang. com</email> <first-name>test4</first-name> <last-name>laxmi</last-name> </contact> <preferences acl-id="653" lang="en" time-zone-id="4" /> <principal account-id="7" has-children="false" is-primary="false" principal-id="653" type="user"> <login>test4-lnagaraj@test. enang. com</login> <name>test4 laxmi</name> </principal> <principal-custom-field-values> <field field-id="652" custom-seq="1" account-id="7" type="optional" principal-id="653"> <name>Phone number</name> <value>408-1111-111</value> </field> </principal-custom-field-values> </results> See 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: Field principal-list contact-id type Filter/Sort Filter and sort Filter and sort Filter and sort 56 Chapter 4: Action Reference Field has-children is-primary is-hidden name login description Filter/Sort Filter and sort Filter and sort Filter and sort Filter and sort Filter and sort 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 <results> <status code="ok" /> <principal-list> <principal principal-id="8" contact-id="3" type="user" haschildren="false" is-primary="false" is-hidden="0"> <name>Enterprise Administrator</name> <login>lnagaraj@macromedia. com</login> <email>lnagaraj@macromedia. com</email> </principal> <principal principal-id="18" contact-id="" type="authors" haschildren="true" is-primary="true" is-hidden="0"> <name>Account Authors</name> <login>Account Authors</login> <description>Account authors group</description> </principal> </principal-list> </results> principal-update Description Updates information for a principal in the current account or creates a new principal. For information about 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 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. [. . . ] If you provide an invalid access key, there is no subcode value. Indicates that there is no data available (in response to an action that would normally result in returning data). Usually indicates that there is no item with the ID you specified. To resolve the error, change the specified ID to that of an item that exists. [. . . ]