Know the commonly used XML elements and attributes from the Adobe Connect Web Services API calls and server responses.

This article describes XML elements and attributes that are used by more than one action in Adobe® Connect™ Web Services. The elements described here are referenced from the request and response tables describing actions in the Web Services XML API.

All parameter, element, and attribute names and values are case sensitive. For example, name is not the same as Name, and sco-id is not equivalent to sco-ID. You must enter them exactly as shown in this reference.

access

Description

An attribute describing the level of access a user has to a course or curriculum.

Values

Value

Description

access-blocked

The course or curriculum is restricted and users cannot take it.

access-hidden

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).

access-open

The course or curriculum is open and users can take it.

access-optional

The course or curriculum is optional.

access-pass

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 9 Using Guide.

Values

Value

Description of functionality when value is enabled

fid-archive

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 Adobe Connect to automatically record all meetings, you must both disable fid-archive and enable fid-archive-force.

fid-archive-force

Sets all meetings to be recorded upon the start of the meeting. Recorded meetings appear in Adobe Connect Central.

fid-archive-publish-link

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.

fid-chat-transcripts

Creates a transcript file (one per meeting session) of all text messages exchanged in Chat, Q&A, and IM Pods.

fid-meeting-app-sharing

Lets host request control of attendee's input device (mouse or keyboard) when attendee is sharing their screen, desktop, or application.

fid-meeting-auto-promote

Lets hosts enable the option to automatically promote participants to presenters.

fid-meeting-breakout

Allows users to create breakout meetings.

fid-meeting-chat

Enables the Chat pod.

fid-meeting-chat-clear

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.

fid-meeting-chat-private

Lets users send chat messages to specific attendees.

fid-meeting-chat-public

Lets users send chat messages to all attendees.

fid-meeting-desktop-sharing

Lets users share their screen (both the complete desktop and individual applications).

fid-meeting-dialout

Lets users use Call Out and Call Me features.

fid-meeting-disclaimer

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 Adobe 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.

fid-meeting-file-share

Enables the File Share pod.

fid-meeting-flv

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.

fid-meeting-hold

Lets hosts place participants on hold.

fid-meeting-host-cursors

Lets a host change the display of the host’s cursor.

fid-meeting-im

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.

fid-meeting-manage-link

Enables the "Manage Room with Web Manager" link in the meeting menu.

fid-meeting-note

Enables the Notes pod.

fid-meeting-notes-clear

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 Adobe Connect Central. However, by default, this feature is disabled. Account Administrators can enable the feature in Adobe 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.

fid-meeting-people-list

Enables the Attendee List pod.

fid-meeting-poll

Enables the Poll pod.

fid-meeting-pres-only

Enables the use of the Presenter-Only area.

fid-meeting-pr-mode

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.

fid-meeting-qa-clear

Automatically clears Q & A pod history when a new session of an existing meeting is started.

fid-meeting-questions

Enables the Q & A pod.

fid-meeting-room-bg

Lets a host change a meeting room background. Backgrounds are typically set in the meeting template.

fid-meetings-custom-pods

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.)

fid-meeting-show-talker

Lets hosts enable or disable the "Who’s Speaking" area in a meeting.

fid-meeting-show-talker-area

Enables the "Who’s Speaking" area.

fid-meeting-video

Enables the Camera pod.

fid-meeting-voip

Enables voice controls within the meeting user interface, such as the ability to broadcast audio using VoIP.

fid-meeting-web-links

Enables the Web Links pod.

fid-meeting-white-board

Enables use of the white board in the Share pod.

fid-start-meeting-button

Lets a user start the meeting again after the host ends the meeting.

fid-training-openenroll

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

permission-id

Allowed value

The permission needed to access the custom field. See permission-id for valid values.

object-type

Allowed value

A definition for a valid object on the server (see type for values).

field-id

String

A piece of text that identifies the custom field. Adobe Connect Central does not display the field-id, but various actions return it.

account-id

Integer

An ID for the user who is presently logged in, assigned by the server.

display-seq

Integer

The order in which the custom field is displayed in the user interface or returned by the action.

field-type

String

The type of data the field accepts. Allowed values are text, textarea, and password.

is-primary

Boolean

Whether the custom field can be deleted. true means the field cannot be deleted. false means it can.

is-required

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.

acl-id

Integer

The custom field’s ID in an access control list (ACL).

custom-seq

Integer

The sequence number assigned to the custom field in UI display.

type

String

The type of custom field (see type for values).

principal-id

Integer

The ID of the principal for whom the custom field is defined.

icon

Description

The symbol used to identify a SCO in Adobe Connect Central.

Values

Value

Description

archive

An archive of an Adobe Connect meeting.

attachment

A piece of content uploaded as an attachment.

authorware

A piece of multimedia content created with Macromedia® Authorware® from Adobe.

captivate

A demo or movie created with Adobe Captivate™ .

course

A training course.

curriculum

A curriculum.

external-event

An external training that can be added to a curriculum.

flv

A media file in the FLV file format.

html

An HTML file.

image

An image.

lms-plugin

A piece of content from an external learning management system.

logos

A custom logo used in a meeting room or Adobe Connect Central.

meeting-template

A custom look and feel for a meeting.

mp3

An MP3 file.

pdf

An Adobe Portable Document Format file.

pod

A visual box that provides functionality in a meeting room layout.

presentation

A presentation created with an earlier version of Adobe Breeze® software.

producer

A presentation created with Adobe Presenter.

seminar

A seminar created with Adobe Connect Seminars.

session

One occurrence of a recurring Adobe Connect meeting.

swf

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

en eng

English

fr fre

French (do not use fra)

de ger

German (do not use deu)

ja jpn

Japanese

ko kor

Korean

object-type

Description

An attribute describing the type of a Adobe Connect object.

Values

Value

Meaning

object-type-account

An account that contains principals and SCOs.

object-type-action

An action in the Web Services XML API.

object-type-event

An Adobe Connect event.

object-type-hidden

A SCO that is not visible in Adobe Connect Central (or in your application, if you use this value).

object-type-meeting

An Adobe Connect meeting.

object-type-principal

A user or group.

object-type-readonly

A setting indicating that Adobe Connect Central displays some data, but a user cannot set the data in Adobe Connect Central.

object-type-sco

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

completion-none

The current SCO is not a completion requirement for the curriculum.

completion-required

The current SCO is a completion requirement.

prereq-none

The current learning object has no prerequisites.

prereq-required

The current SCO has a prerequisite that must be completed.

prereq-hidden

The target learning object is required as a prerequisite. The current learning object is hidden until the target learning object is completed.

prereq-suggested

The current SCO has a prerequisite that is recommended, not required.

preass-blocked

The current SCO has a test-out. If the enrollee passes, this item is locked. If the enrollee fails, this item is available.

preass-none

The current SCO has no test-outs.

preass-hidden

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.

preass-optional

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

view

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.

host

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.

mini-host

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.

remove

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.

publish

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.

manage

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.

denied

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.

Caution:

When you select the option Anyone who has the URL, your room is publicly available. Any content uploaded to your room, is also publicly available. Any user who has the URL can access the uploaded content without your knowledge.

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

invalid

Indicates that a call is invalid in some way. The invalid element provides more detail.

no-access

Indicates that you don’t have permission to call the action. The subcode attribute provides more details.

no-data

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.

ok

Indicates that the action has completed successfully.

too-much-data

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

account-expired

The customer account has expired.

denied

Based on the supplied credentials, you don’t have permission to call the action.

no-login 

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.

illegalparent

The specified acl-id is not a seminar or an unknown issue occured while retrieving the quota for that seminar.

no-quota

The account limits have been reached or exceeded.

not-available

The required resource is unavailable.

not-secure

You must use SSL to call this action.

pending-activation

The account is not yet activated.

pending-license

The account’s license agreement has not been settled.

sco-expired

The course or tracking content has expired.

sco-not-started

The meeting or course has not started.

valuelessthanorequal

Value is not a valid integer or is greater than the allowed license quota for that seminar.

The invalid element

An element that gives information describing a status code of invalid.

Element

Attribute

Type

Description

invalid

Empty, with attributes

Information about why the call was invalid.

field

String

The name of the request parameter that was incorrect or missing.

type

Allowed value

The type of the incorrect or missing field.

subcode

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

duplicate

The call attempted to add a duplicate item in a context where uniqueness is required.

format

A passed parameter had the wrong format.

illegal-operation

The requested operation violates integrity rules (for example, moving a folder into itself).

missing

A required parameter is missing.

no-such-item

The requested information does not exist.

range

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

user-passed

The SCO has scored interactions the user has passed.

user-failed

The SCO has scored interactions. The user has answered them, but failed.

completed

The user has viewed all of the SCO’s content, but the content has no scored interactions.

incomplete

The user has not viewed all of the SCO’s content.

not-attempted

The user has not started viewing all of the SCO’s content.

review

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

0

(GMT-11:00) Midway Island, Samoa

1

(GMT-10:00) Hawaii

2

(GMT-09:00) Alaska

3

(GMT-08:00) Pacific Time (US and Canada); Tijuana

4

(GMT-07:00) Mountain Time (US and Canada)

10

(GMT-07:00) Chihuahua, La Paz, Mazatlan

13

(GMT-07:00) Arizona

15

(GMT-06:00) Central Time (US and Canada)

20

(GMT-06:00) Saskatchewan

25

(GMT-06:00) Guadalajara, Mexico City, Monterrey

30

(GMT-06:00) Central America

33

(GMT-05:00) Eastern Time (US and Canada)

35

(GMT-05:00) Indiana (East)

40

(GMT-05:00) Bogota, Lima, Quito

45

(GMT-04:00) Atlantic Time (Canada)

50

(GMT-04:00) Caracas, La Paz

55

(GMT-04:00) Santiago

56

(GMT-03:30) Newfoundland

60

(GMT-03:00) Brasilia

65

(GMT-03:00) Buenos Aires, Georgetown

70

(GMT-03:00) Greenland

73

(GMT-02:00) Mid-Atlantic

75

(GMT-01:00) Azores

80

(GMT-01:00) Cape Verde Islands

83

(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London

85

(GMT) Casablanca, Monrovia

90

(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague

95

(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb

100

(GMT+01:00) Brussels, Copenhagen, Madrid, Paris

105

(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna

110

(GMT+01:00) West Central Africa

113

(GMT+02:00) Bucharest

115

(GMT+02:00) Cairo

120

(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius

125

(GMT+02:00) Athens, Istanbul, Minsk

130

(GMT+02:00) Jerusalem

135

(GMT+02:00) Harare, Pretoria

140

(GMT+03:00) Moscow, St. Petersburg, Volgograd

145

(GMT+03:00) Kuwait, Riyadh

150

(GMT+03:00) Nairobi

155

(GMT+03:00) Baghdad

158

(GMT+03:30) Tehran

160

(GMT+04:00) Abu Dhabi, Muscat

165

(GMT+04:00) Baku, Tbilisi, Yerevan

170

(GMT+04:30) Kabul

175

(GMT+05:00) Ekaterinburg

180

(GMT+05:00) Islamabad, Karachi, Tashkent

185

(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi

190

(GMT+05:45) Kathmandu

193

(GMT+06:00) Astana, Dhaka

195

(GMT+06:00) Sri Jayawardenepura

200

(GMT+06:00) Almaty, Novosibirsk

201

(GMT+06:30) Rangoon

203

(GMT+07:00) Bangkok, Hanoi, Jakarta

205

(GMT+07:00) Krasnoyarsk

207

(GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi

210

(GMT+08:00) Kuala Lumpur, Singapore

215

(GMT+08:00) Taipei

220

(GMT+08:00) Perth

225

(GMT+08:00) Irkutsk, Ulaan Bataar

227

(GMT+09:00) Seoul

230

(GMT+09:00) Osaka, Sapporo, Tokyo

235

(GMT+09:00) Yakutsk

240

(GMT+09:30) Darwin

245

(GMT+09:30) Adelaide

250

(GMT+10:00) Canberra, Melbourne, Sydney

255

(GMT+10:00) Brisbane

260

(GMT+10:00) Hobart

265

(GMT+10:00) Vladivostok

270

(GMT+10:00) Guam, Port Moresby

275

(GMT+11:00) Magadan, Solomon Islands, New Caledonia

280

(GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands

285

(GMT+12:00) Auckland, Wellington

290

(GMT+13:00) Nuku’alofa

300

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

content

A viewable file uploaded to the server, for example, an FLV file, an HTML file, an image, a pod, and so on.

curriculum

A curriculum.

event

A event.

folder

A folder on the server’s hard disk that contains content.

link

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.

meeting

An Adobe Connect meeting.

session

One occurrence of a recurring Adobe Connect meeting.

tree

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

archive

An archived copy of a live Adobe Connect meeting or presentation.

attachment

A piece of content uploaded as an attachment.

authorware

A piece of multimedia content created with Macromedia Authorware from Adobe.

captivate

A demo or movie authored in Adobe Captivate.

curriculum

A curriculum, including courses, presentations, and other content.

external-event

An external training that can be added to a curriculum.

flv

A media file in the FLV file format.

image

An image, for example, in GIF or JPEG format.

meeting

An Adobe Connect meeting.

presentation

A presentation.

swf

A SWF file.

Principal types

For principals, the allowed values for type are shown in the following table:

Value

Description

admins

The built-in group Administrators, for Adobe Connect server Administrators.

authors

The built-in group Authors, for authors.

course-admins

The built-in group Training Managers, for training managers.

event-admins

The built-in group Event Managers, for anyone who can create an Adobe Connect meeting.

event-group

The group of users invited to an event.

everyone

All Adobe Connect users.

external-group

A group authenticated from an external network.

external-user

A user authenticated from an external network.

group

A group that a user or Administrator creates.

guest

A non-registered user who enters an Adobe Connect meeting room.

learners

The built-in group learners, for users who take courses.

live-admins

The built-in group Meeting Hosts, for Adobe Connect meeting hosts.

seminar-admins

The built-in group Seminar Hosts, for seminar hosts.

user

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

required

A required custom field for the account.

optional

An optional field that is displayed during self-registration.

optional-no-self-reg

An optional field that is hidden during self-registration.

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

Legal Notices   |   Online Privacy Policy