Name
Last updated on
May 15, 2021
Fetch detailed information about any content, meeting, or sessions (SCO) in Adobe Connect.
Availability
Breeze 4
Description
Provides information about a SCO on Adobe Connect. The object can have any valid SCO type. See type for a list of the allowed SCO types.
The response includes the account the SCO belongs to, the dates it was created and last modified, the owner, the URL that reaches it, and other data. For some types of SCOs, the response also includes information about a template from which this SCO was created.
Request URL
http://server_name/api/xml
?action=sco-info
&sco-id=integer
&session=BreezeSessionCookieValue
http://server_name/api/xml
?action=sco-info
&sco-id=integer
&session=BreezeSessionCookieValue
http://server_name/api/xml ?action=sco-info &sco-id=integer &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Y |
The unique ID of a SCO on the server. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<sco account-id=integer disabled=datetime display-seq=integer
folder-id=integer icon=allowedValue lang=allowedValue
max-retries=integer sco-id=integer source-sco-id=integer
type=allowedValue version=integer>
<date-begin>datetime</date-begin>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
<date-modified>datetime</date-modified>
<description>string</description>
<name>string</name>
<url-path>string</url-path>
<passing-score>integer</passing-score>
<duration>datetime</duration>
<section-count>integer</section-count>
</sco>
<source-sco>
<source-sco account-id=integer display-seq=integer folder-id=integer
icon=allowedValue lang=allowedValue max-retries=integer
sco-id=integer source-sco-id=integer type=allowedValue
version=integer>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<name>string</name>
<url-path>string</url-path>
</source-sco>
</source-sco>
</results>
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<sco account-id=integer disabled=datetime display-seq=integer
folder-id=integer icon=allowedValue lang=allowedValue
max-retries=integer sco-id=integer source-sco-id=integer
type=allowedValue version=integer>
<date-begin>datetime</date-begin>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
<date-modified>datetime</date-modified>
<description>string</description>
<name>string</name>
<url-path>string</url-path>
<passing-score>integer</passing-score>
<duration>datetime</duration>
<section-count>integer</section-count>
</sco>
<source-sco>
<source-sco account-id=integer display-seq=integer folder-id=integer
icon=allowedValue lang=allowedValue max-retries=integer
sco-id=integer source-sco-id=integer type=allowedValue
version=integer>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<name>string</name>
<url-path>string</url-path>
</source-sco>
</source-sco>
</results>
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <sco account-id=integer disabled=datetime display-seq=integer folder-id=integer icon=allowedValue lang=allowedValue max-retries=integer sco-id=integer source-sco-id=integer type=allowedValue version=integer> <date-begin>datetime</date-begin> <date-created>datetime</date-created> <date-end>datetime</date-end> <date-modified>datetime</date-modified> <description>string</description> <name>string</name> <url-path>string</url-path> <passing-score>integer</passing-score> <duration>datetime</duration> <section-count>integer</section-count> </sco> <source-sco> <source-sco account-id=integer display-seq=integer folder-id=integer icon=allowedValue lang=allowedValue max-retries=integer sco-id=integer source-sco-id=integer type=allowedValue version=integer> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <name>string</name> <url-path>string</url-path> </source-sco> </source-sco> </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). |
|
| sco | Container |
Information about the SCO. |
|
| account-id | BIGINT |
The ID of the account the SCO belongs to. |
|
| disabled | Datetime |
An empty value if the SCO has not been disabled. If it has, the date and time it was disabled. |
|
| display-seq | Integer |
The sequence in which 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. |
|
| folder-id | BIGINT |
The ID of the folder the SCO belongs to. |
|
| icon | Allowed value |
The type of icon used as a visual identifier for the SCO (see icon). |
|
| lang | Allowed value |
An abbreviation for the new language (see type for values). |
|
| max-retries | Integer |
The number of times the user is allowed to attempt to take the SCO. |
|
| sco-id | BIGINT |
The unique ID of the SCO. |
|
| source-sco-id | BIGINT |
The unique ID of a template from which the SCO is derived. |
|
| type | Allowed value |
The content type of the SCO (see type for values). type is a high-level category. icon provides more detail on the type of content. |
|
| version | Integer |
The version number of the SCO, incremented when the object is modified or uploaded to the server. |
|
| date-begin | Datetime |
If the SCO is a meeting, the date and time the meeting starts. |
|
| date-created | Datetime |
The date and time the SCO was created (or, for content, uploaded). |
|
| date-end | Datetime |
If the SCO is a meeting, the date and time the meeting ends. |
|
| date-modified | Datetime |
The date and time the SCO was last modified. |
|
| description | String |
The description of the SCO entered when the SCO was created. |
|
| name | String |
The name of the SCO. |
|
| url-path | String |
The path to the SCO on the server. |
|
| passing-score | Integer |
The minimum score that a user must have to pass a training course. |
|
| duration | Integer |
The length of time needed to view or play the SCO, in milliseconds. |
|
| section-count | Integer |
The number of sections in the course content, including the number of slides, pages, chapters, interactions, or other content divisions. |
|
| source-sco | Container |
Information about any SCOs that are templates for, or provide content to, the SCO you are interested in. The SCOs that can have a source are meetings, courses, or events. |
|
| source-sco | Container |
Details about one SCO that is a template for, or provides source content to, the SCO you are interested in. Has additional elements and attributes, the same as the sco element. |
Sample request
https://example.com/api/xml?action=sco-info&sco-id=2006320683
https://example.com/api/xml?action=sco-info&sco-id=2006320683
https://example.com/api/xml?action=sco-info&sco-id=2006320683
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<sco account-id="624520" disabled="" display-seq="0"
folder-id="2006258750" icon="meeting" lang="en" max-retries=""
sco-id="2006320683" source-sco-id="-1625529" type="meeting"
version="0">
<date-begin>2006-05-04T11:15:00.000-07:00</date-begin>
<date-created>2006-05-04T11:27:47.087-07:00</date-created>
<date-end>2006-05-04T12:15:00.000-07:00</date-end>
<date-modified>2006-05-04T11:27:47.087-07:00</date-modified>
<name>Technology and Law Review Meeting</name>
<url-path>/tlawreview/</url-path>
</sco>
<source-sco>
<source-sco account-id="624520" display-seq="0" folder-id="-625529"
icon="meeting" lang="en" max-retries="" sco-id="-1625529"
source-sco-id="-8888" type="meeting" version="0">
<date-created>2004-10-05T00:49:30.217-07:00</date-created>
<date-modified>2005-01-04T15:03:25.937-08:00</date-modified>
<name>Default Meeting Template</name>
<url-path>/defaultMeetingTemplate/</url-path>
</source-sco>
</source-sco>
</results>
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<sco account-id="624520" disabled="" display-seq="0"
folder-id="2006258750" icon="meeting" lang="en" max-retries=""
sco-id="2006320683" source-sco-id="-1625529" type="meeting"
version="0">
<date-begin>2006-05-04T11:15:00.000-07:00</date-begin>
<date-created>2006-05-04T11:27:47.087-07:00</date-created>
<date-end>2006-05-04T12:15:00.000-07:00</date-end>
<date-modified>2006-05-04T11:27:47.087-07:00</date-modified>
<name>Technology and Law Review Meeting</name>
<url-path>/tlawreview/</url-path>
</sco>
<source-sco>
<source-sco account-id="624520" display-seq="0" folder-id="-625529"
icon="meeting" lang="en" max-retries="" sco-id="-1625529"
source-sco-id="-8888" type="meeting" version="0">
<date-created>2004-10-05T00:49:30.217-07:00</date-created>
<date-modified>2005-01-04T15:03:25.937-08:00</date-modified>
<name>Default Meeting Template</name>
<url-path>/defaultMeetingTemplate/</url-path>
</source-sco>
</source-sco>
</results>
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258750" icon="meeting" lang="en" max-retries="" sco-id="2006320683" source-sco-id="-1625529" type="meeting" version="0"> <date-begin>2006-05-04T11:15:00.000-07:00</date-begin> <date-created>2006-05-04T11:27:47.087-07:00</date-created> <date-end>2006-05-04T12:15:00.000-07:00</date-end> <date-modified>2006-05-04T11:27:47.087-07:00</date-modified> <name>Technology and Law Review Meeting</name> <url-path>/tlawreview/</url-path> </sco> <source-sco> <source-sco account-id="624520" display-seq="0" folder-id="-625529" icon="meeting" lang="en" max-retries="" sco-id="-1625529" source-sco-id="-8888" type="meeting" version="0"> <date-created>2004-10-05T00:49:30.217-07:00</date-created> <date-modified>2005-01-04T15:03:25.937-08:00</date-modified> <name>Default Meeting Template</name> <url-path>/defaultMeetingTemplate/</url-path> </source-sco> </source-sco> </results>
