sco-expanded-contents

Availability

Breeze 5; Connect Enterprise Web Services 6

Description

Lists all of the SCOs in a folder, including the contents of subfolders, curriculums, and any type of enclosing SCO.

If you do not use a filter, the list of SCOs is returned in the same order as it appears in Connect Enterprise Manager. If you use a filter or a sort, the list is returned according to the filter or sort you use.

Request URL

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

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The unique ID of a folder.
`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 date in ISO 8601 format but without a time zone, for example:
```
filter-date-modified=2005-01-05T10:44:03
```
However, you can use filter-gt-datefield or filter-lt-datefield with a full date that includes a time zone.
Do not use partial match filters constructed with filter-like (such as filter-like-name), as they might affect server performance.

You can sort the response on any element or attribute except date-begin, date-created, date-modified, and url-path.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
    <expanded-scos> 
        <sco depth=integer sco-id=integer folder-id=integer type=allowedValue
                icon=allowedValue lang=allowedValue source-sco-id=integer 
                display-seq=integer source-sco-type=integer> 
            <name>string</name> 
            <url-path>string</url-path> 
            <date-created>datetime</date-created> 
            <date-modified>datetime</date-modified> 
        </sco>
        ... more sco elements ...
    </expanded-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).
`expanded-scos`		Container	The list of all SCOs the folder contains.
`sco`		Container	Details about one SCO in the folder. This SCO can be a folder or any other type of object.
	`depth`	Integer	The depth in the content tree at which this object appears, with top-level objects at `1`.
	`sco-id`	Integer	The unique ID of the SCO. If the SCO is a folder, same as `folder-id`.
	`folder-id`	Integer	The ID of the folder the SCO belongs to.
	`type`	Allowed value	The type of this content object (see type).
	`icon`	Allowed value	The name of the icon that visually identifies this object.
	`lang`	Allowed value	The language in which information about the SCO is displayed (see lang for values).
	`source-sco-id`	Integer	The ID of a SCO from which this SCO was created, such as a meeting template or course content.
	`display-seq`	Integer	The sequence in which Enterprise Manager (or your application, if you use this value) displays a list of SCOs. Values are not necessarily unique, so multiple SCOs can have the same `display-seq` value. In that case, the application must define the display sequence. The default is `0`.
	`source-sco-type`	Integer	An integer indicating the type of the SCO from which this SCO was created.

Sample request

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

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <expanded-scos>
        <sco depth="0" sco-id="624529" folder-id="624520" type="folder"
                icon="folder" lang="en" source-sco-id="" display-seq="0" 
                source-sco-type="">
            <name>Shared Meetings</name> 
            <url-path>/f624529/</url-path> 
            <date-created>2004-03-09T09:45:41.060-08:00</date-created> 
            <date-modified>2005-03-18T10:19:38.950-08:00</date-modified> 
        </sco>
        <sco depth="1" sco-id="2598379" folder-id="624529" type="meeting"
                icon="meeting" lang="en" source-sco-id="-8888" display-seq="0" 
                source-sco-type="3">
            <name>Monday Night Football</name> 
            <url-path>/r68075204/</url-path> 
            <description>Monday Night Football</description> 
            <date-begin>2004-05-17T15:30:00.000-07:00</date-begin> 
            <date-end>2004-05-18T00:15:00.000-07:00</date-end> 
            <date-created>2004-05-17T15:50:39.733-07:00</date-created> 
            <date-modified>2006-08-16T00:34:52.930-07:00</date-modified> 
        </sco>
    </expanded-scos>
</results>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04c_ac12.htm