User Guide

Generating reports 39
3. Call the sco-update API, using the folder’s ID for the folder-id parameter. Don’t specify a
sco-id parameter.
4. Verify that the API completed successfully by checking the returned status tag.
To search for content:
1. Obtain the string to search for from the user, using a web-based form.
2. Log in as the user.
3. Call the sco-search API, using the specified string as the value of the query parameter.
4. Parse the returned XML to find information about the SCOs that contain the string; display
the relevant information to the user.
Generating reports
Suppose you want your application to provide information about all the courses a user is
registered for or to identify the users who registered for a given meeting. The Breeze XML web
services include a variety of reports, each of which provides data on Breeze use.
Report data is returned in XML form. You can use the results in your system, such as a web
application, or you can convert the data into other file formats, such as comma separated value
(CSV) files.
To generate a learner status report as a CSV file:
1. Log in as an administrator.
2. Call the sco-contents API to determine the ID of a course.
3. Call the report-quiz-takers API.
This API returns a set of
row tags, each providing information about a user who is signed up
for the course.
4. Parse the XML and write the data as text, with commas separating the fields, to a CSV file.
The most common approach shows the resulting CSV file as text in the user’s browser, which
lets the user save the file to their local disk.
You can use a server language such as CFML to translate the file to CSV, or you can use a
transformation language such as XSL Transformations (XSLT). For information about XSLT,
see “Additional resources” on page 11.