access
Description
An attribute describing the level of access
a user has to a course or curriculum.
Values
Value
|
Description
|
|
The course or curriculum is restricted and
users cannot take it.
|
|
The course or curriculum is restricted,
users cannot take it, and it is hidden in Adobe Connect Central
(or the user interface of a custom application, if you use this
value).
|
|
The course or curriculum is open and users
can take it.
|
|
The course or curriculum is optional.
|
|
The user has already taken the course or
curriculum and passed it.
|
feature-id
Description
An
attribute describing a feature that either users can use or things
that can occur during a meeting. Use
feature-id
with
the
meeting-feature-update
action.
For
more information on the pods that can be enabled or disabled, see
the
Adobe Connect User Guide
.
Values
Value
|
Description of functionality when value
is enabled
|
|
Lets a host start and stop the recording
of a meeting. Disabling this setting means that recording settings
are not controllable by the host.
To set Connect to automatically
record all meetings, you must both disable
fid-archive
and enable
fid-archive-force
.
|
|
Sets all meetings to be recorded upon the
start of the meeting. Recorded meetings appear in Adobe Connect
Central.
|
|
When meetings are set to be automatically
recorded (by enabling
fid-archive-force
), lets
host create a link to the recording in the meeting folder.
|
|
Creates a transcript file (one per meeting
session) of all text messages exchanged in Chat, Q&A, and IM
Pods.
|
|
Lets host request control of attendee's
input device (mouse or keyboard) when attendee is sharing their
screen, desktop, or application.
|
|
Lets hosts enable the option to automatically
promote participants to presenters.
|
|
Allows users to create breakout meetings.
|
|
Enables the Chat pod.
|
|
Automatically clears Chat pod history when
a new session of an existing meeting is started.
|
fid-meeting-chat-presenter
|
Lets users send chat messages only to the
presenter.
|
|
Lets users send chat messages to specific
attendees.
|
|
Lets users send chat messages to all attendees.
|
fid-meeting-desktop-sharing
|
Lets users share their screen (both the
complete desktop and individual applications).
|
|
Lets users use Call Out and Call Me features.
|
|
Shows a disclaimer (for example, explaining
that the meeting is being recorded) when a user starts or attends
any meeting in this account. To proceed with the meeting, the host
or attendees must first accept the disclaimer. If a user does not
accept, the disclaimer user is returned to the Connect home page.
To
set the text of the disclaimer, use the
meeting-disclaimer-update
action.
|
fid-meeting-enhanced-rights
|
Lets host change the access of attendees
to specific subfeatures.
|
|
Enables the File Share pod.
|
|
Lets users use FLV files and mp3 files in
the meeting.
|
fid-meeting-full-screen-affects-all
|
Enables "Presenter Changes affect everyone"
for full-screen mode. Note: this feature does not enable or disable
users’ ability to enter full-screen mode.
|
|
Lets hosts place participants on hold.
|
|
Lets a host change the display of the host’s
cursor.
|
|
Enables the Instant Messages pod. This feature
is part of the Adobe Connect integration with supported Microsoft
real-time communication servers.
Disable this feature when
you want to show the Invitee List pod (
fid-meeting-invitee-presence=true
)
but hide the associated Instant Messages pod.
|
fid-meeting-invitee-presence
|
Enables the Invitee List pod and the associated
Instant Messages pod. This feature is part of the Adobe Connect
integration with supported Microsoft real-time communication servers.
|
|
Enables the "Manage Room with Web Manager"
link in the meeting menu.
|
|
Enables the Notes pod.
|
|
Automatically clears Notes pod history when
a new session of an existing meeting is started.
|
fid-meeting-passcode-notallowed
|
Meeting hosts can assign passcodes to meetings
in Connect Central. However, by default, this feature is disabled.
Account Administrators can enable the feature in Connect Central
or you can pass this feature ID and set
enable=false
.
|
fid-meeting-pause-annotate
|
Lets users pause during screen sharing and
annotate on an overlay white board.
|
|
Enables the Attendee List pod.
|
|
Enables the Poll pod.
|
|
Enables the use of the Presenter-Only area.
|
|
Enables Preparing Mode, which lets hosts
change the meeting layout without affecting other users’ layouts.
When the layout is ready, disable this mode to show the layout to
all users.
|
|
Automatically clears Q & A pod history
when a new session of an existing meeting is started.
|
|
Enables the Q & A pod.
|
|
Lets a host change a meeting room background.
Backgrounds are typically set in the meeting template.
|
|
Enables custom pods.
|
fid-meeting-shared-library
|
Lets users select documents from the Content
Library while in the Share pod. (This setting doesn't affect the
File Share pod.)
|
fid-meeting-shared-upload
|
Lets users upload documents to the Content
Library while in the Share pod. (This setting doesn't affect the
File Share pod.)
|
|
Lets hosts enable or disable the "Who’s
Speaking" area in a meeting.
|
fid-meeting-show-talker-area
|
Enables the "Who’s Speaking" area.
|
|
Enables the Camera pod.
|
|
Enables voice controls within the meeting
user interface, such as the ability to broadcast audio using VoIP.
|
|
Enables the Web Links pod.
|
|
Enables use of the white board in the Share
pod.
|
|
Lets a user start the meeting again after
the host ends the meeting.
|
|
Enables open enrollment, which lets users
enroll themselves in a course without approval from the Training
Manager.
Disabling this feature for an account means that
a training manager cannot change the settings of a course in Adobe
Connect Central to let learners enroll without approval.
|
fid-archive-localdownload-notallowed
|
Enables or disables downloading of recordings
locally.
|
field
Description
An
element containing information about a custom field defined for
an object or principal.
Attributes
Attribute
|
Type
|
Description
|
|
Allowed value
|
The permission needed to access the custom
field. See
permission-id
for valid values.
|
|
Allowed value
|
A definition for a valid object on the server
(see
type
for values).
|
|
String
|
A piece of text that identifies the custom
field. Adobe Connect Central does not display the
field-id
,
but various actions return it.
|
|
Integer
|
An ID for the user who is presently logged
in, assigned by the server.
|
|
Integer
|
The order in which the custom field is displayed
in the user interface or returned by the action.
|
|
String
|
The type of data the field accepts. Allowed
values are
text
,
textarea
, and
password
.
|
|
Boolean
|
Whether the custom field can be deleted.
true
means
the field cannot be deleted.
false
means it can.
|
|
Boolean
|
Whether the custom field is required.
true
means
a value must be specified for this field in each principal or SCO
that uses it.
false
means values for this field
are not required.
|
|
Integer
|
The custom field’s ID in an access control
list (ACL).
|
|
Integer
|
The sequence number assigned to the custom
field in UI display.
|
|
String
|
The type of custom field (see
type
for values).
|
|
Integer
|
The ID of the principal for whom the custom
field is defined.
|
icon
Description
The symbol used to identify a SCO in Connect
Central.
Values
Value
|
Description
|
|
An archive of an Adobe Connect meeting.
|
|
A piece of content uploaded as an attachment.
|
|
A piece of multimedia content created with
Macromedia® Authorware® from
Adobe.
|
|
A demo or movie created with Adobe Captivate™ .
|
|
A training course.
|
|
A curriculum.
|
|
An external training that can be added to
a curriculum.
|
|
A media file in the FLV file format.
|
|
An HTML file.
|
|
An image.
|
|
A piece of content from an external learning
management system.
|
|
A custom logo used in a meeting room or
Adobe Connect Central.
|
|
A custom look and feel for a meeting.
|
|
An MP3 file.
|
|
An Adobe Portable Document Format file.
|
|
A visual box that provides functionality
in a meeting room layout.
|
|
A presentation created with an earlier version
of Adobe Breeze® software.
|
|
A presentation created with Adobe Presenter.
|
|
A seminar created with Adobe Connect Seminars.
|
|
One occurrence of a recurring Adobe Connect
meeting.
|
|
A SWF file.
|
lang
Description
A two-letter or three-letter code describing
a language according to the ISO 639 specifications. ISO 639-1 describes
two-letter codes, and ISO 639-2 describes three-letter codes. The
language code affects a Adobe Connect application display, for example,
a meeting room or a Adobe Connect Central display.
Values
Two-Letter Value
|
Three-Letter Value
|
Language
|
|
|
English
|
|
|
French (do not use
fra
)
|
|
|
German (do not use
deu
)
|
|
|
Japanese
|
|
|
Korean
|
object-type
Description
An attribute describing the type of a
Adobe Connect object.
Values
Value
|
Meaning
|
|
An account that contains principals and
SCOs.
|
|
An action in the Web Services XML API.
|
|
An Adobe Connect event.
|
|
A SCO that is not visible in Adobe Connect
Central (or in your application, if you use this value).
|
|
An Adobe Connect meeting.
|
|
A user or group.
|
|
A setting indicating that Adobe Connect
Central displays some data, but a user cannot set the data in Adobe
Connect Central.
|
|
A SCO representing a meeting, course, curriculum,
piece of content, folder, or any other object on the server.
|
path-type
Description
The
path-type
attribute
describes a type of learning path between two objects in a curriculum,
for example, whether one must be completed as a prerequisite to
the next.
Values
Value
|
Meaning
|
|
The current SCO is not a completion requirement
for the curriculum.
|
|
The current SCO is a completion requirement.
|
|
The current learning object has no prerequisites.
|
|
The current SCO has a prerequisite that
must be completed.
|
|
The target learning object is required as
a prerequisite. The current learning object is hidden until the
target learning object is completed.
|
|
The current SCO has a prerequisite that
is recommended, not required.
|
|
The current SCO has a test-out. If the enrollee
passes, this item is locked. If the enrollee fails, this item is
available.
|
|
The current SCO has no test-outs.
|
|
The current SCO has a test-out. If the user
passes, the current SCO can be hidden from the user. If the user fails,
the current SCO is visible and the user can enroll.
|
|
The current SCO has a test-out. If the user
passes, the current SCO is no longer required to complete the curriculum.
|
permission-id
Description
The
permission-id
parameter
(or attribute) defines a permission. Depending on the context of
the action or response, the permission might be one a principal has
on a SCO, or a permission that is needed in order to execute an
action.
Values
Permission
|
Description
|
|
The principal can view, but cannot modify,
the SCO. The principal can take a course, attend a meeting as participant, or
view a folder’s content.
|
|
Available for meetings only.
The
principal is host of a meeting and can create the meeting or act
as presenter, even without
view
permission on the
meeting’s parent folder.
|
|
Available for meetings only.
The
principal is presenter of a meeting and can present content, share
a screen, send text messages, moderate questions, create text notes,
broadcast audio and video, and push content from web links.
|
|
Available for meetings only.
The
principal does not have participant, presenter or host permission
to attend the meeting. If a user is already attending a live meeting,
the user is not removed from the meeting until the session times out.
|
|
Available for SCOs other than meetings.
The
principal can publish or update the SCO. The
publish
permission includes
view
and
allows the principal to view reports related to the SCO. On a folder,
publish
does
not allow the principal to create new subfolders or set permissions.
|
|
Available for SCOs other than meetings or courses.
The
principal can view, delete, move, edit, or set permissions on the
SCO. On a folder, the principal can create subfolders or view reports
on folder content.
|
|
Available for SCOs other than meetings.
The
principal cannot view, access, or manage the SCO.
|
Special permissions
The
server defines a special principal,
public-access
,
which combines with values of
permission-id
to
create special access permissions to meetings:
-
principal-id=public-access
and
permission-id=view-hidden
means
the Adobe Connect meeting is public, and anyone who has the URL
for the meeting can enter the room.
-
principal-id=public-access
and
permission-id=remove
means
the meeting is protected, and only registered users and accepted guests
can enter the room.
-
principal-id=public-access
and
permission-id=denied
means
the meeting is private, and only registered users and participants
can enter the room.
quota-ID
Description
The
quota-ID
parameter
defines a quota in the system. The quota type you specify determines
the value of
acl-id
to use.
Values
Quota type
|
Quota description
|
Corresponding acl-id to use
|
live-user-quota
|
The number of account-wide Meeting Attendees.
|
The account-id of the account.
|
concurrent-user-per-meeting-quota
|
The number of concurrent users in one meeting.
|
The tree-id of the user-meetings tree or meetings
tree.
|
training-user
|
The number of concurrent Learners for one account.
|
The account-id of the account.
|
num-of-members-quota
|
The number of Authors or Meeting Hosts.
|
The principal-id for either the Authors
group or the Meeting Hosts (live-admins), depending on which quota
you want to specify.
|
status
Description
A status code returned by Adobe Connect
in the response to all actions in the Web Services XML API.
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue >
</results>
or
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code=allowedValue>
<invalid field=string type=allowedValue subcode=allowedValue />
</status>
</results>
Attributes
-
code
-
The status of the response.
Value
|
Description
|
|
Indicates that a call is invalid in some
way. The
invalid
element provides more detail.
|
|
Indicates that you don’t have permission
to call the action. The
subcode
attribute provides
more details.
|
|
Indicates that there is no data available
(in response to an action that would normally result in returning data).
Usually indicates that there is no item with the ID you specified.
To resolve the error, change the specified ID to that of an item
that exists.
|
|
Indicates that the action has completed
successfully.
|
|
Indicates that the action should have returned
a single result but is actually returning multiple results. For example,
if there are multiple users with the same user name and password,
and you call the
login
action using that user name
and password as parameters, the system cannot determine which user
to log you in as, so it returns a
too-much-data
error.
|
-
subcode
-
If present, provides more detail describing the status of
the response. For example,
subcode
values are used
to differentiate between different situations in which
code
is
set to
noaccess
‑.
Value
|
Description
|
|
The customer account has expired.
|
|
Based on the supplied credentials, you don’t
have permission to call the action.
|
|
The user is not logged in. To resolve the
error, log in (using the
login
action) before you
make the call. For more information, see
login
.
|
|
The account limits have been reached or
exceeded.
|
|
The required resource is unavailable.
|
|
You must use SSL to call this action.
|
|
The account is not yet activated.
|
|
The account’s license agreement has not
been settled.
|
|
The course or tracking content has expired.
|
|
The meeting or course has not started.
|
The invalid element
An
element that gives information describing a status code of
invalid
.
Element
|
Attribute
|
Type
|
Description
|
|
|
Empty, with attributes
|
Information about why the call was invalid.
|
|
|
String
|
The name of the request parameter that was
incorrect or missing.
|
|
|
Allowed value
|
The type of the incorrect or missing field.
|
|
|
Allowed value
|
A code explaining why the request was invalid
(see the following table for values).
|
The following table shows the allowed values
for
subcode
when
code
is
invalid
.
Value
|
Description
|
|
The call attempted to add a duplicate item
in a context where uniqueness is required.
|
|
A passed parameter had the wrong format.
|
|
The requested operation violates integrity
rules (for example, moving a folder into itself).
|
|
A required parameter is missing.
|
|
The requested information does not exist.
|
|
The value is outside the permitted range
of values.
|
Returned by
All
actions in the Adobe Connect Web Services XML API.
Samples
This
is a successful response:
<status code="ok" />
This
is an invalid response:
<status code="invalid">
<invalid field="principal-id" type="id" subcode="missing" />
</status>
status attribute
Description
An attribute that describes a user’s progress
with a course or curriculum SCO. It is returned by actions that
provide training reports.
A curriculum or folder can only
have a
status
of
completed
or
incomplete
.
The
following table shows the allowed values for
status
when
returned in a
row
element describing a course.
Value
|
Description
|
|
The SCO has scored interactions the user
has passed.
|
|
The SCO has scored interactions. The user
has answered them, but failed.
|
|
The user has viewed all of the SCO’s content,
but the content has no scored interactions.
|
|
The user has not viewed all of the SCO’s
content.
|
|
The user has not started viewing all of
the SCO’s content.
|
|
The user has passed or completed the course
or used all available retries.
|
Sample
<?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>
</report-user-training-transcripts>
</results
time-zone-id
Description
Settings that describe time zones that
you can use with
time-zone-id
.
Values
Time zone setting
|
Value
|
(GMT-12:00) International Date Line West
|
|
(GMT-11:00) Midway Island, Samoa
|
|
(GMT-10:00) Hawaii
|
|
(GMT-09:00) Alaska
|
|
(GMT-08:00) Pacific Time (US and Canada);
Tijuana
|
|
(GMT-07:00) Mountain Time (US and Canada)
|
|
(GMT-07:00) Chihuahua, La Paz, Mazatlan
|
|
(GMT-07:00) Arizona
|
|
(GMT-06:00) Central Time (US and Canada)
|
|
(GMT-06:00) Saskatchewan
|
|
(GMT-06:00) Guadalajara, Mexico City, Monterrey
|
|
(GMT-06:00) Central America
|
|
(GMT-05:00) Eastern Time (US and Canada)
|
|
(GMT-05:00) Indiana (East)
|
|
(GMT-05:00) Bogota, Lima, Quito
|
|
(GMT-04:00) Atlantic Time (Canada)
|
|
(GMT-04:00) Caracas, La Paz
|
|
(GMT-04:00) Santiago
|
|
(GMT-03:30) Newfoundland
|
|
(GMT-03:00) Brasilia
|
|
(GMT-03:00) Buenos Aires, Georgetown
|
|
(GMT-03:00) Greenland
|
|
(GMT-02:00) Mid-Atlantic
|
|
(GMT-01:00) Azores
|
|
(GMT-01:00) Cape Verde Islands
|
|
(GMT) Greenwich Mean Time: Dublin, Edinburgh,
Lisbon, London
|
|
(GMT) Casablanca, Monrovia
|
|
(GMT+01:00) Belgrade, Bratislava, Budapest,
Ljubljana, Prague
|
|
(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb
|
|
(GMT+01:00) Brussels, Copenhagen, Madrid,
Paris
|
|
(GMT+01:00) Amsterdam, Berlin, Bern, Rome,
Stockholm, Vienna
|
|
(GMT+01:00) West Central Africa
|
|
(GMT+02:00) Bucharest
|
|
(GMT+02:00) Cairo
|
|
(GMT+02:00) Helsinki, Kiev, Riga, Sofia,
Tallinn, Vilnius
|
|
(GMT+02:00) Athens, Istanbul, Minsk
|
|
(GMT+02:00) Jerusalem
|
|
(GMT+02:00) Harare, Pretoria
|
|
(GMT+03:00) Moscow, St. Petersburg, Volgograd
|
|
(GMT+03:00) Kuwait, Riyadh
|
|
(GMT+03:00) Nairobi
|
|
(GMT+03:00) Baghdad
|
|
(GMT+03:30) Tehran
|
|
(GMT+04:00) Abu Dhabi, Muscat
|
|
(GMT+04:00) Baku, Tbilisi, Yerevan
|
|
(GMT+04:30) Kabul
|
|
(GMT+05:00) Ekaterinburg
|
|
(GMT+05:00) Islamabad, Karachi, Tashkent
|
|
(GMT+05:30) Chennai, Kolkata, Mumbai, New
Delhi
|
|
(GMT+05:45) Kathmandu
|
|
(GMT+06:00) Astana, Dhaka
|
|
(GMT+06:00) Sri Jayawardenepura
|
|
(GMT+06:00) Almaty, Novosibirsk
|
|
(GMT+06:30) Rangoon
|
|
(GMT+07:00) Bangkok, Hanoi, Jakarta
|
|
(GMT+07:00) Krasnoyarsk
|
|
(GMT+08:00) Beijing, Chongqing, Hong Kong
SAR, Urumqi
|
|
(GMT+08:00) Kuala Lumpur, Singapore
|
|
(GMT+08:00) Taipei
|
|
(GMT+08:00) Perth
|
|
(GMT+08:00) Irkutsk, Ulaan Bataar
|
|
(GMT+09:00) Seoul
|
|
(GMT+09:00) Osaka, Sapporo, Tokyo
|
|
(GMT+09:00) Yakutsk
|
|
(GMT+09:30) Darwin
|
|
(GMT+09:30) Adelaide
|
|
(GMT+10:00) Canberra, Melbourne, Sydney
|
|
(GMT+10:00) Brisbane
|
|
(GMT+10:00) Hobart
|
|
(GMT+10:00) Vladivostok
|
|
(GMT+10:00) Guam, Port Moresby
|
|
(GMT+11:00) Magadan, Solomon Islands, New
Caledonia
|
|
(GMT+12:00) Fiji Islands, Kamchatka, Marshall
Islands
|
|
(GMT+12:00) Auckland, Wellington
|
|
(GMT+13:00) Nuku’alofa
|
|
type
Description
A
return element or attribute defining the type of a SCO or principal
on the server. The allowed values for
type
are
different for SCOs and principals.
SCO types
A
SCO can be content, a meeting, an event, a curriculum, a folder
or tree, or other object on Adobe Connect. Most SCOs can have any
of the following values for
type
:
Value
|
Description
|
|
A viewable file uploaded to the server,
for example, an FLV file, an HTML file, an image, a pod, and so
on.
|
|
A curriculum.
|
|
A event.
|
|
A folder on the server’s hard disk that
contains content.
|
|
A reference to another SCO. These links
are used by curriculums to link to other SCOs. When content is added to
a curriculum, a link is created from the curriculum to the content.
|
|
An Adobe Connect meeting.
|
|
One occurrence of a recurring Adobe Connect
meeting.
|
|
The root of a folder hierarchy. A tree’s
root is treated as an independent hierarchy; you can’t determine
the parent folder of a tree from inside the tree.
|
Content objects returned by some actions
(for example,
report-bulk-objects
) have the
type
values
shown in the following table:
Value
|
Description
|
|
An archived copy of a live Adobe Connect
meeting or presentation.
|
|
A piece of content uploaded as an attachment.
|
|
A piece of multimedia content created with
Macromedia Authorware from Adobe.
|
|
A demo or movie authored in Adobe Captivate.
|
|
A curriculum, including courses, presentations,
and other content.
|
|
An external training that can be added to
a curriculum.
|
|
A media file in the FLV file format.
|
|
An image, for example, in GIF or JPEG format.
|
|
An Adobe Connect meeting.
|
|
A presentation.
|
|
A SWF file.
|
Principal types
For
principals, the allowed values for
type
are shown
in the following table:
Value
|
Description
|
|
The built-in group Administrators, for Adobe
Connect server Administrators.
|
|
The built-in group Authors, for authors.
|
|
The built-in group Training Managers, for
training managers.
|
|
The built-in group Event Managers, for anyone
who can create an Adobe Connect meeting.
|
|
The group of users invited to an event.
|
|
All Adobe Connect users.
|
|
A group authenticated from an external network.
|
|
A user authenticated from an external network.
|
|
A group that a user or Administrator creates.
|
|
A non-registered user who enters an Adobe
Connect meeting room.
|
|
The built-in group learners, for users who
take courses.
|
|
The built-in group Meeting Hosts, for Adobe
Connect meeting hosts.
|
|
The built-in group Seminar Hosts, for seminar
hosts.
|
|
A registered user on the server.
|
Custom field types
When
used with a custom field,
type
can have any of
the following values.
Value
|
Description
|
|
A required custom field for the account.
|
|
An optional field that is displayed during
self-registration.
|
|
An optional field that is hidden during
self-registration.
|
|
|
|