User Guide

9
INTRODUCTION
Before You Begin
The Macromedia Breeze XML web services enable your external system (such as a web
application) to interact with a Breeze server.
This manual provides information on how to call XML web services (also called APIs or actions)
on the Breeze server from your external system and how to interpret the XML results that Breeze
returns. This manual also contains reference material explaining what each application
programming interface (API) does and what its parameters are.
Audience
This manual is intended for developers who want to integrate the Breeze XML web services into
their external systems, such as web applications.
Before you use this manual, you should understand the basics of XML and of using HTTP
requests to communicate between an application and a server. You must also understand how to
program using a server language such as Macromedia ColdFusion Markup Language (CFML).
What’s new in the Breeze XML APIs
Custom field APIs let you add, update, and get information about custom fields: acl-field-
info
, acl-field-list, acl-field-update.
New Report APIs let you gather data from the Breeze server: report-bulk-consolidated-
transactions
, report-bulk-objects, report-bulk-questions, report-bulk-slide-
views
, report-bulk-users, report-bandwidth, and report-my-events.
Updated Report-quiz APIs include new interaction data types: report-quiz-interactions,
report-quiz-question-answer-distribution, report-quiz-question-distribution,
report-quiz-question-response.
Updated Principals APIs include information about custom fields.
Updated SCO APIs include new shareable content object (SCO) and content types.
New SCO API lists all of the SCOs in an account. Use the sco-expanded-contents API with
filters to locate particular SCOs.
Curriculum APIs let you gather information about and update curriculums: learning-path-
info
, learning-path-update.