To create a new meeting:
Log in as the user.
1.
(Optional) Let the user determine the ID of the folder in which to create the new meeting, using
2.
a web-based interface. If you don't specify a folder, the meeting is created in the my-meetings
folder. You can determine the ID of the my-meetings folder by calling the
action.
Call the
3.
sco-update
a
parameter.
sco-id
Verify that the action completed successfully by checking the returned
4.
To search for content:
Obtain the string to search for from the user, using a web-based form.
1.
Log in as the user.
2.
Call the
3.
sco-search
Parse the returned XML to find information about the SCOs that contain the string; display
4.
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-values
(CSV) files.
To generate a learner status report as a CSV file:
Log in as an administrator.
1.
Determine the ID of a course. In most cases, you are presenting a list of courses (obtained by
2.
calling the
sco-contents
UI, and the user selects a course.
Call the
3.
report-course-takers
This action returns a set of
for the course.
Parse the XML and write the data as text, with commas separating the fields, to a CSV file. The
4.
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 XSLT. For information about XSLT, see
resources" on page
action, using the folder's ID for the
action, using the specified string as the value of the
action, which also gives the IDs for the courses) in the application's
action.
tags, each providing information about a user who is signed up
row
10.
sco-shortcuts
parameter. Don't specify
folder-id
tag.
status
query
"Additional
Generating reports
parameter.
35
Need help?
Do you have a question about the BREEZE-USING THE BREEZE XML WEB SERVICES and is the answer not in the manual?