sco-contents

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Returns a list of SCOs within another SCO. The enclosing SCO can be a folder, meeting, or curriculum.

In general, the contained SCOs can be of any type--meetings, courses, curriculums, content, events, folders, trees, or links (see the list in type). However, the type of the contained SCO needs to be valid for the enclosing SCO. For example, courses are contained within curriculums, and meeting content is contained within meetings.

Because folders are SCOs, the returned list includes SCOs and subfolders at the next hierarchical level, but not the contents of the subfolders. To include the subfolder contents, call sco-expanded-contents.

Request URL

http://server_name/api/xml
    ?action=sco-contents
    &sco-id=integer
    &filter-definition=value
    &sort-definition=value
    &session=value

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The unique ID of a folder for which you want to list contents. You can get the `sco-id` by calling `sco-shortcuts`.
`filter-definition`	Filter definition	N	A filter to reduce the volume of the response.
`sort-definition`	Sort definition	N	A sort to return results in a certain sequence.
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter the response on any element or attribute, with these exceptions:

You cannot filter on duration or is-folder.
If you use filter-date-begin, filter-date-end, or filter-date-modified, specify a time without a time zone, for example:
filter-date-modified=2005-01-05T10:44:03

You can use filter-gt or filter-lt with a date field and a full date, including the time zone.

You can sort the response on any element or attribute.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
    <scos> 
        <sco sco-id=integer source-sco-id=integer folder-id=integer
                type=allowedValue icon=allowedValue display-seq=integer 
                is-folder=boolean byte-count=integer ref-count=integer> 
            <name>string</name> 
            <url-path>string</url-path>
            <description>string</description>
            <date-begin>string</date-begin>
            <date-modified>datetime</date-modified> 
            <date-end>string</date-end>
            <sco-tag>string</sco-tag>
        </sco>
    </scos>
</results>

Response values

Element	Attribute	Type	Description
`results`		Container	All results the action returns.
`status`		Empty, with attributes	The status of the response.
	`code`	Allowed value	A code indicating the response status (see status).
`scos`		Container	The list of objects within the folder.
`sco`		Container	One object within the folder.
	`sco-id`	Integer	The unique ID of one object within the folder.
	`source-sco-id`	Integer	The unique ID of a content SCO used in a course or curriculum.
	`folder-id`	Integer	The ID of a folder, passed as `sco-id` in the request.
	`type`	Allowed value	The type of the object (see type for values). SCOs that represent content have a type of `content`, rather than a more specific type, such as `presentation`.
	`icon`	Allowed value	The name of the icon that identifies the object. Provides more detail on the type of object in `type`.
	`display-seq`	Integer	The sequence in which Enterprise Manager or your application displays the object.
	`is-folder`	Boolean	A value indicating whether the object is a folder (if `1`) or not (if `0`).
	`byte-count`	Integer	The size of the content. For folders, this value will be `0`.
	`ref-count`	Integer	The number of SCOs that reference this SCO.
`name`		String	The name of the object on the server.
`url-path`		String	The unique identifier after the domain name in the URL to the SCO.
`description`		String	The description of the object.
`date-modified`		Datetime	The date the object was last modified.
`date-begin`		Datetime	The beginning date of a course or meeting (returned for a course or meeting only).
`date-end`		Datetime	The end date of a course or meeting (returned for a course or meeting only).
`domain-name`		String	The domain name at which you can access a meeting or event (returned for meetings and events only).
`duration`		Datetime	The length of time a course or meeting lasted (returned for a course or meeting only).
`sco-tag`		String	A brief description of the SCO.

Sample request

https://example.com/api/xml?action=sco-contents&sco-id=2006258748

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <scos>
        <sco sco-id="2007035246" source-sco-id="2006334909" 
                    folder-id="2006258748" type="content" icon="course" 
                    display-seq="0" is-folder="0">
            <name>Java 101</name> 
            <url-path>/java101/</url-path> 
            <date-begin>2006-07-20T17:15:00.000-07:00</date-begin> 
            <date-modified>2006-07-20T17:21:38.860-07:00</date-modified> 
        </sco>
    </scos>
</results>