Lists all SCOs in a curriculum, including the contents of subfolders.

Availability

Adobe Connect Pro 7

Description

Lists all of the SCOs in a curriculum, including the contents of subfolders.

Note:

To list the contents of a curriculum, use this action instead of sco-expanded-contents

To find a sco-id to pass in the request URL, call sco-shortcuts. For more information, see Find SCOs.

Request URL

 http://server_name/api/xml 
     ?action=curriculum-contents 
     &sco-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The unique ID of a curriculum.

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 cannot sort or filter the response to this API call.

Response structure

 <results> 
    <status code=allowedValue/> 
    <curriculum-contents> 
        <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 source-sco-icon=integer content-source-sco-icon=integer> 
            <name>string</name> 
            <url-path>string</url-path> 
            <description> 
             string 
            </description> 
            <date-created>datetime</date-created> 
            <date-modified>datetime</date-modified> 
        </sco> 
        ...more sco elements... 
    </curriculum-contents> 
</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).

curriculum-contents

 

Container

The list of all SCOs the curriculum contains.

sco

 

Container

Details about one SCO. 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

BIGINT

The unique ID of the SCO. If the SCO is a folder, same as folder-id.

 

folder-id

BIGINT

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 Adobe Connect Central (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 SCO from which this SCO was created.

 

source-sco-icon

Integer

An integer indicating the type of icon from which this icon was created.

 

content-source-sco-icon

Integer

An integrer indicating the type of content from which this icon was created.

name

 

String

The name of the contained SCO.

url-path

 

String

The URL of the SCO within the curriculum.

description

 

String

The summary in the UI. If a SCO has a summary, this field exists, otherwise, the field does not exist.

date-created

 

Datetime

The date and time the principal began interacting with the SCO and the transaction was created.

date-modified

 

Datetime

The date the SCO was last updated.

Sample request

 http://example.com/api/xml?action=curriculum-contents&sco-id=11697&session=breezq7dyhc7m3de8dksr

Sample response

 <results> 
    <status code="ok"/> 
    <curriculum-contents> 
        <sco depth="1" sco-id="31949" folder-id="11697" type="link" icon="course" lang="en" source-sco-id="41184" display-seq="0" source-sco-type="0" source-sco-icon="1" content-source-sco-icon="1025"> 
            <name>FlashBelt09</name> 
            <url-path>/l66176109/</url-path> 
            <date-created>2009-05-27T03:48:54.277+05:30</date-created> 
            <date-modified>2009-05-27T03:48:54.277+05:30</date-modified> 
        </sco> 
        <sco depth="0" sco-id="11697" folder-id="41177" type="curriculum" icon="curriculum" lang="en" source-sco-id="" display-seq="0" source-sco-type="" source-sco-icon="" content-source-sco-icon=""> 
            <name>Backyard Cooking</name> 
            <url-path>/cooking/</url-path> 
            <description> 
             Learn how to cook with things you can find in most urban backyards. 
            </description> 
            <date-begin>2009-05-27T03:45:00.000+05:30</date-begin> 
            <date-created>2009-05-27T03:48:40.383+05:30</date-created> 
            <date-modified>2009-05-27T03:48:40.383+05:30</date-modified> 
        </sco> 
    </curriculum-contents> 
</results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy