Macromedia Connect - 8.0 Service manual

Using

ADOBE® CONNECT™ 8

Web Services

This user guide is protected under copyright law, furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide.

This user guide is licensed for use under the terms of the Creative Commons Attribution Non-Commercial 3.0 License. This License allows users to copy, distribute, and transmit the user guide for noncommercial purposes only so long as (1) proper attribution to Adobe is given as the owner of the user guide; and (2) any reuse or distribution of the user guide contains a notice that use of the user guide is governed by these terms. The best way to provide notice is to include the following link. To view a copy of this license, visit

http://creativecommons.org/licenses/by-nc-sa/3.0/

Adobe, the Adobe logo, Acrobat Connect, Adobe Captivate, Adobe Connect, Authorware, Flash, Flash Builder, Flex, and Flex Builder are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. All other trademarks are the property of their respective owners.

Updated Information/Additional Third Party Code Information available at www.adobe.com/go/thirdparty/

Portions include software under the following terms:

This software is based in part on the work of the Independent JPEG Group.

Sorenson Spark(tm) video compression and decompression technology licensed from Sorenson Media, Inc.

This product contains either BSAFE and/or TIPEM software by RSA Security, Inc.

This product includes software developed by the Apache Software Foundation (www.apache.org/).

Portions © 1995-2005 Jean-loup Gailly and Mark Adler. This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly (jloup@gzip.org) Mark Adler (madler@alumni.caltech.edu)

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

Notice to U.S. Government End Users. The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Last updated 12/16/2010

Chapter 1: Before you begin

Development environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2: Architecture

Data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Making your first API call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 3: Login and requests

Log in from an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Send a request in an XML document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Parse a response with XPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Parse an error response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Log a user out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

iii

Chapter 4: Basics

Find a principal-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

List principals or guests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Create users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Update users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Create custom fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Create groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Find SCOs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Download files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Check permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 5: Meetings

Using web services with Adobe Connect meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Find meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Display meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Create meeting room URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Create meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Set or reset a meeting passcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Create customized meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Invite users to meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Remove users from meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Calculate meeting usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Check meeting quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Get meeting archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Get meeting poll results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Launch meetings with external authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Configure compliance settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Contents

Chapter 6: Training

Using web services with Adobe Connect Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Training library permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Find courses and curriculums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Create a course . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

View a user’s training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Enroll one user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Enroll a large number of users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

View curriculum information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Report scores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Chapter 7: Action reference

What’s new in Adobe Connect 8 Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Sample action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 8: Filter and sort reference

filter-definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

sort-definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Chapter 9: Using the Telephony XML API

telephony-profile-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

telephony-profile-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

telephony-profile-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

telephony-profile-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

telephony-provider-conf-number-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

telephony-provider-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

telephony-provider-dial-in-info-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

telephony-provider-field-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

telephony-provider-field-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

telephony-provider-field-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

telephony-provider-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

telephony-provider-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

telephony-provider-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Chapter 10: Common reference

Common XML elements and attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Chapter 11: Sample application

Getting started with the sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Build an adapter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Log the user in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Send XML requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Parse XML responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Display user information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

List a user’s meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Create and update meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Display meeting detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Last updated 12/16/2010

Chapter 1: Before you begin

Adobe® Connect® exposes web services that clients can call to exchange data with Adobe Connect accounts. You can use web services with Adobe Connect hosted accounts and with accounts on Adobe Connect licensed servers.

This guide explains how an application calls Adobe Connect web services and interprets the XML response. It is intended for developers who want to build custom applications for Adobe Connect or integrate it with another system such as a learning management system or LDAP directory service.

Before you use this guide, you should understand the basics of XML and of using HTTP to communicate with a server from a client application. This guide includes some Java™ code samples, but it does not presume that you are using one specific language or environment.

Development environment

Adobe Connect Web Services allows you to use any language or platform that can send and receive XML over HTTP to develop custom applications. For example, you can use Java and the J2EE platform, C#.NET, PHP, a portal server, or any web development platform. Most custom applications are web applications or portals.

In general, you may find these types of tools useful:

• An XML parser code library, if your programming language supports XML parsing.

• A cookie management code library, to help you manage the session cookies Adobe Connect returns.

• A tool for viewing HTTP request and response headers in a browser. Many such tools are available on the Internet.

Additional resources

You can find many useful resources on the Internet that provide information about Adobe Connect, web services and XML, and other technologies that Adobe Connect uses.

Adobe Connect

Adobe Connect User Community The Adobe Connect User Community at connectusers.com is the hub of the

Adobe Connect community. This site has forums, tutorials, events, announcements, a partner showcase and much more.

Adobe Connect Help Support Center The Adobe Connect Help and Support Center contains the Adobe Connect

documentation and Support contact information.

XML and web services

The Web Services Primer at the Xml.com website (xml.com) is a good introduction to web services.

The XML Tutorial at the W3Schools website (w3schools.com) can help you get started with XML.

The XPath Tutorial also at the W3Schools website (w3schools.com), describes XPath, which parses an XML document

so that you can use it in an application.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Before you begin

The XSLT Tutorial, a third tutorial at the W3Schools website (w3schools.com), teaches you XSL Transformations,

which you use to convert XML data to other formats.

The XSL Transformations (XSLT) specification at the W3C website (w3.org) is the official definition of XSLT, from the

standards committee who created it.

Numeric Representation of Dates and Time, at the International Organization for Standardization website (iso.org),

provides information about how to use the ISO 8601 standard date and time format.

Date and Time Formats at the W3C website (w3.org) is the official definition of the ISO 8601 date and time format.

Other technologies

Flash Player Developer Center and Flash Media Server Developer Center, both available from the Adobe Developer

Center, offer articles, samples, and insights to developing applications that use Adobe Flash Player and Adobe Flash

Media Server.

SCORM Concepts, at the Eduworks Corporation website (eduworks.com), is a tutorial about the Shareable Content

Object Reference Model and describes Shareable Content Objects (SCOs) and Learning Management Systems (LMSs).

An LDAP Roadmap at the Kings Mountain Systems website (www.kingsmountain.com), provides a useful overview of

the Lightweight Directory Access Protocol (LDAP). This site might provide good background material or links for developers integrating an LDAP directory with Adobe Connect.

Microsoft SQL Server Adobe Connect uses a Microsoft SQL Server database, which your custom applications

retrieve data from and write data to. You may find useful resources at the Microsoft SQL Server Developer Center (msdn.microsoft.com) including references, community, support, and other information.

Conventions

This guide uses industry standard conventions for displaying code that you are already familiar with.

However, API reference is a formal definition of the API contract between a calling application and the server. As such, the syntax definitions of request URLs should be described.

We have placed distinct sections of a request URL on separate lines for readability, like this:

http://server_name/api/xml ?action=custom-fields &filter-definition=value &session=BreezeSessionCookieValue

When you enter a request URL in the address bar of a browser or construct it in an application, enter it or construct it as a single line:

https://example.com/api/xml?action=custom-fields&filter-name=location

Syntax elements in blue code font represent definitions that you construct, with a hyperlink to the syntax of the definition.

Last updated 12/16/2010

Chapter 2: Architecture

Adobe® Connect™ Web Services is the web service layer over the Adobe Connect Server suite of applications.

Web services allow you to build portals or web applications that integrate Adobe Connect functionality and reporting information with third-party systems such as portals, customer relationship management systems, and enterprise resource planning systems.

Authoring tools

Adobe Presenter

Adobe Captivate

eLearning Suite

Adobe Acrobat

Adobe Connect Web Services provides meeting, training, and events functionality to your applications through its XML API.

Adobe Connect

Training Events

Training

Deployment Models

Extensibility

Webcast

On PremiseHosted

Managed

Services

XML API

SDK

As an example, you might have a central user management system, such as an LDAP directory, Microsoft Active Directory, or another third-party system, that is an integral part of your business processes.

Using web services, you can write an application that synchronizes users between your system and Adobe Connect. The application can use the J2EE platform or another technology of your choice to pull a list of users from the directory, compare it against a list of Adobe Connect users, and then perform requested updates within the Adobe Connect user repository, such as adding or deleting users or groups.

Data flow

The data flows between client applications and Adobe Connect are shown in the following diagram. Custom applications that you write use paths 1 to 2 and A to B. Adobe Connect applications (such as Adobe Connect Meeting, Adobe Connect Training, or Adobe Connect Events) can use any of the data flow paths.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

Client application

Web browser

Flash Player

HTTP:80

HTTPS:443

RTMPS:443

RTMP:1935

3a 4a

RTMPT:80

Adobe Connect

Web

Services

API

Flash Media Server

SQL database

Web/application

server

The data flow between Adobe Connect and client applications

The data flow can be encrypted with SSL or unencrypted.

Unencrypted If the data flow is unencrypted, connections are made over HTTP and Adobe Real Time Messaging

Protocol (RTMP) and follow the paths described in the following table.

Diagram number Description

1 The client web browser requests an Adobe Connect meeting or content URL over port HTTP:80 (connection paths may

vary).

2 The web server responds with content transfer or provides the client browser with information to enter Adobe Connect.

Adobe Flash® Player requests a connection to Adobe Flash Media Server over RTMP:1935 and HTTP:80.

4 Flash Media Server responds, and a persistent connection is opened to stream meeting traffic to the browser.

3a (alternate) In some cases, Flash Player requests a connection to the Flash Media Server, but can only obtain a tunneled connection

over RTMPT:80.

4a (alternate) Flash Media Server responds, and a tunneled connection is opened to stream meeting traffic to the browser.

Encrypted If the data flow is encrypted, connections are made securely over HTTPS and RTMPS (Real Time

Messaging Protocol over SSL), as follows.

Diagram number Description

A The client web browser requests a secure meeting or content URL over an encrypted connection on HTTPS:443

(connection paths may vary).

B The web/application server responds with an encrypted content transfer or provides the client with information to

make an encrypted connection to Adobe Connect.

C Flash Player requests an encrypted connection to Flash Media Server over RTMPS:443.

D Flash Media Server responds, and a persistent connection is opened to stream meeting traffic to the browser.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

Custom applications

Adobe Connect Web Services provides an XML API, so your application must be able to communicate with Adobe Connect using XML over HTTP or XML over HTTPS. Your application calls the API by building a request URL and passing it one or more parameters, either as name/value pairs or as an XML document. Web Services returns an XML response, from which you can extract values.

Custom applications retrieve metadata from the Adobe Connect database. Metadata includes meeting or course names and times, meeting room URLs, content URLs, and report information.

The data flow for a custom application retrieving metadata from the database is from a client web browser, to the client web application server, to the XML API, the Adobe Connect web application server, and the SQL database—and then back again.

The data flow between a custom application and Adobe Connect works like this:

1 A user accesses your custom application from a web browser.

2 The application calls the XML API over HTTP:80 or HTTPS:443.

3 The Adobe Connect web application server authorizes the application and its users, retrieves metadata from the

SQL database, and returns the metadata.

4 On the client side, your web or application server, XML parser, and software libraries handle the response and

return it to your application.

5 The user continues to work in your custom application, and clicks a meeting or content URL. At this point, the user

accesses a Adobe Connect application to enter a meeting room, and the typical data flow between a Adobe Connect application and the server begins.

Adobe Connect applications

Adobe Connect applications call the server using the same Web Services XML API that you use from a custom application.

In general, content is transported over HTTP port 80 or HTTPS port 443. Content includes slides, HTTP pages, SWF files, and files transferred through the FileShare pod. These are default port numbers that you can configure (see Migrating, Installing, and Configuring Adobe Connect Server for details).

Streamed, real-time communications from Flash Media Server are transported over RTMP port 1935. Streamed communications include audio, video (webcam and FLV), file share, and chat. Meeting state is also maintained over RTMP port 1935.

Components of Adobe Connect

Adobe Connect is architected with two server components, and each server uses a SQL database.

The web application server The web application server is the brains of Adobe Connect. It contains and executes all of

the business logic needed to deliver content to users. It handles access control, security, quotas, and licensing, as well as management functions such as clustering, failover, and replication.

The web application server also handles Adobe Connect Central, the application through which you view and manage your organization’s content and users—when you are not using a custom application or integrated third-party system. The metadata describing content and users can be stored in either single or multiple replicated SQL databases. The web application server is stateless, which means that scaling is near linear.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

Flash Media Server Flash Media Server is the muscle of Adobe Connect. Flash Media Server streams audio, video, and

rich media content using RTMP. When a meeting is recorded and played back, audio and video are synchronized, or content is converted and packaged for real-time screen sharing, Flash Media Server does the job.

Flash Media Server also plays a vital role in reducing server load by caching frequently accessed web pages, streams, and shared data.

The SQL database Adobe Connect uses the Microsoft SQL Server database for persistent storage of transactional and

application metadata, including users, groups, content, and reporting information. The XML API retrieves metadata stored in the database. The database can be implemented with either the Microsoft SQL Server Desktop Engine (MSDE) or the full version of Microsoft SQL Server 2005.

Making your first API call

Adobe Connect Web Services uses a servlet framework to handle XML API requests. In the data flow diagram, the servlet framework is represented by the API component. The API servlet receives XML requests from clients and returns XML responses from the web application server and the database.

A request to the XML API is formatted as an HTTP request URL that the API servlet handles. A request URL has an action name and parameters in name/value pairs, like this:

https://example.com/api/xml?action=sco-info&sco-id=2006334909

If you have access to a Adobe Connect account in which you can test API calls, you can experiment. In fact, Adobe recommends testing API calls in the browser while you learn the API and write applications.

Before you begin, it’s useful to install a tool that allows you to view HTTP request and response headers in your browser.

Call common-info in a browser

1 (Optional) Enable a tool for viewing HTTP headers in your browser.

2 Open a browser and navigate to your Adobe Connect login page.

3 Without logging in, delete the part of the URL after the domain name and add a call to common-info:

https://example.com/api/xml?action=common-info

The response from common-info gives you information about your session with the server, especially the cookie that identifies your session:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <common locale="en" time-zone-id="85"> <cookie>breezbryf9ur23mbokzs8</cookie> <date>2008-03-13T01:21:13.190+00:00</date> <host>https://example.com</host> <local-host>abc123def789</local-host> <url>/api/xml?action=common-info</url> <version>connect_700_r641</version> <user-agent> Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322) </user-agent> </common> </results>

When you log a user in from an application, you need to send the cookie value back to the server to identify the user’s session (see

Call principal-list in a browser

Once you have the BREEZESESSION cookie value from common-info, the browser adds it to the request header on your next request.

1 In a web browser, log in to Adobe Connect. Change the browser URL to call principal-list:

https://example.com/api/xml?action=principal-list

2 Check the request header. This time it sends the BREEZESESSION cookie value back to the server:

GET /api/xml?action=principal-list HTTP/1.1 Accept: */* Accept-Language: en-us Accept-Encoding: gzip, deflate User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322) Host: example.com Connection: Keep-Alive Cookie: BREEZESESSION=breezbryf9ur23mbokzs8

3 Check the response, which lists all principals on the server, each in its own principal element.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

<?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"> <name>joe harrison</name> <login>jharrison@example.com</login> <email>jharrison@example.com</email> </principal> <principal principal-id="624550" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>bob jones</name> <login>bjones@example.com</login> <email>bjones@example.com</email> </principal> ... </principal-list> </results>

Add filters and sorts

Many actions in the API allow you to add a filter to return only certain response elements or a sort to display response elements in a certain order.

A filter is a special parameter that starts with the keyword filter, followed by an optional modifier, then a field name and a value. These are all examples of filters:

• filter-name=jazz doe (which matches results with the exact name jazz doe)

• filter-like-name=jazz (which matches any results that contain jazz in the name)

• filter-out-type=user (which returns any results that do not have a type of user)

These are just a few filter types, and you can find more in filter-definition. Check an action in the reference (at “Action reference” on page 58) to see whether its response can be filtered. In general, if an action allows filters, you can use them on any response element or attribute.

A sort is another special parameter that starts with the keyword sort (or sort1 or sort2), followed by a field name and then one of the keywords

asc or desc, for example:

• sort-name=asc (to sort in ascending order by name)

• sort-group-id=desc (to sort in descending order by group-id)

These are just a few sort examples. You can test sorts in the browser or see sort-definition for more.

Make a call with a filter and sort

1 Call principal-list again, displaying only groups and sorting them alphabetically by name:

https://example.com/api/xml?action=principal-list&filter-type=group &sort-name=asc

2 To tighten the response, choose a group from the list and filter on its name:

https://example.com/api/xml?action=principal-list&filter-name=developers

This time, only one group is returned:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Architecture

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <principal-list> <principal principal-id="2007105030" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>developers</name> <login>developers</login> </principal> </principal-list> </results>

Where to go from here

At this point, you can continue to test calls in the browser and observe how they work. It’s the best and easiest way to learn the XML API. When you need more information, turn to any of these sources:

• The API reference in “Action reference” on page 58

• “Login and requests” on page 10 for information on how to log users in from applications

• “Basics” on page 18 to learn the three basic concepts underlying the API

• “Meetings” on page 30 if you want to create and manage meetings from an application

• “Training” on page 47 if you are building a training application

Last updated 12/16/2010

Chapter 3: Login and requests

This chapter explains how to log a user in from your application, make requests, handle responses, and log the user out.

There are several ways to accomplish most of these tasks, depending on your development environment, server configuration, and application design.

Log in from an application

Any custom application you write that uses Adobe® Connect™ Web Services functionality or integrates with a thirdparty system needs to log in a user to Adobe Connect. In its simplest form, the process of logging in calls the action.

However, the technique for logging in varies according to whether you use cookie management, have a licensed server or a hosted account, and authenticate directly to Adobe Connect or use external authentication. Depending on your environment and server configuration, you might also use combinations of these options.

Cookie management When a user logs in, Adobe Connect returns a cookie that identifies the user’s session. You need

to pass the cookie back to the server on all calls made to the server during the user’s session. Then, when the user logs out, the server makes the cookie expire and you should invalidate it.

In your development environment, you can use a code library that manages cookies for you. The process of logging in and managing a user’s session varies according to whether you use a cookie management library or manage the user’s session yourself.

Licensed server or hosted account Your organization might have a licensed Adobe Connect server within your

firewall, or you may have an Adobe Connect hosted account at Adobe. Either way, you send XML requests over HTTP or HTTPS, but security requirements and the login process vary. If you are a hosted customer, you can use certain parameters with the

Direct or external authentication Whether you are a hosted or licensed customer, your application might authenticate

directly to Adobe Connect, or you might authenticate users on your own network, set an identifier in an HTTP request header, and send it to Adobe Connect. The login process varies according to whether you use direct or external authentication.

Log in to Adobe Connect server

The standard technique for logging a user in to Adobe Connect server uses the login action, passing the user’s login ID and password. This technique works with both HTTP

You also need to manage the BREEZESESSION cookie the server returns for each user session. If you use a client-side cookie management library, it is much easier to allow it to manage cookies for you than to manage the cookies yourself. If you do not have such a library, call HTTP header values.

Note: If you send user passwords to Adobe Connect server, use SSL so passwords are encrypted in transit, even if you have a licensed Adobe Connect server within your own firewall.

GET and POST requests.

1 Call the login action, passing it the user’s login ID and password, but no session parameter:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

http://example.com/api/xml?action=login&login=bobs@acme.com &password=football

2 Parse the response for a status code of ok.

If the login is successful, the server returns the BREEZESESSION cookie in the response header:

Set-Cookie: BREEZESESSION=breezbryf9ur23mbokzs8;domain=.macromedia.com;path=/

3 Allow your cookie management library to manage the BREEZESESSION cookie.

Your client-side library passes the cookie back to the server in a request header on subsequent calls for the remainder of the user’s session. You do not need to set the cookie in the request header explicitly. When the user logs out, the cookie expires.

1 Before you log the user in, call common-info to get the value of the BREEZESESSION cookie:

http://example.com/api/xml?action=common-info

2 Extract the cookie value from the response:

<cookie>breezxq66rt43poai3if8</cookie>

3 Log the user in, specifying the cookie value:

http://example.com/api/xml?action=login&login=bobs@acme.com &password=football&session=breezxq66rt43poai3if8

4 Parse the response for a status code of ok.

Use the

https://example.com/api/xml?action=principal-list &session=breezxq66rt43poai3if8

session

parameter with the same cookie value on subsequent calls for the user, until the user’s session ends:

6 When the user logs out or the user’s session ends, do not reuse the cookie value.

Log in to a Adobe Connect hosted account

If you want to log in directly to an Adobe Connect hosted account or multiple hosted accounts, you still use the login action, but you need to specify an account ID or domain name, in addition to the user’s login ID and password. You can specify a domain name if you want to avoid sending an account ID over the Internet.

With an Adobe Connect hosted account, you cannot use single sign-on or external authentication. You must pass the user’s authentication credentials on the Adobe Connect hosted account, not the credentials for an external network.

Note: It is important to have SSL enabled on your Adobe Connect hosted account, because you are sending user IDs, passwords, and account information over the Internet to your Adobe Connect account hosted at Adobe.

1 Before you log the user in, call common-info with the domain name of your Adobe Connect hosted account in

either the request URL or the

http://acme.adobe.com/api/xml?action=common-info http://adobe.com/api/xml?action=common-info&domain=acme.adobe.com

domain parameter:

2 Parse the response for the values of cookie and account-id:

<cookie>Sbreezzd2dfr2ua5gscogv</cookie> ... <account account-id="295153" />

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

3 Collect the user’s login ID and password in your application.

4 Call the login action, adding the user’s credentials and the account-id and session parameters:

https://example.com/api/xml?action=login&login=joy@acme.com &password=happy&account-id=295153&session=Sbreezzd2dfr2ua5gscogv

5 Parse the response for a status code of ok.

6 (Optional) If you prefer, you can call login before common-info, extract the cookie value from the response

header, and manage it yourself or using a cookie management library.

1 Before you log the user in, call common-info with the domain name of your Adobe Connect hosted account in

either the request URL or the

http://acme.adobe.com/api/xml?action=common-info http://adobe.com/api/xml?action=common-info&domain=acme.adobe.com

domain parameter:

2 Parse the response for the values of cookie and host:

<cookie>breezxq66rt43poai3if8</cookie> ... <host>https://acme.adobe.com</host>

3 Extract the domain name from the value of host:

acme.adobe.com

4 In your application, collect the user’s login ID and password.

Be sure the login ID is the user’s Adobe Connect hosted account login ID, not an external one.

5 Call login, adding the user’s credentials and the domain and session parameters:

https://example.com/api/xml?action=login&login=joe &password=smith99&domain=acme.adobe.com&session=breezxq66rt43poai3if8

The domain is equivalent to the account-id, but by using it you can avoid sending an account ID over the Internet, especially if you use a non-encrypted connection.

6 Parse the response for a status code of ok.

7 (Optional) If you prefer, you can call login before common-info, extract the cookie value from the response

header, and manage it yourself or using a cookie management code library.

Log in using HTTP header authentication

Note: The instructions in this section apply only to Adobe Connect server.

Your application can use a trusted central server to authenticate users with single sign-on and pass your network’s (here called external) authentication to Adobe Connect server, without explicitly passing an Adobe Connect server user ID and password. (For detailed instructions on how to set up and configure HTTP header authentication, see Adobe Connect Installation and Configuration Guide).

With HTTP header authentication, a user logs in to your authentication server. Once the user is authenticated, you add an HTTP request header that identifies the user, or configure a proxy server to add the header. The authentication filter on Adobe Connect (named

HeaderAuthenticationFilter) converts your user identifier to an Adobe Connect

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Authentication Server

Authentication filters convert external authentication credentials to Adobe Connect credentials.

Authentication Filter Adobe Connect ServerProxy Server

SQL database

External authentication works in addition to standard Adobe Connect authentication. Each user who needs to access Adobe Connect server needs a valid Adobe Connect server login and password.

When you send a login request to Adobe Connect server with an external authentication credential:

• The authentication filter intercepts the request and checks for a user on Adobe Connect server with an ext-login

field that matches your external credential.

•

If a match exists, the filter passes your external authentication to Adobe Connect server, and the server logs the user in.

• If no match exists, the filter passes the login request to the server, which displays its login page. The user must then

• If the user logs in successfully, Adobe Connect server updates the ext-login field in the user’s profile with the

external credential from your request. The next time you send a request with the user’s external credential, Adobe Connect server finds a match in

ext-login, and the user does not need to log in to Adobe Connect.

• If the user does not log in successfully, the user is not allowed access to Adobe Connect server applications, content,

or meetings.

The steps that follow describe how to call login when you use HTTP header authentication.

1 Configure your network servers and Adobe Connect server for HTTP header authentication using the instructions

in Adobe Connect Installation and Configuration Guide.

2 In [your server directory]/appserv/conf/WEB-INF/web.xml, remove comment tags around the filter-mapping

element for

<filter-mapping> <filter-name>HeaderAuthenticationFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <!-- <filter-mapping> <filter-name>NtlmAuthenticationFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

-->

HeaderAuthenticationFilter and add comment tags around any other filter-mapping elements:

3 In the filter element for HeaderAuthenticationFilter, enable the /api/ pattern for request URLs. You have

two choices for how to do this:

If your application uses the XML API and any Adobe Connect applications In the filter element for

HeaderAuthenticationFilter, use comment tags to disable the init-param element with a param-value

api/:

of/

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

<!-- <init-param> <param-name>ignore-pattern-0</param-name> <param-value>/api/</param-value> </init-param>

-->

If your application uses only the XML API Change the filter-mapping element for your filter type to use the URL

pattern

<filter-mapping> <filter-name>HeaderAuthenticationFilter</filter-name> <url-pattern>/api/*</url-pattern> </filter-mapping>

/api/* instead of /*:

Then, in the filter element for your filter type, add comment tags around all init-param elements with a param-

name of ignore-pattern-x:

<filter> <filter-name>HeaderAuthenticationFilter</filter-name> <filter-class> com.macromedia.airspeed.servlet.filter.HeaderAuthenticationFilter </filter-class> <!-- <init-param> <param-name>ignore-pattern-0</param-name> <param-value>/api/</param-value> </init-param> ... <init-param> <param-name>ignore-pattern-4</param-name> <param-value>/servlet/testbuilder</param-value> </init-param>

--> </filter>

4 Configure Adobe Connect server so that users are created with the field ext-login set to the external user ID you

send (see Adobe Connect Installation and Configuration Guide for details).

By default, ext-login has the same value as login, the Adobe Connect server login ID.

5 Once your system authenticates the user, create a login request. Add the parameter external-auth=use, but no

https://example.com/api/xml?action=login&external-auth=use

6 Add your authenticated user ID to the HTTP request header. By default, use the header name x-user-id:

x-user-id: joesmith

You can specify a different header name by setting a value for HTTP_AUTH_HEADER in the custom.ini file. You can also configure a proxy server to set the HTTP header value. See Adobe Connect Installation and Configuration Guide for details of either.

7 Parse the response for a status code of ok.

8 Handle the BREEZESESSION cookie value returned in the response header. You have two choices for how to do this:

If you use a client library that manages cookies Allow your library to extract the cookie value, store it, and pass it

back to the server on subsequent requests for the user.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

If you manage cookies yourself Extract the value of the BREEZESESSION cookie from the response header. Store it

and pass it back to the server in the as the user’s session is valid:

https://example.com/api/xml?action=principal=list&session=breezs7zuepmy9wh2tseu

Be sure not to reuse the cookie value when the user’s session ends.

session parameter of all subsequent actions you call for the same user, as long

Send a request in an XML document

At times, you may prefer to send an HTTP POST request to the server to make sure the data is secure and not visible in transit. In that case, specify the action name and parameters in an XML document.

Make an XML document request

1 Create an XML document with the root element params and param child elements for the action name and each

parameter:

<params> <param name="action">login</param> <param name="login">jon@doe.com</param> <param name="password">foobar</param> </params>

• You can only send one action in the params root element. You cannot batch multiple actions to be executed

sequentially.

• The XML document you send must be valid and well-formed. Try validating the document in an XML editor

before you send it.

2 Write code that sends an HTTP POST request to Adobe Connect and receives an XML response.

The specific code will vary according to your programming language and development environment.

3 In your code, send the XML document to Adobe Connect in the body of the HTTP POST request.

• Read the XML document into the request.

• Be sure to set a content-type header of text/xml or application/xml.

Parse a response with XPath

When you receive an XML response from Adobe Connect, you need to be able to parse it to extract the XML elements you need.

If you are working in a language such as Java™, with an XML parser (such as Xerces or JDOM) installed, you can parse through an XML response, select values from nodes, and then use those values.

Use XPath to parse a response

❖ Write a method that calls one or more actions. Create an instance of the XPath class so that you can use the XPath

expressions. Call the actions, read the XML response, and use XPath syntax to select the values you need:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

public String scoUrl(String scoId) throws XMLApiException { try { Element e = request("sco-info", "sco-id=" + scoId); if(!(codePath.valueOf(e).equalsIgnoreCase("ok"))) return ""; XPath xpath = XPath.newInstance("//url-path/text()"); String path = ((Text) xpath.selectSingleNode(e)).getText();

e = request("sco-shortcuts", null); xpath = XPath.newInstance("//domain-name/text()"); String url = ((Text) xpath.selectSingleNode(e)).getText();

return url + "/" + path.substring(1) + "?session=" + breezesession; } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } }

You can also use string pattern matching to check for a status code of ok. A successful action always returns this response:

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>

You can check the response for the pattern ok or code="ok" .

Parse an error response

When an API action completes successfully, it returns a status code of ok. If the call is not successful, it can also return any of the following status codes:

invalid Indicates that the call is invalid in some way, usually invalid syntax.

no-access Shows that the current user does not have permission to call the action, and includes a subcode attribute

with more information.

no-data Indicates that there is no data available for the action to return, when the action would ordinarily return data.

too-much-data Means that the action should have returned a single result but is actually returning multiple results.

When the status code is invalid, the response also has an invalid element that shows which request parameter is incorrect or missing:

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="invalid"> <invalid field="has-children" type="long" subcode="missing" /> </status> </results>

When the status code is no-access, the subcode explains why:

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="no-access" subcode="denied" /> </results>

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

All valid values for code, subcode, and invalid are described in status, in the API reference. Your application needs to read and handle status codes and subcodes.

Handle status codes

1 Write a method that parses an XML API response for the status code and subcode. This is an example in Java:

private String getStatus(Element el) throws JDOMException { String code = codePath.valueOf(el); String subcode = subcodePath.valueOf(el); StringBuffer status = new StringBuffer(); if(null != code && code.length() > 0) status.append(code); if(null != subcode && subcode.length() > 0) status.append(" - " + subcode); return status.toString(); }

2 When you call an action, parse the response for the status.

3 If the status is not ok, return a null value, display the error status code for debugging, or throw an application

exception.

The action to take depends on which call you are making and how your application is designed.

Log a user out

When a user logs out, the user’s session ends, and Adobe Connect invalidates the BREEZESESSION cookie by setting it to null and using an expiration date that has passed. For example, if you call

Set-Cookie method in the response header, setting an empty cookie value and an expiration date a year earlier:

Set-Cookie: BREEZESESSION=;domain=.macromedia.com;expires=Mon, 29-Aug-2005 22:26:15 GMT;path=/

If you are managing the BREEZESESSION cookie, invalidate the value so it is not reused after a user logs out.

Log a user out and invalidate the session cookie

1 Call logout to log the user out:

https://example.com/api/xml?action=logout

2 Parse for a status code of ok to make sure the logout was successful.

3 Set the cookie value to null or otherwise invalidate it. For example, in this Java code snippet, the breezesession

variable stores the cookie value and is set to

public void logout() throws XMLApiException { request("logout", null); this.breezesession = null; }

null:

logout on August 29, 2006, you see this

Last updated 12/16/2010

Chapter 4: Basics

To get started with Adobe Connect Web Services, you need to understand three key concepts:

• Principals, who are users and groups

• SCOs, which are Shareable Content Objects and represent meetings, courses, and just about any content that can

be created on Adobe Connect. SCOs (pronounced sko, which rhymes with snow) are compatible with the industry standard Shareable Content Object Reference Model (SCORM) specification and can be used with a Learning Management System (LMS).

• Permissions, which define how principals can act on objects

This chapter describes basic tasks you can do with Web Services, regardless of which Adobe Connect applications you have licensed. Many tasks are described as if you are running them in a browser. If you want to make the call from an application, translate the XML request to the language you are working in (for an example of how to do this in Java™,

“Send XML requests” on page 249).

see

Find a principal-id

A principal is a user or group that has a defined permission to interact with a SCO on the server. You can create users and groups for your organization and modify their permissions.

Adobe Connect also has built-in groups: Administrators, Limited Administrators, Authors, Training Managers, Event Managers, Learners, Meeting Hosts, and Seminar Hosts. You can add users and groups to built-in groups, but you can’t modify the permissions of built-in groups.

Note: The built-in groups that are available depend on your account.

Each Adobe Connect user and group has a principal-id. In some API calls, the principal-id is called a group-id

user-id to distinguish it from other values. The value of the ID that identifies a user or group is always the same,

or regardless of its name. You can check the syntax of any action in

Get the principal-id of a user or group

1 Call principal-list with a filter:

https://example.com/api/xml?action=principal-list&filter-name=jazz doe

It is best to use filter-name, filter-login, or filter-email for an exact match. Be careful with filter-like-

name, as it may affect server performance.

2 Parse the principal elements in the response for the principal-id:

<principal principal-id="2006282569" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>jazz doe</name> <login>jazzdoe@example.com</login> <email>jazzdoe@newcompany.com</email> </principal>

“Action reference” on page 58

Get the principal-id of the current user

1 Call common-info after the user is logged in:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

https://example.com/api/xml?action=common-info

2 Parse the user elements in the response for the user-id:

Here, the principal-id is called user-id, because it always represents a user who is authenticated to Adobe Connect. A group cannot log in to the server. You can pass the

user-id value as a principal-id in other actions.

List principals or guests

A principal with a type of user is a registered Adobe Connect user, while a user with a type of guest has entered a meeting room as a guest. The server captures information about the guest and gives the guest a

List all principals on the server

1 Call principal-list with no parameters:

https://example.com/api/xml?action=principal-list

principal-id.

This call returns all Adobe Connect users, so be prepared for a large response.

2 Parse the principal elements in the response for the values you want:

List all guests on the server

1 Call <<UNRESOLVED XREF>> report-bulk-users, filtering for a type of guest:

https://example.com/api/xml?action=report-bulk-users&filter-type=guest

2 Parse the row elements in the response:

<row principal-id="51157227"> <login>joy@acme.com</login> <name>joy@acme.com</name> <email>joy@acme.com</email> <type>guest</type> </row>

List all users who report to a specific manager

When you call principal-info with a principal-id, the response shows the principal. If the principal is a user who has a manager assigned in Adobe Connect, the response also shows data about the principal’s manager in a

manager

element:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

<manager account-id="624520" disabled="" has-children="false" is-hidden="false" isprimary="false" principal-id="2006282569"type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name> <email>joy@example.com</email> <first-name>jazz</first-name> <last-name>doe</last-name> <x-2006293620>23456</x-2006293620> <x-2007017651>chicago</x-2007017651> </manager>

You can use the manager’s principal-id with principal-list to list all users who are assigned to the manager.

1 Call principal-list, filtering on manager-id:

https://example.com/api/xml?action=principal-list&filter-manager-id=2006282569

2 Parse the response for the principal elements:

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

Create users

To create a new user, you need Administrator privilege. Adobe recommends that you create a user who belongs to the

admins group for your application to use to make API calls that require Administrator privilege.

Create a new user and send a welcome e-mail

1 In your application, log in as an Administrator user.

See Log in from an application for various ways to log in.

2 Call <<UNRESOLVED XREF>> principal-update with at least these parameters:

https://example.com/api/xml?action=principal-update &first-name=jazz&last-name=doe&login=jazz99@doe.com&password=hello &type=user&send-email=true&has-children=0&email=jazz99@doe.com

The type must be user, has-children must be 0 or false, send-email must be true, and email must have a valid e-mail address.

The server sends a welcome e-mail with login information to the user’s e-mail address.

3 Parse the principal element in the response for the user’s principal-id:

<principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> <login>jammdoe@example.com</login> <ext-login>jammdoe@example.com</ext-login> <name>jamm doe</name> </principal>

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

Create a new user without using an e-mail address as a login ID

1 In Connect Central, navigate to Administration > Users and Groups > Edit Login and Password Policies. Make sure

that Use E-mail Address as the Login is set to No.

2 In your application, log in as an Administrator user.

3 Call <<UNRESOLVED XREF>> principal-update to create the new user, passing both login and email

parameters:

https://example.com/api/xml?action=principal-update&first-name=jazz &last-name=doe&login=jazz&email=jazzdoe@company.com &password=nothing&type=user&has-children=0

4 Parse the response for the principal-id of the new user:

<principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> <login>jazzdoe@example.com</login> <ext-login>jazzdoe@example.com</ext-login> <name>jazz doe</name> </principal>

In the response, ext-login has the same value as login by default, until the user logs in successfully using external authentication (see

Update users

Once you create users, you often need to update their information. You can update standard fields that Adobe Connect defines for users by calling

If you have defined custom fields for the principal, use acl-field-update to update them.

You need Administrator privilege to update users, so your application must first log in as a user in the admins group. You cannot log in as the user and then have the user update his or her own profile.

Update standard user information

1 Log in as an Administrator user.

2 Call principal-list with a filter to get the user’s principal-id (see Find a principal-id).

3 Call <<UNRESOLVED XREF>> principal-update to update the user:

https://example.com/api/xml?action=principal-update &principal-id=2006282569&email=jazzdoe@newcompany.com

4 Parse the response for a status code of ok.

Update custom field values for a user

1 Log in as an Administrator user.

2 Call custom-fields to get the field-id of the custom field:

https://example.com/api/xml?action=custom-fields

principal-update with the user’s principal-id. The standard fields include email,

3 Get the principal-id, sco-id, or account-id you want to update.

This value is the acl-id you pass to acl-field-update.

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

4 Call acl-field-update to update the value of the custom field:

https://example.com/api/xml?action=acl-field-update&field-id=x-2007396975&aclid=2006258745&value=44444

Create custom fields

Custom fields are additional data fields that you define. You can define up to eight custom fields on a principal or SCO

custom-field-update.

using

Once you define the custom field, by default you can set its value either by editing the value in Adobe Connect Central or by calling

To specify that the value can only be updated through the API, call custom-field-update with the parameter

object-type=object-type-read-only.

Define a custom field and set it on a user

1 First, create the field with custom-field-update:

https://example.com/api/xml?action=custom-field-update &object-type=object-type-principal&permission-id=manage &account-id=624520&name=Location&comments=adobe%20location &field-type=text&is-required=true&is-primary=false&display-seq=9

custom-field-update.

The name field defines the field name as your application displays it, so use appropriate spelling and capitalization. The custom field in this example is defined for all Adobe Connect principals.

2 Parse the field element in the response for the field-id:

<field field-id="2007184366" object-type="object-type-principal" display-seq="9" account-id="624520" is-primary="false" permission-id="manage" is-required="true" field-type="text"> <comments>test</comments> <name>Country</name> </field>

3 Get the principal-id of the user (see Find a principal-id).

4 Call acl-field-update to set the value of the field, passing a field-id, the user’s principal-id as acl-id, and

a value:

https://example.com/api/xml?action=acl-field-update &acl-id=2006258745&field-id=2007017474&value=San%20Francisco

5 Parse the response for a status code of ok.

Create groups

To add users to groups, you need to call principal-update as your application’s Administrator user.

Add a user to a group

1 Log in as your application’s Administrator user.

2 (Optional) If the user does not yet exist, create the user with <<UNRESOLVED XREF>> principal-update:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

https://example.com/api/xml?action=principal-update &first-name=jazzwayjazz&last-name=doe&login=jazz@doe.com &password=nothing&type=user&has-children=0

3 (Optional) Parse the response for the new user’s principal-id.

4 If the user already exists, call principal-list to get the user’s principal-id:

https://example.com/api/xml?action=principal-list&filter-type=user

5 Parse the response for the principal-id:

<principal principal-id="5611980" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>Joy Black</name> <login>joy@acme.com</login> <email>joy@acme.com</email> </principal>

6 Call principal-list again to get the group’s principal-id:

https://example.com/api/xml?action=principal-list&filter-type=group

7 Call group-membership-update with is-member=true to add the user to the group:

https://example.com/api/xml?action=group-membership-update &group-id=4930296&principal-id=2006258745&is-member=true

• The principal-id is the user’s principal-id.

• The group-id is the group’s principal-id.

• The parameter is-member must be true.

Check whether a specific user is in a group

1 Call principal-list with a group-id, filter-is-member, and a filter that identifies the principal:

https://example.com/api/xml?action=principal-list&group-id=624523 &filter-is-member=true&filter-like-name=bob

2 Parse for a principal element in the response. A successful response looks like this:

<principal-list> <principal principal-id="624660" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>Bill Jones</name> <login>bjones@acme.com</login> <email>bjones@acme.com</email> <is-member>true</is-member> </principal> </principal-list>

If the user is not a group member, the principal-list element is empty:

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <principal-list /> </results>

Check which users are in a group

1 To get the group’s principal-id, call principal-list with filters:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

https://example.com/api/xml?action=principal-list&filter-type=group &filter-name=developers

With filter-type and filter-name, principal-list should return a unique match.

2 Parse the response for the principal-id:

<principal principal-id="2007105030" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>developers</name> <login>developers</login> <is-member>false</is-member> </principal>

3 Call principal-list again, with the principal-id as a group-id and filter-is-member=true:

https://example.com/api/xml?action=principal-list&group-id=2007105030 &filter-is-member=true

4 Parse the response for the principal elements:

<principal principal-id="5698354" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>Bob Jones</name> <login>bobjones@acme.com</login> <is-member>true</is-member> </principal>

List all groups a user belongs to

1 Call principal-list with the user’s principal-id and filter-is-member=true:

https://example.com/api/xml?action=principal-list &principal-id=2006258745&filter-is-member=true

2 Parse the response for the principal elements:

Find SCOs

All objects on Adobe Connect are Shareable Content Objects, or SCOs. The word Shareable comes from learning management systems in which content is combined into courses or curriculums and shared among them.

On the server, a SCO can be any content object that is combined with other content objects into a course or curriculum. Courses, curriculums, presentations, and other types of content are SCOs. Meetings, events, folders, trees, links, graphics files, or any other object are also SCOs.

Each SCO has a unique integer identifier called a sco-id. The sco-id is unique across the entire server. On a Adobe Connect hosted account, the

sco-id is unique across all accounts.

Each SCO also has a type, such as content, course, meeting, and so on. You can see the sco-id and type values in the response from

sco-info or other actions:

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

Characteristics of SCOs

When you study the XML responses of various calls, you notice more characteristics of SCOs:

• A SCO’s identifier is called a sco-id in some actions, but can also be called folder-id, acl-id, or another name

in other actions. It’s the same unique ID.

• Each SCO can be accessed by various principals, either users or groups. The specific principals who can access a

SCO are defined in access control lists, or ACLs.

• Each SCO has a unique URL, with two parts: a domain name (like http://example.com) and an URL path (like

/f2006123456/). You can concatenate these to form the full URL that accesses the SCO.

• Each SCO has a navigation path that describes where it resides in the folder hierarchy.

• Each SCO has a permission defined for each principal who can access it.

• Some SCOs have description fields, which are text strings that give you information about the SCO.

Often you need to find the ID of a SCO or some information about it. SCOs are arranged in a specific folder hierarchy where folders have names that indicate whether they are at the top level, contain shared content or templates, or hold user content and templates.

When you call sco-shortcuts, it returns a list of folders. Notice that folders have different types:

<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <shortcuts> <sco tree-id="624530" sco-id="2006258751" type="my-meeting-templates"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624529" sco-id="624529" type="meetings"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624530" sco-id="624530" type="user-meetings"> <domain-name>http://example.com</domain-name> </sco> ... </shortcuts> </results>

The folders shown in this example happen to be for meetings, but folders for other types of SCOs follow a similar pattern. Each folder type stores certain types of objects, with certain access privileges, as follows:

content, courses, meetings, events, seminars These are shared folders, such as Shared Meetings, Shared Training, and

so on. The Adobe Connect Administrator has access to this folder. The Administrator can assign Manage permission to any user, but only members of the built-in group associated with the folder can create new content or meetings within it.

user-content, user-meetings, user-courses, user-events These folders each contain a folder for each user who can

create content within it (for example, one folder for each meeting host or training developer).

Last updated 12/16/2010

USING ADOBE CONNECT 8 WEB SERVICES

Basics

my-courses, my-events, my-meetings, my-meeting-templates, my-content Users create their own content in these

folders and have Manage permission on the content. For example, meeting hosts create meetings in their

meetings folder and have Manage permission on those meetings.

shared-meeting-templates This folder is within the Shared Meetings folder, contains meeting templates, and inherits

my-

permissions from Shared Meetings.

You can list the contents of any folder to get information about a specific SCO. When you need to search for a SCO but do not have a

sco-search, as it returns only certain types of SCOs.

sco-id, move through folders using sco-shortcuts and sco-expanded-contents. Do not use

Find a SCO when you do not know the sco-id

1 Call <<UNRESOLVED XREF>> sco-shortcuts to get a list of root folders on Adobe Connect:

https://example.com/api/xml?action=sco-shortcuts

2 Parse the response for a type of the root folder that would logically contain the SCO, for example, my-courses for

a course the user has created.

3 Parse the resulting sco element for a sco-id:

<sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com</domain-name> </sco>

4 Create a call to <<UNRESOLVED XREF>> sco-expanded-contents to list the contents of the folder, adding an

exact match filter, if possible:

https://example.com/api/xml?action=sco-expanded-contents &sco-id=2006258748&filter-name=All About Web Communities

You have several choices of filters:

• An exact match filter on name or url-path (like filter-name or filter-url-path), if you know the name or

URL of the SCO.

• A greater-than or less-than date filter (filter-gt-date or filter-lt-date) on date-begin, date-created,

date-modified, if you know one of those dates.

• A partial name filter (like filter-like-name), if you do not know the exact SCO name. However, using this

filter might affect system performance.

5 Parse the response for the sco-id:

<sco depth="1" sco-id="2006745671" folder-id="2006258748" type="folder" icon="folder" lang="en" source-sco-id="2006745669" display-seq="0" source-sco-type="14"> <name>A Day in the Life Resources</name> <url-path>/f28435879/</url-path> <date-created>2006-06-12T14:47:59.903-07:00</date-created> <date-modified>2006-06-12T14:47:59.903-07:00</date-modified> </sco>

Get information about a SCO

1 Call sco-info with the sco-id:

https://example.com/api/xml?action=sco-info&sco-id=2006745669

2 Parse the response for name, url-path, or any other value:

Last updated 12/16/2010

+ 231 hidden pages