User Guide

139
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 API call. For information about the APIs you can call on the server, see
Chapter 4, “XML API Reference,” on page 41.
About returned XML code
When you call an API 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 API was called successfully. In most cases, if the API was called
successfully, the
results tag also contains other tags that contain the data returned by the API.
For example, a
common-info API might return the following results:
<results>
<status code="ok"/>
<common locale="en">
<cookie>breezcywdihbvipp9kcrg.P01BRZPR36</cookie>
<date>2005-02-24T17:10:05.190-08:00</date>
<host>http://admin.breezecentral.com</host>
<url>/api/xml?action=common-info</url>
<version>breeze_500_r271</version>
<account account-id="38181499"/>
<user user-id="38181502" type="user">
<name>Joan Beckworth</name>
<login>[e-mail]</login>
</user>
<user-agent>
Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107
Firefox/1.0
</user-agent>
</common>
</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 API, see the documentation for that API
in Chapter 4, “XML API Reference,” on page 41.