User Guide

sco-upload 135
sco-upload
Availability
Breeze 4.
Description
Uploads a file to the Breeze server when creating a presentation using the XML API. (For more
information, see
sco-update and sco-build.)
You must send the parameters for this API using the multipart/form-data media type. The easiest
way to create the
file parameter is to use a form control of file type in a form on a web page.
After you upload a file, call the
sco-build API to build it.
The following sample HTML is a form for associating content with a presentation created with
the XML API:
<FORM action="http://<domain-name>/api/xml?action=sco-upload&sco-
id=xx&summary=xxx&title=xxx" enctype="multipart/form-data" method="post">
<P>
What files are you sending?
<INPUT type="file" name="file">
<BR>
<INPUT type="submit" value="Send"> <INPUT type="reset">
</FORM>
This form uploads a single file. If you need to upload multiple files (for example, a PPT and a
PPC file), you must pass an additional
file parameter:
<FORM action="http://<domain-name>/api/xml?action=sco-upload&sco-
id=xxx&summary=xxx&title=xxxx" enctype="multipart/form-data" method="post">
<P>
PPT files you are sending <INPUT type="file" name="file"><BR>
PPC files you are sending <INPUT type="file" name="file"><BR>
<INPUT type="submit" value="Send"> <INPUT type="reset">
</FORM>
Note: Call the sco-info API to obtain the latest SCO status. The SCO status is initially in-progress,
which means that the content is being built. When the status becomes active, the content has
finished being built and is now accessible.
Parameters
file
The file that you want to upload. This should be the actual data for the file, not just a
filename or path.
sco-id The ID of the new SCO. You must have already set a type for the SCO; for example, by
using
sco-update.
summary A brief summary of general information about the SCO. The summary appears in
content listings and is returned by the
sco-info API. This parameter is optional.
title The title of the new SCO.