|
account-expiry-info
Availability
Acrobat
Connect Pro Server 7
Description
Returns
the expiration date of an account.
Request URL
http://server_name/api/xml
?action=account-expiry-info
&account-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
account-id
|
Integer
|
N
|
The ID of the account for which you want
expiration information. If you don’t provide an account ID, the
expiration date for the current user is returned.
|
|
session
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<Account account-id=integer>
<name>String</name>
<date-expired>Datetime</date-expired>
</Account>
</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
).
|
|
Account
|
|
Container
|
Information about all fields describing
the account.
|
|
|
account-id
|
Integer
|
The ID of the account.
|
|
name
|
|
String
|
The name of the account.
|
|
date-expired
|
|
Datetime
|
The date the account expired.
|
Sample request
https://example.com/api/xml?action=acount-expiry-info&account-id=7
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<Account account-id="7">
<name>Enterprise Account</name>
<date-expired>2009-09-11T18:15:00.000+05:30</date-expired>
</Account>
</results>
acl-field-info
Description
Returns
information about a principal, account, or SCO, as defined in an
access control list (ACL).
The returned information includes
fields and their values. Each field has an ID—a name that describes
the field.
To call
acl-field-info
, you must
have view permission for the principal, account, or object. You
must also specify a value for
acl-id
, which is
the object the principal has access to. The
acl-id
can
be a
sco-id
, an
account-id
, or a
principal-id
.
You can call
principal-list
to determine the
account-id
or
principal-id
,
or
sco-shortcuts
or
sco-contents
to get
a
sco-id
.
Request URL
http://server_name/api/xml
?action=acl-field-info
&acl-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the SCO, account, or principal
for which you want field information. Can be a valid
sco-id
,
account-id
,
or
principal-id
.
|
|
|
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 />
<acl-fields>
<field acl-id=integer field-id=string>
<value>string</value>
</field>
...
</acl-fields>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all fields describing
the principal, account, or object.
|
|
|
|
Container
|
One field describing the principal, account,
or object.
|
|
|
|
Integer
|
The
acl-id
specified in
the request, which is a
sco-id
,
principal-id
,
or
account-id
.
|
|
|
|
String
|
The name of the field.
|
|
|
|
String
|
The value of the field.
|
Sample request
https://example.com/api/xml?action=acl-field-info&acl-id=2006258745
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<acl-fields>
<field acl-id="2006258745" field-id="email">
<value>joy@acme.com</value>
</field>
<field acl-id="2006258745" field-id="first-name">
<value>Joy</value>
</field>
<field acl-id="2006258745" field-id="last-name">
<value>Smith</value>
</field>
</acl-fields>
</results>
acl-field-list
Description
Returns
a list of values for all instances of a field name on your Adobe
Connect Server account.
For example, to list the first names
of all users in the account, call
acl-field-list
with
field-id=first-name
.
You
can call
acl-field-info
first to get
a list of field names.
Request URL
http://server_name/api/xml
?action=acl-field-list
&field-id=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
Y
|
The name of a field in the access control
list for which you want values and IDs. Only one field name is allowed.
|
|
|
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 />
<acl-field-list>
<acl acl-id=integer>
<value>string</value>
</acl>
...
</acl-field-list>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all of the values in the
account for the specified field.
|
|
|
|
Container
|
Information about one value for the specified
field.
|
|
|
|
Integer
|
The ID of the principal, SCO, or account
the field belongs to.
|
|
|
|
String
|
The value of the field.
|
Sample request
https://example.com/api/xml?action=acl-field-list&field-id=first-name
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<acl-field-list>
<acl acl-id="381223">
<value>John</value>
</acl>
<acl acl-id="381302">
<value>Daryl</value>
</acl>
<acl acl-id="381405">
<value>Mary</value>
</acl>
</acl-field-list>
</results>
acl-field-update
Description
Updates
the value of an ACL field that belongs to a SCO or an account.
Note:
To update a standard field for a principal (a
user or a group), use the
principal-update
action.
To update a custom field for a principal, use the
acl-field-update
action.
Each
SCO or account belongs to at least one access control list (ACL).
The ACL lists the principals that have permission to access the
SCO or account.
Call
acl-field-info
to determine
the fields in the ACL for a SCO or account. The response contains
the
field-id
you need for the request to
acl-field-update
:
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<acl-fields>
<field acl-id="2006258745" field-id="email">
<value>joy@acme.com</value>
</field> ...
</acl-fields>
</results>
You can specify multiple trios of
acl-id
,
field-id
,
and
value
. If you do, use an HTTP
POST
method,
rather than a
GET
, to make the request. The
GET
method has
limitations that might cause the request to be truncated. With a
POST
,
you can add about 50 trios to the request.
To call
acl-field-update
,
you need
modify
permission on the SCO or account.
Request URL
http://server_name/api/xml
?action=acl-field-update
&acl-id=integer
&field-id=string
&value=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the SCO or account. Can be a valid
sco-id
or
account-id
.
|
|
|
String
|
Y
|
The name of the field for which you want
to update value. The field can be a server-defined field or a custom
field. A custom field has a
field-id
starting with
x-
,
such as
x-12056
.
|
|
|
String
|
Y
|
The value to set.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=acl-field-update&acl-id=2007035246
&field-id=name&value=Java 101
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
acl-preference-update
Description
Updates
a user profile with new language and time zone settings.
Request URL
http://server_name/api/xml
?action=acl-preference-update
&acl-id=integer
&lang=allowedValue
&time-zone-id=allowedValue
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the user whose preferences will
be updated. Can be a valid
principal-id
.
|
|
|
Allowed value
|
N
|
An abbreviation for the new language (see
lang
for valid values).
|
|
|
Allowed value
|
N
|
An integer setting for the new time zone
(see
time-zone-id
for values).
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://server.com/api/xml?action=acl-preference-update&acl-id=12345
&lang=fr&time-zone-id=0
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
common-info
Description
Returns
basic information about the current user and the Adobe Connect server or
Adobe Connect hosted account, including the value of the
BREEZESESSION
cookie.
If
you call
common-info
without logging in, the response
does not contain
user
and
account
elements,
because the server cannot identify a user. However, even without
logging in,
common-info
returns a
BREEZESESSION
cookie
value.
The response also contains
host
,
local-host
,
and
admin-host
elements. If Adobe Connect is hosted
on a cluster,
host
is the cluster name;
local-host
is the
name of the server in the cluster that executes the call to
common-info
; and
admin-host
is
the name of the secure host on a cluster that supports SSL. Your
application can use the value of
admin-host
to
convert HTTP URLs to more secure HTTPS URLs.
Request URL
http://server_name/api/xml
?action=common-info
&domain=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
N
|
A domain name identifying a Adobe Connect
hosted account. Use to get information about your hosted account.
|
|
|
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 />
<common locale=allowedValue time-zone-id=integer>
<cookie>string</cookie>
<date>datetime</date>
<host>url</host>
<local-host>hostname</local-host>
<admin-host>hostname</admin-host>
<url>/api/xml?action=common-info</url>
<version>string</version>
<account account-id=integer />
<user user-id=integer type="user">
<name>string</name>
<login>string</login>
</user>
<user-agent>string</user-agent>
</common>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Common information about your connection
to the server.
|
|
|
|
Allowed value
|
A setting that defines how Connect Central
or your application displays information to a user (see
lang
for values).
|
|
|
|
Allowed value
|
A code that defines the user’s time zone
(see
time-zone-id
for values).
|
|
|
|
String
|
The value of the
BREEZESESSION
cookie
(a string the server returns identifying this user for this login
session).
|
|
|
|
Datetime
|
The date and time the call to
common-info
was
made, in
ISO 8601
format.
|
|
|
|
String
|
If Adobe Connect runs on a server, the URL
of the fully qualified host name of the server. If a cluster, the
name that identifies the cluster.
|
|
|
|
String
|
The name of the computer that executed the
action (on a single server, the same as
host
; on
a cluster, the name of the server that executed the action).
|
|
|
|
String
|
The name of the secure host on a cluster
that supports SSL.
|
|
|
|
String
|
The part of the URL making this call that
identifies the action name.
|
|
|
|
String
|
The server version name and number.
|
|
|
|
Empty, with attribute
|
Information about the account the user belongs
to. Returned if you are logged in to Adobe Connect or are making
the call on a Adobe Connect hosted account.
|
|
|
|
Integer
|
The ID of the account the user belongs to.
|
|
|
|
Container
|
Information about the user who established
a session with the server. Returned only if the user making the
call is logged in.
|
|
|
|
Integer
|
The ID of the user who established a session
with the server.
|
|
|
|
Allowed value
|
The type of principal who has a session
(usually user; see allowed values for principals at
type
).
|
|
|
|
String
|
The full name of the user who established
a session with the server.
|
|
|
|
String
|
The login name of the user who is logged
in to the server, often the user’s e-mail address.
|
|
|
|
String
|
The identifier of the web browser or client
that established a session with the server.
|
Sample request
https://example.com/api/xml?action=common-info
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<common locale="en" time-zone-id="4">
<cookie>breezsi4dundh5srw2fq6</cookie>
<date>2006-09-08T11:17:04.470-07:00</date>
<host>https:example.com</host>
<local-host>localserver17</local-host>
<admin-host>securehost.com</admin-host>
<url>/api/xml?action=common-info</url>
<version>connect_6000</version>
<account account-id="624520" />
<user user-id="2006258745" type="user">
<name>Joy Smith</name>
<login>joy@acme.com</login>
</user>
<user-agent>Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;
.NET CLR 1.1.4322)</user-agent>
</common>
</results>
curriculum-contents
Availability
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
|
Integer
|
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
|
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 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>
custom-fields
Description
Lists
all custom fields defined in an account and details about the fields.
Custom
fields provide information about objects (SCOs) or principals that
is not already defined in Connect Central. You can create custom
fields, or update their value, using
custom-field-update
.
Request URL
http://server_name/api/xml
?action=custom-fields
&filter-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
filter-definition
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
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 it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<custom-fields>
<field permission-id=allowedValue object-type=allowedValue
field-id=string account-id=integer display-seq=integer
field-type=allowedValue is-primary=boolean is-required=boolean>
<name>string</name>
</field>
</custom-fields>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
code
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of custom fields that match the
query.
|
|
|
|
Container
|
Details about one custom field.
|
|
|
permission-id
|
Allowed value
|
The permission the current user has to access
the custom field (see
permission-id
for values).
|
|
|
object-type
|
Allowed value
|
The type of object the custom field describes
(see
permission-id
|
|
|
|
String
|
The name of the field, as identified on
the server.
|
|
|
|
Integer
|
The ID of the account in which the custom
field is defined.
|
|
|
|
Integer
|
The sequence in which Connect Central or
your application displays the custom field, relative to other custom
fields.
|
|
|
|
Allowed value
|
The type of data the custom field accepts.
Allowed values are
text
,
textarea
,
and
password
.
|
|
|
|
Boolean
|
Whether the custom field can be deleted
(
true
if no, and
false
if yes).
|
|
|
|
Boolean
|
Whether this custom field is required.
true
if
a value must be specified for this field in each object that uses
it. Otherwise,
false
.
|
|
|
|
String
|
The name of the custom field as Connect
Central or your application displays it.
|
Sample request
https://example.com/api/xml?action=custom-fields&filter-like-name=name
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<custom-fields>
<field permission-id="manage" object-type="object-type-principal"
field-id="first-name" account-id="624520" display-seq="1"
field-type="text" is-primary="true" is-required="true">
<name>First Name</name>
</field>
<field permission-id="manage" object-type="object-type-principal"
field-id="last-name" account-id="624520" display-seq="2"
field-type="text" is-primary="true" is-required="true">
<name>Last Name</name>
</field>
</custom-fields>
</results>
custom-fields-delete
Description
Deletes
a custom field.
The value of
is-primary
for
a custom field must be
false
before the field can be
deleted. If
is-primary
is
true
and
you want to change its value, call
custom-field-update
.
Request URL
http://server_name/api/xml
?action=custom-fields-delete
&field-id=string
&object-type=allowedValue
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
Y
|
The ID of the field to be deleted. Call
custom-fields-delete
to obtain
the ID, which is returned in the
field-id
attribute
of the
field
element.
|
|
|
String
|
Y
|
The type of SCO for which the field is defined
(for values, see
type
).
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=custom-fields-delete&field-id=2006338719&object-type=object-type-principal
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
custom-field-update
Description
Creates
a new custom field or updates the value of an existing one.
You
can define up to eight custom fields on a principal or SCO. To create
a custom field, call
custom-field-update
with at
least the following fields:
object-type
,
permission-id
,
name
,
field-type
,
is-required
,
and
is-primary
. If
custom-field-update
is
successful, it returns a
field-id
.
To update
a custom field, specify the
field-id
, an
object-type
,
and a
name
for each field that has a value you
want to change.
Be careful when defining custom fields, as
retrieving those fields in a report (for example, by calling
report-bulk-users
)
can affect the performance of the server and the database.
Request URL
http://server_name/api/xml
?action=custom-field-update
&account-id=integer
&object-type=object-type-allowedValue
&permission-id=allowedValue
&name=string
&comments=string
&field-type=allowedValue
&is-required=boolean
&is-primary=boolean
&display-seq=integer
&field-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The account ID in which the field is created.
|
|
|
String
|
Y
|
The type of SCO this field applies to. Required
to create and update fields.
Allowed values:
-
object-type-principal
-
object-type-meeting
-
object-type-sco
-
object-type-event
-
object-type-read-only
Example:
object-type=object-type-principal
The
value
object-type-read-only
means that Connect
Central displays the value but a user cannot set it using Connect
Central. You can also use this value in custom applications.
|
|
|
String
|
Y
|
The permission a principal needs on the
object to set or view the field’s value. The only allowed value
is
manage
. Required to create a field.
|
|
|
String
|
Y
|
The label for the field in the user interface.
Required to create a field.
|
|
|
String
|
N
|
Any comments you define for the custom field,
displayed as hint text in your user interface. Can be up to 60 characters
long.
|
|
|
String
|
Y
|
The type of field. Allowed values are
text
,
textarea
,
and
password
. Required to create a field.
|
|
|
Boolean
|
Y
|
Whether this custom field is required. Use
true
if
a value must be specified for this field in each object that uses
it. Otherwise, use
false
. Required to create a
field.
|
|
|
Boolean
|
Y
|
Whether this custom field can be deleted
through the user interface (
true
if it cannot be
deleted, and
false
if it can).
|
|
|
Integer
|
N
|
The sequence in which Connect Central or
your application displays the custom field, relative to other custom
fields.
|
|
|
Integer
|
Y
|
The name of a field that has a value you
want to update. Required to update a field.
|
|
|
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 />
<field field-id=integer display-seq=integer object-type=allowedValue
account-id=integer is-primary=boolean permission-id=allowedValue
is-required=boolean field-type=string>
<comments>string</comments>
<name>string</name>
</field>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Empty, with attributes
|
Information about the custom field.
|
|
|
|
Integer
|
A numeric identifier for the field.
|
|
|
|
Integer
|
The sequence in which Connect Central or
your application displays the field.
|
|
|
|
Allowed value
|
The type of object the field describes (see
type
for allowed values).
|
|
|
|
Integer
|
For customers on Adobe Connect hosted accounts,
the ID of the account in which the field is defined.
|
|
|
|
Boolean
|
Whether this custom field can be deleted
(
true
if no,
false
if yes).
|
|
|
|
Allowed value
|
The permission needed to access the custom
field (see
permission-id
|
|
|
|
Boolean
|
Whether a value for this custom field is
required (
true
if yes and
false
if no).
|
|
|
|
Allowed value
|
The type of data the field accepts. Allowed
values are
text
,
textarea
, and
password
.
|
|
|
|
String
|
The comment entered in
comments
in
the request.
|
|
|
|
String
|
The name of the field entered in
name
in
the request.
|
Sample request
https://example.com/api/xml?action=custom-field-update
&object-type=object-type-principal&permission-id=manage
&account-id=624520&name=jobtitle&comments=test&field-type=text
&is-required=true&is-primary=false&display-seq=1
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<field field-id="2006472106" object-type="object-type-principal"
display-seq="1" account-id="624520" is-primary="false"
permission-id="manage" is-required="true" field-type="text">
<comments>test</comments>
<name>jobtitle</name>
</field>
</results>
expiry-settings-info
Availability
Acrobat
Connect Pro Server 7
Description
Returns
information about the current settings for account-expiration notifications
(the warnings given to users before an account expires). A user
is notified
x
number of days before their account expires.
This action simply returns the value of
x
.
Request URL
https://example.com/api/xml
?action=expiry-settings-info
&account-id=Integer
&session=String
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the account. If you don’t provide
an account ID, the information for the current account is returned.
|
|
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<expiry-num-of-days>
<value>30</value>
</expiry-num-of-days>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the current settings for
account-expiration notifications.
|
|
|
|
Integer
|
The user is notified this many days before
their account expires. The default value is 30. For example, if
a
user’s
account expires on December 31, the user is notified on December
1.
|
Sample request
https://example.com/api/xml?action=expiry-settings-info&account-id=7
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<expiry-num-of-days>
<value>30</value>
</expiry-num-of-days>
</results>
expiry-settings-update
Availability
Acrobat
Connect Pro Server 7
Description
Updates
information about the settings for account-expiration notification
(the notification given to users before an account expires). A user
is notified
x
number of days before their account expires.
This action simply updates the value of
x
.
Request URL
https://example.com/api/xml
?action=expiry-settings-update
&account-id=Integer
&session=String
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the account. If you don’t provide
an account ID, the information for the current account is updated.
|
|
|
Integer
|
Y
|
A user is notified this many days before
their account expires. The default value is 30; possible values
are 30, 60, and 90.
For example, if the value of this parameter
is 30, a user is notified 30 days before their account is due to
expire.
|
|
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=expiry-settings-update&account-id=7&expiry-num-of-days=30
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
</results>
group-membership-update
Description
Adds
one or more principals to a group, or removes one or more principals
from a group.
To update multiple principals and groups, specify
multiple trios of
group-id
,
principal-id
,
and
is-member
parameters.
You can obtain
a
group-id
by calling
principal-list
and filtering
the response with
filter-type=group
or another
filter value such as
filter-type=admins
. The built-in
groups have distinctive types other than
group
(see
type
for a list of values).
Request URL
http://server_name/api/xml
?action=group-membership-update
&group-id=integer
&principal-id=integer
&is-member=boolean
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the group in which you want to
add or change members.
|
|
|
Integer
|
Y
|
The ID of the principal whose membership
status you want to update. Returned by
principal-info
.
|
|
|
Boolean
|
Y
|
Whether the principal is added to (
true
)
or deleted from (
false
) the group.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
Top-level element for the response.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=group-membership-update&group-id=632398
&principal-id=2006258745&is-member=true
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
learning-path-info
Description
Returns
a list of learning paths for a learning object that belongs to a
curriculum.
A learning object is any SCO that has been added
to a curriculum. A learning path is determined by rules that establish
whether a learner can proceed to the next learning object.
You
can create a learning path by establishing prerequisite requirements, completion
requirements, or preassessment requirements. For example, a learning
path might be the rule that the class
Welcome to AcmeCo
must
be completed before
Managing Projects at AcmeCo
.
A
call to
learning-path-info
lists modules within
a curriculum and their paths to each other. To see the complete
contents of a curriculum, including content, meetings, and so on,
call
sco-expanded-contents
.
Request URL
http://server_name/api/xml
?action=learning-path-info
&curriculum-id=integer
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the curriculum the learning object
belongs to.
|
|
|
Integer
|
Y
|
The ID of the curriculum module (course,
presentation, or similar) for which you want a learning path.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<learning-paths>
<learning-path curriculum-id=integer current-sco-id=integer target-sco-id=integer path-type=allowedValue>
<name>string</name>
</learning-path>
</learning-paths>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about learning paths in a curriculum.
|
|
|
|
Integer
|
The numeric ID of the curriculum.
|
|
|
|
Integer
|
The learning object for which you want a
path.
|
|
|
|
Integer
|
The ID of the learning object that restricts
access to the current learning object (for example, a prerequisite
learning object).
|
|
|
|
Allowed value
|
The type of path between the target and
current learning objects (for example, whether completion of the
target is required as a prerequisite). See
path-type
for allowed values.
|
|
|
|
String
|
The name of the target learning object.
|
Sample request
https://example.com/api/xml?action=learning-path-info&sco-id=2006334909
&curriculum-id=2006298444
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<learning-paths>
<learning-path curriculum-id="2006298444" current-sco-id="2006298444"
target-sco-id="2006298445" path-type="completion-required">
<name>Security at AcmeCo</name>
</learning-path>
</learning-paths>
</results>
learning-path-update
Description
Updates
the learning path for a single learning object in a curriculum.
A learning object is any SCO that is added to a curriculum.
Request URL
http://server_name/api/xml
?action=learning-path-update
&curriculum-id=integer
¤t-sco-id=integer
&target-sco-id=integer
&path-type=allowedValue
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the curriculum to which this learning
object belongs.
|
|
|
Integer
|
N
|
The ID of the learning object that has the
access you want to update.
|
|
|
Integer
|
N
|
The ID of the learning object that restricts
access to the current learning object (for example, a prerequisite
course).
|
|
|
Allowed value
|
Y
|
The type of path between the target learning
object and the current learning object (see
path-type
for allowed values).
|
|
|
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="ok" />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
Top-level element for the response.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=learning-path-update
&curriculum-id=2006298444¤t-sco-id=2007064258
&target-sco-id=2007035246&path-type=completion-required
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
</results>
limited-administrator-permissions info
Availability
Acrobat Connect Pro 7
Description
Returns
a list of permissions that can be enabled or disabled for the Limited Administrators
group and whether or not that permission is currently enabled. For
more information on Limited Administrators, see
limited-administrator-permissions-update
.
Request URL
http://server_name/api/xml
?action=limited-administrator-permissions-info
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
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="ok"/>
<permissions>
<permission>
<enabled>Boolean</enabled>
<name>string</name>
</permission>
</permissions>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
A list of permissions.
|
|
|
|
Container
|
A list of information about the permission.
|
|
|
|
Boolean
|
A value indicating whether the permission
is enabled (
true
) or not (
false
).
|
|
|
|
String
|
The name of the permission.
|
Sample request
https://example.com/api/xml?action=limited-administrator-permissions-info
&session=breeze6qdeheiso93efb5
Sample response
<?xml version="1.0" encoding="utf-8"?>
<results>
<status code="ok"/>
<permissions>
<permission>
<enabled>true</enabled>
<name>edit-account-info</name>
</permission>
<permission>
<enabled>false</enabled>
<name>view-disk-usage-and-reports</name>
</permission>
<permission>
<enabled>true</enabled>
<name>reset-password</name>
</permission>
<permission>
<enabled>true</enabled>
<name>view-user-data</name>
</permission>
<permission>
<enabled>true</enabled>
<name>add-users-groups-webui</name>
</permission>
<permission>
<enabled>false</enabled>
<name>add-users-groups-csv</name>
</permission>
<permission>
<enabled>true</enabled>
<name>set-content-meeting-permissions</name>
</permission>
<permission>
<enabled>true</enabled>
<name>user-profile-fields</name>
</permission>
<permission>
<enabled>true</enabled>
<name>change-login-pw-policy</name>
</permission>
<permission>
<enabled>false</enabled>
<name>delete-users-groups</name>
</permission>
<permission>
<enabled>true</enabled>
<name>modify-current-users-groups</name>
</permission>
<permission>
<enabled>false</enabled>
<name>customization</name>
</permission>
<permission>
<enabled>false</enabled>
<name>compliance</name>
</permission>
<permission>
<enabled>false</enabled>
<name>chargebacks</name>
</permission>
<permission>
<enabled>false</enabled>
<name>view-system-usage-reports</name>
</permission>
<permission>
<enabled>false</enabled>
<name>quota-threshold-notifications</name>
</permission>
</permissions>
</results>
limited-administrator-permissions-update
Availability
Acrobat
Connect Pro 7
Description
Updates
the permissions that can be enabled for Limited Administrators.
With
Limited Administrators, your organization can have finer control
over administrators and what types of things they can access. Your
organization can separate system administrators who control all
aspects of the system from Limited Administrators, who can access
and control a subset of the system.
Each Adobe Connect installation
has one Limited Administrators group. Users in the Administrators
group can edit the permissions of Limited Administrators.
Request URL
http://server_name/api/xml
?action=limited-administrator-permissions-update
&view-disk-usage-and-reports=boolean
&reset-password=boolean
&view-user-data=boolean
&add-users-groups-webui=boolean
&add-users-groups-csv=boolean
&user-profile-fields=boolean
&change-login-pw-policy=boolean
&delete-users-groups=boolean
&modify-current-users-groups=boolean
&customization=boolean
&edit-account-info=boolean
&set-content-meeting-permissions=boolean
&compliance=boolean
&chargebacks=boolean
&view-training-reports=boolean
&reset-to-default=value
Parameters
When
you use this command, pass at least one parameter. The descriptions
that follow indicate if the permission is set to
true
by
default.
|
Name
|
Type
|
Required
|
Description
|
|
view-disk-usage-and-reports
|
Boolean
|
N
|
A value of
true
allows
limited administrators to view disk usage and reports. The default
value is
true
.
|
|
reset-password
|
Boolean
|
N
|
A value of
true
allows
limited administrators to reset the password of a user. Part of
the view-user-data set. The default value is
true
.
|
|
view-user-data
|
Boolean
|
N
|
Superset; a value of
true
allows
limited administrators to view user data. By setting this parameter
to enable, you enable all parameters in this set. (See all parameters
that are part of the view-user-data set.) The default value is
true
.
|
|
add-users-groups-webui
|
Boolean
|
N
|
A value of
true
allows
limited administrators to add users and groups by using the management
console. Part of the view-user-data set. The default value is
true
.
|
|
add-users-groups-csv
|
Boolean
|
N
|
A value of
true
allows
limited administrators to add users or groups by importing a CSV
file. Part of the view-user-data set
|
|
user-profile-fields
|
Boolean
|
N
|
A value of
true
allows
limited administrators to modify user profile fields.
|
|
change-login-pw-policy
|
Boolean
|
N
|
A value of
true
allows
limited administrators to change the login and password policies.
|
|
delete-users-groups
|
Boolean
|
N
|
A value of
true
allows
limited administrators to delete users or groups. Part of the view-user-data
set
|
|
modify-current-users-groups
|
Boolean
|
N
|
A value of
true
allows
limited administrators to modify currents users and groups. Part
of the view-user-data set. The default value is
true
.
|
|
customization
|
Boolean
|
N
|
A value of
true
allows
limited administrators to customize the colors of the account web
pages, meetings, and the login page.
|
|
edit-account-info
|
Boolean
|
N
|
A value of
true
allows
limited administrators to edit account information.
|
|
set-content-meeting-permissions
|
Boolean
|
N
|
A value of
true
allows
limited administrators to set the permissions for content or meetings.
The default value is
true
.
|
|
compliance
|
Boolean
|
N
|
A value of
true
allows
limited administrators to change compliance settings (settings for
enabling pods, sharing, and recording, and for training settings).
|
|
chargebacks
|
Boolean
|
N
|
A value of
true
allows
limited administrators to access the cost-center settings for this
account.
|
|
view-training-reports
|
Boolean
|
N
|
A value of
true
allows
limited administrators to view training reports.
|
|
reset-to-default
|
Boolean
|
N
|
A value of
true
resets
all permissions to the default permissions set by Adobe.
|
Filters
Results
cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
The
example shows
https://admin.ibreeze.macromedia.com/api/xml?action=limited-administrator-permissions-update
&session=breezghd9nxdhh768vpob
&view-user-data=true
&view-user-data=false
&reset-password=true
&reset-password=false
&modify-current-users-groups=true
&modify-current-users-groups=false
&add-users-groups-webui=true
&add-users-groups-webui=false
&add-users-groups-csv=false
&delete-users-groups=false
&user-profile-fields=true
&user-profile-fields=false
&change-login-pw-policy=true
&change-login-pw-policy=false
&chargebacks=false
&edit-account-info=true
&edit-account-info=false
"a-threshold-notifications=false
&customization=false
&view-disk-usage-and-reports=false
&view-system-usage-reports=false
&compliance=false
&set-content-meeting-permissions=true
&set-content-meeting-permissions=false
Sample response
<?xml version="1.0" encoding="utf-8"?>
<results><status code="ok"/>
</results>
login
Description
Logs
a user in to Adobe Connect Server.
In a client application,
after logging in a user, you must read and store the cookie called
BREEZESESSION
,
which can be found in the HTTP headers of the response from
login
.
You must then include the value of that cookie in every subsequent
request that you make for that user.
If you cannot retrieve cookie values from
HTTP response headers, you can call
common-info
to
get the cookie value before the user logs in. Then, pass the value
to
login
using the
session
request
parameter:
https://example.com/api/xml?action=login&login=loginId&password=password
&session=value
You can also use the
session
parameter
on any API call you make after
login
. For example,
to call
principal-list
after logging in, you can
enter:
https://example.com/api/xml?action=principal-list&session=value
The
BREEZESESSION
value
is valid for only one login session. Your application must store
a new cookie value each time the user logs in.
When you call
the
login
action, you are sending a login ID and
password across a network, unless you use external authentication.
Use SSL or another appropriate security method to protect passwords
in transit.
Request URL
http://server_name/api/xml
?action=login
&login=string
&password=string
&account-id=integer
&external-auth=use
&domain=string
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of your Adobe Connect hosted account.
If your organization is running a licensed Adobe Connect Server,
do not use
account-id
.
|
|
|
Allowed value
|
N
|
A value indicating whether you send an external
network login ID to represent the user to Adobe Connect. If so,
use
external-auth=use
.
|
|
|
String
|
Y/N
|
The user’s login name. Do not use if you
use external or HTTP header authentication.
|
|
|
String
|
Y/N
|
The user’s password. Do not use if you use
external or HTTP header authentication.
|
|
|
String
|
N
|
The domain name of your Adobe Connect hosted
account. If your organization is running a licensed of Adobe Connect
Server, do not use
domain
.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
http://example.com/api/xml?action=login&login=joy@acme.com&password=happy
&session=breeztg8mz53r93vebwur
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
logout
Description
Ends
a user’s login session, invalidating the cookie value associated
with the user’s session.
After calling
logout
,
set the
BREEZESESSION
cookie value to
null
.
Do not reuse the cookie value after your user logs out.
Request URL
http://server_name/api/xml
?action=logout
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
http://example.com/api/xml?action=logout
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
meeting-disclaimer-info
Availability
Acrobat
Connect Pro 7
Description
Provides
information about the disclaimer text that is shown when a user
enters a meeting. For more information about the disclaimer, see
meeting-disclaimer-update
.
Request URL
https://servername/api/xml
?action=meeting-disclaimer-info
&account-id=integer
&session=string
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
account-id
|
Integer
|
N
|
The ID of the account for which the disclaimer
text is retrieved. If not used, the account that you are currently
logged in to is updated.
|
|
session
|
String
|
N
|
A string; the value of the BREEZESESSION
cookie.
|
Filters
Filters
cannot be used with this action.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<disclaimer>
string
</disclaimer>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
String
|
The text of the disclaimer notice.
|
Sample request
https://example.com/api/xml?action=meeting-disclaimer-info&account-id=7
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<disclaimer>
This meeting may be recorded for compliance purpose. By clicking OK you agree to the terms of meeting.
</disclaimer>
</results>
meeting-disclaimer-update
Availability
Acrobat
Connect Pro 7
Description
Updates
the disclaimer text that is shown when a user enters a meeting.
To
comply with communications regulations or standards, you can set
up a disclaimer notice to appear when a user enters a meeting. The
disclaimer notice typically displays boilerplate information for
your organization. It advises users of the status of the meeting
and the terms of use for the meeting. For example, a disclaimer
notice could advise users that the meeting is being recorded, and
that users cannot join the meeting unless they accept the notice.
If
the disclaimer is activated, the notice is shown in all meetings.
Activate the disclaimer either through the management console or
by using the
meeting-feature-update
action
with the
fid-meeting-disclaimer
parameter set to
enabled
.
Request URL
https://servername/api/xml
?action=meeting-disclaimer-update
&account-id=integer
&disclaimer=string
&session=string
Parameters
|
Value
|
Type
|
Required
|
Description
|
|
account-id
|
Integer
|
N
|
The ID of the account for which the disclaimer
text is updated. If not used, the account that you are currently
logged into is updated.
|
|
disclaimer
|
String
|
Y
|
The disclaimer text that is shown when a
user starts a meeting. The disclaimer can, for example, notify users
that a meeting is being recorded.
The limit is 1500 characters.
The disclaimer text can contain XML-compliant HTML tags. For example:
<b>This meeting is being recorded.</b>
|
|
session
|
String
|
N
|
The value of the BREEZESESSION cookie.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=code />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=meeting-disclaimer-update&disclaimer=Please note that this meeting is being recorded.
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
meeting-feature-update
Availability
Acrobat
Connect Pro 7
Description
Enables
or disables features in a meeting. This action is used to manage
features such as recording of meetings and control of pods. For
more information on usage, see
Configure compliance settings
. You can append multiple
feature-id
and
enable
pairs
to the end of the request URL.
Request URL
http://server name/api/xml
?action=meeting-feature-update
&account-id=integer
&feature-id=value
&enable=value
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of your Adobe Connect hosted account.
For enterprise installations, the ID is 7. For licensed installations,
use
common-info
to get the ID.
|
|
|
Integer
|
Y
|
The ID of the feature to enable or disable.
For available IDs, see
feature-id
.
|
|
|
Boolean
|
Y
|
Whether to enable the specified feature
(true) or not (false).
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=code />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
The
following sample disables the Chat pod.
https://example.com/api/xml?action=meeting-feature-update&account-id=7&feature-id=fid-meeting-chat&enable=false
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
permissions‑info
Description
Returns
the list of principals (users or groups) who have permissions to
act on a SCO, principal, or account.
To call
permissions-info
,
you must specify an
acl-id
, which is the ID of
a SCO, principal, or account that can be acted on. ACL stands for
access control list
, and
means the list of entities who have permission.
With just
an
acl-id
,
permissions-info
returns
a list of all principals in the account, showing each principal’s
permission on the principal or SCO specified in the
acl-id
:
https://example.com/api/xml?action=permissions-info&acl-id=2006258745
To
check the permissions a specific principal has on a principal or
SCO within an account, call
permissions-info
with
an
acl-id
and a filter on
principal-id:
http://example.com/api/xml?action=permissions-info&acl-id=7&filter-principal-id=10022
To
check the permissions a principal has on an account, call
permissions-info
with
both an
acl-id
(specifying an
account-id
)
and a
principal-id
:
https://example.com/api/xml?action=permissions-info &acl-id=624520&principal-id=624523
Request URL
http://server_name/api/xml
?action=permissions-info
&acl-id=integer
&principal-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a SCO, account, or principal that
a principal has permission to act on. The
acl-id
is
a
sco-id
,
principal-id
, or
account-id
in other
calls.
|
|
|
Integer
|
N
|
The ID of a principal who has a permission
(even if
denied
) to act on an object.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<permissions>
<principal principal-id=integer is-primary=boolean type=allowedValue
has-children=boolean permission-id=integer training-group-id=integer>
<name>string</name>
<login>string</login>
</principal> </permissions>
...
<permission acl-id=integer permission-id=allowedValue
principal-id=integer />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
A list of principals showing their permission
to access the SCO, account, or principal.
|
|
|
|
Container
|
Information about one principal showing
the principal’s permission level on the SCO, account, or principal.
|
|
|
|
Integer
|
The ID of a principal who has permission
on a SCO, account, or principal.
|
|
|
|
Boolean
|
A value indicating whether the principal
is a primary group (same as a built-in group).
|
|
|
|
Allowed value
|
The type of principal (see
type
for allowed values).
|
|
|
|
Boolean
|
A value indicating whether the principal
has children. Groups have children and users don’t, so if
true
,
the principal is a group.
|
|
|
|
Allowed value
|
The permission the principal has on the
SCO, account, or principal (see
permission-id
for values).
|
|
|
|
Integer
|
The ID of the SCO on which the permission
is defined.
|
|
|
|
String
|
The name of the principal who has permission
to access the SCO.
|
|
|
|
String
|
The login name of the principal who has
permission to access the SCO.
|
|
|
|
Empty, with attributes
|
Information about the permission one principal
has on a SCO, account, or principal. If empty, no permission is
defined.
|
|
|
|
Integer
|
The ID of the object on which the principal
has permission.
|
|
|
|
Allowed value
|
The permission the principal has to act
on the object (see
permission-id
for values).
|
|
|
|
Integer
|
The ID of the principal who has permission
to act on the object.
|
|
|
|
Integer
|
The ID of the training group.
|
Sample request
https://example.com/api/xml?action=permissions-info&acl-id=2006334033
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<permissions>
<principal principal-id="2006258745" is-primary="false" type="user"
has-children="false" permission-id="host" training-group-id="2007842424">
<name>Joy Smith</name>
<login>joy@acme.com</login>
</principal>
...
</permissions>
</results>
permissions-reset
Description
Resets
all permissions any principals have on a SCO to the permissions
of its parent SCO. If the parent has no permissions set, the child
SCO will also have no permissions.
Request URL
http://server_name/api/xml
?action=permissions-reset
&acl-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a SCO that has permissions you
want to reset.
|
|
|
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=code />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=permissions-reset&acl-id=2006334033
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
permissions-update
Description
Updates
the permissions a principal has to access a SCO, using a trio of
principal-id
,
acl-id
,
and
permission-id
. To update permissions for multiple
principals or objects, specify multiple trios. You can update more
than 200 permissions in a single call to
permissions-update
.
Call
permissions-update
to
give a user access to a Adobe Connect meeting, course, curriculum,
or other SCO. For example, you can use
permissions-update
to:
-
Invite a user to a meeting as participant, presenter, or
host (with a
permission-id
of
view
,
mini-host
,
or
host
, respectively)
-
Remove a user’s participant, presenter, or host access to
a meeting (with a
permission-id
of
remove
)
-
Enroll users in courses (with a
permission-id
of
view
)
If
you use multiple trios and any of them have invalid information
(for example, an incorrect
acl-id
or
principal-id
),
permissions-update
returns
an
ok
status, the correct trios execute, and the
invalid ones do not.
Request URL
http://server_name/api/xml
?action=permissions-update
&acl-id=integer
&principal-id=integer
&permission-id=allowedValue
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a SCO (a
sco-id
)
for which you want to update permissions.
|
|
|
Integer
|
Y
|
The ID of a principal, either a user or
group.
|
|
|
String
|
Y
|
The permission to assign (see
permission-id
for values).
|
|
|
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=code />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=permissions-update&acl-id=2006334033
&principal-id=2006258745&permission-id=host
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
See also
permissions‑info, permissions-reset
principal-info
Description
Provides
information about one principal, either a user or a group.
You
must specify a
principal-id
. To find the
principal-id
,
call
principal-list
, using a filter if necessary
to limit the response.
Request URL
http://server_name/api/xml
?action=principal-info
&principal-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a user or group you want information
about. You can get the ID by calling
principal-list
.
|
|
|
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 />
<contact>
<email>string</email>
<first-name>string</first-name>
<last-name>string</last-name>
</contact>
<manager account-id=integer disabled=boolean has-children=boolean
is-hidden=boolean is-primary=boolean principal-id=integer
type=allowedValue>
<ext-login>string</ext-login>
<login>string</login>
<name>string</name>
<email>string</email>
<first-name>string</first-name>
<last-name>string</last-name>
<x-customfield1>string</x-customfield1>
<x-customfield2>string</x-customfield2>
...
</manager>
<preferences acl-id=integer lang=allowedValue
time-zone-id=allowedValue />
<principal account-id=integer disabled=boolean has-children=boolean
is-hidden=boolean is-primary=boolean principal-id=integer
type=allowedValue>
<description>string</description>
<ext-login>string</ext-login>
<login>string</login>
<name>string</name>
<email>string</email>
<first-name>string</first-name>
<last-name>string</last-name>
<x-customfield1>string</x-customfield1>
<x-customfield2>string</x-customfield2>
...
</principal>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
Top-level element for the response.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the contact person for
a principal. If the principal is a user, usually the same as information
in
principal
.
|
|
|
|
String
|
The e-mail address of the contact person.
|
|
|
|
String
|
The first name of the contact person.
|
|
|
|
String
|
The last name of the contact person.
|
|
|
|
Container
|
Information describing a user’s manager,
who is also a principal.
|
|
|
|
Container
|
Information describing the principal.
|
|
|
|
Integer
|
The ID of the account the principal belongs
to.
|
|
|
|
Datetime
|
If the principal’s account is valid, a null
value returned as "". If the account is disabled, the date it was
disabled.
|
|
|
|
Boolean
|
Whether the principal has children. Groups
have children and users don’t, so this attribute indicates whether
the principal is a group.
|
|
|
|
Boolean
|
Whether the principal is hidden (
true
)
or not (
false
) in Connect Central or your application.
|
|
|
|
Boolean
|
Whether the principal is a built-in group
(
true
) or not (
false
).
|
|
|
|
Integer
|
The ID of the principal.
|
|
|
|
Allowed value
|
The type of principal (see
type
for values).
|
|
|
|
String
|
For a group, the group name.
|
|
|
|
String
|
For a user, the login ID sent from an external
network. By default, the same value as
login
, so
change it if you use external authentication.
|
|
|
|
String
|
The principal’s login ID on Adobe Connect.
Can be the same as an e-mail address.
|
|
|
|
String
|
For a user, the full name, concatenated
from
first-name
and
last-name
.
|
|
|
|
String
|
For a user, the e-mail address.
|
|
|
|
String
|
For a user, the first name.
|
|
|
|
String
|
For a user, the last name.
|
|
|
|
String
|
A custom field defined for the user or group.
|
|
|
|
Empty, with attributes
|
Information about the principal’s preferences.
|
|
|
|
Integer
|
The principal’s ID.
|
|
|
|
Allowed value
|
The language setting the principal has chosen
for Adobe Connect applications.
|
|
|
|
Allowed value
|
The time zone setting the principal has
chosen for Adobe Connect applications.
|
Sample request
https://example.com/api/xml?action=principal-info&principal-id=2006258745
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<contact>
<email>bob@acme.com</email>
<first-name>Bob</first-name>
<last-name>Jones</last-name>
</contact>
<manager account-id="624520" disabled="" has-children="false"
is-hidden="false" is-primary="false" principal-id="2006282569"
type="user">
<ext-login>jazzdoe@example.com</ext-login>
<login>jazzdoe@example.com</login>
<name>jazz doe</name>
<email>jazzdoe@example.com</email>
<first-name>Jazz</first-name>
<last-name>Doe</last-name>
<x-2007017651>San Francisco</x-2007017651>
</manager>
<preferences acl-id="2006258745" lang="en" time-zone-id="4" />
<principal account-id="624520" disabled="" has-children="false"
is-hidden="false" is-primary="false" principal-id="2006258745"
type="user">
<ext-login>joy@acme.com</ext-login>
<login>joy@acme.com</login>
<name>Joy Smith</name>
<email>joy@acme.com</email>
<first-name>Joy</first-name>
<last-name>Smith</last-name>
<x-2007017651>San Francisco</x-2007017651>
</principal>
</results>
principal-list
Description
Provides
a complete list of users and groups, including primary groups.
This
call is useful for getting a
principal-id
when
you don’t have one. However, be aware that it returns a list of
all principals on your Adobe Connect Server or Adobe Connect hosted
account, unless you use a filter to limit the response.
You
can also use
principal-list
to get a list of groups
in an account by filtering on the
type
and
is-member
fields:
https://example.com/api/xml?action=principal-list&filter-type=group
&filter-is-member=true
However,
filter-type=group
returns
groups you have created, not built-in groups predefined on the server.
Built-in groups have
type
values other than
group
,
such as
admins
and
authors
(see
type
for a list of the values).
You
can filter the response with a
filter-type
parameter
set to the type of group you want, then parse the response for a
principal-id
,
then pass the
principal-id
as a
group-id
on
another request to
principal-list
.
Request URL
http://server_name/api/xml
?action=principal-list
&group-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of a group. Same as the
principal-id
of
a principal that has a
type
value of
group
.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Note:
Filtering on the
login
element
is useful but slow, and reduced performance is unavoidable.
You
can also filter on a special field name,
manager-id
,
to return a list of principals who report to a given manager, for
example:
https://example.com/api/xml?action=principal-list
&filter-manager-id=2006282569
When you use
filter-manager-id
,
each
principal
element in the response has a
manager-id
attribute:
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<principal-list>
<principal principal-id="2006258745" account-id="624520" type="user"
has-children="false" is-primary="false" is-hidden="false"
manager-id="2006282569">
<name>Pat Lee</name>
<login>plee@mycompany.com</login>
<email>plee@mycompany.com</email>
</principal>
</principal-list>
</results>
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<principal-list>
<principal principal-id=integer account-id=integer type=allowedValue
has-children=boolean is-primary=boolean is-hidden=boolean
manager-id=integer training-group-id=integer>
<name>string</name>
<login>string</login>
<email>string</email>
</principal>
</principal-list>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of principals.
|
|
|
|
Container
|
Details about one principal.
|
|
|
|
Integer
|
The ID of the principal.
|
|
|
|
Integer
|
The ID of the account the principal belongs
to.
|
|
|
|
Allowed value
|
The type of principal (see
type
for values).
|
|
|
|
Boolean
|
Indicates whether the principal has children.
Groups have children and users do not, so when
has-children
is
true
,
the principal is a group.
|
|
|
|
Boolean
|
Whether the principal is a built-in group
(
true
) or not (
false
).
|
|
|
|
Boolean
|
Whether Connect Central or your application
displays the principal (
true
for not displayed
and
false
for displayed).
|
|
|
|
Integer
|
The
principal-id
of the
manager the principal reports to. Returned only if you use
filter-manager-id
in
the request.
|
|
|
|
Integer
|
The ID of the training group.
|
|
|
|
String
|
The principal’s full name.
|
|
|
|
String
|
The principal’s login ID, often an e-mail
address.
|
|
|
|
String
|
The principal’s e-mail address.
|
principal-custom-field-values
|
|
Container
|
The entire list of custom field values defined
for the principal.
|
|
|
|
Container
|
Details about one custom field defined for
the principal (see
field
for contents).
|
Sample request
https://example.com/api/xml?action=principal-list
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<principal-list>
<principal principal-id="624526" account-id="624520" type="user"
has-children="false" is-primary="false" is-hidden="false" training-group-id="">
<name>ned mack</name>
<login>nmack@acme.com</login>
<email>nmack@acme.com</email>
</principal>
<principal principal-id="624550" account-id="624520" type="user"
has-children="false" is-primary="false" is-hidden="false" training-group-id="">
<name>amelie jones</name>
<login>amelie@example.com</login>
<email>amelie@example.com</email>
</principal>
...
</principal-list>
</results>
principal-list-by-field
Description
Lists
principals that have a specified value in a custom field. Use this
action to query custom fields for principals. Use
principal-list
to
get a list of custom fields that are defined for the principal.
In
the
value
parameter, enter the value of a custom
database field. The
name
element returned by
principal-list
,
for example, is a full name concatenated from the
first-name
(
bob
)
and
last-name
(
jones
) database fields. If you
search on
bob jones
,
principal-list-by-field
does
not return a value, unless the full name is defined as a database
field (in this case, a custom field defined on principals).
The
search is case insensitive, and the query string can contain spaces.
Wildcards
are not allowed in the query string. For example, if you enter
t*
,
principal-list-by-field
searches
for the exact string
t*
.
The
principal-list-by-field
action
searches in all custom database fields defined for the principal;
it does not search principal fields.
Request URL
http://server_name/api/xml
?action=principal-list-by-field
&value=string
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
Y
|
The value for which you want to search all
fields. You do not need to enter a field name.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<principal-list>
<principal account-id=integer principal-id=integer type=allowedValue
has- children=boolean is-primary=boolean is-hidden=boolean>
<name>string</name>
<login>string</login>
</principal>
</principal-list>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of principals that match
the value in one or more custom fields.
|
|
|
|
Container
|
One principal that matches the value.
|
|
|
|
Integer
|
The ID of the principal.
|
|
|
|
Integer
|
The ID of the account the principal belongs
to.
|
|
|
|
Allowed value
|
The type of principal (see
type
for values).
|
|
|
|
Boolean
|
Indicates whether the principal has children.
Groups have children and users don’t, so this attribute indicates
whether the principal is a group.
|
|
|
|
Boolean
|
Whether the principal is a built-in group
(
true
) or not (
false
).
|
|
|
|
Boolean
|
Whether the principal is hidden in the user
interface (
true
) or not (
false
).
|
|
|
|
String
|
The principal’s full name, concatenated
from the
first-name
and
last-name
fields.
|
|
|
|
String
|
The principal’s login ID, often an e-mail
address.
|
Sample request
https://example.com/api/xml?action=principal-list-by-field&value=inactive
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<principal-list>
<principal account-id="624520" principal-id="2616099" type="user"
has-children="false" is-primary="false" is-hidden="false">
<name>Bob Jones</name>
<login>bjones@acme.com</login>
</principal>
</principal-list>
</results>
principals-delete
Description
Removes
one or more principals, either users or groups. To delete principals,
you must have Administrator privilege.
To delete multiple
principals, specify multiple
principal-id
parameters.
All of the principals you specify will be deleted.
The
principal-id
can
identify either a user or group. If you specify a user, the user
is removed from any groups the user belongs to. If you specify a
group, the group is deleted, but the users who belong to it are
not.
Request URL
http://server_name/api/xml
?action=principals-delete
&principal-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a user or group you want to delete.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=principals-delete
&principal-id=2006339311&principal-id=2006339323
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
principal-update
Description
Creates
a principal (a user or group) or updates a standard field for a
principal. The principal is created or updated in the same account
as the user making the call.
To create a new principal, call
principal-update
without
specifying a
principal-id
. To update, add the
principal-id
.
Before you update metadata about a principal, call
principal-info
to get the
existing version.
If a principal has custom fields, use
acl-field-update
to update
them, rather than
principal-update
.
You need
Administrator privileges to create or update a principal.
Request URL
http://server_name/api/xml
?action=principal-update
&description=string
&email=string
&first-name=string
&has-children=boolean
&last-name=string
&login=string
&name=string
&password=string
&principal-id=integer
&send-email=boolean
&type=allowedValue
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
N
|
The new group’s description. Use only when
creating a new group.
|
|
|
String
|
N
|
The user’s e-mail address. Can be different
from the
login
. Be sure to specify a value if you
use
send-email=true
.
|
|
|
String
|
Y/N
|
The user’s new first name. Use only with
users, not with groups. Required to create a user.
|
|
|
Boolean
|
Y
|
Whether the principal has children. If the
principal is a group, use
1
or
true
. If
the principal is a user, use
0
or
false
.
|
|
|
String
|
Y/N
|
The new last name to assign to the user.
Required to create a user. Do not use with groups.
|
|
|
String
|
Y/N
|
The principal’s new login name, usually
the principal’s e-mail address. Must be unique on the server. Required
to create or update a user. Do not use with groups.
|
|
|
String
|
Y/N
|
The new group’s name. Use only when creating
a new group. Required to create a group.
|
|
|
String
|
N
|
The new user’s password. Use only when creating
a new user.
|
|
|
String
|
Y/N
|
The ID of the principal that has information
you want to update. Required to update a user or group, but do not
use to create either.
|
|
|
Boolean
|
N
|
A flag indicating whether the server should
send an e-mail to the principal with account and login information.
|
|
|
String
|
Y/N
|
The type of principal. Use only when creating
a new principal (see
type
for values).
|
|
|
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 />
<principal principal-id=integer account-id=integer
has-children=integer type=integer>
<login>string</login>
<ext-login>string</ext-login>
<name>string</name>
</principal>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the newly created principal.
|
|
|
|
Integer
|
The ID of the newly created user.
|
|
|
|
Integer
|
The ID of the account the new user belongs
to. Same as the account of the current user.
|
|
|
|
Boolean
|
Whether the principal has children, which
indicates whether the principal is a user or group (
1
if
a group, or
0
if a user).
|
|
|
|
Allowed value
|
The type of principal (see
type
for values).
|
|
|
|
String
|
The principal’s login ID, often an e-mail
address.
|
|
|
|
String
|
The principal’s external authentication
ID. By default, the value is the same as login, unless you explicitly
set the value to an authentication ID from your network.
|
|
|
|
String
|
The principal’s name. If the principal is
a user, concatenated from the
first-name
and
last-name
parameters
in the request.
|
Sample request
https://example.com/api/xml?action=principal-update&first-name=jake
&last-name=doe&has-children=0&login=jakedoe@example.com&type=user
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<principal principal-id="2006403978" account-id="624520" type="user"
has-children="0">
<login>jakedoe@example.com</login>
<ext-login>jakedoe@example.com</ext-login>
<name>jake doe</name>
</principal>
</results>
quota-threshold-info
Availability
Acrobat
Connect Pro 7
Description
Provides
the list of quotas for which capacity notifications are provided,
along with their current threshold settings.
Each Adobe Connect
account has system quotas that determine, for example, how many
seats are available for Meeting Hosts, Learners, and so on. Each
quota has a threshold; when the threshold is crossed, the system
notifies administrators that the quota is in danger of being reached.
The settings for the threshold and the notifications vary depending
on the quota.
Request URL
https://example.com/api/xml
?action=quota-threshold-info
&account-id=integer
&session=integer
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the account for which you want
quota threshold information. If you don’t specify an ID, the current
account to which the user is logged in is used.
|
|
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<Principals>
<Principal principal-id="integer" type="string"/>
</Principals>
<Quotas>
<Quota acl-id="integer" quota-id="string" threshold-pct="integer" login-notif="boolean" email-notif="boolean" monthly-emails="boolean" limit="integer" used="integer"/>
<Quota acl-id="integer" quota-id="string" threshold-pct="integer" login-notif="boolean" email-notif="boolean" monthly-emails="boolean" limit="intger" used="integer"/>
</Quotas>
<Trees>
<Tree tree-id="integer" type="string"/>
</Trees>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Lists the principals specifying the groups
for which system capacity notifications are provided.
|
|
|
|
Container
|
Information about the principal for which
system capacity notification is provided.
|
|
|
|
Integer
|
The principal ID specifying the group.
|
|
|
|
String
|
The group type. Depending on the license,
this value can be one of the following:
|
|
|
|
Container
|
Lists the quotas.
|
|
|
|
Container
|
Information about the quota and its settings.
|
|
|
|
Integer
|
ACL ID of the quota.
|
|
|
|
Integer
|
The ID of the quota. For possible values,
see
quota-ID
.
|
|
|
|
Integer
|
The percent value of the threshold.
|
|
|
|
Boolean
|
Whether administrators are notified upon
logging in that a threshold is exceeded (
true
)
or not (
false
).
|
|
|
|
Boolean
|
Whether administrators are notified through
e-mail that a threshold is exceeded (
true
) or not
(
false
).
|
|
|
|
Boolean
|
Whether administrators are sent monthly
threshold reports through e-mail (
true
) or not
(
false
).
|
|
|
|
Integer
|
The limit of member seats.
|
|
|
|
Integer
|
Number of member seats used.
|
|
|
|
Container
|
Provides information about the tree type
quotas (the quota for the number of concurrent users per meeting).
|
|
|
|
Container
|
Information about the tree.
|
|
|
|
Integer
|
The tree ID.
|
|
|
|
String
|
The tree type, which is one of the following
values:
|
Sample request
https://example.com/api/xml?action=quota-threshold-info&account-id=7
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<Principals>
<Principal principal-id="20013" type="authors"/>
<Principal principal-id="10051" type="live-admins"/>
</Principals>
<Quotas>
<Quota acl-id="7" quota-id="training-user" threshold-pct="90" login-notif="true" email-notif="true" monthly-emails="true" limit="10" used="0"/>
<Quota acl-id="20013" quota-id="num-of-members-quota" threshold-pct="10" login-notif="true" email-notif="true" monthly-emails="true" limit="10" used="3"/>
</Quotas>
<Trees/>
</results>
quota-threshold-exceeded
Availability
Acrobat
Connect Pro 7
Description
Returns
information about system quota thresholds that have been exceeded.
Each
Adobe Connect account has system quotas that determine, for example, how
many seats are available for Meeting Hosts, Learners, and so on.
Each quota has a threshold; when the threshold is crossed, the system
notifies administrators that the quota is in danger of being reached.
The threshold varies depending on the quota. For more information
about automatic notification, see
Adobe Connect User Guide
.
Request URL
https://example.com/api/xml
?action=quota-threshold-exceeded
&account-id=Integer
&acl-id=Integer
"a-id=String
&num-of-days=Integer
&session=String
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the account. Specify either account-id
or acl-id (not both). If you do not specify either
account-id
or
acl-id
,
results are returned for the account which the current user is logged
into.
If you specify
account-ID
, results
are returned for all quota thresholds that have been reached in
the account.
|
|
|
Integer
|
N
|
The ID of the SCO, account, or principal
for which you want threshold information. Can be a valid
sco-id
,
account-id
,
or
principal-id
. If you do not specify a value
for
acl-id
, the value for
account-id
is
used.
The value to use for
acl-id
depends
on the quota ID used; for more information, see
quota-ID
|
|
|
String
|
N
|
The ID of the system quota for which you
want information. For available values, see
quota-ID
.
|
|
|
Integer
|
N
|
Number of days from the current day for
which records are retrieved. If you do not specify a value, all
the previous records for the specified quotas are retrieved.
|
|
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<Records>
<Record acl-id="Integer" quota-id="String" peak-used="Integer" count="Integer" threshold-pct="Integer" sco-id="Integer">
<record-date>Date</record-date>
</Record>
</Records>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Lists the records returned.
|
|
|
|
Container
|
Lists information about the record returned.
|
|
|
|
Integer
|
The ID of the ACL returned.
|
|
|
|
String
|
The ID of the quota returned. For available
values, see
quota-ID
.
|
|
|
|
Integer
|
The peak value of quota used on the specified
date. This attribute is null for training and group quotas.
|
|
|
|
Integer
|
Number of times the threshold was crossed
for the quota on the specified date. This attribute is null for
training and group quotas.
|
|
|
|
Integer
|
Percentage threshold when the threshold
was crossed.
|
|
|
|
Integer
|
The ID of the meeting for which the threshold
was crossed. This attribute is applicable only for the quota ID
concurrent-users-per-meeting
;
for other quotas, it is null.
|
|
|
|
Date
|
Date when the threshold was crossed (UTC),
in MM/DD/YYYY format.
|
Sample request
https://example.com/api/xml?action=quota-threshold-exceeded&acl-id=20013"a-id=num-of-members-quota&num-of-days=30
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok"/>
<Records>
<Record acl-id="20013" quota-id="num-of-members-quota" peak-used="" count="" threshold-pct="10" sco-id="">
<record-date>11/20/2007</record-date>
</Record>
</Records>
</results>
quota-threshold-update
Availability
Acrobat
Connect Pro 7
Description
Updates
the threshold settings of the specified quotas.
Each Adobe
Connect account has system quotas that determine, for example, how
many seats are available for meeting hosts, trainers, training managers,
and so on. Each quota has a threshold; when the threshold is crossed,
the system notifies administrators that the quota is in danger of
being reached. The settings for the thresholds and notifications
vary depending on the quota, and you can configure the settings
using this action.
Request URL
https://example.com/api/xml
?action=quota-threshold-update
&account-id=integer
&acl-id=integer
"a-id=string
&threshold-pct=integer
&login-notif=Boolean
&email-notif=Boolean
&monthly-emails=Boolean
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the account for which quota settings
are updated.
|
|
|
Integer
|
Y
|
The ID of the SCO, account, or principal
for which you want threshold information. Can be a valid
sco-id
,
account-id
,
or
principal-id
. If you do not specify a value
for
acl-id
, the value for
account-id
is
used.
The value to use for
acl-id
depends
on the quota ID used; for more information, see
quota-ID
.
|
|
|
String
|
Y
|
The ID of the quota whose settings are updated.
For available values, see
quota-ID
.
|
|
|
Integer
|
Y
|
The percent threshold for the quota. The
lower the value, the more frequently administrators are notified
when the threshold is exceeded (if notifications are enabled).
|
|
|
Boolean
|
Y
|
Specifies whether to notify administrators
upon logging in that a threshold is exceeded (
true
)
or not (
false
).
|
|
|
Boolean
|
Y
|
Specifies whether to notify administrators
through e-mail that a threshold is exceeded (
true
)
or not (
false
).
|
|
|
Boolean
|
Y
|
Specifies whether to send administrators
monthly threshold reports through e-mail (
true
)
or not (
false
).
|
|
|
String
|
N
|
The value of the
BREEZESESSION
cookie.
Use this parameter if you do not use a client-side cookie management
library.
|
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=quota-threshold-update&account-id=7&acl-id=7"a-id=training-user&threshold-pct=90&login-notif=false&email-notif=true&monthly-emails=true
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
report-active-meetings
Description
Returns
a list of Adobe® Connect™ meetings
that are currently in progress, including the number of minutes
the meeting has been active.
For
report-active-meetings
to
return results, at least one user must be present in at least one
meeting room. If meetings are scheduled at present, but no users
are attending those meetings,
report-active-meetings
returns an
empty response.
Request URL
http://server_name/api/xml
?action=report-active-meetings
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
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
<results>
<status code=allowedValue />
<report-active-meetings>
<sco sco-id=integer active-participants=integer
length-minutes=integer>
<name>string</name>
<url-path>string</url-path>
<date-begi>datetime</date-begin>
</sco>
</report-active-meetings>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of all meetings currently in progress.
|
|
|
|
Container
|
Information about one meeting in progress.
|
|
|
|
Integer
|
The unique ID of a meeting in progress.
|
|
|
|
Integer
|
The number of users attending the meeting
in progress, including hosts and presenters.
|
|
|
|
Integer
|
The number of minutes the meeting has been active.
|
|
|
|
String
|
The name of the meeting, defined when the
meeting was created.
|
|
|
|
String
|
The part of the meeting URL that comes after
the domain and is unique to this meeting.
|
|
|
|
Datetime
|
The date and time the meeting began.
|
Sample request
https://example.com/api/xml?action=report-active-meetings
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-active-meetings>
<sco sco-id="2006778715" active-participants="" length-minutes="1">
<name>Designing Online Courses</name>
<url-path>/online/</url-path>
<date-begin>2006-06-28T14:35:21.307-07:00</date-begin>
</sco>
</report-active-meetings>
</results>
report-bulk-consolidated-transactions
Description
Returns
information about principal-to-SCO transactions on your Adobe Connect
server or in your Adobe Connect hosted account.
A transaction
is an instance of one principal visiting one SCO. The SCO can be
a Adobe Connect meeting, course, document, or any content on the
server.
These are all examples of transactions:
-
If a principal attends a meeting twice, two transactions
exist: one for each time the principal attended the meeting.
-
If five people attend a meeting, five transactions exist:
one for each user who attended the meeting.
-
If a principal takes two courses three times each and passes
each only on the third try, six transactions exist: one for each
attempt on each course.
This call returns all transactions,
so consider using a filter to reduce the volume of the response.
For example, if you use
filter-type=meeting
, the
call returns all meeting transactions:
https://example.com/api/xml?action=report-bulk-consolidated-transactions
&filter-type=meeting
From the response, you
can calculate Adobe Connect meeting usage by comparing times in
date-created
and
date-closed
(see
“
Calculate meeting usage
”). However, this call to
report-bulk-consolidated-transactions
,
with
filter-type=meeting
, returns only users who logged
in to the meeting as participants, not users who entered the meeting
as guests.
Request URL
http://server_name/api/xml
?action=report-bulk-consolidated-transactions
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-bulk-consolidated-transactions>
<row transaction-id=integer sco-id=integer type=allowedValue
principal-id=integer score=integer>
<name>string</name>
<url>relativeUrl</url>
<login>string</login>
<user-name>string</user-name>
<status>allowedValue</status>
<date-created>datetime</date-created>
<date-closed>datetime</date-closed>
</row>
...
</report-bulk-consolidated-transactions>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-bulk-consolidated-transactions
|
|
Container
|
The entire list of transactions that matches the
request.
|
|
|
|
Container
|
Details of one transaction that matches
the request.
|
|
|
|
Integer
|
The ID of the transaction.
|
|
|
|
Integer
|
The unique ID of the object (SCO) the user interacted
with.
|
|
|
|
Allowed value
|
The type of the SCO (see
type
for allowed values).
|
|
|
|
Integer
|
The ID of the principal involved in the transaction.
|
|
|
|
Integer
|
If the transaction (such as a quiz) assigned a
score, the actual score. Otherwise,
0
.
|
|
|
|
String
|
The name assigned to the SCO involved in the
transaction.
|
|
|
|
String
|
The file name portion of the URL to the
SCO involved in the transaction.
|
|
|
|
String
|
The principal’s login ID.
|
|
|
|
String
|
The full name of the user involved in the transaction
(concatenated from
first-name
and
last-name
).
|
|
|
|
Allowed value
|
The status of the transaction. Allowed values
are
completed
,
in-progress
,
user-passed
,
and
user-failed
.
|
|
|
|
Datetime
|
The date and time the principal began interacting
with the SCO and the transaction was created.
|
|
|
|
Datetime
|
The date and time the principal finished interacting
with the SCO and the transaction was complete.
|
Sample request
https://example.com/api/xml?action=report-bulk-consolidated-transactions
&filter-type=meeting
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-bulk-consolidated-transactions>
<row transaction-id="2006905086" sco-id="2006905049" type="meeting"
principal-id="2006258745" score="0">
<name>Celebrate End of June Meeting</name>
<url>/endjune/</url>
<login>joy@acme.com</login>
<user-name>Joy Smith</user-name>
<status>completed</status>
<date-created>2006-06-30T11:10:37.003-07:00</date-created>
<date-closed>2006-06-30T11:45:21.397-07:00</date-closed>
</row>
<row transaction-id="2006905795" sco-id="2006905049" type="meeting"
principal-id="2006258745" score="0">
<name>Celebrate End of June Meeting</name>
<url>/endjune/</url>
<login>joy@acme.com</login>
<user-name>Joy Smith</user-name>
<status>completed</status>
<date-created>2006-06-30T17:58:29.060-07:00</date-created>
<date-closed>2006-06-30T17:59:09.970-07:00</date-closed>
</row>
...
</report-bulk-consolidated-transactions>
</results>
report-bulk-objects
Description
Returns
information about all objects (SCOs) on a licensed Adobe Connect
Server or in a Adobe Connect hosted account. The object types returned
include
archive
,
attachment
,
authorware
,
captivate
,
course
,
curriculum
,
external-event
,
flv
,
image
,
meeting
,
presentation
, and
swf
.
Because
the response is likely to be large, use filters to limit it. For
example, to return a list of all meetings on the server, filter
on the
type
field:
http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting
Request URL
http://server_name/api/xml
?action=report-bulk-objects
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-bulk-objects>
<row sco-id=integer type=allowedValue>
<url>string</url>
<name>string</name>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
<date-modified>datetime</date-modified>
<description>datetime</description>
</row>
...
</report-bulk-objects>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of SCOs on the server; or,
if a filter is used, the entire list of SCOs that matches the filter.
|
|
|
|
Container
|
Details about one SCO.
|
|
|
|
Integer
|
The unique ID of the SCO.
|
|
|
|
Allowed value
|
The type of SCO (see
type
).
|
|
|
|
String
|
The unique identifier of the training SCO,
placed in the URL after the domain name.
|
|
|
|
String
|
The name assigned to the SCO.
|
|
|
|
Datetime
|
The date the SCO was created. For a meeting,
the date and time the meeting starts.
|
|
|
|
Datetime
|
If the SCO is a meeting or event, the date
it ended.
|
|
|
|
Datetime
|
The date the SCO was last updated.
|
|
|
|
String
|
The description of the SCO.
|
Sample request
http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting
&filter-gt-date-created=2006-06-01
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-bulk-objects>
<row sco-id="2006778715" type="meeting">
<url>/online/</url>
<name>Designing Online Courses</name>
<date-created>2006-06-28T14:15:00.000-07:00</date-created>
<date-end>2006-06-28T14:30:00.000-07:00</date-end>
<date-modified>2006-07-13T14:57:54.150-07:00</date-modified>
</row>
...
</report-bulk-objects>
</results>
report-bulk-questions
Description
Returns
information about every quiz question in the account you are logged
in to.
The response includes a combination of the quiz question,
the answer, the ID of the user who answered, and the ID of the transaction.
This
action returns all question-and-answer combinations in the account,
unless you use a filter to limit the size of the response.
Request URL
http://server_name/api/xml
?action=report-bulk-questions
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-bulk-questions>
<row transaction-id=integer score=integer principal-id=integer>
<question>string</question>
<response>string</response>
<date-created>datetime</date-created>
</row>
...
</report-bulk-questions>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of question-and-answer combinations
that match the request.
|
|
|
|
Container
|
Details about one question-and-answer combination.
|
|
|
|
Integer
|
The ID of the interaction between a user
and a quiz.
|
|
|
|
Integer
|
The score assigned to the question.
|
|
|
|
Integer
|
The ID of the user who answered or viewed
the question.
|
|
|
|
String
|
The text of the question, which might be
phrased as a statement.
|
|
|
|
String
|
The response the user chose or entered.
|
|
|
|
Datetime
|
The date and time the user answered the
question.
|
Sample request
https://example.com/api/xml?action=report-bulk-questions
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-bulk-questions>
<row transaction-id="2006335803" score="10" principal-id="2006258745">
<question>The capital of California is<1></question>
<response>Sacramento</response>
<date-created>2006-05-11T15:50:23.643-07:00</date-created>
</row>
<row transaction-id="2006335827" score="0" principal-id="2006258745">
<question>The capital of California is<1></question>
<response>san francisco</response>
<date-created>2006-05-11T17:32:53.970-07:00</date-created>
</row>
</report-bulk-questions>
</results>
report-bulk-slide-views
Description
Returns
information about each occasion on which a principal views a slide.
The slide can be in any presentation in the account the current
user belongs to.
Each slide view is a transaction. A
transaction
is
an interaction between a user and any SCO on Adobe Connect. In this
case, the transaction is between a user and a slide.
This
action returns all occurrences of principals viewing slides in the
account, unless you filter the response.
Request URL
http://server_name/api/xml
?action=report-bulk-slide-views
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-bulk-slide-views>
<row transaction-id=integer principal-id=integer>
<page>integer</page>
<date-created>datetime</date-created>
</row>
...
</report-bulk-slide-views>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of slide views that match
the request.
|
|
|
|
Container
|
Details about one slide view.
|
|
|
|
Integer
|
The ID of the interaction between the user
and the slide.
|
|
|
|
Integer
|
The ID of the user who viewed the slide.
|
|
|
|
Integer
|
The page number of the slide in the presentation.
|
|
|
|
Datetime
|
The date and time the user viewed the slide.
|
Sample request
https://example.com/api/xml?action=report-bulk-slide-views
&filter-principal-id=123456
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-bulk-slide-views>
<row transaction-id="2006334916" principal-id="123456">
<page>0</page>
<date-created>2006-05-11T12:02:01.470-07:00</date-created>
</row>
<row transaction-id="2006334916" principal-id="123456">
<page>0</page>
<date-created>2006-05-11T12:02:01.487-07:00</date-created>
</row>
...
</report-bulk-slide-views>
</results>
report-bulk-users
Description
Returns
information about all users in an account. The difference between
this call and
principal-list
is that
principal-list
returns
both users and groups, while
report-bulk-users
returns
only users.
The response from
report-bulk-users
can
be quite large, especially if you use custom fields, so remember
that you can filter and sort it. For example, the following call
returns a list of all users who have the letters
Jo
in their
name, in ascending order by name:
http://myserver.com/api/xml?action=report-bulk-users&sort-name=asc
&filter-like-name=Jo
If you pass
custom-fields=true
,
by default
report-bulk-users
returns up to eight
custom fields defined for users. If you have defined more than eight
custom fields for users,
report-bulk-users
returns
the first eight in the list in the Customize User Profile screen
in Connect Central (at Administration > Users and Groups >
Customize User Profile).
If you use Adobe Connect Server,
you can set a value for
REPORT_MAX_CUSTOM_FIELDS
in
the custom.ini file to have
report-bulk-users
return
more than eight custom fields. You can use any value, but higher
values risk a greater impact to database performance. You cannot
change this setting on a Adobe Connect hosted account.
Request URL
http://server_name/api/xml
?action=report-bulk-users
&custom-fields=boolean
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Boolean
|
N
|
Whether to return custom fields in the response.
Returns up to eight custom fields. If true, the
manager
field
is not returned in the response.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
You
can use
filter-type
with
report-bulk-users
to
filter the type of users returned (
user
or
guest
).
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-bulk-users>
<row principal-id=integer type="string">
<login>string</login>
<name>string</name>
<email>string</email>
<manager>string</manager>
.. any custom fields ..
</row>
...
</report-bulk-users>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
Top-level element for the response.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of users in the account.
|
|
|
|
Container
|
Details about one user in the account.
|
|
|
|
Integer
|
The ID of the user.
|
|
|
|
String
|
The type of user, either
user
or
guest
.
|
|
|
|
String
|
The user’s login ID, often an e-mail address.
|
|
|
|
String
|
The full name of the user, concatenated
from the user’s first name and last name.
|
|
|
|
String
|
The user’s e-mail address.
|
|
|
|
String
|
The user’s manager, also a registered user.
Returned if a manager has been set for the user. Not returned if
custom-fields
is
true
in
the request.
|
Sample request
https://example.com/api/xml?action=report-bulk-users&filter-like-name=john
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-bulk-users>
<row principal-id="5417288" type="guest">
<login>john@example.com</login>
<name>John Owens</name>
<email>john@example.com</email>
</row>
<row principal-id="5417255" type="user">
<login>jsmith@example.com</login>
<name>John Smith</name>
<email>jsmith@example.com</email>
</row>
...
</report-bulk-users>
</results>
report-course-status
Description
Returns
summary information about a course, including the number of users who
have passed, failed, and completed the course, as well as the current number
of enrollees. The request requires the
sco-id
of
a course.
Connect Central uses this call to display Course
Status in the Summary report. This report is available at Training
> Shared Training >
[course name]
> Reports > Summary.
Request URL
http://server_name/api/xml
?action=report-course-status
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of the course for which you
want summary information.
|
|
|
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 />
<report-course-status total-course-completions=integer
total-unique-course-completions=integer num-passed=integer
num-failed=integer num-enrollees=integer />
<date-last-taken>datetime</date-last-taken>
</report-course-status>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Summary information about a course.
|
|
|
|
Integer
|
The total number of times users have completed
the course, including passing scores, failing scores, and multiple
attempts by the same user.
|
|
|
total-unique-course-completions
|
Integer
|
The number of distinct users who have completed
the course, including passing and failing scores but not multiple attempts
by the same user.
|
|
|
|
Integer
|
The number of users who have completed the
course, for courses that do not have a passing score.
|
|
|
|
Integer
|
The number of users who have passed the course,
for courses that have a passing score.
|
|
|
|
Integer
|
The number of users who have failed the course,
for courses that have a passing score.
|
|
|
|
Integer
|
The number of users presently enrolled in the
course.
|
|
|
|
Datetime
|
The last time any user attempted the course
but was not in server-side review mode.
|
Sample request
https://example.com/api/xml?action=report-course-status&sco-id=123456
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-course-status total-course-completions="1"
total-unique-course-completions="1" num-completed="0"
num-passed="1" num-failed="0" num-enrollees="4">
<date-last-taken>2006-10-10T13:55:24.480-07:00</date-last-taken>
</report-course-status>
</results>
report-curriculum-taker
Availability
Connect
Enterprise 6
Description
Returns
information about a user’s progress in a curriculum.
The
response includes a
row
element for each course
in the curriculum, which has information such as access to the course,
whether credit was granted, the user’s score, the unique
url-path
to
the course, and so on.
Request URL
http://server_name/api/xml
?action=report-curriculum-taker
&user-id=integer
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the user whose scores you want
to check.
|
|
|
Integer
|
Y
|
The unique ID of the curriculum for which
you want a summary.
|
|
|
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 />
<report-curriculum-taker>
<sco transcript-id=integer path-type=allowedValue asset-id=integer
sco-id=integer depth=integer folder-id=integer
type=integer icon=allowedValue lang=allowedValue
max-retries=integer source-sco-id=integer
source-sco-type=allowedValue status=allowedValue score=integer
certificate=integer max-score=integer attempts=integer>
<access>allowedValue</access>
<credit-granted>boolean</credit-granted>
<name>string</name>
<url-path>string</url-path>
<date-modified>datetime</date-modified>
<override>boolean</override>
</sco>
</report-curriculum-taker>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the user’s performance
in the entire curriculum.
|
|
|
|
Container
|
Information about the user’s work with one course
or curriculum.
|
|
|
|
Integer
|
The ID of the user’s transcript for the
course or curriculum.
|
|
|
|
Allowed value
|
The learning path a user must take before attempting
this course or curriculum (see
path-type
for allowed values).
|
|
|
|
Integer
|
The version of the course or curriculum
the user attempted to complete. The
asset-id
is incremented
each time the course or curriculum has new content uploaded.
|
|
|
|
Integer
|
The unique ID of the course or curriculum.
|
|
|
|
Integer
|
A course’s level below the curriculum in
the navigation hierarchy. For a curriculum,
0
;
for a course one level below the curriculum,
1
.
|
|
|
|
Integer
|
The ID of the folder that contains the course
or curriculum. For a course, the ID of a curriculum; for a curriculum,
the ID of a user.
|
|
|
|
Integer
|
The type of the course or curriculum (see
type
for allowed values).
|
|
|
|
Allowed value
|
The type of icon that identifies the course
or curriculum in Connect Central (see
icon
for values).
|
|
|
|
Allowed value
|
The language associated with the course
or curriculum (see
lang
for values).
|
|
|
|
Integer
|
The maximum number of times a user can retake
the course or curriculum. If a user can take the course 3 times,
max-retries
is
2.
|
|
|
|
Integer
|
The unique ID of the SCO used as a template for
the course or curriculum.
|
|
|
|
Integer
|
The type of SCO used as a template for the course
or curriculum (see
type
for values).
|
|
|
|
Allowed value
|
The status of the user’s attempt to use
the course or curriculum.
For courses, allowed values are
completed
,
incomplete
,
user-passed
,
user-failed
, and
not-attempted
.
For
curriculums and folders, allowed values are
completed
and
incomplete.
|
|
|
|
Integer
|
The score the user earned on the course
or curriculum.
|
|
|
|
Integer
|
The ID of the user’s certificate.
|
|
|
|
Integer
|
The maximum score possible for the course
or curriculum.
|
|
|
|
Integer
|
The number of times the user has attempted the
course or curriculum.
|
|
|
|
Allowed value
|
The level of access the user has to the
course or curriculum (see
access
for allowed values).
|
|
|
|
Boolean
|
A value indicating whether credit was granted for
the course or curriculum.
|
|
|
|
String
|
The name of the learning object or curriculum.
|
|
|
|
String
|
The part of the URL after the domain name that
uniquely identifies the object on the server.
|
|
|
|
Datetime
|
The date and time the SCO was last modified, in
ISO
8601
format.
|
|
|
|
Boolean
|
A value indicating whether the transcript
for the SCO has been adjusted.
|
Sample request
https://example.com/api/xml?action=report-curriculum-taker
&user-id=2006258748&sco-id=2006298444
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-curriculum-taker>
<sco transcript-id="2006905613" path-type="prereq-none"
asset-id="2006334911" sco-id="2006334909" depth="0"
folder-id="2006258747" type="content" icon="producer"
lang="en" max-retries="" source-sco-id="" source-sco-type=""
status="user-failed" score="0" certificate="" max-score="0"
attempts="5">
<access>access-open</access>
<credit-granted>false</credit-granted>
<name>Test Quiz</name>
<url-path>/quiz/</url-path>
<date-created>2006-06-30T15:24:34.897-07:00</date-created>
<date-modified>2006-05-16T15:22:25.703-07:00</date-modified>
<date-taken>2006-06-30T15:24:34.897-07:00</date-taken>
<override>false</override>
</sco>
</report-curriculum-taker>
</results>
report-meeting-attendance
Description
Returns
a list of users who attended a Adobe Connect meeting. The data is returned
in
row
elements, one for each person who attended.
If the meeting hasn’t started or had no attendees, the response
contains no rows.The response does not include meeting hosts or
users who were invited but did not attend.
To call
report-meeting-attendance
,
you must have
publish
,
mini-host
,
or
host
permission on the meeting (see
permission-id
for details).
Request URL
http://server_name/api/xml
?action=report-meeting-attendance
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a meeting.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-meeting-attendance>
<row transcript-id=integer sco-id=integer principal-id=integer
answered-survey=boolean>
<login>string</login>
<session-name>string</session-name>
<sco-name>string</sco-name>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
<participant-name>string</participant-name>
</row>
...
</report-meeting-attendance>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-meeting-attendance
|
|
Container
|
The entire list of attendees for the meeting.
|
|
|
|
Container
|
Data about one meeting attendee.
|
|
|
|
Integer
|
The ID of the meeting transcript.
|
|
|
|
Integer
|
The unique ID of the meeting.
|
|
|
|
Integer
|
The ID of the principal who attended the
meeting.
|
|
|
|
Boolean
|
Whether the meeting participant responded
to a meeting poll. If 0 or false, the meeting did not have a poll
or the participant did not respond (if 1 or true, the opposite).
This value is updated when the poll is closed.
|
|
|
|
String
|
The meeting attendee’s login name.
|
|
|
|
String
|
The name of the user who entered the meeting room,
creating a session.
|
|
|
|
String
|
The name of the meeting.
|
|
|
|
Datetime
|
The date the meeting was created.
|
|
|
|
Datetime
|
The date the meeting ended.
|
|
|
|
String
|
The name of the meeting attendee as registered with
the server.
|
Sample request
https://example.com/api/xml?action=report-meeting-attendance
&sco-id=2006778715
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-meeting-attendance>
<row transcript-id="2006778723" sco-id="2006778715"
principal-id="2006258745" answered-survey="0">
<login>joy@acme.com</login>
<session-name>Joy Smith</session-name>
<sco-name>Designing Online Courses</sco-name>
<date-created>2006-06-28T14:35:21.307-07:00</date-created>
<date-end>2006-06-28T15:09:05.447-07:00</date-end>
<participant-name>Joy Smith</participant-name>
</row>
</report-meeting-attendance>
</results>
report-meeting-concurrent-users
Description
Returns
the maximum number of users in Adobe Connect meetings concurrently in
the last 30 days, and the number of times the maximum has been reached.
The maximum is the peak number of users in any meetings at a single
moment, whether one meeting, multiple concurrent meetings, or multiple
overlapping meetings.
You can change the time period to a
period greater than 30 days by adding a
length
parameter,
for example,
length=120
.
The maximum number
of users (
max-users
) is determined by the account license
and applies to the server overall, not to a specific meeting. This
action also returns the number of times in the current month the
maximum has been reached (
max-participants-freq
).
Request URL
http://server_name/api/xml
?action=report-meeting-concurrent-users
&length=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The number of days in the time period to
check for concurrent meeting usage. Use a value greater than 30.
The default value is 30.
|
|
|
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
<results>
<status code=allowedValue />
<report-meeting-concurrent-users max-users=integer
max-participants-freq=integer />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-meeting-concurrent-users
|
|
Empty, with attributes
|
Information about the peak number of users
in meetings at the same moment.
|
|
|
|
Integer
|
The peak number of users in meetings at the
same moment (either a single meeting or concurrent meetings) during
the time period.
|
|
|
|
Integer
|
The number of times the maximum has been
reached in the time period.
|
Sample request
https://example.com/api/xml?action=report-meeting-concurrent-users
Sample response
<results>
<status code="ok" />
<report-meeting-concurrent-users max-users="400"
max-participants-freq="1" />
</results>
report-meeting-session-users
Availability
Adobe
Connect 8.1
Description
Provides information about
all the user sessions for an Adobe Connect meeting session. A user
session is created when a participant enters a meeting session.
As more participants join the meeting, they join the meeting session.
The user session ends when the user leaves the meeting session.
When a new participant enters an empty meeting, a new meeting session
and new user session is started.
Request URL
http://server_name/api/xml
?action=report-meeting-session-users
&sco-id=integer
&asset-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
sco-id
|
Integer
|
Y
|
The ID of a meeting for which you want user
session information.
|
|
asset-id
|
Integer
|
Y
|
The ID of the meeting session. As returned
by report-meetings-sessions.
|
|
filter-definition
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
sort-definition
|
Filter 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 or sort the response
on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8"?>
<results>
<status code="ok"/>
<report-meeting-session-users>
<row principal-id=integer>
<principal-name>string</principal-name>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
</row>
...
</report-meeting-session-users>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
results
|
|
Container
|
All results that the action returns.
|
|
status
|
|
Empty, with attributes
|
The status of the response.
|
|
|
code
|
Allowed value
|
A code indicating the response status (see
status).
|
|
report-meeting-session-users
|
|
Container
|
The list of user-sessions for the meeting
session.
|
|
row
|
|
Container
|
The information for one user-session.
|
|
|
principal-id
|
|
Unique ID of a user/participant.
|
|
principal-name
|
|
String
|
Name of a user/participant.
|
|
date-created
|
|
Datetime
|
The date and time the user-session was created
when the participant entered the meeting session.
|
|
date-end
|
|
Datetime
|
The date and time the user-session ended
when the participant exited the meeting session.
|
Sample request
https://example.com/api/xml?action=report-meeting-session-users&sco-id=2006811328&asset-id=446653455
Sample response
<?xml version="1.0" encoding="utf-8"?>
<results>
<status code="ok"/>
<report-meeting-session-users>
<row principal-id="52904333">
<principal-name>John Doe</principal-name>
<date-created>2011-08-30T15:46:46.190-04:00</date-created>
<date-end>2011-08-30T16:51:30.950-04:00</date-end>
</row>
</report-meeting-session-users>
</results>
report-meeting-sessions
Description
Provides information about all the sessions
of a Adobe Connect meeting. A
session
is created when a participant
enters an empty meeting. As more participants join the meeting,
they join the session. The session ends when all attendees leave
the meeting. When a new participant enters the now-empty meeting,
a new session starts. For example, a recurring weekly meeting has
a session each week when the meeting is held.
You can call
report-meeting-sessions
on
past meetings, active meetings, or future meetings, but future meetings
are not likely to have sessions.
Request URL
http://server_name/api/xml
?action=report-meeting-sessions
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a meeting for which you want session
information.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-meeting-sessions>
<row sco-id=integer asset-id=integer version=integer
num-participants=integer>
<date-created>datetime</date-created>
<date-end>datetime</date-end>
</row>
...
</report-meeting-sessions>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of sessions for the meeting.
|
|
|
|
Container
|
Information about one session.
|
|
|
|
Integer
|
The unique ID of the meeting.
|
|
|
|
Integer
|
The unique ID of the session.
|
|
|
|
Integer
|
A sequential ID for the session, starting
at 1.
|
|
|
|
Integer
|
The number of participants in the meeting,
other than the host.
|
|
|
|
Datetime
|
The date and time the session was created,
when the participant entered the meeting room.
|
|
|
|
Datetime
|
The date and time the session ended, when
the participant left the meeting room.
|
Sample request
https://example.com/api/xml?action=report-meeting-sessions
&sco-id=2006811328
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-meeting-sessions>
<row sco-id="2006811328" asset-id="2006811333" version="1"
num-participants="1">
<date-created>2006-06-29T11:46:52.210-07:00</date-created>
<date-end>2006-06-29T13:34:43.410-07:00</date-end>
</row>
</report-meeting-sessions>
</results>
report-meeting-summary
Description
Returns
summary information about a specific Adobe Connect meeting. The results
indicate how many users were invited, how many invited participants
and guests attended, and other information about the meeting.
To
use
report-meeting-summary
, you need
publish
,
host
,
or
mini-host
permission on the meeting. With one
of these permissions, you can run
report-meeting-summary
on
a current, completed, or future meeting. The results are most useful
for a completed meeting.
A meeting might be recurring (for
example, a weekly staff meeting) and have an occurrence each time
the meeting is held. If the meeting is recurring, the statistics
returned by
report-meeting-summary
are cumulative,
applying to all occurrences of the meeting, not just the latest
one.
Request URL
http://server_name/api/xml
?action=report-meeting-summary
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a meeting for which you
have
publish
or
host
permission.
|
|
|
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 />
<report-meeting-summary num-unique-meetings=integer peak-users=integer
num-invitees=integer num-invitees-attended=integer ispublic=boolean
num-guests-attended=integer />
</results>
Returned XML elements
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Empty, with attributes
|
Details about the meeting or meeting series.
|
|
|
|
Integer
|
The number of occurrences of a recurring meeting.
|
|
|
|
Integer
|
The highest number of participants in the meeting
room at one time, during any one meeting occurrence.
|
|
|
|
Integer
|
The number of users who were invited.
|
|
|
|
Integer
|
The number of invited users who attended.
|
|
|
|
Boolean
|
Whether the meeting is public and guests can
enter automatically (if
1
or
true
),
or private and must wait for permission (if
0
or
false
).
|
|
|
|
Integer
|
The number of participants who entered the
meeting room as guests rather than as registered attendees.
|
Sample request
https://example.com/api/xml?action=report-meeting-summary&sco-id=2006334033
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-meeting-summary num-unique-meetings="1" peak-users="1"
num-invitees="1" num-invitees-attended="1" ispublic="1"
num-guests-attended="0">
<most-recent-session>
2006-06-28T15:11:15.133-07:00
</most-recent-session>
</report-meeting-summary>
</results>
report-my-courses
Description
Provides
information about each course the current user is or was enrolled
in.
The returned courses include future courses, past courses,
and courses the user is presently taking. The list of courses can
be quite large, so remember to use a filter to reduce the response.
Each
course has a
permission-id
that shows the level
of access the user has to the course. For example, the access might
be
view
,
publish
, or
manage
.
Request URL
http://server_name/api/xml
?action=report-my-courses
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<my-courses>
<course sco-id=integer type="content" icon="course"
permission-id=allowedValue>
<name>string</name>
<description>string</description>
<url>string</url>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<date-begin>datetime</date-begin>
<url-path>string</url-path>
<expired>boolean</expired>
<completed>boolean</completed>
</course>
...
</my-courses>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all courses the user is
enrolled in.
|
|
|
|
Container
|
Information about one course the user is
enrolled in.
|
|
|
|
Integer
|
The unique ID of the course.
|
|
|
|
Allowed value
|
The type of the course (for allowed values,
see
type
).
|
|
|
|
Allowed value
|
The type of icon that identifies the course
in the user interface. For a course, always
course
.
|
|
|
|
Allowed value
|
The level of permission the user has on
the course (see
permission-id
for values).
|
|
|
|
String
|
The name of the course.
|
|
|
|
String
|
The URL at which a user can reach the course
on the server. Includes the domain name and the course identifier.
|
|
|
|
Datetime
|
The date and time the course was created.
|
|
|
|
Datetime
|
The date and time the course was last modified.
|
|
|
|
Datetime
|
The date and time the course is available
for users to start.
|
|
|
|
Datetime
|
The date and time the course closes.
|
|
|
|
String
|
The part of the course URL that is the course
identifier, after the domain name.
|
|
|
|
Boolean
|
Whether the course has expired (
true
if
it has,
false
if it has not).
|
|
|
|
Boolean
|
Whether the user has completed the course
(
true
if yes,
false
if no).
|
Sample request
https://example.com/api/xml?action=report-my-courses
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<my-courses>
<course sco-id="2006298431" type="content" icon="course"
permission-id="view">
<name>Test Course</name>
<url>example.com/test/</url>
<date-created>2006-05-03T10:21:46.810-07:00</date-created>
<date-modified>2006-05-03T10:22:30.803-07:00</date-modified>
<date-begin>2006-05-03T10:15:00.000-07:00</date-begin>
<url-path>/test/</url-path>
<expired>false</expired>
<completed>false</completed>
</course>
</my-courses>
</results>
report-my-events
Description
Provides
information about each event the current user has attended or is scheduled
to attend. The user can be either a host or a participant in the
event. The events returned are those in the user’s
my-events
folder.
To
obtain information about all events on your Adobe Connect Server
or in your Adobe Connect hosted account, call
sco-shortcuts
to
get the
sco-id
of the
events
folder.
Then, call
sco-contents
with the
sco-id
to
list all events.
Request URL
http://server_name/api/xml
?action=report-my-events
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<my-events>
<event sco-id=integer type="event" icon="event"
permission-id=allowedValue>
<name>string</name>
<domain-name>string</domain-name>
<url-path>string</url-path>
<date-begin>datetime</date-begin>
<date-end>datetime</date-end>
<expired>boolean</expired>
<duration>datetime/duration>
</event>
...
</my-events>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of events the user is or
has been registered for.
|
|
|
|
Container
|
Information about one event.
|
|
|
|
Integer
|
The unique ID of the event.
|
|
|
|
Allowed value
|
The type of the object. For an event, always
event
.
|
|
|
|
Allowed value
|
An icon identifying the object. For an event,
always
event
.
|
|
|
|
Allowed value
|
The permission the user has for the event
(see
permission-id
for values).
|
|
|
|
String
|
The name of the event.
|
|
|
|
String
|
The domain name of the Adobe Connect server,
which comes after
http://
(or
https://
)
and before the unique event name in the event URL.
|
|
|
|
String
|
The unique event name, which comes after
the domain name in the event URL.
|
|
|
|
Date
|
The date the event begins, in
ISO 8601
format.
|
|
|
|
Date
|
The date the event ends, in
ISO 8601
format.
|
|
|
|
Boolean
|
A value indicating whether the event has
ended. If the event is currently underway, the value is
false
.
|
|
|
|
Time
|
The amount of time the event is scheduled
to last. Uses the time portion of an
ISO 8601
date format.
|
Sample request
https://example.com/api/xml?action=report-my-events
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<my-events>
<event sco-id="2006334107" type="event" icon="event"
permission-id="host">
<name>Meet the Famous Author</name>
<domain-name>example.com</domain-name>
<url-path>/author/</url-path>
<date-begin>2006-05-12T18:00:00.000-07:00</date-begin>
<date-end>2006-05-12T20:00:00.000-07:00</date-end>
<expired>true</expired>
<duration>02:00:00.000</duration>
</event>
</my-events>
</results>
report-my-meetings
Description
Provides
information about all Adobe Connect meetings for which the user
is a host, invited participant, or registered guest. The meeting
can be scheduled in the past, present, or future.
Request URL
http://server_name/api/xml
?action=report-my-meetings
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<my-meetings>
<meeting sco-id=integer type="meeting" icon="meeting"
permission-id=allowedValue active-participants=integer>
<name>string</name>
<description>string</description>
<domain-name>domain</domain-name>
<url-path>url</url-path>
<date-begin>date</date-begin>
<date-end>date</date-end>
<expired>boolean</expired>
<duration>time</duration>
</meeting>
...
</my-meetings>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all meetings the user
is, or has been, invited to.
|
|
|
|
Container
|
Details about one of the user’s meetings.
|
|
|
|
Integer
|
The unique ID of the meeting.
|
|
|
|
Allowed value
|
The type of the object returned (for this
call, always
meeting
).
|
|
|
|
Allowed value
|
The icon that visually identifies the meeting
in Connect Central (for this call, always
meeting
).
|
|
|
|
Allowed value
|
The level of permission the user has to
the meeting (see
permission-id
for values).
|
|
|
|
Integer
|
The number of participants the meeting currently
has, including hosts and presenters.
|
|
|
|
String
|
The name of the meeting.
|
|
|
|
String
|
The domain name portion of the URL to the
meeting room.
|
|
|
|
String
|
The part of the meeting room URL that identifies
the meeting and comes after the domain name.
|
|
|
|
Datetime
|
The date and time the meeting begins (or
has begun).
|
|
|
|
Datetime
|
The date and time the meeting ends (or has
ended).
|
|
|
|
Boolean
|
Whether the meeting has ended (
true
if
it has,
false
if it has not).
|
|
|
|
Time
|
The actual length of time of the meeting.
This may be longer or shorter than the time the meeting was scheduled
for.
|
Sample request
https://example.com/api/xml?action=report-my-meetings
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<my-meetings>
<meeting sco-id="2006334033" type="meeting" icon="meeting"
permission-id="host" active-participants="0">
<name>How to Write a Novel</name>
<domain-name>example.com</domain-name>
<url-path>/novel/</url-path>
<date-begin>2006-05-11T11:30:00.000-07:00</date-begin>
<date-end>2006-05-11T12:30:00.000-07:00</date-end>
<expired>true</expired>
<duration>01:00:00.000</duration>
</meeting>
<meeting sco-id="2006743452" type="meeting" icon="meeting"
permission-id="host" active-participants="0">
<name>Intro to Film</name>
<domain-name>example.com</domain-name>
<url-path>/film/</url-path>
<date-begin>2006-06-09T14:00:00.000-07:00</date-begin>
<date-end>2006-06-09T20:00:00.000-07:00</date-end>
<expired>true</expired>
<duration>06:00:00.000</duration>
</meeting>
</my-meetings>
</results>
report-my-training
Availability
Connect
Enterprise 6
Description
Returns
a list of all courses and curriculums a user or group is enrolled
in. If you do not use a
principal-id
, the list
is for the current user. If you add a
principal-id
,
the list is for the principal you specify.
The response contains
a list of
row
elements. In the list, courses have
the attributes
type=content
and
icon=course
,
while curriculums have
type=curriculum
and
icon=curriculum
.
Request URL
http://server_name/api/xml
?action=report-my-training
&principal-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The unique ID of a user or group whose courses
and curriculums you want to list. If you do not specify a value,
the response is for the current user.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-my-training>
<row sco-id=integer type=allowedValue icon=allowedValue max-retries=integer
permission-id=allowedValue transcript-id=integer attempts=integer>
<name>string</name>
<url>string</url>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<date-begin>datetime</date-begin>
<url-path>string</url-path>
<expired>boolean</expired>
<completed>boolean</completed>
</row>
...
</report-my-training>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire list of courses and curriculums
the user is enrolled in.
|
|
|
|
Container
|
Information about one course or curriculum
the user is enrolled in.
|
|
|
|
Integer
|
The unique ID of the course or curriculum.
|
|
|
|
Allowed value
|
The type of the object (see
type
for allowed values).
|
|
|
|
Allowed value
|
The icon that identifies the object in Connect
Central (see
icon
for allowed values).
If
type
is
content
, the
icon
value describes
the content.
|
|
|
|
Integer
|
The allowed number of attempts that the
course can be retaken.
|
|
|
|
Allowed value
|
The permission the principal has on the
object (see
permission-id
for allowed
values).
|
|
|
|
Integer
|
The ID of the course transcript.
|
|
|
|
Integer
|
The number of times the user has tried to
complete the course.
|
|
|
|
String
|
The name of the course or curriculum.
|
|
|
|
String
|
The course or curriculum description.
|
|
|
|
String
|
The part of the URL to the course or curriculum
that includes the domain name and unique name, without
http://
or
https://
.
|
|
|
|
Datetime
|
The date and time the course or curriculum
was created.
|
|
|
|
Datetime
|
The date and time the course or curriculum
was last modified.
|
|
|
|
Datetime
|
The start date and time of the course or
curriculum, either past or future.
|
|
|
|
Datetime
|
The end date or time of the course or curriculum,
either past or future.
|
|
|
|
String
|
A non-unique identifier for the course or
curriculum as shown in the user interface, for example, ECON101.
|
|
|
|
String
|
The unique name of the course or curriculum
in its URL.
|
|
|
|
Boolean
|
A value indicating whether the end date
of the course or curriculum has passed (
true
if
it has,
false
if not).
|
|
|
|
Boolean
|
A value indicating whether the user or group
has completed the course.
|
|
|
|
String
|
Whether the user has attempted to take the
course (
attempted
)or not (
not-attempted
).
|
Sample request
https://example.com/api/xml?action=report-my-training
&principal-id=2006258745
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-my-training>
<row sco-id="2006298431" type="content" icon="course" max-retries=""
permission-id="view" transcript-id="" attempts="0">
<name>Intro to Psychology</name>
<url>example.com/psychology/</url>
<date-created>2006-05-03T10:21:46.810-07:00</date-created>
<date-modified>2006-05-03T10:22:30.803-07:00</date-modified>
<date-begin>2006-05-03T10:15:00.000-07:00</date-begin>
<url-path>/psychology/</url-path>
<expired>false</expired>
<completed>true</completed>
</row>
<row sco-id="2006745669" type="curriculum" icon="curriculum"
permission-id="view">
<name>A Day in the Life</name>
<url>example.com/day/</url>
<date-created>2006-06-12T14:47:59.903-07:00</date-created>
<date-modified>2006-06-12T14:47:59.903-07:00</date-modified>
<date-begin>2006-06-12T14:45:00.000-07:00</date-begin>
<url-path>/day/</url-path>
<expired>false</expired>
<completed>false</completed>
<tr-status>not-attempted</tr-status>
</row>
</report-my-training>
</results>
report‑quiz‑interactions
Description
Provides
information about all the interactions users have had with a certain quiz.
An
interaction
identifies all answers one user makes to one
quiz question. If a user answers the same question more than once,
all answers are part of the same interaction and have the same
interaction-id
.
This
report provides information about every answer that any user has
ever given to questions on a quiz. You can filter the response to
make it more meaningful, using any allowed filters. For example,
you can request all answers a certain user has given:
https://example.com/api/xml?action=report-quiz-interactions
&sco-id=2006334909&filter-like-name=Joy%20Smith
Or,
you can request only a certain user’s answers to a specific question:
https://example.com/api/xml?action=report-quiz-interactions
&sco-id=2006334909&filter-name=Joy%20Smith
&filter-like-description=What is the capital of California
Request URL
http://server_name/api/xml
?action=report-quiz-interactions
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation or course
that contains a quiz.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<results>
<status code=allowedValue />
<report-quiz-interactions>
<row display-seq=integer transcript-id=integer interaction-id=integer
sco-id=integer score=integer>
<name>string</name>
<sco-name>string</sco-name>
<date-created>datetime</date-created>
<description>string</description>
<response>integer</response>
</row>
...
</report-quiz-interactions>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all interactions all users
have had with the quiz.
|
|
|
|
Container
|
Information about one user, one quiz question,
and one answer. Multiple
row
elements can be part
of the same interaction.
|
|
|
|
Integer
|
The sequence number of this question in
the quiz.
|
|
|
|
Integer
|
The ID of one user’s attempt to take a quiz,
with one user, one attempt at a quiz, and multiple questions and
answers. Each time the user takes the quiz, the
transcript-id
changes.
|
|
|
|
Integer
|
The ID of all answers one user makes to
one quiz question.
|
|
|
|
Integer
|
The unique ID of a presentation or course
that contains the quiz.
|
|
|
|
Integer
|
The user’s score for this question.
|
|
|
|
String
|
The name of the user.
|
|
|
|
Integer
|
The name of the presentation or course that
contains the quiz.
|
|
|
|
Datetime
|
The date the presentation or course was
created.
|
|
|
|
String
|
The quiz question the user answered.
|
|
|
|
String
|
The response the user gave.
|
Sample request
https://example.com/api/xml?action=report-quiz-interactions
&sco-id=2006334909&filter-name=Joy Smith
&filter-like-description=governor
Sample request
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-interactions>
<row display-seq="2" transcript-id="2006335803"
interaction-id="2006334914" sco-id="2006334909" score="10">
<name>Joy Smith</name>
<sco-name>California Quiz</sco-name>
<date-created>2006-05-11T15:50:23.643-07:00</date-created>
<description>
The governor of California is a former actor.
</description>
<response>true</response>
</row>
<row display-seq="2" transcript-id="2006335827"
interaction-id="2006334914" sco-id="2006334909" score="0">
<name>Joy Smith</name>
<sco-name>California Quiz</sco-name>
<date-created>2006-05-11T17:32:53.970-07:00</date-created>
<description>
The governor of California is a former actor.
</description>
<response>false</response>
</row>
<row display-seq="2" transcript-id="2006335954"
interaction-id="2006334914" sco-id="2006334909" score="10">
<name>Joy Smith</name>
<sco-name>California Quiz/sco-name>
<date-created>2006-05-12T11:55:24.940-07:00</date-created>
<description>
The governor of California is a former actor.
</description>
<response>true</response>
</row>
</report-quiz-interactions>
</results>
report-quiz-question-answer-distribution
Description
Returns
information about the number of users who chose a specific answer
to a quiz question. The combination of one quiz question and all
of one user’s answers to it is called an
interaction
. If
the user answers the question more than once, all answers are part
of the same interaction and have the same
interaction-id
.
Call
report‑quiz‑interactions
to
determine an
interaction-id
to specify in the request.
The
interaction-id
does not correspond to the question
number in the quiz (for example, question 1, question 2, and so
on).
Request URL
http://server_name/api/xml
?action=report-quiz-question-answer-distribution
&interaction-id=integer
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID that describes all of one user’s
responses to one quiz question.
|
|
|
Integer
|
Y
|
The unique ID of a presentation or course
that contains a quiz.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-quiz-question-answer-distribution>
<row display-seq=integer interaction-id=integer score=integer
asset-id=integer num-selected=integer>
<response>string</response>
</row>
...
</report-quiz-question-answer-distribution>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-quiz-question-answer-distribution
|
|
Container
|
The list of questions and answers.
|
|
|
|
Container
|
Information about one user, one question,
and one answer.
|
|
|
|
Integer
|
The sequence number of the question in the
quiz.
|
|
|
|
Integer
|
The ID of all of one user’s responses to
one quiz question. If the user answers the question multiple times, all
answers have the same
interaction-id
.
|
|
|
|
Integer
|
The score the user earned on the question.
|
|
|
|
Integer
|
The ID of the version of the quiz in which
the user answered the question. The
asset-id
changes
when you upload a new content version.
|
|
|
|
Integer
|
In multiple choice or true/false quiz questions,
the sequence number of the answer selected.
|
|
|
|
String
|
The response the user gave to the question.
|
Sample request
https://example.com/api/xml
?action=report-quiz-question-answer-distribution&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-question-answer-distribution>
<row display-seq="1" interaction-id="2006334913" score="0"
asset-id="2006334911" num-selected="1">
<response>san francisco</response>
</row>
<row display-seq="1" interaction-id="2006334913" score="10"
asset-id="2006334911" num-selected="2">
<response>Sacramento</response>
</row>
<row display-seq="2" interaction-id="2006334914" score="0"
asset-id="2006334911" num-selected="1">
<response>false</response>
</row>
...
</report-quiz-question-answer-distribution>
</results>
report‑quiz‑question‑distribution
Description
Returns
information about the number of correct and incorrect answers to
the questions on a quiz. This call can help you determine how a
group responded to a quiz question overall.
Because this call
returns information about all the questions on a quiz, you may want
to filter the results for a specific question or group of questions.
Request URL
http://server_name/api/xml
?action=report-quiz-question-distribution
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation that contains
a quiz.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-quiz-question-distribution>
<row display-seq=integer interaction-id=integer num-correct=integer
num-incorrect=integer total-responses=integer
percentage-correct=integer score=integer>
<name>string</name>
<description>string</description>
</row>
...
</report-quiz-question-distribution>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-quiz-question-distribution
|
|
Container
|
Information about all the questions on a quiz.
|
|
|
|
Container
|
Information about one question on the quiz.
|
|
|
|
Integer
|
The sequence in the quiz in which this question
falls.
|
|
|
|
Integer
|
The ID of the quiz question.
|
|
|
|
Integer
|
The number of correct answers to this question.
|
|
|
|
Integer
|
The number of incorrect answers to this question.
|
|
|
|
Integer
|
The total number of responses to this question.
|
|
|
|
Integer
|
The percentage of the total responses that were
correct.
|
|
|
|
Integer
|
The score assigned to the quiz question.
|
|
|
|
String
|
The name of the quiz question, defined when
the question was created in Quiz Manager.
|
|
|
|
String
|
The definition of the quiz question, defined when
the question was created in Quiz Manager.
|
Sample request
https://example.com/api/xml?action=report-quiz-question-distribution
&sco-id=2006334909&filter-like-description=The capital of California
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-question-distribution>
<row display-seq="1" interaction-id="2006334913" num-correct="2"
num-incorrect="1" total-responses="3" percentage-correct="66"
score="10">
<name>The capital of California is<1></name>
<description>The capital of California is<1></description>
</row>
</report-quiz-question-distribution>
</results>
report‑quiz‑question‑response
Description
Provides
a list of answers that users have given to questions on a quiz.
Without
filtering, this action returns all answers from any user to any
question on the quiz. However, you can filter the response for a
specific user, interaction, or answer (see the filter syntax at
filter-definition
).
An
interaction
is
a combination of one user and one question. If the user answers the
same question more than once, all answers are part of the same interaction and
have the same
interaction-id
.
Request URL
http://server_name/api/xml
?action=report-quiz-question-response
&sco-id=integer
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation that contains
a quiz.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-quiz-question-response>
<row principal-id=integer interaction-id=string>
<user-name>string</user-name>
<response>string</response>
<date-created>datetime</date-created>
</row>
</report-quiz-question-response>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-quiz-question-response
|
|
Container
|
Information about all responses to all questions on
the quiz.
|
|
|
|
Container
|
Information about one response.
|
|
|
|
Integer
|
The ID of the user who answered the quiz
question.
|
|
|
|
Integer
|
The ID of one response to one question.
|
|
|
|
String
|
The name of the user as registered on the
server.
|
|
|
|
String
|
The user’s response to the question, including
a word or phrase,
true
,
false
,
or a letter choice.
|
|
|
|
Datetime
|
The date and time the user responded.
|
Sample request
https://example.com/api/xml?action=report-quiz-question-response
&sco-id=2006334909&filter-interaction-id=2006334913
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-question-response>
<row principal-id="2006258745" interaction-id="2006334913">
<user-name>Joy Smith</user-name>
<response>Sacramento</response>
<date-created>2006-05-11T15:50:23.643-07:00</date-created>
</row>
<row principal-id="2006258745" interaction-id="2006334913">
<user-name>Joy Smith</user-name>
<response>san francisco</response>
<date-created>2006-05-11T17:32:53.970-07:00</date-created>
</row>
<row principal-id="2006258745" interaction-id="2006334913">
<response>Sacramento</response>
<date-created>2006-05-12T11:55:24.940-07:00</date-created>
</row>
</report-quiz-question-response>
</results>
report-quiz-summary
Description
Provides
a summary of data about a quiz, including the number of times the
quiz has been taken; average, high, and low scores; and other information.
Request URL
http://server_name/api/xml
?action=report-quiz-summary
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation that contains
a quiz.
|
|
|
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 />
<report-quiz-summary>
<row num-questions=integer average-score=integer low-score=integer
high-score=integer numtaken=integer numdistincttaken=integer
maxpossiblescore=integer asset-id=integer />
</report-quiz-summary>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Contains information about the quiz.
|
|
|
|
Empty, with attributes
|
Summary information about the quiz. Can
return more than one
row
element if the
maxpossiblescore
is
different for different transcripts.
|
|
|
|
Integer
|
The number of questions on the quiz.
|
|
|
|
Integer
|
The average score, across all users who
have taken the quiz.
|
|
|
|
Integer
|
The lowest score a user has received on
the quiz.
|
|
|
|
Integer
|
The highest score a user has received on
the quiz.
|
|
|
|
Integer
|
The total number of times the quiz has been
taken.
|
|
|
|
Integer
|
The number of times the quiz has been taken
by distinct principals. If a principal takes the quiz more than
once, only one time is counted.
|
|
|
|
Integer
|
The highest possible score on the quiz.
|
|
|
|
Integer
|
The ID of the latest version of the SCO
uploaded to the server.
|
Sample request
https://server.com/api/xml?action=report-quiz-summary&sco-id=2006123456
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-summary>
<row num-questions="2" average-score="0" low-score="0" high-score="0"
numtaken="1" numdistincttaken="1" maxpossiblescore="0"
asset-id="2006334911" />
<row num-questions="2" average-score="13" low-score="0" high-score="20"
numtaken="3" numdistincttaken="3" maxpossiblescore="20"
asset-id="2006334911" />
</report-quiz-summary>
</results>
report-quiz-takers
Description
Provides
information about all users who have taken a quiz in a training.
Use a
sco-id
to identify the quiz.
To reduce
the volume of the response, use any allowed filter or pass a
type
parameter
to return information about just one type of SCO (courses, presentations,
or meetings).
Request URL
http://server_name/api/xml
?action=report-quiz-takers
&sco-id=integer
&principal-id=integer
&type=allowedValue
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation or course
that contains a quiz.
|
|
|
Integer
|
N
|
The ID of a principal for whom you want
quiz results.
|
|
|
Allowed value
|
N
|
The type of content for which you want results.
Allowed values are
course
,
presentation
,
and
meeting
.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-quiz-takers>
<row transcript-id=integer sco-id=integer principal-id=integer
status=allowedValue score=integer asset-id=integer
permission-id=allowedValue attempts=integer time-taken=integer
certificate=integer answered-survey=boolean version=integer>
<name>string</name>
<login>string</login>
<date-created>datetime</date-created>
<principal-name>string</principal-name>
<override>boolean</override>
</row>
</report-quiz-takers>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all users who have taken
the quiz.
|
|
|
|
Container
|
Information about one user who has taken
the quiz.
|
|
|
|
Integer
|
The ID of the transcript on which the user’s
quiz score is recorded.
|
|
|
|
Integer
|
The unique ID of the presentation, course,
or meeting that has the quiz.
|
|
|
|
Integer
|
The ID of the user who took the quiz.
|
|
|
|
Allowed value
|
Whether the user passed or failed the most
recent attempt at the quiz. Allowed values are
user-passed
and
user-failed
.
|
|
|
|
Integer
|
The user’s score on the most recent attempt
at the quiz.
|
|
|
|
Integer
|
The ID of the version of the quiz the user
attempted.
|
|
|
|
Allowed value
|
The level of permission the user has to
access the quiz (see
permission-id
for values).
|
|
|
|
Integer
|
The number of times the user has taken the
quiz.
|
|
|
|
Integer
|
The amount of time the user spent taking
the quiz, in milliseconds.
|
|
|
|
Integer
|
The unique ID of a user’s transcript.
|
|
|
|
Boolean
|
Whether the learner completed a quiz. If
0 or false, the training does not have a quiz or the learner did
not complete it. If 1 or true, the learner completed the quiz.
|
|
|
|
Integer
|
The revision number of the quiz.
|
|
|
|
String
|
The name of the quiz.
|
|
|
|
String
|
The user’s login name on the server.
|
|
|
|
Datetime
|
The date and time of the user’s most recent
quiz attempt.
|
|
|
|
String
|
The full name of the user taking the quiz.
|
|
|
|
Boolean
|
A setting indicating whether a training
manager can change the user’s score on the quiz.
|
Sample request
https://example.com/api/xml?action=report-quiz-takers&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quiz-takers>
<row transcript-id="2006337854" sco-id="2006334909"
principal-id="2006258745" status="incomplete" score="0"
max-score="20" asset-id="2006334911" permission-id=""
attempts="4" time-taken="12593" certificate="" answered-survey="1"
version="1">
<name>California State Quiz</name>
<login>joy@acme.com</login>
<date-created>2006-05-16T11:14:47.000-07:00</date-created>
<principal-name>Joy Smith</principal-name>
<override>false</override>
</row>
</report-quiz-takers>
</results>
report-quotas
Description
Returns
information about the quotas that apply to your Adobe Connect license or
Adobe Connect hosted account. Adobe Connect enforces various quotas,
for example, the number of concurrent users in training, the number
of downloads, the number of authors, and so on.
Although your
server license determines certain quotas, you can scale your license
beyond your limit. In the response from
report-quotas
,
the
soft-limit
is the number defined by your license.
The
soft-limit
is the same as the
limit
,
unless you purchase a Burst Pack for meetings, which allows additional
participants to join past the limit, on an overage basis.
Request URL
http://server_name/api/xml
?action=report-quotas
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
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 />
<report-quotas>
<quota acl-id=integer quota-id=string used=integer
limit=allowedValue soft-limit=integer>
<date-begin>datetime</date-begin>
<date-end>datetime</date-end>
</quota>
</report-quotas>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all of the quotas set
for the account.
|
|
|
|
Container
|
Information about one quota.
|
|
|
|
Integer
|
The ID of the account on which the quota
is defined.
|
|
|
|
Allowed value
|
The name of the quota defined by the server,
ending in
-quota
.
|
|
|
|
Integer
|
The number of uses that count toward this
quota.
|
|
|
|
Integer
|
The limit at which the server does not allow
access. Has the same value as soft-limit, unless you have purchased
a Burst Pack to allow for overage. The value is either an integer
or
unlimited
.
|
|
|
|
Integer
|
The limit determined by your server license.
|
|
|
|
Datetime
|
The date and time the quota was effective
on the server.
|
|
|
|
Datetime
|
The date the quota expires.
|
Sample request
https://example.com/api/xml?action=report-quotas
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-quotas>
<quota acl-id="624520" quota-id="download-quota"
used="1" limit="unlimited" soft-limit="1000000000">
<date-begin>2004-03-09T09:45:41.047-08:00</date-begin>
<date-end>3000-01-01T00:00:00.000-08:00</date-end>
</quota>
<quota acl-id="624520" quota-id="bandwidth-quota" used="12802"
limit="unlimited" soft-limit="1000000000">
<date-begin>2006-05-31T17:00:00.943-07:00</date-begin>
<date-end>2006-06-30T17:00:00.943-07:00</date-end>
</quota>
...
</report-quotas>
</results>
report-sco-slides
Description
Returns
information about the slides in a presentation. The information
includes how many times, and how recently, each slide has been viewed.
Request URL
http://server_name/api/xml
?action=report-sco-slides
&sco-id=integer
&asset-id=integer
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a presentation.
|
|
|
Integer
|
N
|
The version number of a presentation, incremented
each time a presentation is uploaded.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-sco-slides>
<row slide=integer name=integer asset-id=integer views=integer>
<date-created>datetime</date-created>
</row>
...
</report-sco-slides>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all of the slides in a
presentation, indicating how many times and how recently a slide
has been viewed.
|
|
|
|
Container
|
Information about one slide in the presentation.
|
|
|
|
Integer
|
The number of the slide within the presentation.
|
|
|
|
Integer
|
The name of the slide in the presentation.
|
|
|
|
Integer
|
The version number of the presentation.
Each time a presentation is published, it has a new
asset-id
.
|
|
|
|
Integer
|
The number of times the slide has been viewed.
|
|
|
|
Datetime
|
The date and time the slide was last viewed.
|
Sample request
https://example.com/api/xml?action=report-sco-slides&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-sco-slides>
<row slide="1" name="1" views="4">
<date-created>2006-05-16T11:14:54.453-07:00</date-created>
</row>
<row slide="2" name="2" views="4">
<date-created>2006-05-16T11:14:59.593-07:00</date-created>
</row>
<row slide="3" name="3" views="3">
<date-created>2006-05-12T11:55:52.330-07:00</date-created>
</row>
<row slide="4" name="4" views="3">
<date-created>2006-05-12T11:55:55.487-07:00</date-created>
</row>
<row slide="5" name="5" views="3">
<date-created>2006-05-12T11:56:00.233-07:00</date-created>
</row>
</report-sco-slides>
</results>
report-sco-views
Description
Indicates
how many times, and how recently, a SCO was viewed.
Request URL
http://server_name/api/xml
?action=report-sco-views
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a SCO to check for views.
|
|
|
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 />
<report-sco-views sco-id=integer type=allowedValue is-folder=boolean
views=integer>
<name>string</name>
<last-viewed-date>string</last-viewed-date>
</report-sco-views>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about how many times, and how
recently, the presentation was viewed.
|
|
|
|
Integer
|
The unique ID of the presentation.
|
|
|
|
Allowed value
|
The type of content object (SCO). Allowed
values are
content
,
curriculum
,
event
,
folder
,
link
,
meeting
,
and
tree
.
|
|
|
|
Boolean
|
A value indicating whether the SCO is a
folder (if
1
) or another type of object (if
0
).
|
|
|
|
Integer
|
The number of times users have viewed the
SCO.
|
|
|
|
String
|
The name of the SCO.
|
|
|
|
Datetime
|
The date and time the SCO was last viewed.
|
Sample request
https://server.com/api/xml?action=report-sco-views&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-sco-views sco-id="2006334909" type="content" is-folder="0"
views="3">
<name>Quiz on California</name>
<last-viewed-date>2006-05-12T11:55:24.940-07:00</last-viewed-date>
</report-sco-views>
</results>
report-user-trainings-taken
Availability
Connect
Enterprise 6
Description
Returns
a list of all courses and curriculums a user has taken, whether
or not the user has completed the training. Each course or curriculum
is returned in a separate
row
element and has the
most recent transcript of the user’s scores.
Request URL
http://server_name/api/xml
?action=report-user-trainings-taken
&principal-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a user for whom you want a list
of trainings.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-user-trainings-taken>
<row transcript-id=integer max-retries=integer sco-id=integer
type=allowedValue icon=allowedValue status=allowedValue
certificate=integer score=integer permission-id=allowedValue
attempts=allowedValue>
<name>string</name>
<description>string</description>
<url-path>string</url-path>
<date-taken>datetime</date-taken>
<from-curriculum>boolean</from-curriculum>
</row>
...
</report-user-trainings-taken>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Allowed value
|
The type of the SCO. Allowed values are
user-content
,
content
,
and
my-content
.
|
report-user-trainings-taken
|
|
Container
|
A list of all trainings the user has attempted.
|
|
|
|
Container
|
Information about one course or curriculum
the user has taken, whether or not passed.
|
|
|
|
Integer
|
The ID of the record of the user’s most
recent score on this training.
|
|
|
|
Integer
|
The maximum number of times the user can
repeat the training.
|
|
|
|
Integer
|
The ID of the training SCO.
|
|
|
|
Allowed value
|
The type of the training SCO (see allowed
values at
type
).
|
|
|
|
Allowed value
|
The type of icon that identifies the course
or curriculum in Connect Central. Provides information about the
course or curriculum in addition to its
type
(see allowed
values at
icon
).
|
|
|
|
Allowed value
|
The status of the user’s work with the SCO.
Allowed values for a course or presentation are
user-passed
,
user-failed
,
completed
,
incomplete
,
not-attempted
,
and
review
. A curriculum or folder can only be
completed
or
incomplete
.
|
|
|
|
Integer
|
The ID of the record that shows the user
passed or completed the training.
|
|
|
|
Integer
|
The score the user earned on the most recent
attempt at the training.
|
|
|
|
Allowed value
|
The permission the user has been assigned
to access the course or curriculum (see
permission-id
for allowed
values).
|
|
|
|
Integer
|
The number of attempts the user has made
at this training.
|
|
|
|
String
|
The name of the training SCO.
|
|
|
|
String
|
The description of the training SCO.
|
|
|
|
String
|
The unique identifier of the SCO that appears
in its URL after the domain name.
|
|
|
|
Datetime
|
The date the user interacted with the training
SCO (viewed a presentation, took a quiz, and so on).
|
|
|
|
Boolean
|
A value indicating whether this course was
taken as part of a curriculum.
|
Sample request
https://example.com/api/xml?action=report-user-trainings-taken
&principal-id=2006258745&principal-id=4797406
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-user-trainings-taken>
<row transcript-id="2006745722" max-retries="" sco-id="2006745673"
type="content" icon="course" status="user-passed"
certificate="2006745722" score="0" permission-id=""
attempts="1">
<name>All About Web Communities</name>
<description>test</description>
<url-path>/p33096345/</url-path>
<date-taken>2006-06-12T15:06:02.947-07:00</date-taken>
<from-curriculum>false</from-curriculum>
</row>
...
</report-user-trainings-taken>
</results>
report-user-training-transcripts
Availability
Connect
Enterprise 6
Description
Returns
a list of transcripts for trainings a user has taken. A
transcript
is
the record of one score a user obtained from one attempt at taking
one training. A training can be a course, curriculum, meeting, or
event.
The response can include more than one transcript
for a training SCO, if the user has attempted the training more
than once. A user can fail a training the first time and then pass
on the second attempt. Each attempt has its own transcript, and both
transcripts are included in the report.
Request URL
http://server_name/api/xml
?action=report-user-training-transcripts
&principal-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of a user whose transcripts you want.
|
|
|
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 or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<report-user-training-transcripts>
<row transcript-id=integer sco-id=integer
principal-id=integer status=allowedValue score=integer
max-score=integer certificate=integer type=allowedValue
icon=allowedValue>
<name>string</name>
<url-path>string</url-path>
<login>string</login>
<date-taken>datetime</date-taken>
<principal-name>string</principal-name>
<sco-tag>string</sco-tag>
</row>
...
</report-user-training-transcripts>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
report-user-training-transcripts
|
|
Container
|
Information about all transcripts for the
specified user.
|
|
|
|
Container
|
Information about one attempt the user made on
the training.
|
|
|
|
Integer
|
The ID of the transcript on which the user’s
score is recorded. A distinct transcript exists for each of the
user’s attempts at taking the SCO.
|
|
|
|
Integer
|
The ID of the SCO, which can be a meeting,
content, course, curriculum, event, or seminar.
|
|
|
|
Integer
|
The ID of the user.
|
|
|
|
Allowed value
|
The status of the user’s work with the SCO
(see
status attribute
for allowed
values).
|
|
|
|
Integer
|
The score the user earned on the SCO. If
the SCO does not have a score, as with a meeting, the value of
score
is
0
.
|
|
|
|
Integer
|
The maximum score possible on the course
or curriculum.
|
|
|
|
Integer
|
The ID of the record of the courses and
curriculums the user has passed or completed.
|
|
|
|
Allowed value
|
The type of the SCO. Allowed values are
user-content
,
content
,
and
my-content
.
|
|
|
|
Allowed value
|
The name of the icon that identifies the
course or curriculum in Adobe Connect Central.
|
|
|
|
String
|
The name of the course or curriculum.
|
|
|
|
String
|
The unique identifier of the course or curriculum that
appears in its URL after the domain name.
|
|
|
|
String
|
The user’s login ID on Adobe Connect Server.
|
|
|
|
Datetime
|
The date the user interacted with the course
or curriculum (viewed a presentation, took a quiz, and so on).
|
|
|
|
String
|
The name of the user interacting with the
SCO.
|
|
|
|
String
|
A descriptive label for the SCO, in addition
to the name (for example, a short course name).
|
Sample request
https://example.com/api/xml?action=report-user-training-transcripts
&principal-id=2006258745
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-user-training-transcripts>
<row transcript-id="2006905612" sco-id="2006298431"
principal-id="2006258745" status="review" score="0" max-score=""
certificate="" type="content" icon="course">
<name>Test Course</name>
<url-path>/test/</url-path>
<login>joy@acme.com</login>
<date-taken>2006-06-30T15:23:55.070-07:00</date-taken>
<principal-name>Joy Smith</principal-name>
</row>
<row transcript-id="2007016805" sco-id="2006298431"
principal-id="2006258745" status="review" score="0" max-score=""
certificate="" type="content" icon="course">
<name>Test Course</name>
<url-path>/test/</url-path>
<login>joy@acme.com</login>
<date-taken>2006-07-14T16:55:28.440-07:00</date-taken>
<principal-name>Joy Smith</principal-name>
</row>
</report-user-training-transcripts>
</results>
sco-by-url
Availability
Connect
Pro 7
Description
Returns
information about a SCO at a specified URL path. The URL path is
the unique identifier after the domain name in the URL to the SCO.
For example, if you have a meeting with the custom URL
http://example.acrobat.com/teammeeting
,
the URL path is
/teammeeting
. If you pass the full
URL path, Connect returns the status code
"no data"
.
Request URL
http://server_name/api/xml
?action=sco-by-url
&url-path=url
Parameters
|
Name
|
Required
|
Description
|
|
|
Y
|
The unique identifier after the domain name
in the URL to the SCO.
|
Filters
You
cannot filter or sort the response.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<owner-principal type="allowedValue" principal-id="number" account-id="number" has-children="Boolean" is-hidden="Boolean" is-primary="Boolean">
<ext-login></ext-login>
<login></login>
<name></name>
<email></email>
</owner-principal>
- <sco sco-id="number" account-id="number" display-seq="number" folder-id="number" icon="string" lang="string" max-retries="number" source-sco-id="number" type="allowedValue" version="number">
<url-path></url-path>
<date-begin></date-begin>
<date-created></date-created>
<date-modified></date-modified>
<name></name>
</sco>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
owner-principal
|
|
Container
|
Contains information about a principal.
|
|
|
type
|
Allowed value
|
The type of principal (see
type
for values).
|
|
|
principal-id
|
Integer
|
The ID of the principal.
|
|
|
account-id
|
Integer
|
The ID of the account the principal belongs
to.
|
|
|
has-children
|
Boolean
|
Whether the principal has children. Groups
have children and users don’t, so this attribute indicates whether
the principal is a group.
|
|
|
is-hidden
|
Boolean
|
Whether the principal is hidden (
true
)
or not (
false
) in Connect Central or your application.
|
|
|
is-primary
|
Boolean
|
Whether the principal is a built-in group
(
true
) or not (
false
).
|
|
ext-login
|
|
String
|
The login ID sent from an external network.
By default, the same value as login.
|
|
login
|
|
String
|
The login name of the user who is logged
in to the server, often the user’s e-mail address.
|
|
name
|
|
String
|
The name of the user who is logged in to
the server.
|
|
e-mail
|
|
String
|
The e-mail address of the user who is logged
in to the server.
|
|
|
|
Container
|
One object within the folder.
|
|
|
|
Integer
|
The unique ID of an object.
|
|
|
account-id
|
Integer
|
The unique ID of an account.
|
|
|
display-seq
|
Integer
|
The sequence in which Connect Central or
your application displays the field.
|
|
|
folder-id
|
Integer
|
The ID of a folder.
|
|
|
icon
|
Allowed value
|
The name of the icon that visually identifies
this object.
|
|
|
lang
|
String
|
The language in which information about
the SCO is displayed (see
lang
for values).
|
|
|
max-retries
|
Integer
|
The maximum number of times a user can retake
the course or curriculum. If a user can take the course 3 times,
max-retries
is
2.
|
|
|
|
Integer
|
The unique ID of a content SCO used in a
course or curriculum.
|
|
|
|
Allowed value
|
The type of the object (see
type
for values).
|
|
|
|
Integer
|
A sequential ID for the session, starting
at 1.
|
|
|
|
String
|
The unique identifier after the domain name
in the URL to the SCO.
|
|
|
|
Datetime
|
The beginning date of a course or meeting
(returned for a course or meeting only).
|
|
|
|
Datetime
|
The date a course or meeting was created
(returned for a course or meeting only).
|
|
|
|
Datetime
|
The date the object was last modified.
|
|
|
|
String
|
The name of the object on the server.
|
Sample request
http://example.acrobat.com/api/xml?action=sco-by-url&url-path=/p18656190/
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<owner-principal type="content" principal-id="824622254" account-id="824592506" has-children="false" is-hidden="false" is-primary="false">
<ext-login>jdoe@adobe.com</ext-login>
<login>jdoe@adobe.com</login>
<name>Jane Doe</name>
<email>jdoe@adobe.com</email>
</owner-principal>
- <sco sco-id="825344405" account-id="824592506" display-seq="0" folder-id="824622258" icon="curriculum" lang="en" max-retries="" source-sco-id="" type="curriculum" version="0">
<url-path>/p18656190/</url-path>
<date-begin>2009-09-15T13:30:00.000-07:00</date-begin>
<date-created>2009-09-15T13:32:45.683-07:00</date-created>
<date-modified>2009-09-15T13:32:45.683-07:00</date-modified>
<name>Test Curriculum</name>
</sco>
</results>
sco-contents
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
|
|
|
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
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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.
-
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
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of objects within the folder.
|
|
|
|
Container
|
One object within the folder.
|
|
|
|
Integer
|
The unique ID of one object within the folder.
|
|
|
|
Integer
|
The unique ID of a content SCO used in a
course or curriculum.
|
|
|
|
Integer
|
The ID of a folder, passed as
sco-id
in
the request.
|
|
|
|
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
.
|
|
|
|
Allowed value
|
The name of the icon that identifies the
object. Provides more detail on the type of object in
type
.
|
|
|
|
Integer
|
The sequence in which Connect Central or
your application displays the object.
|
|
|
|
Boolean Integer
|
A value indicating whether the object is
a folder (
1
) or not (
0
).
|
|
|
|
Integer
|
The size of the content. For folders, this
value will be
0
.
|
|
|
|
Integer
|
The number of SCOs that reference this SCO.
|
|
|
|
String
|
The name of the object on the server.
|
|
|
|
String
|
The unique identifier after the domain name
in the URL to the SCO.
|
|
|
|
String
|
The description of the object.
|
|
|
|
Datetime
|
The date the object was last modified.
|
|
|
|
Datetime
|
The beginning date of a course or meeting
(returned for a course or meeting only).
|
|
|
|
Datetime
|
The end date of a course or meeting (returned
for a course or meeting only).
|
|
|
|
String
|
The domain name at which you can access
a meeting or event (returned for meetings and events only).
|
|
|
|
Datetime
|
The length of time a course or meeting lasted
(returned for a course or meeting only).
|
|
|
|
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>
sco-delete
Description
Deletes
one or more objects (SCOs).
If the
sco-id
you
specify is for a folder, all the contents of the specified folder are
deleted. To delete multiple SCOs, specify multiple
sco-id
parameters.
You
can use a call such as
sco-contents
to check the
ref-count
of
the SCO, which is the number of other SCOs that reference this SCO.
If the SCO has no references, you can safely remove it, and the
server reclaims the space.
If the SCO has references, removing
it can cause the SCOs that reference it to stop working, or the
server not to reclaim the space, or both. For example, if a course references
a quiz presentation, removing the presentation might make the course
stop working.
As another example, if a meeting has used a
content SCO (such as a presentation or video), there is a reference
from the meeting to the SCO. Deleting the content SCO does not free
disk space, because the meeting still references it.
To delete
a SCO, you need at least
manage
permission (see
permission-id
for details).
Users who belong to the built-in
authors
group
have
manage
permission on their own content folder,
so they can delete content within it.
Request URL
http://server_name/api/xml
?action=sco-delete
&sco-id=integer
&session=value
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a SCO.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=sco-delete&sco-id=2007171127
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
sco-expanded-contents
Availability
Breeze
5
To list the contents of a curriculum in Connect Pro 7 and
later, use
curriculum-contents
.
Description
Lists
all of the SCOs in a folder, including the contents of subfolders,
curriculums, and any type of enclosing SCO.
Note:
If
you call this command on a large folder—such as the root meeting
folder for a large account—the amount of data returned is very large.
If
you do not use a filter, the list of SCOs is returned in the same
order as it appears in Connect Central. 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
|
|
|
Integer
|
Y
|
The unique ID of a folder.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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
.
-
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
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of all SCOs the folder contains.
|
|
|
|
Container
|
Details about one SCO in the folder. This
SCO can be a folder or any other type of object.
|
|
|
|
Integer
|
The depth in the content tree at which this
object appears, with top-level objects at
1
.
|
|
|
|
Integer
|
The unique ID of the SCO. If the SCO is
a folder, same as
folder-id
.
|
|
|
|
Integer
|
The ID of the folder the SCO belongs to.
|
|
|
|
Allowed value
|
The type of this content object (see
type
).
|
|
|
|
Allowed value
|
The name of the icon that visually identifies
this object.
|
|
|
|
Allowed value
|
The language in which information about
the SCO is displayed (see
lang
for values).
|
|
|
|
Integer
|
The ID of a SCO from which this SCO was
created, such as a meeting template or course content.
|
|
|
|
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
.
|
|
|
|
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>
sco-info
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
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a SCO on the server.
|
|
|
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>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the SCO.
|
|
|
|
Integer
|
The ID of the account the SCO belongs to.
|
|
|
|
Datetime
|
An empty value if the SCO has not been disabled.
If it has, the date and time it was disabled.
|
|
|
|
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
.
|
|
|
|
Integer
|
The ID of the folder the SCO belongs to.
|
|
|
|
Allowed value
|
The type of icon used as a visual identifier
for the SCO (see
icon
).
|
|
|
|
Allowed value
|
An abbreviation for the new language (see
type
for values).
|
|
|
|
Integer
|
The number of times the user is allowed
to attempt to take the SCO.
|
|
|
|
Integer
|
The unique ID of the SCO.
|
|
|
|
Integer
|
The unique ID of a template from which the
SCO is derived.
|
|
|
|
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.
|
|
|
|
Integer
|
The version number of the SCO, incremented
when the object is modified or uploaded to the server.
|
|
|
|
Datetime
|
If the SCO is a meeting, the date and time
the meeting starts.
|
|
|
|
Datetime
|
The date and time the SCO was created (or,
for content, uploaded).
|
|
|
|
Datetime
|
If the SCO is a meeting, the date and time
the meeting ends.
|
|
|
|
Datetime
|
The date and time the SCO was last modified.
|
|
|
|
String
|
The description of the SCO entered when
the SCO was created.
|
|
|
|
String
|
The name of the SCO.
|
|
|
|
String
|
The path to the SCO on the server.
|
|
|
|
Integer
|
The minimum score that a user must have
to pass a training course.
|
|
|
|
Integer
|
The length of time needed to view or play
the SCO, in milliseconds.
|
|
|
|
Integer
|
The number of sections in the course content,
including the number of slides, pages, chapters, interactions, or
other content divisions.
|
|
|
|
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.
|
|
|
|
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
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>
sco-move
Description
Moves
a SCO from one folder to another.
To move a SCO to a folder,
the current user must have permission to create content in the target
folder. In general, users have permission on their own folders (such
as
my-meetings
,
my-courses
,
my-events
,
my-content
, and
my-meeting-templates
)
by default. To move SCOs to a shared folder such as
content
,
courses
,
and
meetings
, a user must have Manage permission
or be an Administrator.
Request URL
http://server_name/api/xml
?action=sco-move
&folder-id=integer
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the destination folder.
|
|
|
Integer
|
Y
|
The unique ID of the SCO to move.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=sco-move&sco-id=2006744233
&folder-id=2006258748
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
sco-nav
Description
Describes
the folder hierarchy that contains a SCO.
The
sco-nav
call
is useful for creating a navigation tree, breadcrumb trail, or any other
type of user interface hierarchy. The response contains a list of
sco
elements,
one for the SCO you are querying and one for each of its enclosing folders
up to the top-level folder. The top-level folder is one of the list
of folders returned by
sco-shortcuts
.
In
each
sco
element, the
depth
attribute
indicates how many hierarchical levels the SCO is from the SCO you
specify in the request. A
depth
of 0 indicates
the SCO you are querying, a
depth
of 1 indicates
the folder that contains the SCO, and so on.
Request URL
http://server_name/api/xml
?action=sco-nav
&sco-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The unique ID of a SCO for which you want
a folder hierarchy up to the root level.
|
|
|
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-nav>
<sco sco-id=integer type=allowedValue icon=allowedValue depth=integer>
<name>string</name>
</sco>
...
</sco-nav>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The entire navigation tree from the top-level
folder to the SCO.
|
|
|
|
Container
|
Information about one SCO in the hierarchy.
|
|
|
|
Integer
|
The unique ID of the SCO.
|
|
|
|
Allowed value
|
The type of SCO (see
type
for values).
|
|
|
|
Allowed value
|
The icon that visually represents the SCO
(see
icon
for values).
|
|
|
|
Integer
|
A number representing the level of a SCO
in the folder hierarchy relative to the SCO passed in the request
(
0
for the passed SCO,
1
for one
level above, and so on). Values increase as you move up the hierarchy
toward the top-level folder.
|
|
|
|
String
|
The name of the SCO.
|
Sample request
https://example.com/api/xml?action=sco-nav&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<sco-nav>
<sco sco-id="624522" type="folder" icon="folder" depth="2">
<name>User Content</name>
</sco>
<sco sco-id="2006258747" type="folder" icon="folder" depth="1">
<name>joy@acme.com</name>
</sco>
<sco sco-id="2006334909" type="content" icon="producer" depth="0">
<name>Test Quiz</name>
</sco>
</sco-nav>
</results>
sco-search
Description
Provides
a list of all SCOs that have content matching the search text.
The
sco-search
action
searches the content of some types of SCOs for the query string.
The types of SCOs searched include presentation archives, meeting archives,
and the presentation components of a course or curriculum. A presentation
that is included in a course returns two sets of results, one for
the actual presentation and one for the course. The search does
not include the SCO name or any metadata about the SCO stored in
the database.
The query is not case-sensitive and allows wildcards
at the end of a query string. The allowed wildcards are:
For
example, you can use the query strings
quiz
,
qu*
,
or
qui?
. However, you cannot use a wildcard at the beginning
or within a query string.
You can also use the operators
and
and
or
to
return multiple matches, with spaces separating the operator and
the search terms, like this:
https://example.com/api/xml?action=sco-search&query=quiz or test
If
you search on
quizortest
, for example, the server interprets
it as a literal string and returns only exact matches.
Request URL
http://server_name/api/xml
?action=sco-search
&query=querystring
&filter-definition=value
&sort-definition=value
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Query string
|
Y
|
A string to search for. To use any of these
special characters in the query string, escape them with a backslash
before the character:
+ - && || ! ( ) { } [ ] ^ " ~ *
? : \
The
query string is not case-sensitive and allows wildcard characters
* and ? at the end of the query string.
|
|
|
Filter definition
|
N
|
A filter to reduce the volume of the response.
|
|
|
Sort definition
|
N
|
A sort to return results in a certain sequence.
|
|
|
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 it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<sco-search-info>
<sco sco-id=integer folder-id=integer type=allowedValue
icon=allowedValue byte-count=integer tree-type=integer>
<name>string</name>
<url-path>string</url-path>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<hit>integer</hit>
<hit-type>allowedValue</hit-type>
<thumbnail-path>string</thumbnail-path>
</sco>
</sco-search-info>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of objects (SCOs) that match the
search query.
|
|
|
|
Container
|
Details about one object that matches the
search.
|
|
|
|
Integer
|
The unique ID of the SCO.
|
|
|
|
Integer
|
The ID of the folder in which the SCO is
stored.
|
|
|
|
Allowed value
|
The content type assigned to the SCO (see
type
for values).
|
|
|
|
Allowed value
|
The icon that visually identifies the SCO
in a user interface.
|
|
|
|
Integer
|
The size of the SCO, in bytes.
|
|
|
|
Integer
|
The tree type.
|
|
|
|
String
|
The file name of the SCO.
|
|
|
|
String
|
The unique identifier that comes after the
domain name in the SCO URL.
|
|
|
|
Datetime
|
The date the SCO was created.
|
|
|
|
Datetime
|
The date the SCO was modified.
|
|
|
|
Integer
|
The sequence number of this occurrence of
the query string in the SCO.
|
|
|
|
Allowed value
|
The type of content in which the search
term was found. Allowed values are
metadata
and
slide
.
|
|
|
|
String
|
A relative URL to the position where the
search term was found in the content, for example, to a specific
slide. Must be appended to the
url-path
.
|
|
|
|
String
|
A relative URL to an image of the SCO that
contains the search term.
|
Sample request
https://example.com/api/xml?action=sco-search&query=quiz
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<sco-search-info>
<sco sco-id="5677964" folder-id="2562850" type="content"
icon="producer" byte-count="5985" tree-type="13">
<name>Final Quiz</name>
<url-path>/p46125962/</url-path>
<date-created>2005-05-09T14:24:36.390-07:00</date-created>
<date-modified>2005-05-09T14:24:36.390-07:00</date-modified>
<hit>0</hit>
<hit-type>metadata</hit-type>
</sco>
<sco sco-id="5677964" folder-id="2562850" type="content"
icon="producer" byte-count="5985">
<name>Final Quiz</name>
<url-path>/p46125962/</url-path>
<date-created>2005-05-09T14:24:36.390-07:00</date-created>
<date-modified>2005-05-09T14:24:36.390-07:00</date-modified>
<hit>7</hit>
<hit-type>slide</hit-type>
<hit-url>slide=7</hit-url>
</sco>
...
</sco-search-info>
</results>
sco-search-by-field
Availability
Acrobat
Connect Pro 7
Description
Provides
a list of all SCOs matching the search text within the specified
field. This action allows you to search for objects in the database
based on the SCO’s name, description, or author, or all three of
those fields.
The
sco-search-by-field
action
searches the content of some types of SCOs for the query string.
The search includes folders, training courses, curriculums, meetings,
content, and archives.
To search for multi-word terms with
spaces between the words, search only on the first word in the term
and use a wildcard at the end. For example, to search for
Sales Presentation
,
use the following string:
query=sales*
Note:
The sco-search-by-field command does not support
the and/or operators.
Request URL
http://server_name/api/xml
?action=sco-search-by-field
&query=SearchTerm
&field=allowedValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
query
|
String
|
Y
|
The term to search for within the specified
field. The query is case-insensitive.
|
|
field
|
String
|
N
|
The field to search. Accepts four possible
values:
name
,
description
,
author
,
or
allfields
:
-
name
searches
only the name field for SCOs.
-
description
searches only the description
field for SCOs.
-
author
matches the full name field (not
the first-name or last-name fields) of the principal that created
the SCOs.
-
allfields
searches the
name
,
description
,
and
author
fields.
If this
parameter is omitted, the
name
field is searched.
|
Filters
Filters
are supported on any field that can be returned. For example, you
can use
&filter-gt-date-created=2007-09-12T08:00:00.000
if
you want to show only results created after 8:00 AM on September
12, 2007.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<sco-search-info>
<sco sco-id=integer tree-id=integer folder-id=integer type=allowedValue status=allowedValue sco-data-id=integer source-sco-id=integer host-id=integer author-contact-id=integer learning-time=allowedValue lang=allowedValue seq-id=integer icon=allowedValue display-seq=integer max-retries=integer version=integer account-id=integer tree-type=integer>
<name>string</name>
<url-path>string</url-path>
<date-created>datetime</date-created>
<date-modified>datetime</date-modified>
<principal-name>string</principal-name>
<folder-name>string</folder-name>
</sco>
</sco-search-info>
</results>
Response value
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
The list of objects (SCOs) that match the
search query.
|
|
|
|
Container
|
Details about one object that matches the
search.
|
|
|
|
Integer
|
The unique ID of the SCO.
|
|
|
|
Integer
|
The ID of the folder in which the SCO is
stored.
|
|
|
|
Allowed value
|
The content type assigned to the SCO (see
type
for values).
|
|
|
|
Allowed value
|
The icon that visually identifies the SCO
in a user interface.
|
|
|
|
String
|
The file name of the SCO.
|
|
|
|
String
|
The unique identifier that comes after the
domain name in the SCO URL.
|
|
|
|
Datetime
|
The date the SCO was created.
|
|
|
|
Datetime
|
The date the SCO was last modified.
|
|
|
|
String
|
The author of the SCO.
|
|
|
|
String
|
The name of the folder in which the SCO
is stored.
|
Sample request
https://example.com/api/xml?action=sco-search-by-field&query=Marketing*&field=description
Sample response
<results>
<status code="ok"/>
<sco-search-by-field-info>
<sco sco-id="2007775205" tree-id="" folder-id="2007470298" type="meeting" status="" sco- data-id="" source-sco-id="2007470292" host-id="" author-contact-id="" learning-time="" lang="en" seq-id="" icon="virtual-classroom" display-seq="0" max-retries="" version="0" account-id="2007470268" tree-type="4">
<name>virt1</name>
<url-path>/r72655596/</url-path>
<date-created>2007-10-10T16:41:31.643-07:00</date-created>
<date-modified>2007-10-10T16:41:31.643-07:00</date-modified>
<principal-name>Piet Pompies</principal-name>
<folder-name>ppompies@adobe.com</folder-name>
</sco>
<sco sco-id="2007775257" tree-id="" folder-id="2007775254" type="folder" status="" sco-data-id="" source-sco-id="" host-id="" author-contact-id="" learning-time="" lang="en" seq-id="" icon="folder" display-seq="0" max-retries="" version="0" account-id="2007470268">
<name>test1</name>
<url-path>/f13818712/</url-path>
<date-created>2007-10-10T18:00:31.083-07:00</date-created>
<date-modified>2007-10-10T18:00:31.083-07:00</date-modified>
<principal-name>trainer two</principal-name>
<folder-name>trainer@two.com</folder-name>
</sco>
</sco-search-by-field-info>
</results>
sco-shortcuts
Description
Provides
information about the folders relevant to the current user. These
include a folder for the user’s current meetings, a folder for the
user’s content, as well as folders above them in the navigation
hierarchy.
To determine the URL of a SCO, concatenate the
url-path
returned
by
sco-info
,
sco-contents
, or
sco-expanded-contents
with
the
domain-name
returned by
sco-shortcuts
.
For example, you can concatenate these two strings:
-
http://test.server.com
(the
domain-name
returned
by
sco-shortcuts
)
-
/f2006123456/
(the
url-path
returned
by
sco-info
,
sco-contents
, or
sco-expanded-contents
)
The
result is this URL:
http://test.server.com/f2006123456/
You
can also call
sco-contents
with the
sco-id
of
a folder returned by
sco-shortcuts
to see the contents
of the folder.
Request URL
http://server_name/api/xml
?action=sco-shortcuts
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
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=code />
<shortcuts>
<sco tree-id=integer sco-id=integer type=allowedValue>
<domain-name>string</domain-name>
</sco>
...
</shortcuts>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all of the folders that
relate to the current user.
|
|
|
|
Container
|
Information about one of the current user’s
folders.
|
|
|
|
Integer
|
The ID of the navigation tree that contains
the folder. Several folders might have the same
tree-id
.
|
|
|
|
Integer
|
The unique ID of the folder.
|
|
|
|
Allowed value
|
The type of the folder. Allowed values are
shown in the following table.
|
|
|
|
String
|
The domain name of the folder.
|
The values that can be returned in the
type
attribute
of the
sco
element (for this call only,
sco-shortcuts
)
identify Adobe Connect folders. Each folder type maps to a folder
in Connect Central and requires certain permission levels to access,
described in the following table.
|
Value of type
|
Description
|
|
|
Customized content for an account, such
as a customized login page, banner, and so on.
|
|
|
The Shared Content folder. Requires Administrator
privilege or Manage permission.
|
|
|
The Shared Training folder. Requires Administrator
privilege or Manage permission.
|
|
|
The Shared Events folder. Requires Administrator
privilege or Manage permission.
|
|
|
The Shared Meetings folder. Requires Administrator
privilege or Manage permission.
|
|
|
The My Training folder. By default, the
individual user has Manage permission.
|
|
|
The My Content folder. By default, the individual
user has Manage permission.
|
|
|
The My Events folder. By default, the individual
user has Manage permission.
|
|
|
The My Meetings folder. By default, the
individual user has Manage permission.
|
|
|
The My Templates folder. By default, the
individual user has Manage permission.
|
|
|
The Shared Seminars folder. Requires Administrator
privilege or Manage permission.
|
|
|
The Shared Templates folder. Inherits permissions
from Shared Meetings.
|
|
|
Contain the user content folders.
|
|
|
Contain the user courses folders.
|
|
|
Contain the user events folders.
|
|
|
Contain the user meeting folders.
|
Sample request
http://example.com/api/xml?action=sco-shortcuts
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<shortcuts>
<sco tree-id="4930295" sco-id="2006258748" type="my-courses">
<domain-name>http://example.com</domain-name>
</sco>
<sco tree-id="4930293" sco-id="2006258749" type="my-events">
<domain-name>http://example.com</domain-name>
</sco>
...
</shortcuts>
</results>
sco-update
Description
Creates
metadata for a SCO, or updates existing metadata describing a SCO.
Call
sco-update
to
create metadata only for SCOs that represent content, including
meetings. You also need to upload content files with either
sco-upload
or Connect Central.
You
must provide a
folder-id
or a
sco-id
,
but not both. If you pass a
folder-id
,
sco-update
creates
a new SCO and returns a
sco-id
. If the SCO already
exists and you pass a
sco-id
,
sco-update
updates
the metadata describing the SCO.
To create a course, pass
type=content&icon=course
,
as in the following:
https://example.com/api/xml?action=sco-update&name=AutomatedCourse&type=content&icon=course&folder-id=20002&source-sco-id=23510
After
you create a new SCO with
sco-update
, call
permissions-update
to specify
which users and groups can access it.
Request URL
http://server_name/api/xml
?action=sco-update
&author-info-1=string
&author-info-2=string
&author-info-3=string
&date-begin=datetime
&date-end=datetime
&description=string
&email=string
&first-name=string
&folder-id=integer
&icon=allowedValue
&lang=allowedValue
&last-name=string
&name=string
&sco-id=integer
&sco-tag=string
&source-sco-id=integer
&type=allowedValue
&url-path=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
N
|
Information about the author. Used only
with presentations. Can be used for the author’s name or any other
information.
|
|
|
String
|
N
|
Additional information about the author.
Used only with presentations. Can be used for the author’s professional
title or any other information.
|
|
|
String
|
N
|
Additional information about the author.
Used only with presentations. Can be used for the author’s company
name or any other information.
|
|
|
Datetime
|
N
|
The scheduled beginning date and time, in
ISO
8601
format. Used only for meetings and courses.
|
|
|
Datetime
|
N
|
The scheduled ending date and time, in
ISO
8601
format. Used only for meetings and courses.
|
|
|
String
|
N
|
A description of the SCO to be displayed
in the user interface.
|
|
|
String
|
N
|
The e-mail address of the contact person
for a presentation (used only with presentation SCOs).
|
|
|
String
|
N
|
The first name of the contact person for
a presentation (used only with presentation SCOs).
|
|
|
Integer
|
Y/N
|
The ID of the folder in which a new SCO
will be stored. Required for a new SCO, but do not use for an existing
SCO.
|
|
|
Allowed value
|
N
|
An abbreviation for the language associated
with the SCO (see
lang
for values). If not
specified, the default value for the folder in which the SCO is
created is used.
|
|
|
Allowed value
|
N
|
The visual symbol used to identify a SCO
in Connect Central; also provides information about the SCO in addition
to its type.
|
|
|
String
|
N
|
The last name of the contact person for
a presentation (used only with presentations).
|
|
|
String
|
Y/N
|
The name of the SCO, with or without spaces.
Required to create a SCO.
|
|
|
Integer
|
Y/N
|
The unique ID of a SCO to update. Use
sco-id
or
folder-id
,
but not both. Required to update an existing SCO.
|
|
|
String
|
N
|
A label for any information you want to
record about a course. Use only with courses.
|
|
|
Integer
|
N
|
The unique ID of a template you can use
to create a meeting or a piece of content from which you can build
a course.
|
|
|
Allowed value
|
N
|
The type of the new SCO (for allowed values,
see
type
). The default value is
content
.
|
|
|
String
|
N
|
The custom part of the URL to the meeting
room that comes after the domain name. The
url-path
must
be unique within the folder. If not specified, the server assigns
a value.
|
|
|
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 folder-id=integer lang=allowedValue type=allowedValue
sco-id=integer version=integer account-id=integer icon=integer>
<url-path>string</url-path>
<description>string</description>
<name>string</name>
</sco>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about a new SCO just created,
including the
sco-id
. Returned only if you create
a SCO.
|
|
|
|
Integer
|
The ID of the folder in which the new SCO
is stored.
|
|
|
|
Allowed value
|
A code for the language associated with
the SCO (see
lang
for values).
|
|
|
|
Allowed value
|
The type of the new SCO (see
type
for values).
|
|
|
|
Allowed value
|
The unique ID of the new SCO.
|
|
|
|
Integer
|
The version number of the new SCO. When
the SCO is first created, the
version
is
0
.
|
|
|
|
Integer
|
The ID of the account in which the new SCO
is created.
|
|
|
|
Integer
|
The type of icon that identifies a new SCO
in Connect Central (see
icon
for values).
|
|
|
|
String
|
The part of the SCO URL that comes after
the domain name and uniquely identifies the SCO.
|
|
|
|
String
|
A text description of the SCO.
|
|
|
|
String
|
The name of the SCO.
|
Sample request
https://example.com/api/xml?action=sco-update&folder-id=2006258747
&description=test&name=More About Web Communities&type=content
&lang=en
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<sco folder-id="2006258747" account-id="624520" type="content" lang="en"
icon="content" sco-id="2006752036" version="0">
<url-path>/p53884157/</url-path>
<description>test</description>
<name>More About Web Communities</name>
</sco>
</results>
sco-upload
Description
Uploads
a file to the server and then builds the file, if necessary.
If
you are adding a new file, call
sco-update
first
and pass the
sco-id
returned to
sco-upload
.
If you are updating the content of a file that already exists on
the server, you can call
sco-upload
directly.
You
must call
sco-upload
within an HTML
form
element.
The
form
element must have an encoding type of
multipart/form-data
.
The HTML form must also have an
input
element with
name=file
,
as this example shows:
<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. To
upload multiple files (for example, a PPT and a PPC file), you must
use additional
input
elements with
name=file
,
for example:
<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>
After the upload, call
sco-info
to get the status
of the SCO. The status is initially
in-progress
,
which means that the content is being built. When the status becomes
active
,
the content build is finished, and users can access the content.
Request URL
http://server_name/api/xml
?action=sco-upload
&file=formElementName
&sco-id=integer
&summary=string
&title=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Form element name
|
Y
|
The file to upload, sent from an
input
element
with
name=file
in an HTML form. The HTML form must
also have an encoding type of
multipart/form-data
defined
in the
form
element.
|
|
|
Integer
|
Y
|
The ID of the SCO you want to upload, returned
by
sco-update
.
|
|
|
String
|
N
|
A brief description of the SCO that Connect
Central or your application displays.
|
|
|
String
|
N
|
The title of the SCO.
|
|
|
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 />
<files>
<file>
<path>string</path>
</file>
</files>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about all of the uploaded files.
Deprecated and may be removed in a future release.
|
|
|
|
Container
|
Information about one file. Deprecated and
may be removed in a future release.
|
|
|
|
String
|
The path to the newly uploaded file. For
Adobe internal use only. Deprecated and may be removed in a future
release.
|
Sample request
This
request is created by uploading a file through an HTML form:
http://example.com/api/xml?action=sco-upload&sco-id=2006768386
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<files>
<file>
<path>624520/2006768386-10/input/WhatMakesAGreatFilm.ppt</path>
</file>
</files>
</results>
user-accounts
Description
Provides
a list of the accounts a user belongs to.
The
user-accounts
action
is only used when a user belongs to more than one account on the
server and uses the same login ID and password for each. In that case,
a user’s login is likely to fail with a status message of
too-much-data
.
This action is useful when you want to retrieve a list of a user’s
accounts and give the user a choice of which account to log in to.
Request URL
http://server_name/api/xml
?action=user-accounts
&login=string
&password=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
String
|
Y
|
The user’s login name, which may be the
user’s e-mail address.
|
|
|
String
|
Y
|
The user’s password.
|
|
|
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. The default sort is by
account-name
.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue />
<users>
<user user-id=integer account-id=integer>
<name>string</name>
<date-expired>datetime</date-expired>
</user>
...
</users>
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
|
|
|
Container
|
Information about the accounts the user
belongs to.
|
|
|
|
Container
|
Information about a user and an account.
|
|
|
|
Integer
|
The ID of the user on the server.
|
|
|
|
Integer
|
The ID of the account the user belongs to.
|
|
|
|
String
|
The name of the account the user belongs
to.
|
|
|
|
Datetime
|
The date and time the user’s login expires.
|
Sample request
https://sample.com/api/xml?action=user-accounts&login=joy@acme.com
&password=bigdog
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<users>
<user user-id="2006258745" account-id="624520">
<name>Test Account</name>
<date-expired>2999-12-31T16:00:00.000-08:00</date-expired>
</user>
</users>
</results>
user-transcript-update
Description
Overrides
the score on an item within a curriculum.
For example, you
can use
user-transcript-update
to give a user a
score for an external training. This action works only for items
within a curriculum, and you need
manage
permission
for the curriculum.
Request URL
http://server_name/api/xml
?action=user-transcript-update
&curriculum-id=integer
&sco-id=integer
&status=allowedValue
&score=integer
&principal-id=integer
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
N
|
The ID of the curriculum.
|
|
|
Integer
|
Y
|
The unique ID of a SCO with a score you
want to override.
|
|
|
Allowed value
|
Y
|
A value showing the status of the user’s
attempt to use this SCO. Allowed values are
completed
,
incomplete
,
user-passed
,
user-failed
,
and
not-attempted
.
|
|
|
Integer
|
Y
|
An integer value that represents the score
the user has attained on this SCO.
|
|
|
Integer
|
Y
|
The ID of the user whose transcript will
be overridden.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
https://example.com/api/xml?action=user-transcript-update
&curriculum-id=2006298444&sco-id=2006298445&status=user-passed
&principal-id=2006258745&score=100
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
user-update-pwd
Description
Changes
a user’s password. A password can be changed in either of these
cases:
-
By an Administrator logged in to the account,
with or without the user’s old password
-
By any Adobe Connect Server user, with the user’s
principal-id
number, login
name, and old password
An Administrator can create
rules for valid passwords on the server. These rules might include,
for example, the number and types of characters a password must contain.
If a user submits a new password that does not adhere to the rules, Adobe
Connect would throw an error showing that the new password is invalid.
When
you call
user-update-pwd
, the password is sent
over HTTP or HTTPS in hashed form.
Request URL
http://server_name/api/xml
?action=user-update-pwd
&user-id=integer
&password-old=string
&password=string
&password-verify=string
&session=BreezeSessionCookieValue
Parameters
|
Name
|
Type
|
Required
|
Description
|
|
|
Integer
|
Y
|
The ID of the user.
|
|
|
String
|
Y/N
|
The user’s current password. Required for
regular users, but not for Administrator users.
|
|
|
String
|
Y
|
The new password.
|
|
|
String
|
Y
|
A second copy of the new password, for verification.
|
|
|
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 />
</results>
Response values
|
Element
|
Attribute
|
Type
|
Description
|
|
|
|
Container
|
All results the action returns.
|
|
|
|
Empty, with attributes
|
The status of the response.
|
|
|
|
Allowed value
|
A code indicating the response status (see
status
).
|
Sample request
This
request can be used by an Administrator to change a user’s password without
knowing the old password:
https://example.com/api/xml?action=user-update-pwd&user-id=12345&password=newone&password-verify=newone
Sample response
This
response shows that the change was successful:
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
|
|
|
