114
Chapter 5: XML Results Reference
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:
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.
Summary of Contents for BREEZE-USING THE BREEZE XML WEB SERVICES
Page 1: ...Using the Breeze XML Web Services...
Page 8: ...8 Contents...
Page 12: ...12 Introduction Before You Begin...
Page 26: ...26 Chapter 2 Working with Filters...
Page 36: ...36 Chapter 3 Common Tasks...
Page 112: ...112 Chapter 4 Action Reference...
Page 186: ...186 Chapter 5 XML Results Reference...
Page 196: ...196 Index...