2006 Adobe Systems Incorporated. Alle rechten voorbehouden. Werken met Adobe Connect Enterprise Web Services Als deze handleiding wordt

"%0#& $0//&$5 &/5&313*4& ¥

" %0 # & $0 / / & $ 5 & / 5 & 3 1 3 *4& 8 & # 4& 37* $&4 ($* , &/

© 2006 Adobe Systems Incorporated. Alle rechten voorbehouden. Werken met Adobe® Connect™ Enterprise Web Services Als deze handleiding wordt gedistribueerd met software waarin een gebruiksrechtovereenkomst voor eindgebruikers is opgenomen, worden deze handleiding en de software die in de handleiding wordt beschreven, verstrekt onder licentie en mogen deze alleen worden gebruikt of gekopieerd in overeenstemming met de bepalingen van een dergelijke licentie. Tenzij toegestaan volgens voornoemde licentie, mag niets uit deze publicatie worden vermenigvuldigd, opgeslagen in een opslagsysteem of verzonden, in welke vorm of op welke manier dan ook, hetzij elektronisch, mechanisch, via opname of op enige andere manier, zonder voorafgaande schriftelijke toestemming van Adobe Systems Incorporated De inhoud van dit handboek wordt beschermd door het copyright, zelfs indien deze inhoud niet wordt verstrekt bij software die een gebruiksrechtovereenkomst bevat. De inhoud van deze handleiding wordt uitsluitend verstrekt voor informatieve doeleinden, kan zonder kennisgeving worden gewijzigd en mag niet worden opgevat als een toezegging van Adobe Systems Incorporated. Adobe Systems Incorporated neemt geen enkele verantwoordelijkheid en geeft geen enkele garantie met betrekking tot fouten of onnauwkeurigheden, mochten deze in dit handboek voorkomen. Houd rekening met de mogelijkheid dat er copyright rust op bestaande illustraties of afbeeldingen die u wellicht in uw project wilt opnemen. Het zonder toestemming opnemen van dergelijk materiaal in uw werk kan een schending van de rechten van de copyrighteigenaar vormen. U wordt aangeraden toestemming te vragen aan de houder van het copyright voor gebruik van het desbetreffende werk. Eventuele bedrijfsnamen in voorbeeldsjablonen dienen slechts om het gebruik van het product te illustreren en zijn fictief. Adobe, het Adobe-logo, Acrobat, Adobe Captivate, Adobe Connect, Adobe Press, Breeze, Flash, Flash Player, PDF en Shockwave zijn gedeponeerde handelsmerken of handelsmerken van Adobe Systems Incorporated in de Verenigde Staten en/of in andere landen. Java is een handelsmerk of een gedeponeerd handelsmerk van Sun Microsystems, Inc. in de Verenigde Staten en in andere landen. Alle overige handelsmerken zijn het eigendom van hun respectieve houders. Op de akoestische echo-opheffing van RealDuplex™ berust copyright © 1995-2004 SPIRIT. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Kennisgeving aan eindgebruikers bij de Amerikaanse overheid: deze software en documentatie zijn “commerciële artikelen”, zoals gedefinieerd in 48 C.F.R. §2.101, bestaande uit “commerciële computersoftware” en “documentatie bij commerciële computersoftware”, zoals deze begrippen worden genoemd in 48 C.F.R. §12.212 of 48 C.F.R. §227.7202, al naar gelang hetgeen van toepassing is. Conform 48 C.F.R. §12.212 of 48 C.F.R. §227.7202-1 tot en met §227.7202-4, al naar gelang hetgeen van toepassing is, is aan de eindgebruikers bij de Amerikaanse overheid een licentie voor de commerciële computersoftware en de documentatie bij de commerciële computersoftware verleend (a) alleen als commerciële artikelen en (b) met alleen de rechten die aan alle eindgebruikers worden verleend overeenkomstig de voorwaarden en bepalingen in dit document. Niet-gepubliceerde rechten voorbehouden onder de copyrightwetgeving van de Verenigde Staten. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Voor eindgebruikers van de Amerikaanse overheid verklaart Adobe te zullen voldoen aan alle van toepassing zijnde wetten inzake gelijkwaardige behandeling, waaronder, indien van toepassing, de bepalingen van Executive Order 11246, zoals geamendeerd, lid 402 van de Vietnam Era Veterans Readjustment Assistance Act van 1974 (38 USC 4212) en lid 503 van de Rehabilitation Act van 1973, zoals geamendeerd, en de bepalingen in 41 CFR deel 60-1 tot en met 60-60, 60-250 en 60-741. De clausule en regels betreffende positieve actie die zijn opgenomen in de voorafgaande zin zullen worden opgenomen via verwijzing.

Inhoudsopgave

Voordat u begint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Tips en training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Ontwikkelomgeving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Nieuw in deze gids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Aanvullend leermateriaal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Conventies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Hoofdstuk 1: Architectuur. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Gegevensstroom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 De API voor het eerst aanroepen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Hoofdstuk 2: Aanmelding en aanvragen . . . . . . . . . . . . . . . . . . . 23 Aanmelden vanuit een toepassing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Een aanvraag verzenden in een XML-document . . . . . . . . . . . . . . . . . . 31 Een antwoord parseren met XPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Een foutbericht parseren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Een gebruiker afmelden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Hoofdstuk 3: Grondbeginselen . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Een principal-id zoeken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Principals of gasten vermelden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 Gebruikers maken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Gebruikers bijwerken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Aangepaste velden maken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Groepen maken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 SCO's zoeken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Bestanden downloaden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Machtigingen controleren. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Hoofdstuk 4: Vergaderingen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Vergaderingen zoeken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Vergaderingen weergeven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 URL's voor vergaderruimtes maken. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

3

Vergaderingen maken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Aangepaste vergaderingen maken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Gebruikers uitnodigen voor vergaderingen . . . . . . . . . . . . . . . . . . . . . . . 56 Gebruikers verwijderen uit vergaderingen . . . . . . . . . . . . . . . . . . . . . . . . 58 Vergadergebruik berekenen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Vergaderarchieven ophalen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Resultaten van opiniepeilingen ophalen. . . . . . . . . . . . . . . . . . . . . . . . . . 62 Vergaderingen starten met externe verificatie . . . . . . . . . . . . . . . . . . . . 63 Hoofdstuk 5: Training. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Machtigingen voor trainingsbibliotheek . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Cursussen en studieprogramma's zoeken . . . . . . . . . . . . . . . . . . . . . . . . 67 De training van een gebruiker weergeven . . . . . . . . . . . . . . . . . . . . . . . . 69 Eén gebruiker inschrijven. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Een groot aantal gebruikers inschrijven . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Informatie over een studieprogramma weergeven. . . . . . . . . . . . . . . . . 75 Scores rapporteren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Hoofdstuk 6: Actiereferentie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Nieuwe en verwijderde acties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 acl-field-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 acl-field-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 acl-field-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 acl-preference-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 custom-fields-delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 custom-field-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 group-membership-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 learning-path-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 learning-path-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 permissions-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110 permissions-reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114 permissions-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 principal-info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 principal-list-by-field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 principals-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 principal-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

4

Inhoudsopgave

report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134 report-bulk-consolidated-transactions . . . . . . . . . . . . . . . . . . . . . . . . . .136 report-bulk-objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 report-bulk-questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142 report-bulk-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 report-bulk-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150 report-curriculum-taker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 report-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158 report-meeting-concurrent-users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160 report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162 report-meeting-summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165 report-my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 report-my-events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 report-my-meetings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 report-my-training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180 report-quiz-question-answer-distribution. . . . . . . . . . . . . . . . . . . . . . . .183 report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186 report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190 report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193 report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 report-sco-slides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199 report-sco-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 report-user-trainings-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 report-user-training-transcripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210 sco-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214 sco-expanded-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216 sco-info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219 sco-move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 sco-search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 sco-shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231 sco-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 sco-upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 user-accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 user-transcript-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 user-update-pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Inhoudsopgave

5

Hoofdstuk 7: Filter- en sorteringsreferentie . . . . . . . . . . . . . . . 249 filter-definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 sort-definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Hoofdstuk 8: Algemene referentie . . . . . . . . . . . . . . . . . . . . . . . 255 access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255 veld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .256 icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 lang . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258 object-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258 path-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 permission-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 status, kenmerk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .264 time-zone-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .265 type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Bijlage A: Een voorbeeldtoepassing . . . . . . . . . . . . . . . . . . . . . . . 271 Een adapterklasse samenstellen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 De gebruiker aanmelden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 XML-aanvragen verzenden. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 XML-antwoorden parseren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Gebruikersinformatie weergeven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 De vergaderingen van een gebruiker vermelden . . . . . . . . . . . . . . . . .279 Vergaderingen maken en bijwerken . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Vergaderinggegevens weergeven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .283 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

6

Inhoudsopgave

Voordat u begint Adobe® Connect™ Enterprise Web Services stelt uw toepassingen in staat te communiceren met Adobe Connect Enterprise Server 6 of met Adobe Connect Enterprise Hosted 6. In deze gids wordt uitgelegd hoe een toepassing XML API-aanroepen verzendt naar Connect Enterprise en het XML-antwoord interpreteert. Deze gids is bedoeld voor ontwikkelaars die aangepaste toepassingen willen samenstellen voor Connect Enterprise of Connect Enterprise willen integreren met een ander systeem, zoals een LMS of een LDAP-directoryservice. Gebruikers van deze gids dienen op de hoogte te zijn van de grondbeginselen van XML en van het gebruik van HTTP voor de communicatie met een server vanuit een clienttoepassing. Deze gids bevat enkele voorbeelden van Java™-code, maar er wordt niet van uitgegaan dat u één specifieke taal of omgeving gebruikt.

Tips en training Adobe verschaft een uitgebreid aantal bronnen om u te helpen bij het leren en gebruiken van Adobe-producten. ■

Adobe Developer Center: Zelfstudies, referentiemateriaal, scripthandleidingen en andere diepgaande informatie.

■

Andere bronnen: Training, boeken, gebruikersforums, productcertificaten en nog veel meer.

■

Extra’s en downloads: Downloadbare inhoud en software.

Adobe Developer Center In dit gemeenschapsgebied op Adobe.com is informatie beschikbaar voor gevorderde gebruikers en voor ontwikkelaars van software en insteekmodules. U vindt hier zelfstudiemateriaal, SDK's, scripthandleidingen en voorbeeldcode plus forums, RSS-feeds, onlineseminars en andere bronnen van technische informatie.

7

Andere bronnen Er zijn aanvullende informatie- en hulpbronnen beschikbaar voor Adobe-producten. ■

Op de startpagina voor Ondersteuning op de Adobe-website vindt u uitvoerige informatie over gratis en tegen betaling beschikbare opties voor technische ondersteuning. De belangrijkste kwesties worden per product vermeld op de Amerikaanse en Japanse websites van Adobe. Klik op de koppeling Training voor toegang tot de boeken van Adobe Press, tot online trainingsmateriaal, trainingsvideo’s en door instructeurs gegeven training, tot certificeringsprogramma’s voor Adobe-software en nog veel meer.

■

In het gebied Communities van de Adobe-website vindt u forums, blogs en andere hulpmiddelen voor gebruikers om functies en informatie te delen, vragen te stellen en uit te zoeken hoe anderen optimaal gebruikmaken van de software. Op de startpagina voor Ondersteuning van uw lokale Adobe-website vindt u gebruikersforums in het Engels, Frans, Spaans, Duits en Japans. Blogs worden gepubliceerd in een groot aantal verschillende talen.

Extra’s en downloads Voor gratis inhoud en invoegtoepassingen gaat u naar Adobe Studio® Exchange, een online gemeenschap waar gebruikers duizenden gratis handelingen, insteekmodules en andere inhoud voor Adobe-producten kunnen downloaden en delen. Ga naar het Adobe Design Center op de startpagina van de Adobe-website voor toegang tot Adobe Studio Exchange. U kunt van de Adobe-website bijvoorbeeld gratis updates, proefversies en andere nuttige software downloaden. Bovendien hebt u via de sectie Plug-ins van de Adobe Store toegang tot duizenden insteekmodules van externe ontwikkelaars, waarmee u taken kunt automatiseren, workflows kunt aanpassen, speciale professioneel ogende effecten tot stand kunt brengen enz.

Ontwikkelomgeving U kunt in Connect Enterprise Web Services aangepaste toepassingen ontwikkelen met gebruik van alle talen of platforms waarmee XML kan worden verzonden en ontvangen via HTTP. Zo kunt u bijvoorbeeld Java en het J2EE-platform, C#.NET, PHP, een portalserver of ieder ander webontwikkelingsplatform gebruiken. De meeste aangepaste toepassingen zijn webtoepassingen of portals.

8

Voordat u begint

De volgende typen functies kunnen nuttig zijn: ■

Een bibliotheek voor XML-parseercodes, als uw programmeertaal ondersteuning biedt voor XML-parsering.

■

Een bibliotheek voor cookiebeheercodes, om het beheer van de sessiecookies die Connect Enterprise retourneert te vergemakkelijken.

■

Een functie voor het weergeven van HTTP-headers met aanvragen en antwoorden in een browser. Dergelijke functies zijn wijd beschikbaar op internet.

Nieuw in deze gids Het gedeelte voor ontwikkelaars bevat

nieuwe stapsgewijze aanwijzingen waarin de aanroepvolgorde voor het uitvoeren van bepaalde taken met gebruik van de XML API worden beschreven. U kunt deze stappen als code in uw toepassing opnemen. heeft een nieuwe indeling waarin aanvraag-URL's en parameters worden beschreven, evenals antwoordelement en -kenmerken. Ook worden er voorbeelden gegeven van de aanvragen en de antwoorden.

De API-referentie

Een voorbeeldtoepassing is

aan deze release toegevoegd. Het voorbeeld bestaat uit een Javaen JSP-toepassing die kan worden uitgevoerd op een willekeurige met J2EE compatibele webof toepassingsserver en die aantoont hoe u Adobe Acrobat® Connect Professionalvergaderingen kunt maken, weergeven en bijwerken. De voorbeeldtoepassing draagt de naam firstapp en is beschikbaar in het bestand firstapp.zip dat in de map documentation/samples op de product-cd staat. Het Lees mij-bestand bij de voorbeeldtoepassing bevat aanwijzingen voor het installeren en uitvoeren van de voorbeeldtoepassing.

Aanvullend leermateriaal Op internet vindt u vele nuttige bronnen die informatie verschaffen over Connect Enterprise en over webservices en XML.

Connect Enterprise Connect Enterprise Resource Center Het bronnencentrum op de Adobe-website wordt regelmatig bijgewerkt met zelfstudies, simulaties, informatie over de beste werkwijzen en met koppelingen naar procedures.

Ontwikkelaars zullen veel hebben aan het centrum voor ontwikkelaars. Het wordt regelmatig bijgewerkt met zelfstudies en artikelen over het samenstellen van toepassingen voor Connect Enterprise.

Connect Enterprise Developer Center

Aanvullend leermateriaal

9

Connect Enterprise Documentation Center In het documentatiecentrum hebt u toegang tot alle productinformatie over Connect Enterprise en kunt u deze downloaden of weergeven.

Als u technische ondersteuning nodig hebt, vindt u in het ondersteuningscentrum de meest recente informatie, zoals technische notities, Connect Enterprise-presentaties en details over het ondersteuningsprogramma. U kunt ook de ondersteuningsforums raadplegen voor discussies met gelijkgestemden over technische problemen.

Connect Enterprise Support Center

Het ondersteuningscentrum voor gebruikers met een licentie beschikt over documentatie en andere bronnen voor klanten die over een licentie voor Adobe Connect Enterprise Server 6 beschikken.

Connect Enterprise Licensed Support Center

XML- en webservices De Web Services Primer op de website van Xml.com (xml.com) vormt een goede introductie bij webservices. De XML-zelfstudie op

de website van W3Schools (w3schools.com) helpt u te leren werken

met XML. De Xpath-zelfstudie die u ook op de website van W3Schools (w3schools.com) vindt, bevat een beschrijving van XPath, waarmee u een XML-document kunt parseren, zodat u het in een toepassing kunt gebruiken. De XSLT-zelfstudie,

een derde zelfstudie op de website van W3Schools (w3schools.com) verschaft informatie over XSL-transformaties. U gebruikt deze transformaties om XMLgegevens om te zetten in andere indelingen.

De XSLT-specificatie (XSL Transformations) op

de website van W3C (w3.org) is de officiële definitie van XSLT, samengesteld door het normen voorschrijvende comité dat de specificatie heeft ontworpen. Het Engelstalige artikel Numeric Representation of Dates and Time op de website van de ISO (International Organization for Standardization, iso.org) verschaft informatie over het gebruik van de ISO 8601-standaard voor de datum- en tijdnotatie.

Het Engelstalige artikel Date and Time Formats op de website van W3C (w3.org) vormt de officiële definitie van de datum- en tijdnotatie ISO 8601.

10

Voordat u begint

Overige technologieën In het Flash Player Developer Center en het Flash Media Server Developer Center, beide beschikbaar in het centrum voor ontwikkelaars van Adobe vindt u artikelen, voorbeelden en ideeën voor het ontwikkelen van toepassingen die gebruikmaken van Adobe Flash Player en Adobe Flash Media Server. SCORM Concepts op de website van Eduworks Corporation (eduworks.com) is een zelfstudie over SCORM (Shareable Content Object Reference Model). U vindt hier een beschrijving van SCO’s (Shareable Content Objects) en LMS (Learning Management Systems).

Een LDAP Roadmap op de website van Kings Mountain Systems (www.kingsmountain.com) verschaft een nuttig overzicht van LDAP (Lightweight Directory Access Protocol). Deze site verschaft nuttige achtergrondinformatie en koppelingen voor ontwikkelaars die een LDAP-directory willen integreren met Connect Enterprise. Connect Enterprise gebruikt een Microsoft SQL Server-database waaruit uw aangepaste toepassingen gegevens kunnen opvragen en waar ze gegevens naartoe kunnen schrijven. U vindt wellicht nuttige bronnen in het centrum van ontwikkelaars voor Microsoft SQL Server (msdn.microsoft.com), zoals referentiemateriaal, community's, ondersteuning en andere informatie.

Microsoft SQL Server

Conventies Deze gids maakt gebruik van in de industrie gangbare standaardnormen voor het weergeven van code waarmee u al vertrouwd bent. API-referentie is echter een formele definitie van het API-contract tussen de aanvragende toepassing en de server, en als zodanig dienen de syntaxisdefinities van de aanvraag-URL’s te worden beschreven. We hebben de afzonderlijke delen van een aanvraag-URL op verschillende regels geplaatst, teneinde de leesbaarheid te vergemakkelijken: http://server_name/api/xml ?action=custom-fields &filter-definition=value &session=BreezeSessionCookieValue

Voer een aanvraag-URL als één enkele regel in op de adresbalk van een browser of stel een aanvraag-URL samen in één regel in een toepassing: https://example.com/api/xml?action=custom-fields&filter-name=location

Syntaxiselementen in blauw verwijzen naar definities die u samenstelt, met een hyperlink naar de syntaxis van de definitie.

Conventies

11

12

Voordat u begint

HOOFDSTUK 1

1

Architectuur Welkom bij Adobe® Connect™ Enterprise Web Services, de webservicelaag die zich boven Adobe Connect Enterprise Server 6, Adobe Connect Enterprise Hosted 6 en de Connect Enterprise-suite van toepassingen bevindt. Web Services biedt u de mogelijkheid portals of webtoepassingen te maken waarin Connect Enterprise-functies en rapportagegegevens worden geïntegreerd met systemen van derden, zoals portals, CRM-systemen en resourceplanningsystemen voor ondernemingen.

Training

Gebeurtenissen

Presentator

Vergadering

APIs & SDKs

Enterprise Server of Enterprise Hosted

Via de XML API van Connect Enterprise Web Services kunt u functionaliteit voor vergaderingen, trainingen en gebeurtenissen aan uw toepassingen toevoegen. Stel dat u gebruikmaakt van een centraal gebruikersbeheersysteem, zoals een LDAP-directory, Microsoft Active Directory of een ander systeem van derden dat integraal deel uitmaakt van uw bedrijfsprocessen.

13

U kunt dan met Web Services een toepassing schrijven waarmee de gebruikers in uw systeem worden gesynchroniseerd met de gebruikers in Connect Enterprise. U kunt in de toepassing gebruikmaken van het J2EE-platform of een willekeurige andere technologie om een lijst van gebruikers uit de adressenlijst op te halen, deze lijst te vergelijken met een lijst van Connect Enterprise-gebruikers en vervolgens binnen de opslagplaats voor gebruikers van Connect Enterprise de gevraagde updates uit te voeren, zoals gebruikers of groepen toevoegen of verwijderen. Dit is slechts één voorbeeld van een aangepaste toepassing. Bezoek het Connect Enterprise Developer Center als u meer voorbeelden wilt bekijken.

Gegevensstroom In het volgende diagram worden de gegevensstromen tussen clienttoepassingen en Connect Enterprise weergegeven. De aangepaste toepassingen die u schrijft, gebruiken de paden die lopen van 1 naar 2 en van A naar B. Connect Enterprise-toepassingen (zoals Adobe® Acrobat® Connect™ Professional, Connect Training of Connect Events) kunnen alle gegevensstroompaden gebruiken.

`

CLIENTTOEPASSING

Flash Player

1

HTTP:80

A

HTTPS:443

C

RTMPS:443

3

RTMP:1935

4

3a

RTMPT:80

4a

2 Certificeringsinstantie

Webbrowser

CONNECT ENTERPRISE

B

WebservicesAPI

Web-/ toepassingsserver

D

Flash Media Server

SQL-database

De gegevensstroom tussen Connect Enterprise en clienttoepassingen De gegevensstroom kan gecodeerd zijn met SSL of ongecodeerd.

14

Hoofdstuk 1: Architectuur

Ongecodeerd Als de gegevensstroom ongecodeerd is, worden er verbindingen gemaakt via HTTP en RTMP (het Adobe Real Time Messaging Protocol) en volgen deze verbindingen de paden die in de volgende tabel worden vermeld. 1

De clientwebbrowser vraagt een Acrobat Connect Professional-vergadering of inhouds-URL aan via poort HTTP:80 (de verbindingspaden kunnen variëren).

2

De webserver reageert met een inhoudsoverdracht of voorziet de clientbrowser van informatie waarmee deze toegang kan krijgen tot Acrobat Connect Professional.

3

Adobe Flash® Player vraagt een verbinding aan naar Macromedia® Flash Media Server van Adobe via RTMP:1935 en HTTP:80.

4

Flash Media Server antwoordt en er wordt een permanente verbinding geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser.

3a (alternatief)

In sommige gevallen vraagt Flash Player een verbinding naar de Flash Media Server aan, maar kan Flash Player slechts beschikken over een verbinding door een tunnel via RTMPT:80.

4a (alternatief)

Flash Media Server antwoordt en er wordt een verbinding door een tunnel geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser.

Als de gegevensstroom gecodeerd is, worden er als volgt beveiligde verbindingen via HTTPS en RTMPS (Real Time Messaging Protocol via SSL) tot stand gebracht.

Gecodeerd

A

De clientwebbrowser vraagt een beveiligde vergadering of inhouds-URL aan via een gecodeerde verbinding op HTTPS:443 (de verbindingspaden kunnen variëren).

B

De webof toepassingsserver reageert met de overdracht van gecodeerde inhoud of voorziet de client van informatie voor het maken van een gecodeerde verbinding met Acrobat Connect Professional.

C

Flash Player vraagt een gecodeerde verbinding aan naar Flash Media Server via RTMPS:443.

D

Flash Media Server antwoordt en er wordt een permanente verbinding geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser.

Gegevensstroom

15

Aangepaste toepassingen Connect Enterprise Web Services biedt een XML API, dus uw toepassing moet in staat zijn te communiceren met Enterprise Server of Enterprise Hosted met behulp van XML via HTTP of XML via HTTPS. Uw toepassing roept de API aan door een aanvraag-URL te maken en een of meer parameters door te geven, in de vorm van naam-waardeparen of een XMLdocument. Web Services retourneert een XML-antwoord waaruit u waarden kunt extraheren. Aangepaste toepassingen halen metagegevens op uit de Connect Enterprise-database. Tot deze metagegevens behoren namen en tijden van vergaderingen of cursussen, URL's van vergaderruimten, inhouds-URL's en rapportinformatie. De gegevensstroom voor een aangepaste toepassing die metagegevens uit de database ophaalt, loopt van een webbrowser op de client achtereenvolgens naar de webtoepassingsserver op de client, de XML API, de Connect Enterprise-webtoepassingsserver, de SQL-database en weer terug. De gegevensstroom tussen een aangepaste toepassing en Connect Enterprise loopt als volgt: 1.

Een gebruiker opent uw aangepaste toepassing vanuit een webbrowser.

2.

De toepassing roept de XML API aan via HTTP:80 of HTTPS:443.

3.

De Connect Enterprise-webtoepassingsserver verifieert de toepassing en de gebruikers van deze toepassing, haalt metagegevens op uit de SQL-database en retourneert deze metagegevens.

4.

Op de client verwerken uw webof toepassingsserver, XML-parser en softwarebibliotheken het antwoord en retourneren dit naar uw toepassing.

5.

De gebruiker klikt vervolgens in uw aangepaste toepassing op een vergadering of inhoudsURL. Nu opent de gebruiker een Connect Enterprise-toepassing, zoals Acrobat Connect Professional, om een vergaderruimte binnen te gaan en komt er een gegevensstroom op gang tussen de Connect Enterprise-toepassing en de server.

Connect Enterprise-toepassingen De Connect Enterprise-toepassingen roepen de server aan met dezelfde Web Services XML API die u gebruikt vanuit een aangepaste toepassing. Over het algemeen wordt inhoud getransporteerd via HTTP-poort 80 of HTTPS-poort 443. Tot de inhoud behoren dia's, HTTP-pagina's, bestanden die zijn gemaakt met Macromedia® Flash van Adobe (SWF-bestanden) en bestanden die zijn overgebracht via de pod voor het delen van bestanden. Dit zijn standaardpoortnummers die u kunt configureren (raadpleeg de Installatie- en configuratiegids voor Connect Enterprise voor meer informatie).

16


Stroomsgewijze, realtime-communicatie vanaf Flash Media Server vindt plaats via RTMPpoort 1935. Deze stroomsgewijze communicatie kan bestaan uit het afspelen van audio- en videobestanden (webcam en .flv), het delen van bestanden en uit chatten. Ook de status van de vergadering wordt bijgehouden via RTMP-poort 1935.

Onderdelen van Connect Enterprise De architectuur van zowel Enterprise Server als Enterprise Hosted is opgebouwd uit twee serveronderdelen en elke server maakt gebruik van een SQL-database. De webtoepassingsserver De webtoepassingsserver is het brein van Connect Enterprise. Deze server bevat alle bedrijfslogica die nodig is om inhoud te leveren aan gebruikers en voert deze logica uit. De server zorgt voor de toegangscontrole, beveiliging, verdeling van de quota en licentieverlening, maar ook voor beheerfuncties, zoals clustering, failover en replicatie.

Op de webtoepassingsserver is ook de toepassing Connect Enterprise Manager aanwezig, die u kunt gebruiken om de inhoud en gebruikers van uw organisatie weer te geven en te beheren, als u geen aangepaste toepassing of een geïntegreerd systeem van derden gebruikt. De metagegevens die de inhoud en gebruikers beschrijven, kunnen worden opgeslagen in één of meerdere gerepliceerde SQL-databases. De webtoepassingsserver is stateless (houdt geen status bij), wat betekent dat schaling vrijwel lineair is. Flash Media Server Flash Media Server zorgt voor de spierkracht van Connect Enterprise. Flash Media Server verzendt audio- en videogegevens en interactieve multimedia-inhoud stroomsgewijs via RTMP. Wanneer er een vergadering wordt opgenomen en afgespeeld, audio- en videogegevens worden gesynchroniseerd of inhoud wordt geconverteerd en gecodeerd voor realtime-schermdeling, weet u dat Flash Media Server aan het werk is.

Flash Media Server speelt ook een belangrijke rol bij het verminderen van de belasting van de server door webpagina's die vaak worden bezocht, gegevensstromen en gedeelde gegevens die vaak worden opgevraagd, in een cache te plaatsen. Connect Enterprise maakt gebruik van de Microsoft SQL Serverdatabase voor permanente opslag van metagegevens over transacties en toepassingen, waaronder gegevens over gebruikers, groepen en inhoud en rapporten. De XML API haalt metagegevens op die in de database zijn opgeslagen. De database kan worden geïmplementeerd met de Microsoft SQL Server Desktop Engine (MSDE) of de volledige versie van Microsoft SQL Server 2000.

De SQL-database

Gegevensstroom

17

De API voor het eerst aanroepen Connect Enterprise Web Services gebruikt een servlet-raamwerk om aanvragen van de XML API te verwerken. In het gegevensstroomdiagram wordt het servlet-raamwerk vertegenwoordigd door het onderdeel API. De API-servlet ontvangt XML-aanvragen van clients en retourneert XML-antwoorden vanuit de webtoepassingsserver en de database. Een aanvraag die is gericht aan de XML API, wordt opgemaakt als een HTTP-aanvraag-URL die de API-servlet afhandelt. Een aanvraag-URL heeft een handelingnaam en parameters in naam-waardeparen. Hier ziet u een voorbeeld: https://example.com/api/xml?action=sco-info&sco-id=2006334909

Als u toegang hebt tot een Enterprise Server- of Enterprise Hosted-account waarmee u API-aanroepen kunt testen, kunt u experimenten uitvoeren. Adobe raadt u zelfs aan om API-aanroepen te testen in de browser wanneer u de API verkent en toepassingen schrijft. Het is handig om voordat u begint een hulpprogramma te installeren waarmee u HTTPheaders met aanvragen en antwoorden in uw browser kunt weergeven. Common-info aanroepen in een browser 1.

(Optioneel) Schakel in de browser een hulpprogramma voor het weergeven van HTTPheaders in.

2.

Open een browser en ga naar de aanmeldingspagina van Connect Enterprise.

3.

Meld u niet aan, maar verwijder het gedeelte van de URL na de domeinnaam en voeg een aanroep toe voor het opvragen van common-info: https://example.com/api/xml?action=common-info

Het antwoord dat u krijgt na het aanroepen van common-info verschaft informatie over uw sessie met de server. Let vooral op het cookie waarmee uw sessie wordt geïdentificeerd: <status code="ok" /> breezbryf9ur23mbokzs8 2006-08-29T19:02:45.843+00:00 https://example.com abc123def789 /api/xml?action=common-info breeze_530_r212 <user-agent> Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)

18


Wanneer u een gebruiker aanmeldt vanuit een toepassing, moet u de cookiewaarde terugsturen naar de server ter identificatie van de sessie van de gebruiker (zie Aanmelden vanuit een toepassing). Principal-list aanroepen in een browser

Als u de cookiewaarde BREEZESESSION hebt opgevraagd via common-info, voegt de browser deze waarde toe aan de aanvraagheader bij uw volgende aanvraag. 1.

Meld u aan bij Connect Enterprise in een webbrowser. Wijzig de URL in de browser zodanig dat deze principal-list aanroept: https://example.com/api/xml?action=principal-list

2.

Bekijk de aanvraagheader. Deze keer wordt de cookiewaarde BREEZESESSION naar de server teruggezonden: 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.

Bekijk het antwoord, dat bestaat uit een lijst van alle principals op de server, elk met een eigen principal-element. <status code="ok" /> <principal-list> <principal principal-id="624526" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> joe harrison [email protected] <email>[email protected] <principal principal-id="624550" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> bob jones [email protected] <email>[email protected] ...

De API voor het eerst aanroepen

19

Filters en sorteerbewerkingen toevoegen Vele handelingen in de API bieden u de mogelijkheid een filter toe te voegen om slechts bepaalde elementen van het antwoord te retourneren of een sorteerbewerking uit te voeren om elementen van het antwoord in een bepaalde volgorde weer te geven. Een filter is een speciale parameter die begint met het sleutelwoord filter, gevolgd door een optionele modifier en vervolgens een veldnaam en een waarde. Hier volgen enkele voorbeelden van filters: (hiermee worden alleen de resultaten geretourneerd die exact overeenkomen met de tekst jazz doe)

■

filter-name=jazz doe

■

filter-like-name=jazz

■

filter-out-type=user

(hiermee worden alle resultaten geretourneerd die de tekst jazz

bevatten) (hiermee worden alle resultaten geretourneerd die niet van het

type user zijn) Dit zijn slechts een paar filtertypen. Meer voorbeelden kunt u vinden bij filterdefinition. Zoek een handeling op in de referentielijst (in Hoofdstuk 6, “Actiereferentie”) om na te gaan of het antwoord van een handeling kan worden gefilterd. Als een handeling filteren toestaat, kunt u over het algemeen filters gebruiken voor elk antwoordelement of kenmerk. Een sorteerbewerking is ook een speciale parameter die begint met het sleutelwoord sort (of sort1 of sort2), gevolgd door een veldnaam en vervolgens het sleutelwoord asc of desc, bijvoorbeeld: (hiermee sorteert u gegevens in oplopende volgorde op name)

■

sort-name=asc

■

sort-group-id=desc

(hiermee sorteert u gegevens in aflopende volgorde op group-id)

Dit zijn slechts enkele voorbeelden van sorteerbewerkingen. U kunt sorteerbewerkingen testen in de browser of meer voorbeelden van sorteerbewerkingen bekijken bij sortdefinition. Een aanroep maken met een filter en een sorteerbewerking 1.

Roep principal-list opnieuw aan en geef alleen groepen weer die u alfabetisch sorteert op naam: https://example.com/api/xml?action=principal-list&filter-type=group &sort-name=asc

2.

Kies vervolgens een groep in de lijst en filter op de naam van deze groep om het antwoord verder toe te spitsen: https://example.com/api/xml?action=principal-list&filter-name=developers

20


Nu wordt slechts één groep geretourneerd: <status code="ok" /> <principal-list> <principal principal-id="2007105030" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> developers developers

Hoe gaat u van hieruit verder? Op dit punt kunt u doorgaan met het testen van aanroepen in de browser om te zien hoe deze werken. Dit is de beste en gemakkelijkste manier om de XML API te leren kennen. Als u meer informatie nodig hebt, kunt u de volgende bronnen raadplegen: ■

De API-referentie in Hoofdstuk 6, “Actiereferentie”

■

Hoofdstuk 2, “Aanmelding en aanvragen,” voor informatie over de manier waarop gebruikers kunnen worden aangemeld vanuit toepassingen

■

Hoofdstuk 3, “Grondbeginselen,” om te leren welke drie basisconcepten ten grondslag liggen aan de API

■

Hoofdstuk 4, “Vergaderingen,” als u vergaderingen wilt maken en beheren vanuit een toepassing

■

Hoofdstuk 5, “Training,” als u een trainingstoepassing maakt

De API voor het eerst aanroepen

21

22


HOOFDSTUK 2

2

Aanmelding en aanvragen In dit hoofdstuk wordt uitgelegd hoe u vanuit uw toepassing een gebruiker aanmeldt, aanvragen maakt, antwoorden verwerkt en de gebruiker weer afmeldt. De meeste van deze taken kunt u op verschillende manier uitvoeren, afhankelijk van de ontwikkelomgeving en serverconfiguratie waarmee u werkt en het ontwerp van uw toepassing.

Aanmelden vanuit een toepassing Elke aangepaste toepassing die u schrijft en die gebruikmaakt van functionaliteit van Adobe® Connect™ Enterprise Web Services of die is geïntegreerd met een systeem van derden, moet een gebruiker aanmelden bij Adobe Connect Enterprise Server 6- of bij een Adobe Connect Enterprise Hosted 6-account. In zijn meest eenvoudige vorm bestaat het aanmeldingsproces uit het aanroepen van de handeling login. De techniek voor het aanmelden varieert echter en is afhankelijk van de vraag of u gebruikmaakt van cookiebeheer, of u over een server met een licentie of een account op een hostserver beschikt en of de verificatie rechtstreeks in Connect Enterprise plaatsvindt of extern wordt uitgevoerd. Afhankelijk van de omgeving en de serverconfiguratie waarmee u werkt kunt u ook een combinatie van deze opties gebruiken. Wanneer een gebruiker zich aanmeldt, retourneert Connect Enterprise een cookie waarmee de sessie van de gebruiker kan wordt geïdentificeerd. U moet dit cookie telkens terugzenden naar de server wanneer er een aanroep naar de server wordt verzonden tijdens de sessie van de gebruiker. Wanneer de gebruiker zich vervolgens weer afmeldt, zorgt de server ervoor dat het cookie verloopt en moet u het cookie ongeldig maken. Cookiebeheer

In uw onwikkelomgeving kunt u een codebibliotheek gebruiken die zorgt voor het beheer van de cookies. De manier waarop het aanmeldingsproces verloopt en waarop de sessie van een gebruiker wordt beheerd, hangt af van de vraag of u een cookiebeheerbibliotheek gebruikt of de sessie van de gebruiker zelf beheert.

23

Mogelijk beschikt uw organisatie over een Enterprise Server met een licentie binnen de firewall of over een Enterprise Hosted-account bij Adobe. In beide gevallen verzendt u XML-aanvragen via HTTP of HTTPS, maar de beveiligingseisen en het aanmeldingsproces verschillen. Als u een klant bent met een account op een hostserver bij Adobe, kunt u in combinatie met de handeling login bepaalde parameters gebruiken waarmee u kunt voorkomen dat u gebruikers-id's en wachtwoorden via internet worden verzonden.

Een server met een licentie of een account op een hostserver

Rechtstreekse of externe verificatie Of u nu een account op een hostserver hebt of beschikt over een server met een licentie, in beide gevallen is verificatie noodzakelijk. U kunt uw toepassing rechtstreeks laten verifiëren door Connect Enterprise, maar u kunt gebruikers ook op uw eigen netwerk verifiëren, een id in een HTTP-aanvraagheader plaatsen en deze header naar Connect Enterprise verzenden. Hoe het aanmeldingsproces verloopt, is afhankelijk van de vraag of u rechtstreekse of externe verificatie gebruikt.

Aanmelden bij Enterprise Server De standaardtechniek voor het aanmelden van een gebruiker bij Enterprise Server bestaat uit het uitvoeren van de actie login waarbij de aanmeldings-id en het wachtwoord van de gebruiker worden doorgegeven. Deze techniek kan zowel voor de HTTP-aanvragen GET als POST worden gebruikt. U moet ook de BREEZESESSION-cookies beheren die de server retourneert voor elke gebruikerssessie. Als u gebruikmaakt van een cookiebeheerbibliotheek op de client, is het veel gemakkelijker om het beheer van de cookies aan de bibliotheek over te laten in plaats van daar zelf voor te zorgen. Als u niet over een dergelijke bibliotheek beschikt, roept u login aan met de parameter session, omdat dit gemakkelijker en betrouwbaarder is dan het instellen van waarden voor HTTP-headers. O P M E R K I NG

Als u een gebruikerswachtwoord naar Enterprise Server verzendt, kunt u het beste SSL gebruiken om ervoor te zorgen dat de wachtwoorden gecodeerd zijn tijdens de overdracht, zelfs als u een Enterprise Server met een licentie binnen uw eigen firewall gebruikt.

Aanmelden met cookiebeheer 1.

Roep de actie login aan, waarbij u de aanmeldings-id en het wachtwoord van de gebruiker doorgeeft, maar niet de parameter session gebruikt: http://example.com/api/[email protected] &password=football

24

Hoofdstuk 2: Aanmelding en aanvragen

2.

Parseer het antwoord om na te gaan of de statuscode ok is. Als de aanmelding is gelukt, retourneert de server het cookie BREEZESESSION in de antwoordheader: Set-Cookie: BREEZESESSION=breezbryf9ur23mbokzs8;domain=.macromedia.com;path=/

3.

Sta de cookiebeheerbibliotheek toe om het BREEZESESSION-cookie te beheren. De bibliotheek op uw client stuurt het cookie in een aanvraagheader terug naar de server bij alle volgende aanroepen gedurende de rest van de gebruikerssessie. U hoeft het cookie niet expliciet in de aanvraagheader te plaatsen. Wanneer de gebruiker zich afmeldt, verloopt het cookie.

Aanmelden met de session-parameter 1.

Roep common-info aan voordat u de gebruiker aanmeldt om de waarde van het cookie BREEZESESSION op te halen: http://example.com/api/xml?action=common-info

2.

Extraheer de waarde van het cookie uit het antwoord: breezxq66rt43poai3if8

3.

Meld de gebruiker aan en geef daarbij de waarde van het cookie op: http://example.com/api/[email protected] &password=football&session=breezxq66rt43poai3if8

4.

Parseer het antwoord om na te gaan of de statuscode ok is.

5.

Gebruik de parameter session met dezelfde cookiewaarde voor alle volgende aanroepen voor de gebruiker totdat de sessie van de gebruiker wordt beëindigd: https://example.com/api/xml?action=principal-list &session=breezxq66rt43poai3if8

6.

Wanneer de gebruiker zich afmeldt of de sessie van de gebruiker wordt beëindigd, moet u de cookiewaarde niet opnieuw gebruiken.

Aanmelden bij Enterprise Hosted Ook als u zich rechtstreeks wilt aanmelden bij een of meerdere accounts op een hostserver, gebruikt u de actie login, maar in dat geval moet u behalve de aanmeldings-id en het wachtwoord van de gebruiker ook een account-id of domeinnaam opgeven. U kunt een domeinnaam opgeven als u geen account-id via internet wilt verzenden.

Aanmelden vanuit een toepassing

25

Als u een account op een hostserver hebt, kunt u niet gebruikmaken van eenmalige aanmelding of externe verificatie. U moet de verificatiereferenties van de gebruiker voor Enterprise Hosted doorgeven en niet de referenties voor een extern netwerk. OPMERKING

Het is belangrijk dat u SSL inschakelt voor uw Enterprise Hosted-account omdat u gebruikers-id's, wachtwoorden en accountgegevens via internet naar uw account op een hostserver bij Adobe verzendt.

Aanmelden bij Enterprise Hosted met een account-id 1.

Roep voordat u de gebruiker aanmeldt common-info aan met de domeinnaam van uw account op de hostserver in de aanvraag-URL of de parameter domain: http://acme.adobe.com/api/xml?action=common-info http://adobe.com/api/xml?action=common-info&domain=acme.adobe.com

2.

Parseer het antwoord om de waarden van cookie en account-id op te vragen: Sbreezzd2dfr2ua5gscogv ...

3.

Verzamel de aanmeldings-id en het wachtwoord van de gebruiker in uw toepassing.

4.

Roep de actie login aan, waarbij u de referenties van de gebruiker en de parameters account-id en session toevoegt: https://example.com/api/[email protected] &password=happy&account-id=295153&session=Sbreezzd2dfr2ua5gscogv

5.


6.

(Optioneel) U kunt desgewenst login aanroepen voordat u common-info aanroept en de cookiewaarde uit de antwoordheader extraheren, waarna u het cookie zelf beheert of een cookiebeheerbibliotheek gebruikt. Zie Aanmelden met cookiebeheer of Aanmelden met de session-parameter voor meer informatie.

Aanmelden bij Enterprise Hosted met een domeinnaam 1.

Roep voordat u de gebruiker aanmeldt common-info aan met de domeinnaam van uw account op de hostserver in de aanvraag-URL of de parameter domain: http://acme.adobe.com/api/xml?action=common-info http://adobe.com/api/xml?action=common-info&domain=acme.adobe.com

2.

Parseer het antwoord om de waarden van cookie en host op te vragen: breezxq66rt43poai3if8 ... https://acme.adobe.com

26


3.

Extraheer de domeinnaam uit de waarde van host: acme.adobe.com

4.

Verzamel in uw toepassing de aanmeldings-id en het wachtwoord van de gebruiker. Zorg ervoor dat u de aanmeldings-id voor Enterprise Hosted gebruikt en geen externe id.

5.

Roep login aan, waarbij u de referenties van de gebruiker en de parameters domain en session toevoegt: https://example.com/api/xml?action=login&login=joe &password=smith99&domain=acme.adobe.com&session=breezxq66rt43poai3if8

De parameter domain is equivalent aan de parameter account-id, maar door de domeinparameter te gebruiken voorkomt u dat een account-id via internet wordt verzonden. Dat is vooral van belang als u een niet-gecodeerde verbinding gebruikt. 6.


7.

(Optioneel) U kunt desgewenst login aanroepen voordat u common-info aanroept, en de cookiewaarde uit de antwoordheader extraheren waarna u het cookie zelf beheert of een codebibliotheek voor cookiebeheer gebruikt. Raadpleeg Aanmelden met cookiebeheer of Aanmelden met de session-parameter voor meer informatie.

Aanmelden met HTTP-headerverificatie O P ME R K I N G

De instructies in deze sectie zijn alleen van toepassing op Enterprise Server.

Uw toepassing kan een vertrouwde centrale server gebruiken om gebruikers die gebruikmaken van eenmalige aanmelding te verifiëren en de verificatie van uw netwerk (hier externe verificatie genoemd) door te geven aan Enterprise Server, zonder expliciet een gebruikers-id en wachtwoord voor Enterprise Server door te geven. (Raadpleeg de Installatie- en configuratiegids voor Connect Enterprise voor gedetailleerde instructies voor het installeren en configureren van HTTP-headerverificatie).


27

Met HTTP-headerverificatie meldt een gebruiker zich aan bij uw verificatieserver. Als de gebruiker eenmaal is geverifieerd, voegt u een HTTP-aanvraagheader toe waarmee de gebruiker kan worden geïdenitificeerd of configureert u een proxyserver om de header toe te voegen. Het verificatiefilter op Connect Enterprise (met de naam HeaderAuthenticationFilter) converteert uw gebruikersidentificatie naar een aanmeldings-id voor Connect Enterprise en verifieert de gebruiker. Verificatieserver

Proxyserver

Connect Enterprise Server Verificatiefilter

Extern

Extern met header

Enterprise Server

SQL-datatbase

Verificatiefilters converteren externe verificatiereferenties naar Enterprise Server-referenties. Externe verificatie wordt toegevoegd aan de standaardverificatie van Connect Enterprise. Iedere gebruiker die toegang wil tot Enterprise Server heeft een geldige aanmeldings-id en een geldig wachtwoord voor Enterprise Server nodig. Wanneer u een aanmeldingsaanvraag naar Enterprise Server verzendt met een externeverificatiereferentie, wordt de volgende procedure uitgevoerd: ■

Het verificatiefilter onderschept de aanvraag en controleert of er een gebruiker op Enterprise Server aanwezig is met een ext-login-veld dat overeenkomt met uw externe referentie.

■

Als de gebruiker wordt gevonden, geeft het filter uw externe verificatie door aan Enterprise Server en meldt de server de gebruiker aan.

■

Als de gebruiker niet wordt aangetroffen, geeft het filter de aanmeldingsaanvraag door aan de server, waarna op de server de aanmeldingspagina wordt weergegeven. De gebruiker moet zich vervolgens aanmelden bij Enterprise Server.

■

Als de gebruiker zich met succes aanmeldt, werkt Enterprise Server het veld ext-login in het profiel van de gebruiker bij met de externe referentie uit uw aanvraag. Wanneer u de volgende keer een aanvraag verzendt met de externe referentie van de gebruiker, vindt Enterprise Server een ext-login-veld met overeenkomende gegevens en hoeft de gebruiker zich niet aan te melden bij Connect Enterprise.

■

Als de gebruiker zich niet kan aanmelden, heeft de gebruiker geen toegang tot toepassingen, inhoud of vergaderingen van Enterprise Server.

28


Hier volgen de stappen die u moet nemen om login aan te roepen wanneer u HTTPheaderverificatie gebruikt. Aanmelden bij Enterprise Server met HTTP-headerverificatie 1.

Configureer uw netwerkservers en de Enterprise Server voor HTTP-headerverificatie volgens de instructies in de Installatie- en configuratiegids voor Connect Enterprise.

2.

Verwijder in [de locatie van uw server]/appserv/conf/WEB-INF/web.xml de commentaarcodes rond het element filter-mapping voor HeaderAuthenticationFilter en voeg commentaarcodes toe rond alle andere filtermapping-elementen: HeaderAuthenticationFilter /* NtlmAuthenticationFilter /* -->

3.

Schakel in het element filter voor HeaderAuthenticationFilter het /api/-patroon voor aanvraag-URL's in. Dit kunt u op twee manieren doen. Als uw toepassing de XML API én een of meer Connect Enterprise-toepassingen gebruikt Gebruik in het element filter voor HeaderAuthenticationFilter commentaarcodes om het element init-param met de param-value /api/ uit te schakelen: <param-name>ignore-pattern-0 <param-value>/api/ -->

Wijzig het element filter-mapping voor uw filtertype zodanig dat deze het URL-patroon /api/* in plaats van /* gebruikt: Als uw toepassing alleen de XML API gebruikt

HeaderAuthenticationFilter /api/*

Voeg vervolgens in het element filter voor uw filtertype commentaarcodes toe rond alle init-param-elementen met de param-name ignore-pattern-x:


29

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

Configureer Enterprise Server zodanig dat er gebruikers worden aangemaakt voor wie het veld ext-login wordt ingesteld op de externe gebruikers-id die u verzendt (zie de Installatie- en configuratiegids voor Connect Enterprise voor meer informatie). Het veld ext-login heeft standaard dezelfde waarde als login, de aanmeldings-id van Enterprise Server.

5.

Als uw systeem de nieuwe gebruiker eenmaal heeft geverifieerd, maakt u een loginaanvraag. Voeg de parameter external-auth=use toe, maar niet de parameter login of password: https://example.com/api/xml?action=login&external-auth=use

6.

Voeg uw geverifieerde gebruikers-id toe aan de HTTP-aanvraagheader. Gebruik standaard de headernaam x-user-id: x-user-id: joesmith

U kunt een andere headernaam opgeven door in het bestand custom.ini een waarde op te geven voor HTTP_AUTH_HEADER. U kunt ook een proxyserver configureren om de HTTPheaderwaarde in te stellen. Zie de Installatie- en configuratiegids voor Connect Enterprise voor informatie over deze zaken. 7.


8.

Verwerk de cookiewaarde BREEZESESSION die in de antwoordheader is geretourneerd. Dit kunt u op twee manieren doen. Stel de bibliotheek in staat de cookiewaarde te extraheren, deze op te slaan en weer terug te sturen naar de server bij alle volgende aanvragen van de gebruiker.

Als u een clientbibliotheek gebruikt die cookies beheert

30


Extraheer de waarde van het cookie BREEZESESSION uit de antwoordheader. Sla deze waarde op en stuur deze weer terug naar de server in de parameter session van alle volgende aanvraagacties die u aanroept voor dezelfde gebruiker, zolang de sessie van de gebruiker geldig is: Als u de cookies zelf beheert

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

Zorg ervoor dat u de cookiewaarde niet opnieuw gebruikt wanneer de sessie van de gebruiker is beëindigd.

Een aanvraag verzenden in een XMLdocument In sommige gevallen kunt u het beste een HTTP-POST-aanvraag naar de server verzenden om er zeker van te zijn dat de gegevens veilig zijn en niet zichtbaar zijn tijdens de overdracht. Geef in dergelijke gevallen de naam en parameters van de actie op in een XML-document. Een XML-document met een aanvraag maken 1.

Maak een XML-document met het hoofdelement params en onderliggende paramelementen voor de actienaam en elke parameter: <params> <param name="action">login <param name="login">[email protected] <param name="password">foobar

2.

■

U kunt slechts één actie in het hoofdelement params verzenden. U kunt geen batch verzenden van meerdere acties die na elkaar moeten worden uitgevoerd.

■

Het XML-document dat u verzendt, moet geldig zijn en op de juiste manier zijn opgemaakt. Probeer het document te valideren in een XML-editor voordat u het verzendt.

Schrijf code die een HTTP-POST-aanvraag naar Connect Enterprise verzendt en een XMLantwoord ontvangt. De specifieke code die u moet schrijven, is afhankelijk van de programmeertaal en de ontwikkelomgeving die u gebruikt.

3.

Verzend in de code die u schrijft het XML-document naar Connect Enterprise in de body van de HTTP-POST-aanvraag. ■

Neem het XML-document op in de aanvraag.

■

Zorg ervoor dat u de content-type-header instelt op text/xml of application/xml.

Een aanvraag verzenden in een XML-document

31

Een antwoord parseren met XPath Wanneer u een XML-antwoord van Connect Enterprise ontvangt, moet u antwoord kunnen parseren om de benodigde XML-elementen te extraheren. Als u werkt in een programmeertaal, zoals Java™, en u een XML-parser (zoals Xerces of JDOM) hebt geïnstalleerd, kunt u in deze parser een XLM-antwoord doorlopen, waarden uit knooppunten selecteren en deze waarden vervolgens gebruiken. XPath gebruiken om een antwoord te parseren 1.

Schrijf een methode die een of meer acties aanroept. Maak een instantie van de Xpathklasse, zodat u de Xpath-expressies kunt gebruiken. Roep de acties aan, lees het XMLantwoord en gebruik de Xpath-syntaxis om de benodigde waarden te selecteren: 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); } }

U kunt ook gebruikmaken van de mogelijkheid om te zoeken naar overeenkomende tekenreekspatronen om te controleren of de statuscode ok voorkomt. Een actie die is gelukt, retourneert altijd dit antwoord: <status code="ok" />

U kunt het antwoord controleren op het patroon ok of op code=”ok”.

32


Een foutbericht parseren Wanneer een API-actie met succes wordt voltooid, retourneert deze actie de statuscode ok. Als de aanroep echter mislukt, kan de actie ook een van de volgende statuscodes retourneren: invalid Hiermee wordt aangegeven dat de aanroep op een of andere manier ongeldig is. Meestal is de syntaxis ongeldig. no-access Dit betekent dat de huidige gebruiker geen toestemming heeft om de actie aan te roepen. Deze code bevat een subcode-kenmerk met meer informatie.

Hiermee wordt aangegeven dat er voor de actie geen gegevens beschikbaar zijn om te retourneren, terwijl de actie gewoonlijk wel gegevens retourneert.

no-data

Dit betekent dat de actie één enkel resultaat zou moeten retourneren, maar in werkelijkheid meerdere resultaten retourneert. too-much-data

Wanneer de statuscode invalid wordt weergegeven, bevat het antwoord ook een element invalid dat laat zien welke aanvraagparameter onjuist is of ontbreekt: <status code="invalid">

Wanneer de statuscode no-access wordt geretourneerd, wordt bij subcode uitgelegd waarom: <status code="no-access" subcode="denied" />

Alle geldige waarden voor code, subcode en invalid worden beschreven bij in de APIreferentie. Uw toepassing moet statuscodes en subcodes kunnen lezen en verwerken. Statuscodes verwerken 1.

Schrijf een methode die een XML API-antwoord parseert en daarbij zoekt naar de statuscode en de bijbehorende subcode (code en subcode). Dit is een voorbeeld 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(); }

Een foutbericht parseren

33

2.

Parseer nadat u een actie hebt aangeroepen het antwoord om de status te achterhalen.

3.

Als de status niet ok is, retourneert u de waarde null, geeft u de statuscode van de fout weer zodat het probleem kan worden opgespoord of zorgt u dat er een toepassingsuitzondering optreedt. Welke actie u het beste kunt ondernemen, hangt af van de aanroep en van de manier waarop uw toepassing is ontworpen.

Een gebruiker afmelden Wanneer een gebruiker zich afmeldt, wordt de sessie van deze gebruiker beëindigd en maakt Connect Enterprise het BREEZESESSION-cookie ongeldig door het op null in te stellen en een verloopdatum te gebruiken die reeds is verstreken. Als u bijvoorbeeld logout aanroept op 26 augustus 2006, wordt deze Set-Cookie-methode in de antwoordheader weergegeven, waarmee een lege cookiewaarde wordt ingesteld en een verloopdatum van een jaar geleden wordt opgegeven: Set-Cookie: BREEZESESSION=;domain=.macromedia.com;expires=Mon, 29-Aug-2005 22:26:15 GMT;path=/

Als u het BREEZESESSION-cookie beheert, moet u de waarde ongeldig maken, zodat deze niet opnieuw wordt gebruikt nadat de gebruiker zich heeft afgemeld. Een gebruiker afmelden en het sessiecookie ongeldig maken 1.

Roep logout aan om de gebruiker af te melden: https://example.com/api/xml?action=logout

2.

Parseer het antwoord om na te gaan of de statuscode ok is en het afmelden is gelukt.

3.

Stel de cookiewaarde in op null of maak het cookie op een andere manier ongeldig. In dit Java-codefragment is de cookiewaarde in de variabele breezesession opgeslagen en wordt deze variabele op null ingesteld: public void logout() throws XMLApiException { request("logout", null); this.breezesession = null; }

34


HOOFDSTUK 3

3

Grondbeginselen Nu u de architectuur van Adobe® Connect™ Enterprise Server en Adobe Connect Enterprise Hosted begrijpt en weet hoe u een API-aanroep in een browser kunt testen, kunt u XML APIaanvragen verzenden en de antwoorden analyseren. U dient drie belangrijke concepten te begrijpen om te kunnen werken met Adobe Connect Enterprise Web Services: ■

Principals, dit zijn gebruikers en groepen.

■

SCO's, dit zijn Shareable Content Objects (inhoudsobjecten die kunnen worden gedeeld), en deze vertegenwoordigen vergaderingen, cursussen en vrijwel alle inhoud die kan worden gemaakt in Connect Enterprise. SCO's (uitgesproken als skoos) zijn compatibel met de in de industrie gangbare SCORM-specificatie (Shareable Content Object Reference Model) en kunnen worden gebruikt met een LMS (Learning Management System).

■

Machtigingen, deze bepalen welke handelingen principals kunnen uitvoeren op objecten.

In dit hoofdstuk worden de standaardtaken beschreven die u met Web Services kunt uitvoeren, ongeacht de Connect Enterprise-toepassingen waarvoor u een licentie hebt aangeschaft. Vele taken worden beschreven alsof u ze uitvoert vanuit een browser. Als u de aanroep wilt uitvoeren vanuit een toepassing, vertaalt u de XML-aanvraag naar de taal waarin u werkt (een voorbeeld van een omzetting naar Java™ vindt u in “XML-aanvragen verzenden”).

Een principal-id zoeken Een principal is een gebruiker of een groep met gedefinieerde machtigingen voor de interactie met een SCO op de server. U kunt gebruikers en groepen maken voor uw organisatie en hun machtigingen wijzigen.

35

Connect Enterprise beschikt bovendien over de volgende geïntegreerde groepen: Beheerders, Auteurs, Trainingsmanagers, Gebeurtenismanagers, Gastheren van vergaderingen en Gastheren van seminars. U kunt gebruikers en groepen toevoegen aan geïntegreerde groepen, maar u kunt de machtigingen van geïntegreerde groepen niet wijzigen. Elke Connect Enterprise-gebruiker en -groep heeft een principal-id. In sommige APIaanroepen wordt de principal-id een group-id of een user-id genoemd, om deze id te kunnen onderscheiden van andere waarden. De waarde van de id die een gebruiker of groep identificeert, is altijd dezelfde, ongeacht de naam van deze id. U kunt de syntaxis van een willekeurige handeling controleren in Hoofdstuk 6, “Actiereferentie.” De principal-id van een gebruiker of groep opvragen 1.

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

U kunt het beste een filternaam, filteraanmelding of filter-email gebruiken voor een exacte overeenkomst. Wees voorzichtig met filter-like-name, dat kan namelijk de prestaties van de server beïnvloeden. 2.

Parseer de principal-elementen in het antwoord voor de principal-id: <principal principal-id="2006282569" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> jazz doe [email protected] <email>[email protected]

De principal-id van de huidige gebruiker opvragen 1.

Roep common-info aan nadat de gebruiker zich heeft aangemeld: https://example.com/api/xml?action=common-info

2.

Parseer de gebruikerselementen in het antwoord voor de user-id: <user user-id="2007124930" type="user"> jazz doe [email protected]

Hier wordt de principal-id de user-id genoemd, omdat deze altijd een gebruiker vertegenwoordigt die is geverifieerd voor Connect Enterprise. Een groep kan zich niet aanmelden bij de server. U kunt de user-id parseren als een principal-id in andere handelingen.

36

Hoofdstuk 3: Grondbeginselen

Principals of gasten vermelden Een principal met hettype user is een geregistreerde Connect Enterprise-gebruiker, terwijl een gebruiker met het type guest de vergaderruimte als een gast heeft betreden. De server legt informatie over de gast vast en geeft de gast een principal-id. Alle principals op de server vermelden 1.

Roep principal-list aan zonder parameters: https://example.com/api/xml?action=principal-list

Deze aanroep geeft alle Connect Enterprise-gebruikers als resultaat, bereid u dus voor op een uitgebreid antwoord. 2.

Parseer de principal-elementen in het antwoord voor de gewenste waarden: <principal principal-id="2006282569" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> jazz doe [email protected] <email>[email protected]

Alle gasten op de server vermelden 1.

Roep report-bulk-users aan en filter op een type guest: https://example.com/api/xml?action=report-bulk-users &filter-like-type=guest

Gebruik filter-like-type=guest in plaats van filter-type=guest. 2.

Parseer de row-elementen in het antwoord: [email protected] [email protected] <email>[email protected] guest

Principals of gasten vermelden

37

Gebruikers maken U hebt beheerdersrechten nodig om een nieuwe gebruiker te maken. Het wordt aangeraden dat u een gebruiker maakt die deel uitmaakt van de groep admins van uw toepassing om APIaanroepen te kunnen uitvoeren waarvoor beheerdersrechten zijn vereist. Een nieuwe gebruiker maken en een welkomste-mail verzenden 1.

Meld u bij uw toepassing aan als beheerder. In “Aanmelden vanuit een toepassing” worden de manieren beschreven waarop u zich kunt aanmelden.

2.

Roep principal-update aan met gebruik van minstens de volgende parameters: https://example.com/api/xml?action=principal-update [email protected]&password=hello [email protected]

Het type moet user zijn, has-children moet 0 of false zijn, send-email moet true zijn en voor email moet een geldig e-mailadres zijn opgegeven. De server verzendt een welkomste-mail met aanmeldingsgegevens naar het e-mailadres van de gebruiker. 3.

Parseer het principal-element in het antwoord voor de principal-id van de gebruiker: <principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> [email protected] <ext-login>[email protected] jamm doe

Een nieuwe gebruiker maken zonder een e-mailadres te gebruiken als aanmeldings-id 1.

Navigeer in Enterprise Manager naar Beheer > Gebruikers en groepen > Aanmeldingen wachtwoordregels bewerken. Controleer of E-mailadres gebruiken als aanmelding is ingesteld op Nee.

2.

Meld u bij uw toepassing aan als beheerder.

3.

Roep principal-update aan om de nieuwe gebruiker te maken en parseer de twee parameters login en email: https://example.com/api/xml?action=principal-update&first-name=jazz [email protected] &password=nothing&type=user&has-children=0

38


4.

Parseer het antwoord voor de principal-id van de nieuwe gebruiker: <principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> [email protected] <ext-login>[email protected] jazz doe

In het antwoord heeft ext-login standaard dezelfde waarde als login, totdat de gebruiker zich heeft aangemeld met gebruik van externe verificatie (zie “Aanmelden met HTTP-headerverificatie”).

Gebruikers bijwerken U moet vaak de gegevens van reeds gemaakte gebruikers bijwerken. U kunt voor gebruikers gedefinieerde standaardvelden bijwerken door principal-update aan te roepen met gebruik van de principal-id van de gebruiker. Tot de standaardvelden behoren email, login, first-name en last-name. Als u aangepaste velden hebt gedefinieerd voor de principal en deze wilt bijwerken, gebruikt u acl-fieldupdate. U hebt beheerdersrechten nodig om gebruikers te kunnen bijwerken, dus uw toepassing moet zich eerst als een gebruiker aanmelden bij de groep admins. U kunt zich niet aanmelden als de gebruiker en de gebruiker vervolgens zijn of haar eigen profiel laten bijwerken. Aanmelden en een gebruiker bijwerken 1.

Meld u aan als een gebruiker met beheerdersrechten.

2.

Roep principal-list aan met een filter om de principal-id van de gebruiker op te halen (zie “Een principal-id zoeken”).

3.

Roep principal-update aan om de gebruiker bij te werken: https://example.com/api/xml?action=principal-update [email protected]

4.

Parseer het antwoord voor de statuscode ok.

Aangepaste velden maken Aangepaste velden zijn aanvullende velden die u kunt definiëren. U kunt maximaal acht aangepaste velden definiëren voor een principal of een SCO met gebruik van custom-field-update.

Aangepaste velden maken

39

Als u het aangepaste veld hebt gedefinieerd, kunt u standaard de waarde instellen door de waarde te bewerken in Connect Enterprise of door custom-field-update aan te roepen. Als u wilt opgeven dat de waarde alleen mag worden bijgewerkt via de API, roept u custom-field-update aan met de parameter object-type=object-type-read-only. Een aangepast veld definiëren en dit instellen voor een gebruiker 1.

Maak eerst het veld met 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

Het veld name bevat de definitie van de veldnaam die in uw toepassing wordt weergegeven, zorg dus dat u de naam op de juiste wijze spelt. Het aangepaste veld in dit voorbeeld wordt gedefinieerd voor alle Connect Enterprise-principals. 2.

Parseer het field-element in het antwoord voor de veld-id: test Country

3.

Haal de principal-id van de gebruiker op (zie “Een principal-id zoeken”).

4.

Roep acl-field-update aan om de waarde van het veld in te stellen, geef een field-id door, de principal-id van de gebruiker als acl-id en een waarde: https://example.com/api/xml?action=acl-field-update &acl-id=2006258745&field-id=2007017474&value=San%20Francisco

5.

Parseer het antwoord voor de statuscode ok.

Groepen maken Als u gebruikers aan groepen wilt toevoegen, moet u principal-update aanroepen als de beheerder van uw toepassing. Een gebruiker aan een groep toevoegen 1.

Meld u als de gebruiker met beheerdersrechten aan bij uw toepassing.

2.

(Optioneel) Als de gebruiker nog niet bestaat, maakt u deze met gebruik van principal-update: https://example.com/api/xml?action=principal-update [email protected] &password=nothing&type=user&has-children=0

40


3.

(Optioneel) Parseer het antwoord voor de principal-id van de nieuwe gebruiker.

4.

Als deze gebruiker al bestaat, roept u principal-list aan om de principal-id van de gebruiker op te vragen: https://example.com/api/xml?action=principal-list&filter-type=user

5.

Parseer het antwoord voor de principal-id: <principal principal-id="5611980" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> Joy Black [email protected] <email>[email protected]

6.

Roep principal-list nogmaals aan om de principal-id van de groep op te vragen: https://example.com/api/xml?action=principal-list&filter-type=group

7.

Roep group-membership-update aan met is-member=true om de gebruiker aan de groep toe te voegen: https://example.com/api/xml?action=group-membership-update &group-id=4930296&principal-id=2006258745&is-member=true ■

De principal-id is de principal-id van de gebruiker.

■

De group-id is de principal-id van de groep.

■

De parameter is-member moet true zijn.

Controleren of een specifieke gebruiker deel uitmaakt van een groep 1.

Roep principal-list aan met een group-id, filter-is-member en een filter dat de principal identificeert: https://example.com/api/xml?action=principal-list&group-id=624523 &filter-is-member=true&filter-like-name=bob

2.

Parseer voor een principal-element in het antwoord. Een goed antwoord ziet er als volgt uit: <principal-list> <principal principal-id="624660" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> Bill Jones [email protected] <email>[email protected] true

Als de gebruiker geen groepslid is, is het element principal-list leeg:

Groepen maken

41

<status code="ok" /> <principal-list />

Controleren welke gebruikers deel uitmaken van een groep 1.

Als u de principal-id van de groep wilt ophalen, roept u principal-list aan met filters: https://example.com/api/xml?action=principal-list&filter-type=group &filter-name=developers

Met filter-type en filter-name zou principal-list een unieke overeenkomst moeten retourneren. 2.

Parseer het antwoord voor de principal-id: <principal principal-id="2007105030" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> developers developers false

3.

Roep principal-list nogmaals aan met de principal-id als een group-id en filter-is-member=true: https://example.com/api/xml?action=principal-list&group-id=2007105030 &filter-is-member=true

4.

Parseer het antwoord voor de principal-id-elementen: <principal principal-id="5698354" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> Bob Jones [email protected] true

Alle groepen vermelden waarvan een gebruiker deel uitmaakt 1.

Roep principal-list aan met de principal-id en filter-is-member=true van de gebruiker: https://example.com/api/xml?action=principal-list &principal-id=2006258745&filter-is-member=true

2.

Parseer het antwoord voor de principal-id-elementen: <principal principal-id="5698354" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> Bob Jones [email protected] true

42


SCO's zoeken Alle objecten in Connect Enterprise zijn Shareable Content Objects, ofwel SCO's. Het woord Shareable (deelbaar, voor gemeenschappelijk gebruik) is afkomstig uit leerbeheersystemen waarin inhoud wordt gecombineerd tot cursussen of studieprogramma's en door al deze cursussen en studieprogramma's wordt gebruikt. Op de server kan een SCO een willekeurig inhoudsobject zijn dat met andere inhoudsobjecten wordt samengevoegd tot een cursus of studieprogramma. Cursussen, studieprogramma's, presentaties en andere typen inhoud zijn SCO's. Vergaderingen, gebeurtenissen, mappen, structuren, koppelingen, afbeeldingsbestanden en alle andere objecten zijn ook SCO's. Elke SCO heeft een unieke identificatiecode in de vorm van een geheel getal die een sco-id wordt genoemd. De sco-id is uniek in de volledige server. In een gehoste account is de sco-id uniek in alle accounts. Elke SCO heeft ook een type, zoals content, course, meeting enzovoort. U kunt de waarden voor sco-id en type in het antwoord op sco-info of andere handelingen zien: <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258747" icon="producer" lang="en" max-retries="" sco-id="2006334909" source-sco-id="" type="content" version="1">

Kenmerken van SCO's Wanneer u de XML-antwoorden van verschillende aanroepen bekijkt, vallen u waarschijnlijk andere kenmerken van SCO's op: ■

■

■

■

■

■

De identificatiecode van een SCO wordt in sommige handelingen een sco-id genoemd, maar kan in andere handelingen tevens een folder-id, acl-id of anders worden genoemd. Al deze termen verwijzen naar dezelfde unieke id. Elke SCO kan worden geopend door verschillende principals, namelijk gebruikers of groepen. De specifieke principals met toegang tot een SCO worden gedefinieerd in de ACL's, de zogenaamde toegangsbeheerlijsten. Elke SCO heeft een unieke URL die uit twee gedeelten bestaat: een domeinnaam (zoals http://voorbeeld.nl) en een URL-pad (zoals /f2006123456/). U kunt deze aan elkaar plakken om de volledige URL samen te stellen die toegang geeft tot de SCO. Elke SCO beschikt over een navigatiepad waarin de locatie van de SCO in de mapstructuur wordt beschreven. Voor elke SCO is een machtiging gedefinieerd voor elke principal die toegang tot de SCO heeft. Sommige SCO's beschikken over beschrijvingsvelden, dit is tekst waarin informatie over de SCO wordt verschaft.

SCO's zoeken

43

Vaak moet u de id van een SCO achterhalen om informatie over de SCO op te vragen. SCO's zijn gerangschikt in een specifieke mappenstructuur waarin mappen namen hebben die aangeven of ze deel uitmaken van het hoogste niveau, of ze gedeelde inhoud of sjablonen of juist gebruikersinhoud en gebruikerssjablonen bevatten. Als u sco-shortcuts aanroept, wordt een mappenlijst geretourneerd. U ziet dat er verschillende typen mappen zijn: <status code="ok" /> <shortcuts> <sco tree-id="624530" sco-id="2006258751" type="my-meeting-templates"> <domain-name>http://example.com <sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com <sco tree-id="624529" sco-id="624529" type="meetings"> <domain-name>http://example.com <sco tree-id="624530" sco-id="624530" type="user-meetings"> <domain-name>http://example.com ...

In dit voorbeeld wordt verwezen naar de mappen voor vergaderingen, maar de mappen voor andere typen SCO's volgen een vergelijkbaar patroon. In elk type map worden bepaalde typen objecten met bepaalde toegangsrechten opgeslagen, en wel op de volgende manier: Dit zijn gedeelde mappen, zoals gedeelde vergaderingen, gedeelde training, enz. De Connect Enterprise-beheerder heeft toegang tot deze map. De beheerder kan beheerdersrechten toewijzen aan alle gebruikers, maar alleen leden van de geïntegreerde groep die aan de map is gekoppeld, kunnen nieuwe inhoud of vergaderingen in de map maken. inhoud, cursussen, vergaderingen, gebeurtenissen, seminars

Deze mappen bevatten allemaal een map voor iedere gebruiker die inhoud voor de map mag maken (dus bijvoorbeeld een map voor iedere gastheer van een vergadering of voor iedere ontwikkelaar van training). user-content, user-meetings, user-courses, user-events

Gebruikers maken hun eigen inhoud in deze mappen en beschikken over beheerdersmachtigingen voor de inhoud. Zo maken gastheren van vergaderingen bijvoorbeeld vergaderingen in hun map my-meetings en beschikken ze over beheerdersmachtigingen voor deze vergaderingen. my-courses, my-events, my-meetings, my-meeting-templates, my-content

44


Dit is een submap van de map Shared Meetings die vergaderingssjablonen bevat en de machtigingen van de map Shared Meetings overneemt.

shared-meeting-templates

U kunt de inhoud van een map vermelden om informatie over een specifieke SCO op te vragen. Wanneer u een SCO zoekt, maar niet over een sco-id beschikt, navigeert u met scoshortcuts en sco-expanded-contents door de mappen. Gebruik niet sco-search, dan worden namelijk alleen bepaalde typen SCO's geretourneerd. Een SCO zoeken wanneer u de sco-id niet kent 1.

Roep sco-shortcuts aan om een lijst met hoofdmappen van Connect Enterprise op te vragen: https://example.com/api/xml?action=sco-shortcuts

2.

Parseer het antwoord voor een type hoofdmap dat de SCO logisch gezien moet bevatten, dus bijvoorbeeld my-courses voor een cursus die de gebruiker heeft gemaakt.

3.

Parseer het resulterende sco-element voor een sco-id: <sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com

4.

Maak een aanroep bij sco-expanded-contents om de inhoud van de map weer te geven en voeg, indien mogelijk, een filter voor een exacte overeenkomst toe: https://example.com/api/xml?action=sco-expanded-contents &sco-id=2006258748&filter-name=All About Web Communities

U kunt kiezen uit verschillende typen filters:

5.

■

Een exacte-overeenkomstfilter op name of url-path (zoals filter-name of filterurl-path), als u de naam van de URL van de SCO kent.

■

Een 'later dan'- of 'vroeger dan'-datumfilter (filter-gt-date of filter-lt-date) op date-begin, date-created of date-modified, als u een van deze datums kent.

■

Een gedeeltelijke-naamfilter (bijvoorbeeld filter-like-name), als u de SCO-naam niet precies kent. Het gebruik van dit filter kan de prestaties van het systeem echter beïnvloeden.

Parseer het antwoord voor de 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"> A Day in the Life Resources /f28435879/ 2006-06-12T14:47:59.903-07:00 2006-06-12T14:47:59.903-07:00

SCO's zoeken

45

Informatie opvragen over een SCO 1.

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

2.

Parseer het antwoord voor name, url-path of een willekeurige andere waarde: <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258748" icon="curriculum" lang="en" max-retries="" sco-id="2006745669" source-sco-id="" type="curriculum" version="0"> 2006-06-12T14:45:00.000-07:00 2006-06-12T14:47:59.903-07:00 2006-06-12T14:47:59.903-07:00 A Day in the Life /day/

De URL samenstellen voor een SCO 1.

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

2.

Parseer het antwoord voor de domain-name-waarde in een willekeurig sco-element: <sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com

3.


4.

Parseer het antwoord voor het url-path: <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258747" icon="producer" lang="en" max-retries="" sco-id="2006334909" source-sco-id="" type="content" version="1"> 2006-05-11T12:00:02.000-07:00 2006-05-16T15:22:25.703-07:00 Test Quiz /quiz/ <passing-score>10 15100.0 <section-count>6

Zowel voor als achter het url-path staan schuine strepen. U kunt het url-path ontlenen aan report-my-meetings, report-my-training of aan andere aanroepen die het pad retourneren. 5.

Voeg het url-path samen met de domain-name: http://example.com/f2006258748/

46


Bestanden downloaden U kunt ZIP-bestanden downloaden van Connect Enterprise naar de lokale computer van een gebruiker. Een ZIP-bestand is een SCO. Als u dergelijke bestanden wilt downloaden, moet u een download-URL naar het ZIP-bestand samenstellen. Deze download-URL ziet er als volgt uit: http://server-domain/url-path/output/url-path.zip?download=zip

U kent waarschijnlijk de domeinnaam van uw server al (bijvoorbeeld voorbeeld.nl). Als dat niet het geval is, kunt u de domeinnaam ophalen door sco-shortcuts aan te roepen. Een ZIP-bestand downloaden van de server 1.


2.

Extraheer de waarde voor domain-name uit het antwoord: http://example.com

3.

Roep sco-info aan met de sco-id van het ZIP-bestand: https://example.com/api/xml?action=sco-info&sco-id=2006258747

De SCO is het volledige ZIP-bestand. 4.

Parseer het antwoord voor het url-path-element: <sco account-id="624520" disabled="" display-seq="0" folder-id="624522" icon="folder" lang="en" max-retries="" sco-id="2006258747" source-sco-id="" type="folder" version="1"> 2006-04-18T10:21:47.020-07:00 2006-04-18T10:21:47.020-07:00 [email protected] /f124567890/

5.

Stel de download-URL samen, bijvoorbeeld: https://example.com/quiz/output/quiz.zip?download=zip

Vergeet niet de afsluitende schuine streep voor de waarde van het url-path te verwijderen voordat u .zip toevoegt (de waarde moet bijvoorbeeld /quiz.zip zijn en niet /quiz/.zip).

Machtigingen controleren Machtigingen bepalen de manieren waarop een principal kan communiceren met een SCO. De machtigingstoewijzing, die aangeeft over welke machtigingen een principal beschikt voor een bepaalde SCO, wordt een toegangsbeheerlijst, ofwel een ACL genoemd. Een ACL bestaat uit drie verschillende typen gegevens:

Machtigingen controleren

47

■

De id van een principal (een principal-id).

■

De ID van een SCO, account of principal waarop een handeling wordt uitgevoerd. In machtigingsaanroepen wordt deze een acl-id genoemd. In andere aanroepen wordt de id wellicht een sco-id, account-id of principal-id genoemd.

■

Een sleutelwoord dat het machtigingsniveau van de principal aangeeft; dit is een van de geldige waarden in permission-id.

De machtiging van een principal voor een SCO controleren 1.

Roep permissions-info aan met zowel een acl-id als een principal-id: https://example.com/api/xml?action=permissions-info&acl-id=2006334909 &principal-id=2006258745

Als u de machtigingen voor een SCO wilt controleren, is de acl-id een sco-id. De acl-id kan ook een principal-id of een account-id zijn. 2.

Parseer het antwoord voor een permission-id: <status code="ok" />

Als een principal niet over expliciete machtigingen voor de SCO beschikt (in andere woorden, als permission-id=""), gelden de machtigingen van de principal voor het bovenliggende object van de SCO. De machtigingen van alle principals voor een SCO controleren 1.

Roep permissions-info aan met een acl-id, maar zonder principal-id: https://example.com/api/xml?action=permissions-info&acl-id=2006293572

2.

Doorloop de principal-elementen en parseer deze voor permission-id-waarden: <principal principal-id="2596608" is-primary="false" type="user" has-children="false" permission-id="view"> Jay Arnold [email protected]

De geldige machtigingswaarden worden vermeld in permission-id.

48


HOOFDSTUK 4

4

Vergaderingen Met aangepaste toepassingen kunnen Adobe® Acrobat® Connect™ Professional-vergaderingen worden weergegeven, gemaakt en verwijderd in een webtoepassing, portal of andere omgeving. Als u pas begint met het ontwerpen van uw vergadertoepassing, kunt u de voorbeeldtoepassing op de product-cd raadplegen (evenals Bijlage A, “Een voorbeeldtoepassing”). Als gebruikers op de URL van een vergaderruimte klikken, openen ze Acrobat Connect Professional, waarin de vergaderruimte wordt gehost. Met Adobe Connect Enterprise Server of Adobe Connect Enterprise Hosted wordt vervolgens stroomsgewijs audio, video en interactieve multimedia-inhoud naar de gebruikers van de vergaderruimte verzonden. Adobe raadt de volgende acties aan voor vergadertoepassingen: report-my-meetings sco-update

De vergaderingen van een gebruiker weergeven.

Een vergaderruimte maken of informatie erover bijwerken.

permissions-update

Een gastheer, presentator en deelnemers toevoegen aan een

vergadering. report-bulk-consolidated-transactions Vergadergebruik berekenen, met name de hoeveelheid tijd die elke gebruiker heeft doorgebracht in de vergadering. report-quiz-interactions

De resultaten van een opiniepeiling ophalen.

Voor sommige acties voor het verwerken van vergaderingen zijn Administrator-machtigingen nodig, zoals wordt vermeld in de taakinstructies. Maak een Connect Enterprise-gebruiker die lid is van de groep admins voor uw toepassing als u dergelijke aanroepen wilt uitvoeren.

Vergaderingen zoeken U moet vaak de sco-id van een vergadering zoeken zodat u gebruikers kunt uitnodigen, rapportgegevens over de vergadering kunt ophalen of de vergadering kunt bijwerken.

49

Het is belangrijk dat u de structuur begrijpt van de mappen waarin vergaderingen kunnen worden opgeslagen. Standaard worden vergaderingen opgeslagen in de map Mijn vergaderingen van de gastheer (in de API heet deze my-meetings). Zie "Kenmerken van SCO's" voor meer informatie over de mapstructuur. De sco-id van een vergadering zoeken 1.


2.

Parseer het antwoord voor de sco-id van een vergadermap die de vergadering zou kunnen bevatten: <sco tree-id="624530" sco-id="624530" type="user-meetings"> <domain-name>http://example.com

De mapnaam moet meetings, user-meetings of my-meetings zijn. Gebruik een map die zo laag mogelijk in de structuur ligt. 3.

Roep sco-contents aan op de map, waarbij u een of twee filters toevoegt om het antwoord te reduceren: https://example.com/api/xml?action=sco-contents&sco-id=2006258750 &filter-type=meeting&filter-name=Intro to Film

4.

■

Hoe specifieker u de filters kunt maken, hoe beter. Nuttige filters zijn bijvoorbeeld filter-name, filter-url-path of een datumfilter. Wees voorzichtig met het gebruik van filter-like-name, omdat dit invloed kan hebben op de systeemprestaties.

■

U kunt ook sco-expanded-contents aanroepen om submappen en hun inhoud weer te geven. sco-contents is echter beter voor de serverprestaties, als u de sco-id kent van de map die de vergadering bevat.

Parseer het antwoord voor de sco-id van de vergadering: <sco sco-id="2006743452" source-sco-id="-1625529" folder-id="2006258750" type="meeting" icon="meeting" display-seq="0" is-folder="0"> Intro to Film /film/ 2006-06-09T14:00:00.000-07:00 2006-06-09T20:00:00.000-07:00 2006-06-09T14:07:13.767-07:00 06:00:00.000

50

Hoofdstuk 4: Vergaderingen

Vergaderingen weergeven U wilt in uw toepassing misschien lijsten met Acrobat Connect Professional-vergaderingen weergeven, zoals een lijst met de vergaderingen die voor nu of voor de toekomst zijn gepland voor een gebruiker. In de workflow van een toepassing wordt een gebruiker dan bijvoorbeeld aangemeld en worden de vergaderingen van de gebruiker weergegeven of wordt de gebruiker toegevoegd aan een vergadering waarna vergaderingen worden weergegeven. Voor het weergeven van de vergaderingen van een gebruiker moet de inhoud van de map my-meetings worden weergegeven. De vergaderingen van een gebruiker weergeven 1.

Meld de gebruiker aan (zie "Aanmelden vanuit een toepassing").

2.

Roep report-my-meetings aan om de vergaderingen van de gebruiker weer te geven: https://example.com/api/xml?action=report-my-meetings

U kunt een filter toevoegen om het antwoord te reduceren. U kunt bijvoorbeeld vergaderingen uitsluiten die al zijn geëindigd. https://example.com/api/xml?action=report-my-meetings &filter-expired=false 3.

Parseer het antwoord voor waarden uit de meeting-elementen: <meeting sco-id="2007063179" type="meeting" icon="meeting" permissionid="host" active-participants="0"> September All Hands Meeting <domain-name>example.com /sept15/ 2006-09-15T09:00:00.000-07:00 2006-09-15T18:00:00.000-07:00 <expired>false 09:00:00.000

4.

Maak de URL voor de vergaderruimte door http:// of https://, url-path en domainsamen te voegen.

name

Een gebruiker toevoegen aan een vergadering en vergaderingen weergeven 1.

Meld u aan als de Administrator-gebruiker van uw toepassing.

2.

Haal de principal-id van de gebruiker op (zie "Een principal-id zoeken").

3.

Haal de sco-id van de vergadering op (zie "De sco-id van een vergadering zoeken").

Vergaderingen weergeven

51

4.

Roep permissions-update aan om de gebruiker toe te voegen aan de vergadering: https://example.com/api/xml?action=permissions-update &acl-id=2006258765&principal-id=2006258745&permission-id=view

Gebruik de permission-id view voor een deelnemer, mini-host voor de presentator of host voor de gastheer van een vergadering. 5.

Meld u af als de Administrator-gebruiker en meld u aan als de gebruiker die u zojuist hebt toegevoegd aan de vergadering.

6.

Geef de huidige vergaderingen van de gebruiker weer: https://example.com/api/xml?action=report-my-meetings &filter-expired=false

URL's voor vergaderruimtes maken U kunt op verschillende manieren de URL van een vergaderruimte maken. Welke actie u het beste kunt aanroepen, is afhankelijk van hoe uw toepassing is aangemeld en waar u zich bevindt in de workflow van de toepassing. Standaard wordt de vergaderruimte gemaakt in de map my-meetings van de gastheer. De URL maken voor een vergaderruimte waarvoor de gebruiker de gastheer is 1.

Als u bent aangemeld als een gebruiker en u een URL wilt maken voor een vergadering in de map my-meetings van de gebruiker, roept u report-my-meetings aan: https://example.com/api/xml?action=report-my-meetings

2.

Parseer het antwoord voor de waarden van domain-name en url-path: <meeting sco-id="2007063179" type="meeting" icon="meeting" permission-id="host" active-participants="0"> September All Hands Meeting <domain-name>example.com /sept15/ 2006-09-15T09:00:00.000-07:00 2006-09-15T18:00:00.000-07:00 <expired>false 09:00:00.000

3.

Voeg de twee waarden samen en voeg http:// of https:// toe aan het begin: https://example.com/online/

Als u HTTPS gebruikt en u niet expliciet https:// toevoegt, wordt voor de URL standaard http:// gebruikt en krijgt de gebruiker mogelijk geen toegang tot de vergaderruimte.

52


De URL maken voor een vergaderruimte waarvoor de gebruiker geen gastheer is 1.


2.


3.

Parseer het antwoord voor het url-path: <sco account-id="624520" disabled="" display-seq="0" folder-id="624530" icon="folder" lang="en" max-retries="" sco-id="2006258750" source-sco-id="" type="folder" version="1"> 2006-04-18T10:21:47.020-07:00 2006-04-18T10:21:47.020-07:00 [email protected] /f1234567890/

4.

(Optioneel) Als u de domeinnaam van uw Enterprise Server- of Enterprise Hosted-account kent, maakt u de URL met http:// of https://, gevolgd door de domain-name en het url-path.

5.

Als u de domeinnaam niet kent, roept u common-info aan: https://example.com/api/xml?action=common-info

6.

Parseer het antwoord voor de waarde van het host-element.

Vergaderingen maken Een gebruiker die een Acrobat Connect-vergadering wil maken, moet een Administrator zijn. Dit betekent dat de gebruiker lid moet zijn van de groep Gastheren van vergadering. In het antwoord van principal-list heeft deze groep type=live-admins. Een vergadering kan openbaar of privé zijn. Voor het maken van beide typen moet u een specifieke combinatie van principal-id en permission-id instellen: ■

Openbaar, gelijkwaardig aan Iedereen die de URL voor de vergadering heeft, kan de ruimte binnengaan principal-id=public-access&permission-id=view-hidden

■

Privé, gelijkwaardig aan Alleen geregistreerde gebruikers en geaccepteerde gasten kunnen de ruimte binnengaan principal-id=public-access&permission-id=denied

Vergaderingen maken

53

Als een vergadering privé is, kunnen geregistreerde gebruikers die zijn uitgenodigd als deelnemers van de vergadering, de ruimte binnengaan door op de URL van de vergaderruimte te klikken en zich aan te melden. Gebruikers die niet zijn uitgenodigd, kunnen zich aanmelden als gast. De gastheer van de vergadering ontvangt het toegangsverzoek van een gast (dit wordt ’knocking’, ofwel aankloppen genoemd) en kan dat verzoek accepteren of weigeren. Een openbare vergadering maken en gastheer, presentator en deelnemers toevoegen 1.

Roep principal-list aan om te controleren of de gebruiker die de Acrobat Connectvergadering maakt lid is van de groep live-admins: https://example.com/api/xml?action=principal-list&group-id=624523 &filter-is-member=true&filter-like-name=bob

2.

Roep sco-shortcuts aan om de sco-id van de map my-meetings van de gebruiker op te halen: https://example.com/api/xml?action=sco-shortcuts

3.

Parseer het antwoord voor het sco-element met type=my-meetings: <sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com

4.

Roep sco-update aan om de vergaderruimte te maken: https://example.com/api/xml?action=sco-update &type=meeting&name=October All Hands Meeting &folder-id=2006258750&date-begin=2006-10-01T09:00 &date-end=2006-10-01T17:00&url-path=october

De folder-id is de sco-id van de map my-meetings van de gebruiker. 5.

Parseer het antwoord voor de sco-id van de nieuwe vergadering: <sco folder-id="2006258750" lang="en" account-id="624520" type="meeting" icon="meeting" sco-id="2007184134" version="0"> 2006-10-01T09:00 2006-10-01T17:00 /october/ October All Hands Meeting

U kunt het url-path naar de vergadering opslaan, als u later een URL naar de vergaderruimte wilt maken. 6.

Roep permissions-update aan om de vergadering openbaar te maken. Gebruik de sco-id van de vergadering als de acl-id: https://example.com/api/xml?action=permissions-update&acl-id=2007018414 &principal-id=public-access&permission-id=view-hidden

54


7.

Roep permissions-update aan om een gastheer, een presentator en deelnemers toe te voegen: https://example.com/api/xml?action=permissions-update &principal-id=2006258745&acl-id=2007018414&permission-id=host

8.

■

Gebruik de permission-id host voor de gastheer van de vergadering.

■

Gebruik mini-host voor de presentator.

■

Gebruik view voor deelnemers aan de vergadering.

■

U kunt meerdere combinaties van principal-id, acl-id en permission-id gebruiken in één aanroep van permissions-update.

Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken").

Een privé-vergadering maken en gastheer, presentator en deelnemers toevoegen 1.


2.

Volg de stappen voor het maken van een openbare vergadering, maar stel de vergaderingsmachtiging in op privé: https://example.com/api/xml?action=permissions-update&acl-id=2007018414 &principal-id=public-access&permission-id=denied

3.

Roep nogmaals permissions-update aan om een gastheer, een presentator en gasten toe te voegen.

4.


Aangepaste vergaderingen maken Als u een Acrobat Connect Professional-vergadering maakt, kunt u daar een vergaderruimtesjabloon aan toewijzen waarmee een aangepaste schermindeling voor de vergaderruimte wordt gemaakt. Als u geen sjabloon toewijst, wordt de vergaderruimte gemaakt met de standaardsjabloon voor vergaderingen. Als u een vergaderruimtesjabloon wilt bewerken, start u Adobe Enterprise Manager en klikt u op de URL van de sjabloon. U kunt de sjabloon bewerken terwijl deze in een map met vergadersjablonen staat (Mijn sjablonen of Gedeelde sjablonen), mits u bewerkrechten hebt voor de map. Een vergaderruimte maken met een sjabloon 1.


2.


Aangepaste vergaderingen maken

55

3.

Parseer het antwoord voor de sco-id van een map die vergadersjablonen bevat: <sco tree-id="624529" sco-id="-625529" type="shared-meeting-templates"> <domain-name>http://example.com <sco tree-id="624530" sco-id="2006258751" type="my-meeting-templates"> <domain-name>http://example.com

4.

Roep sco-contents aan en geef de sco-id van de map met vergadersjablonen door: https://example.com/api/xml?action=sco-contents&sco-id=2006258751

5.

Parseer het antwoord voor de sco-id van de gewenste vergadersjabloon.

6.

Maak de vergadering met sco-update. Geef de sco-id van de vergadersjabloon door als een source-sco-id: https://example.com/api/xml?action=sco-update&type=meeting &name=August%20All%20Hands%20Meeting&folder-id=2006258750 &date-begin=2006-08-01T09:00&date-end=2006-08-01T17:00 &url-path=august&source-sco-id=2006349744

7.

Ga verder met het instellen van machtigingen voor de vergadering en het toevoegen van deelnemers, een gastheer en een presentator (zie "Vergaderingen maken").

8.


Gebruikers uitnodigen voor vergaderingen Als u een Acrobat Connect-vergadering hebt gemaakt en deelnemers en presentatoren hebt toegevoegd, kunt u uitnodigen verzenden via e-mail. Als u een uitnodiging voor een vergadering wilt verzenden, hebt u informatie nodig over de vergadering, waaronder de naam van de vergadering, de naam en het e-mailadres van de gastheer, de URL van de vergaderruimte, de datum en tijd van de vergadering en de naam en het e-mailadres van de deelnemer (of de presentator). U kunt een e-mailbericht maken met elke techniek die geschikt is voor uw gebruikersinterface. Haal specifieke informatie over de vergadering op door de volgende stappen te volgen.

56


Een e-mailbericht verzenden naar deelnemers van een vergadering 1.

Roep sco-info aan met de sco-id van de vergadering: https://example.com/api/xml?action=sco-info&sco-id=2006334033

2.

Parseer het antwoord voor de naam van de vergadering, de datum of andere waarden: <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258750" icon="meeting" lang="en" max-retries="" sco-id="2007063163" source-sco-id="-1625529" type="meeting" version="0"> 2006-08-15T09:00:00.000-07:00 2006-07-27T15:30:43.220-07:00 2006-08-15T18:00:00.000-07:00 2006-07-27T15:30:43.220-07:00 August All Hands Meeting /august/

3. 4.

Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken"). Roep permissions-info aan om de principal-id-waarden van de presentatoren of deelnemers op te halen, waarbij u filtert op permission-id: https://example.com/api/xml?action=permissions-info &acl-id=2007018414&filter-permission-id=mini-host

5.

■

Voor een lijst van presentatoren gebruikt u permission-id=mini-host.

■

Voor deelnemers gebruikt u permission-id=view.

Parseer het antwoord voor de gewenste principal-id-waarden: <principal principal-id="2006282569" is-primary="false" type="user" has-children="false" permission-id="view"> jazz doe [email protected]

6.

Roep principal-info aan met de principal-id: https://example.com/api/xml?action=principal-info &principal-id=2006282569

7.

Extraheer de name- en email-waarden uit het antwoord: <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id="2006282569" type="user"> <ext-login>[email protected] [email protected] jazz doe <email>[email protected] jazz doe <x-2006293620>E3612 <x-2007017651>San Francisco

Gebruikers uitnodigen voor vergaderingen

57

8.

Roep nogmaals permissions-info aan, waarbij u filtert op een permission-id van host: https://example.com/api/xml?action=permissions-info&acl-id=2007018414 &filter-permission-id=host

9.

Parseer het antwoord voor de principal-id: <principal principal-id="2006282569" is-primary="false" type="user" has-children="false" permission-id="host"> jazz doe [email protected]

10. Roep principal-info

aan met de principal-id:

https://example.com/api/xml?action=principal-info &principal-id=2006258745 11.

Parseer het principal-element van het antwoord voor de name en login (of name en email): <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id="2006282569" type="user"> <ext-login>[email protected] [email protected] jazz doe <email>[email protected] jazz doe <x-2006293620>E3612 <x-2007017651>San Francisco

Dit zijn de gegevens voor de afzender van het e-mailbericht, die de gastheer van de vergadering is.

Gebruikers verwijderen uit vergaderingen Het komt soms voor dat een gebruiker als deelnemer of presentator is uitgenodigd voor een Acrobat Connect Professional-vergadering, maar later moet worden verwijderd van de deelnemerslijst. Het resultaat van het verwijderen van een gebruiker is afhankelijk van het feit of het een openbare vergadering of een privé-vergadering is. ■

Voor een openbare vergadering De machtiging van de gebruiker (deelnemer, presentator of gastheer) wordt verwijderd, maar de gebruiker kan nog wel als gast deelnemen aan de vergadering.

■

Voor een privé-vergadering

58

De machtiging van de gebruiker wordt verwijderd en de gebruiker kan alleen deelnemen als gast en met goedkeuring van de gastheer van de vergadering.


Als u de toegangsmachtiging van een gebruiker wilt verwijderen, roept u permissionsupdate aan met een speciale machtigingswaarde, permission-id=remove. Als de vergadering al is gestart en de gebruiker zich al in de ruimte bevindt, wordt de gebruiker niet uit de vergadering verwijderd. Als de sessie van de gebruiker verloopt, krijgt de gebruiker echter niet opnieuw toegang. De machtiging van een gebruiker voor toegang tot een vergadering verwijderen 1.

(Optioneel) Roep permissions-info aan om de machtiging van de principal voor toegang tot de vergadering te controleren: https://example.com/api/xml?action=permissions-info&acl-id=2007018414

U hoeft echter niet te weten welke specifieke machtiging de principal heeft voordat u de machtiging verwijdert. 2.


3.

Haal de principal-id van de gebruiker op (zie "Een principal-id zoeken").

4.

Roep permissions-update aan, met de sco-id van de vergadering als de acl-id en permission-id=remove: https://example.com/api/xml?action=permissions-update &acl-id=2007018414&principal-id=2006258745&permission-id=remove

Vergadergebruik berekenen Als u gebruikers en Acrobat Connect Professional-vergaderingen hebt gemaakt, kunt u het gebruik van de vergadering berekenen. Het gebruik van een vergadering wordt vaak op een van de volgende manieren berekend: ■

De tijd die elke gebruiker doorbrengt in een specifieke vergadering, in minuten per gebruiker

■

Het aantal gelijktijdige deelnemers aan een vergadering

De tijd die een gebruiker doorbrengt in een vergadering wordt gemeten met een transactie, die de interactie is tussen een principal en een SCO (in dit geval tussen een gebruiker en een vergadering). De datum en tijd waarop een transactie begint en eindigt, worden geretourneerd door report-bulk-consolidated-transactions. Het aantal gebruikers dat gelijktijdig kan deelnemen aan een vergadering is afhankelijk van uw Connect Enterprise-licentie. U kunt controleren wat uw limiet is en wat het grootste aantal gelijktijdige deelnemers aan een vergadering is geweest in een bepaalde periode.

Vergadergebruik berekenen

59

Doorgebrachte tijd in vergaderingen per gebruiker berekenen 1.

Roep report-bulk-consolidated-transactions aan, waarbij u filtert op vergaderingen en (optioneel) een andere waarde: https://example.com/api/xml?action=report-bulk-consolidated-transactions &filter-type=meeting&filter-gt-date-created=2006-07-01

2.

■

Het tweede filter kan zijn voor de datum waarop de transactie is begonnen of geëindigd, de principal-id van de gebruiker, de sco-id van een specifieke vergadering of een ander geldig filter dat voldoet aan uw eisen.

■

Met deze oproep worden alle transacties geretourneerd die voldoen aan de filtercriteria. Houd er rekening mee dat dit er veel kunnen zijn.

Parseer de row-elementen in het antwoord voor date-created en date-closed: Thursday Meeting /thursday/ [email protected] <user-name>jazzwayjazz doe <status>completed 2006-08-03T12:33:48.547-07:00 2006-08-03T12:34:04.093-07:00

3.

Bereken in uw toepassing het tijdsverschil tussen de twee datums.

U kunt dit bijvoorbeeld (in Java™) doen door een hulpprogrammamethode te schrijven waarmee de ISO 8601-datetime-waarden uit het antwoord worden geconverteerd naar een GregorianCalendar-object. Converteer vervolgens elke GregorianCalendar-datum naar milliseconden, bereken het verschil tussen de maak- en sluittijd en converteer het verschil naar minuten. 4. Herhaal dit voor alle vergadertransacties die aan uw criteria voldoen en tel de vergadergebruikstijden bij elkaar op. Informatie ophalen over gelijktijdige deelnemers aan vergaderingen 1.

Roep report-quotas aan om te controleren hoeveel gelijktijdige gebruikers van vergaderingen zijn toegestaan: https://example.com/api/xml?action=report-quotas

2.

Parseer het antwoord voor het quota-element met een quota-id-waarde van concurrenten lees de waarde van soft-limit:

user-per-meeting-quota

2004-03-09T09:45:02.297-08:00 2999-12-31T16:00:00.000-08:00

60


De soft-limit is de limiet die is gedefinieerd door uw Connect Enterprise-licentie. De limit is de waarde waarbij Connect Enterprise gebruikers tegenhoudt die willen deelnemen aan vergaderingen. Dit is meestal dezelfde waarde als soft-limit. 3.

Roep report-meeting-concurrent-users aan om te controleren wat het grootste aantal gelijktijdige deelnemers aan vergaderingen op uw server of in uw account is: https://example.com/api/xml?action=report-meeting-concurrent-users

4.

Parseer het antwoord voor het report-meeting-concurrent-users-element. Lees de waarde van het max-users-kenmerk en vergelijk dit met de waarde van soft-limit: <status code="ok" />

Vergaderarchieven ophalen Een Acrobat Connect Professional-vergadering kan een of meer geregistreerde archieven hebben. Als de vergadering bijvoorbeeld wekelijks plaatsvindt, kan er een archief zijn voor elke sessie. Een vergaderarchief wordt aangeduid met type=content en icon=archive. De icon-waarde werkt als een subcategorie van type, om het type inhoud aan te duiden. Archieven voor een vergaderruimte weergeven 1.


2.

Roep sco-expanded-contents aan met de sco-id en filter-icon=archive om alle archieven weer te geven die zijn gekoppeld aan de vergadering: https://example.com/api/xml?action=sco-contents&sco-id=2007018414 &filter-icon=archive

3.

Parseer het antwoord voor het sco-element en extraheer de gewenste informatie, zoals name, date-created of url-path: <sco sco-id="2598402" source-sco-id="" folder-id="2598379" type="content" icon="archive" display-seq="0" is-folder="0"> EN - Monday Night Football_0 /p71144063/ 2004-05-17T15:51:54.670-07:00 2004-05-17T15:54:52.920-07:00 2004-05-17T15:55:00.733-07:00 00:02:58.250

Vergaderarchieven ophalen

61

Resultaten van opiniepeilingen ophalen Voor toegang tot de resultaten van een opiniepeiling die tijdens een vergadering is gebruikt, gebruikt u report-quiz-interactions. Met deze actie worden alle opiniepeilingresultaten opgehaald, maar u kunt een filter gebruiken om het antwoord te beperken. Elk multiplechoice-antwoord in de opiniepeiling heeft een geheel getal als id, waarbij het eerste antwoord in de weergegeven lijst het nummer 0 heeft, het tweede nummer 1, enzovoort.

antwoord 0 antwoord 1

De resultaten van een opiniepeiling ophalen 1.

Controleer of de gastheer van de vergadering de opiniepeiling heeft gesloten. De resultaten van de opiniepeiling worden opgeslagen in de cache van de vergadering totdat de opiniepeiling is gesloten.

2.


3.

Roep report-quiz-interactions aan met de sco-id van de vergadering: https://example.com/api/xml?action=report-quiz-interactions &sco-id=2007071193

U kunt ook een filter toevoegen om het antwoord te beperken, bijvoorbeeld:

4.

om alle gebruikers te zien die een bepaald antwoord hebben gegeven

■

filter-response

■

filter-interaction-id om alle antwoorden op een opiniepeiling te zien (een vergadering kan meerdere opiniepeilingen hebben)

Parseer het antwoord voor response, name of een andere waarde: jazz doe <sco-name>Thursday Meeting 2006-08-03T12:29:09.687-07:00 <description>What is your favorite color? 4

62


Vergaderingen starten met externe verificatie Als een gebruiker zich heeft aangemeld bij uw netwerk en u de gebruiker hebt geverifieerd voor Enterprise Server of Enterprise Hosted met een externe verificatiereferentie, kunt u de gebruiker toestemming geven deel te nemen aan een vergadering als deelnemer of gast zonder dat deze zich een tweede keer hoeft aan te melden bij Acrobat Connect Professional. Een vergadering starten en de gebruiker laten deelnemen als deelnemer 1.

Als de gebruiker is geverifieerd op uw netwerk, meldt u de gebruiker aan bij Connect Enterprise (zie “Aanmelden met HTTP-headerverificatie” voor meer informatie).

2.

Haal op een van de volgende manieren de waarde van het BREEZESESSION-cookie voor de sessie van de gebruiker op: ■

Roep common-info aan en haal de waarde van cookie op uit het antwoord: breezma6zor9rdfps8h6a

■

Haal de waarde van het BREEZESESSION-cookie op uit de antwoordheader: Set-Cookie: BREEZESESSION=breezqw4vtfarqxvf9pk2; domain=.macromedia.com;path=/

3.

Maak een URL voor de vergaderruimte (zie “URL's voor vergaderruimtes maken” voor meer informatie).

4.

Voeg een session-parameter en de waarde van het BREEZESESSION-cookie toe aan de URL van de vergaderruimte: http://example.com/employeeMeeting/?session=breezbityp829r9ozv5rd

5.

Open de URL van de vergaderruimte waaraan session is toegevoegd. U kunt dit bijvoorbeeld doen met een JavaScript onClick-opdracht: http://example.com/employeeMeeting/

Vergaderingen starten met externe verificatie

63

Een vergadering starten en de gebruiker laten deelnemen als gast 1.

Als de gebruiker is geverifieerd op uw netwerk, meldt u de gebruiker aan bij Connect Enterprise (zie “Aanmelden met HTTP-headerverificatie” voor meer informatie).

2.

Haal op een van de volgende manieren de waarde van het BREEZESESSION-cookie voor de sessie van de gebruiker op: ■

Roep common-info aan en haal de waarde van cookie op uit het antwoord: breezma6zor9rdfps8h6a

■

Haal de waarde van het BREEZESESSION-cookie op uit de antwoordheader nadat u login hebt aangeroepen: Set-Cookie: BREEZESESSION=breezqw4vtfarqxvf9pk2; domain=.macromedia.com;path=/

3.

Maak in uw toepassing een URL voor de vergaderruimte (zie “URL's voor vergaderruimtes maken”).

4.

Voeg een guestname-parameter en de weergegeven gastnaam van de gebruiker toe aan de URL van de vergaderruimte: http://example.com/employeeMeeting/?guestName=joy

5.

Open de URL van de vergaderruimte waaraan de guestname-parameter is toegevoegd. U kunt dit bijvoorbeeld doen met een JavaScript onClick-opdracht: http://example.com/employeeMeeting/

64


HOOFDSTUK 5

5

Training Een aangepaste trainingstoepassing of een aangepast portal kan gebruikmaken van Adobe® Connect™ Training voor het weergeven van beschikbare cursussen, het inschrijven of zelf laten inschrijven van gebruikers, het maken van overzichten van alle cursussen en studieprogramma’s waarvoor de gebruiker is ingeschreven en het genereren van verschillende rapporten. Connect Training heeft twee soorten trainingsmodules: cursussen en studieprogramma's. Een cursus is inhoud (bijvoorbeeld een presentatie) met een aantal ingeschreven cursisten waarbij voor elke persoon afzonderlijk het gebruik wordt bijgehouden. De cursus kan onafhankelijk worden gegeven en beheerd, of als deel van een studieprogramma. Een studieprogramma is een groep cursussen en ander leermateriaal waarmee cursisten een leerpad volgen. Een studieprogramma bevat voornamelijk Connect Training-cursussen, maar kan ook andere onderdelen, zoals inhoud en vergaderingen, bevatten. Net zoals bij cursussen kunt u rapporten genereren om de voortgang bij te houden van ingeschreven studenten die het studieprogramma volgen. Op deze manier kunt u controleren of de deelnemers voldoen aan de leerdoelstellingen. Cursussen en inhoud kunnen beide modules binnen een studieprogramma zijn en een inhoudsobject kan in een onbeperkt aantal cursussen en studieprogramma's worden gebruikt. In Connect Training zijn objecten, cursussen en studieprogramma's allemaal SCO's die allemaal een unieke sco-id hebben. Inhoudsobjecten en cursussen kunnen in overeenkomst met de SCORM-standaard worden gecombineerd en opnieuw worden gebruikt. Voor de ontwikkeling van trainingstoepassingen raadt Adobe de volgende XML API-acties aan: Om gebruikers aan te melden bij cursussen en te controleren of ze de juiste machtigingen hebben voor toegang tot de cursus.

permissions-update

group-membership-update

Om gebruikers toe te voegen aan groepen als u een groep wilt

inschrijven. Om alle cursussen en studieprogramma's weer te geven waarvoor de huidige gebruiker is ingeschreven, inclusief de URL voor toegang tot de cursus of het studieprogramma. report-my-training

65

Om meer informatie op te halen over de voortgang van een gebruiker binnen een studieprogramma.

report-curriculum-taker

Om de meest recente status van alle cursussen en studieprogramma's van een gebruiker weer te geven. report-user-trainings-taken

report-user-training-transcripts

Om een overzicht van alle transcripties en scores van een

gebruiker weer te geven. Deze acties werken op cursussen, studieprogramma's en trainingsmappen en maken gebruik van de machtigingen die zijn toegestaan voor objecten in de trainingsbibliotheek.

Machtigingen voor trainingsbibliotheek De map Gedeelde training die u in Adobe Connect Enterprise Manager ziet, wordt ook wel de trainingsbibliotheek genoemd. Gedeelte training wordt courses genoemd in het antwoord van sco-shortcuts: <sco tree-id="123456" sco-id="123456" type="courses"> <domain-name>example.com

Elke map, elke cursus en elk trainingsprogramma in de bibliotheek is een SCO. Als u door de trainingsbibliotheek bladert, ziet u de sco-id van elk object in de browser-URL. U kunt deze id ook ophalen door sco-contents of sco-expanded-contents aan te roepen op een map in de trainingsbibliotheek. Alle cursussen, studieprogramma's en inhoudsobjecten in de trainingsbibliotheek hebben machtigingen waarmee wordt gedefinieerd welke gebruikers er toegang toe hebben. Houd bij het ontwerpen van uw toepassing rekening met deze machtigingsniveaus: Cursussen en studieprogramma's hebben machtigingen die bepalen welke gebruikers zijn ingeschreven en toegang hebben tot deze cursussen en studieprogramma’s. De twee beschikbare machtigingen zijn Ingeschreven en Afgewezen.

Machtigingen van ingeschreven personen

Cursussen, studieprogramma's en mappen in de trainingsbibliotheek hebben de machtiging Beheren of Afgewezen. De machtiging Beheren betekent dat een gebruiker machtigingen kan maken, verwijderen, bewerken en toewijzen. Standaard hebben gebruikers de machtiging Beheren op hun eigen trainingsmappen, terwijl beheerders de machtiging Beheren hebben op alle mappen in de trainingsbibliotheek. Machtigingen voor trainingsbibliotheek

Een beheerder kan een gebruiker de machtiging Beheren geven voor een afzonderlijke cursus, een studieprogramma of map met permissions-update of kan de machtigingen van een gebruiker controleren met permissions-info.

66

Hoofdstuk 5: Training

In XML API-aanroepen leest of gebruikt u waarden van permission-id terwijl u werkt met de trainingsbibliotheek of stelt u die waarden in. Deze waarden van permission-id gelden voor cursussen en studieprogramma's: De gebruiker heeft toegang tot de cursus of het studieprogramma en de machtiging is Ingeschreven.

view

denied

De gebruiker heeft geen toegang en de machtiging is Afgewezen.

Houd ook rekening met de machtiging die een gebruiker heeft voor een map voordat u een API-aanroep uitvoert. Meld u aan als een gebruiker met de geschikte machtiging of, zo nodig, als de Administrator-gebruiker van uw toepassing. Deze waarden van permission-id gelden voor trainingsmappen: De gebruiker kan machtigingen voor cursussen, studieprogramma's en inhoud in een map toevoegen, verwijderen, wijzigen of toewijzen. De gebruiker kan ook de inhoud van de map weergeven met sco-contents of sco-expanded-contents.

manage

De gebruiker kan geen machtigingen voor inhoud van de map toevoegen, verwijderen, wijzigen of toewijzen, maar kan de inhoud van de map wel weergeven.

denied

Cursussen en studieprogramma's zoeken Voor de meeste XML API-acties die werken met cursussen en studieprogramma's is de scoid van de cursus of het studieprogramma nodig. U moet de sco-id vaak dynamisch zoeken voordat u een andere actie kunt aanroepen, zonder dat u de exacte naam van de SCO kent. Gebruik deze aanbevolen procedures om efficiënt te zoeken naar trainings-SCO's: ■

Maak gespecialiseerde mappen binnen de map Gedeelde training voor de opslag van cursussen en studieprogramma's. U kunt dit doen in Connect Enterprise Manager, of u kunt de XML API gebruiken, waarin de map Shared Training courses wordt genoemd.

■

Gebruik deze mappen voor de opslag van verschillende categorieën van cursussen en studieprogramma's, zoals Marketingtraining of Verkooptraining.

■

Gebruik een platte structuur in de gespecialiseerde mappen en sla cursussen en studieprogramma’s in één niveau op.

Deze mappenstructuur wordt ook aangeraden als u een lijst wilt weergeven met alle cursussen en studieprogramma's (of alle cursussen en studieprogramma's binnen een onderwerpgebied) en als u gebruikers zichzelf wilt laten inschrijven. Als u in Enterprise Manager werkt, kunt u de sco-id van een cursus of studieprogramma vinden door ernaar te bladeren, op de URL te klikken en de waarde van sco-id over te nemen uit de browser-URL. U kunt de sco-id ook vinden vanuit een toepassing, via de XML API.

Cursussen en studieprogramma's zoeken

67

De sco-id van een cursus of studieprogramma zoeken 1.


2.

Parseer het antwoord voor de sco-id van de map courses: <sco tree-id="624528" sco-id="624528" type="courses"> <domain-name>http://example.com

U kunt geen filter met sco-shortcuts gebruiken, maar u kunt het antwoord parseren voor het sco-element dat type=courses heeft. 3.

Roep sco-contents aan, geef daarbij de sco-id van de map courses door en filter op uw gespecialiseerde trainingsmappen: https://example.com/api/xml?action=sco-contents&sco-id=624528 &filter-name=Sales Training

4.

■

U kunt filter-name, filter-url-path, een ander filter voor exacte overeenkomsten of een datumfilter gebruiken. Wees echter voorzichtig met het gebruik van filter-like-name, omdat dit invloed kan hebben op de serverprestaties.

■

U kunt de sco-id van uw gespecialiseerde trainingsmap ook overnemen uit de browser-URL in Enterprise Manager en deze doorgeven aan sco-contents.

Parseer het antwoord voor de sco-id van uw gespecialiseerde trainingsmap: <sco sco-id="2007122244" source-sco-id="" folder-id="624528" type="folder" icon="folder" display-seq="0" is-folder="1">

5.

Roep sco-contents aan, geef daarbij de sco-id van de gespecialiseerde trainingsmap door en voeg een filter toe waarmee de cursus of het studieprogramma wordt geïdentificeerd: https://example.com/api/xml?action=sco-contents &sco-id=2007122244&filter-name=Java 201

6.

■

U kunt sco-contents aanroepen in plaats van sco-expanded-contents als alle cursussen en studieprogramma's zijn opgeslagen in het hoogste niveau van uw gespecialiseerde trainingsmap. Hierdoor worden de prestaties verbeterd.

■

U kunt aangepaste velden voor SCO's definiëren als u ze daarmee gemakkelijker kunt vinden in zoekopdrachten (zie "Aangepaste velden maken").

Parseer de sco-elementen in het antwoord voor desco-id van de cursus of het studieprogramma: <sco depth="2" sco-id="2006745673" folder-id="2006745671" type="content" icon="course" lang="en" source-sco-id="2006744233" display-seq="1" source-sco-type="0"> All About Web Communities /p33096345/ <description>Web 2.0 course

68


2006-06-12T14:48:25.870-07:00 2006-06-12T14:48:25.870-07:00

Alle beschikbare cursussen of studieprogramma's weergeven 1.

Haal de sco-id van een gespecialiseerde trainingsmap die u hebt gemaakt op (zie "De sco-id van een cursus of studieprogramma zoeken"). U kunt de sco-id ook ophalen door naar de map te bladeren in Enterprise Manager, op de URL te klikken en de sco-id in de browser-URL te lezen.

2.

Roep sco-contents aan en geef daarbij de sco-id van de map door: https://example.com/api/xml?action=sco-contents&sco-id=2006258748

Het wordt aangeraden om de gespecialiseerde trainingsmappen één niveau diep te maken. Op die manier kunt u sco-contents aanroepen in plaats van sco-expanded-contents. Dit komt de prestaties ten goede. 3.

Parseer het antwoord voor name, url-path of andere waarden die u wilt weergeven: <sco sco-id="2007035246" source-sco-id="2006334909" folder-id="2006258748" type="content" icon="course" display-seq="0" is-folder="0"> Java 101 /java101/ 2006-07-20T17:15:00.000-07:00 2006-07-20T17:21:38.860-07:00

De training van een gebruiker weergeven Als een gebruiker is aangemeld, kunt u een overzicht weergeven van alle cursussen waarvoor de gebruiker is ingeschreven met report-my-courses, of van alle cursussen en studieprogramma's van de gebruiker met report-my-training. Hiermee worden alleen de cursussen (of cursussen en studieprogramma's) weergegeven waarbij de gebruiker is ingeschreven, niet alle beschikbare cursussen. De cursussen en studieprogramma's van een gebruiker weergeven 1.

Meld de gebruiker aan (zie "Aanmelden vanuit een toepassing").

2.

Roep report-my-training aan om een overzicht weer te geven van alle cursussen en studieprogramma's waarvoor de gebruiker is ingeschreven: https://example.com/api/xml?action=report-my-training

De training van een gebruiker weergeven

69

3.

Parseer het antwoord voor name, url of andere waarden die u wilt weergeven: Java 101 example.com/java101/ 2006-07-20T17:21:11.940-07:00 2006-07-20T17:21:38.860-07:00 2006-07-20T17:15:00.000-07:00 /java101/ <expired>false false

De status van alle cursussen en studieprogramma's van een gebruiker weergeven 1.

Haal de principal -id van de gebruiker op (zie "Een principal-id zoeken").

2.

Roep report-user-trainings-taken aan: https://example.com/api/xml?action=report-user-trainings-taken &principal-id=2006258745

3.

Parseer het antwoord voor status: Programming in Perl <description>Info about Perl /p57283193/ 2006-05-01T17:10:56.400-07:00 false

Een cursus kan veel toegestane waarden hebben voor status, maar een studieprogramma kan alleen de status completed of incomplete hebben. De toegestane waarden voor status worden beschreven in status, kenmerk in de referentie.

Eén gebruiker inschrijven Om gebruikers toegang tot training te geven, raadt Adobe u aan ze in te schrijven voor cursussen. Hierdoor krijgen de gebruikers de juiste machtiging voor het starten en voltooien van de cursus en krijgt u gegevens over het gebruik en de toegang tot verschillende rapportacties. Cursussen zijn iets anders dan inhoud. Cursussen kunnen worden hervat en beschikken over een beoordelingsmodus op de server (zie de gebruikershandleiding van Adobe Connect Enterprise voor gedetailleerde informatie).

70


In uw toepassing kunnen gebruikers mogelijk zichzelf inschrijven voor cursussen, waarvoor permissions-update moet worden aangeroepen om één gebruiker tegelijk in te schrijven. Misschien wilt u ook een workflow, of een reeks acties, schrijven waarmee een nieuwe gebruiker wordt gemaakt en de gebruiker wordt ingeschreven voor een cursus. Eén gebruiker inschrijven voor een cursus of studieprogramma 1.

Haal de sco-id van de cursus op (zie "De sco-id van een cursus of studieprogramma zoeken").

2.

Haal de principal-id van de gebruiker op (zie "De principal-id van de huidige gebruiker opvragen").

3.

Als u de gebruiker wilt inschrijven voor de cursus, roept u permissions-update aan. Gebruik de sco-id van de cursus als de acl-id, met de permission-id view: https://example.com/api/xml?action=permissions-update &acl-id=2007035246&principal-id=2006258745&permission-id=view

4.

Roep report-my-training aan om een overzicht weer te geven van alle cursussen en studieprogramma's waarvoor de gebruiker is ingeschreven: https://example.com/api/xml?action=report-my-training

5.

Parseer de row-elementen in het antwoord voor waarden die u wilt weergeven: Java 101 example.com/java101/ 2006-07-20T17:21:11.940-07:00 2006-07-20T17:21:38.860-07:00 2006-07-20T17:15:00.000-07:00 /java101/ <expired>false false

Een nieuwe gebruiker inschrijven met een workflow 1.

Roep principal-update aan om de nieuwe gebruiker te maken en een welkomstemailbericht te verzenden: https://example.com/api/xml?action=principal-update&first-name=jazz [email protected]&password=hello&type=user [email protected]

Voor het verzenden van de e-mail moet send-email=true zijn. 2.

Meld de gebruiker aan bij de server: https://example.com/api/[email protected] &password=hello&session=breezma6zor9rdfps8h6a

Zie "Aanmelden vanuit een toepassing" voor andere manieren voor het aanroepen van login.

Eén gebruiker inschrijven

71

3.

Roep group-membership-update aan met is-member=true om de gebruiker toe te voegen aan de groep: https://example.com/api/xml?action=group-membership-update &group-id=4930296&principal-id=2006258745&is-member=true

4.

Roep permissions-update aan om de gebruiker in te schrijven voor een studieprogramma: https://example.com/api/xml?action=permissions-update &acl-id=2006745669&principal-id=2007124930&permission-id=view

Gebruik de permission-id view. 5.

Roep report-my-training aan om een overzicht weer te geven van de cursussen en studieprogramma's waarvoor de gebruiker is ingeschreven: https://example.com/api/xml?action=report-my-training

6.

Parseer de row-elementen in het antwoord voor waarden die u wilt weergeven: A Day in the Life example.com/day/ 2006-06-12T14:47:59.903-07:00 2006-06-12T14:47:59.903-07:00 2006-06-12T14:45:00.000-07:00 /day/ <expired>false false

Een groot aantal gebruikers inschrijven Als u een groot aantal gebruikers inschrijft voor een cursus, moet u eerst bepalen of u de gebruikers rechtstreeks wilt inschrijven of of u een groep wilt maken en deze groep wilt inschrijven. Adobe beveelt de volgende procedures aan voor het inschrijven van gebruikers voor cursussen: ■

Schrijf gebruikers rechtstreeks in voor cursussen met permissions-update, waarmee u 1000, 10.000 of meer gebruikers kunt inschrijven met één API-aanroep.

■

Voeg de gebruikers alleen toe aan een groep die u inschrijft als u de groep opnieuw wilt gebruiken (bijvoorbeeld om de groep voor meerdere cursussen in te schrijven). In dit geval kunt u slechts 200 gebruikers tegelijk inschrijven.

72


Een groot aantal gebruikers (meer dan 1000) rechtstreeks inschrijven voor een cursus 1.


2.

Haal de principal-id op van elke gebruiker die u wilt inschrijven. Die kunt u op de volgende manieren doen: ■

Roep principal-list aan met filters om de gebruikers weer te geven die u wilt inschrijven: https://example.com/api/xml?action=principal-list&filter-type=user &filter-type=sales

■

3.

Lees de waarden uit een bestand.

Schrijf een methode waarmee permissions-update wordt aangeroepen met meerdere combinaties (trio’s) van acl-id, principal-id en permission-id: https://example.com/api/xml?action=permissions-update &acl-id=2007064258&principal-id=2007105030&permission-id=view &acl-id=2007064258&principal-id=2006258745&permission-id=view ... ■

De acl-id is de sco-id van de cursus.

■

De permission-id is view voor het inschrijven van gebruikers.

■

De principal-id is uniek in elk trio.

Als er trio's zijn met onjuiste gegevens, retourneert permissions-update de status ok worden de juiste trio's uitgevoerd en worden de ongeldige trio's niet uitgevoerd. 4.

Roep permissions-info aan om te controleren of de gebruikers zijn ingeschreven: https://example.com/api/xml?action=permissions-info &acl-id=2007064258&filter-permission-id=view

Zonder een principal-id retourneert deze aanroep een lijst met alle principals die zijn ingeschreven voor de cursus. Een groot aantal gebruikers (meer dan 1000) uitschrijven voor een cursus 1.


2.

Haal de principal-id op van elke gebruiker die u wilt verwijderen. U kunt het volgende doen: ■

Roep principal-list aan met filters om de gebruikers weer te geven die u wilt uitschrijven: https://example.com/api/xml?action=principal-list&filter-type=user &filter-account-id=624520

■

Lees de waarden uit een bestand.

Een groot aantal gebruikers inschrijven

73

3.

Schrijf een methode waarmee permissions-update wordt aangeroepen met meerdere combinaties (trio's) van acl-id, principal-id en permission-id: https://example.com/api/xml?action=permissions-update &acl-id=2007064258&principal-id=2007105030&permission-id=denied &acl-id=2007064258&principal-id=2006258745&permission-id=denied ...

De permission-id is denied om gebruikers uit te schrijven uit de cursus. 4.

Roep permissions-info aan om te controleren of de gebruikers zijn verwijderd: https://example.com/api/xml?action=permissions-info &acl-id=2007064258&filter-permission-id=denied

Een grote groep gebruikers (meer dan 1000) inschrijven voor een cursus 1.

Maak een groep. Met de XML API

Roep principal-update aan en parseer het antwoord voor de

principal-id: https://example.com/api/xml?action=principal-update&type=group &has-children=1&name=developersc5 Met Enterprise Manager Maak de groep in Beheer > Gebruikers en groepen > Nieuwe groep. Neem de principal-id van de nieuwe groep over uit de browser-URL. 2.

Voeg de gebruikers die u wilt inschrijven toe aan de groep. U kunt een API-aanroep of Enterprise Manager gebruiken, maar u kunt slechts 200 gebruikers tegelijk toevoegen. Roep group-membership-update aan, waarbij u meerdere combinaties (trio's) van group-id, principal-id en is-member=true gebruikt.

Met de XML API

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

Als er trio's zijn met onjuiste gegevens, retourneert group-membership-update de status ok, maar wordt de gebruiker in het onjuiste trio niet toegevoegd aan de groep. Met Enterprise Manager Ga naar Beheer > Gebruikers en groepen > Importeren. U kunt gebruikers importeren uit een CSV-bestand (bestand met door komma’s gescheiden waarden) dat ten minste een aanmeldings-id bevat voor elke gebruiker. 3.

Haal de sco-id van de cursus op (zie “De sco-id van een cursus of studieprogramma zoeken”) met de sco-id van de gespecialiseerde trainingsmap die de cursus bevat.

4.

Roep permissions-update aan om de groep in te schrijven voor de cursus: https://example.com/api/xml?action=permissions-update &acl-id=2007064258&principal-id=2007105030&permission-id=view

74


Een grote groep gebruikers (meer dan 1000) uitschrijven voor een cursus 1.

Roep permissions-info aan op de cursus, waarbij u filtert voor de permission-id view: https://example.com/api/xml?action=permissions-info &acl-id=2007064258&filter-permission-id=view&filter-type=group

2.

Parseer het antwoord voor de principal-id van de groep: <principal principal-id="2006258745" is-primary="false" type="group" has-children="true" permission-id="view"> developers [email protected]

3.

Roep permissions-update aan met de permission-id denied om de toegang van de groep tot de cursus te verwijderen: https://example.com/api/xml?action=permissions-update &acl-id=2007064258&principal-id=2007105030&permission-id=denied

Informatie over een studieprogramma weergeven U moet informatie kunnen ophalen over studieprogramma's die door trainingsmanagers worden gemaakt en over cursussen die door gebruikers worden gevolgd, zodat u die informatie kunt weergeven in uw toepassing. Vaak is één aanroep voldoende om de gewenste informatie op te halen, als u over de sco-id van het studieprogramma of de cursus en over de principal-id van de gebruiker beschikt. U kunt bijvoorbeeld alle gebruikers weergeven die zijn ingeschreven voor een studieprogramma, of alle cursussen die onderdeel uitmaken van een studieprogramma. Een andere algemene taak is het weergeven van de cursussen in een studieprogramma die de gebruiker heeft voltooid, gevolgd door het weergeven van de resterende cursussen. Alle gebruikers weergeven die zijn ingeschreven voor een cursus of studieprogramma 1.

Roep permissions-info aan, waarbij u filtert voor de permission-id view: https://example.com/api/xml?action=permissions-info &acl-id=2006298444&filter-permission-id=view ■

De acl-id is de sco-id van de cursus of het studieprogramma.

■

De permission-id view betekent dat de gebruiker is ingeschreven.

Informatie over een studieprogramma weergeven

75

2.

Parseer het antwoord voor principal-id, name en andere waarden die u nodig hebt: <principal principal-id="2006258745" is-primary="false" type="user" has-children="false" permission-id="view"> Joy Smith [email protected]

Een lijst ophalen van alle cursussen in een studieprogramma

Een studieprogramma is een type map en u kunt de inhoud van een studieprogramma weergeven met sco-contents of sco-expanded-contents. 1.

Haal de sco-id van het studieprogramma op (zie "De sco-id van een cursus of studieprogramma zoeken").

2.

Roep sco-expanded-contents aan, waarbij u de sco-id doorgeeft: https://example.com/api/xml?action=sco-expanded-contents &sco-id=2006745669

3.

Parseer het antwoord voor de sco-id, folder-id en depth: <sco depth="1" sco-id="2006745674" folder-id="2006745669" type="link" icon="course" lang="en" source-sco-id="2006745673" display-seq="0" source-sco-type="0"> All About Web Communities /l80422078/ <description>test 2006-06-12T14:48:25.980-07:00 2006-06-12T14:48:25.980-07:00

Het antwoord retourneert een platte lijst met sco-elementen, maar desgewenst kunt u een hiërarchie maken aan de hand van deze drie waarden. De SCO met type=curriculum is het studieprogramma dat de cursussen bevat. Hier werkt een studieprogramma zoals een map. Het voltooide en resterende werk van een gebruiker in een studieprogramma weergeven 1.

Haal de sco-id van het studieprogramma op (zie "De sco-id van een cursus of studieprogramma zoeken").

2.

Haal de principal-id van de gebruiker op ("Een principal-id zoeken").

3.

Roep report-curriculum-taker aan, waarbij u de principal-id doorgeeft als een user-id: https://example.com/api/xml?action=report-curriculum-taker &user-id=2006258745&sco-id=2006745669

76


4.

Parseer het antwoord voor het status-kenmerk van elk sco-element en andere waarden die u wilt weergeven in uw toepassing: <sco transcript-id="2006745722" path-type="prereq-none" asset-id="" sco-id="2006745674" depth="1" folder-id="2006745669" type="15" icon="course" lang="en" max-retries="" source-sco-id="2006745673" source-sco-type="0" status="user-passed" score="0" certificate="" max-score="0" attempts="0"> access-open true All About Web Communities /l80422078/ <description>test 2006-06-12T15:06:02.947-07:00 2006-06-12T14:48:25.980-07:00 2006-06-12T15:06:02.947-07:00 false ■

De status user-passed of completed geeft aan dat de module door de gebruiker is voltooid.

■

De status not-attempted of incomplete geeft aan dat de gebruiker de module niet heeft voltooid.

■

Het studieprogramma zelf kan alleen de status completed of incomplete hebben.

Scores rapporteren Bij veel cursussen krijgen studenten een aantal herkansingen. Als u de beoordelingsmodus op de server gebruikt, kan een trainingsmanager het maximale aantal pogingen opgeven dat de cursist heeft om de cursus te voltooien of te halen (zie de gebruikershandleiding van Connect Enterprise voor informatie over herkansingen voor cursussen in de beoordelingsmodus op de server en op de client). Dit betekent dat een cursist een cursus meerdere keren kan proberen en meerdere scores kan halen. U wilt in uw toepassing misschien alleen de hoogste score van de cursist weergeven. De hoogste score van een gebruiker voor een cursus of quiz rapporteren 1.

Haal de principal-id van de gebruiker op (zie "De principal-id van de huidige gebruiker opvragen").

2.

Haal de sco-id van de cursus of quiz op (zie "De sco-id van een cursus of studieprogramma zoeken").

Scores rapporteren

77

3.

Roep report-user-training-transcripts aan, waarbij u filtert op de sco-id en sorteert op de score: https://example.com/api/xml?action=report-user-training-transcripts &principal-id=2006258745&filter-sco-id=2006334909&sort-score=desc

4.

Parseer het antwoord voor de hoogste score, die in het eerste row-element van de lijst moet staan: Java Data Type Quiz /quiz/ [email protected] 2006-05-12T11:55:24.940-07:00 <principal-name>Bob Smith

78


HOOFDSTUK 6

6

Actiereferentie In dit hoofdstuk vindt u een referentie voor elke actie in de Adobe® Connect™ Enterprise Web Services XML API. U kunt deze acties aanroepen in Adobe Connect Enterprise Server 6 of Adobe Connect Enterprise Hosted 6. De namen van alle acties, parameters, elementen en kenmerknamen zijn hoofdlettergevoelig. Met andere woorden, naam is niet hetzelfde als Naam en sco-id is geen equivalent van sco-ID. U moet de namen exact invoeren zoals in dit referentiedocument wordt aangegeven, tenzij bij een specifiek item wordt vermeld dat het niet hoofdlettergevoelig is.

Nieuwe en verwijderde acties In deze versie zijn enkele nieuwe acties toegevoegd, is een actie hersteld die in een vorige versie is verwijderd en zijn andere acties verwijderd. Nieuwe rapportacties

stellen u in staat rapporten te genereren van de server:

report-curriculum-taker report-my-training report-user-trainings-taken report-user-training-transcripts Een aangepaste-veldactie

die uit Adobe Breeze® 5 werd verwijderd, is hersteld in Web

Services 6: custom-fields

Bepaalde acties die in vroegere versies werden ondersteund (Breeze 4 of Breeze 5) zijn niet meer beschikbaar. Deze acties staan in de volgende tabel, eventueel met een vervangende actie. Actie

Verwijderd

Vervangen door

accesskey-exec

Breeze 5

Geen vervanging

accesskey-info

Breeze 5

Geen vervanging

action-list

Web Services 6 Geen vervanging

79

Actie

Verwijderd

Vervangen door

report-account-meeting-attendance

Breeze 5

report-meeting-attendance, report-bulk-consolidatedtransactions

report-active-meeting-presenters

Web Services 6 Geen vervanging

report-bandwidth

Breeze 5

Geen vervanging

report-bulk-content-quiz

Breeze 5

Geen vervanging

report-bulk-content-quiz-results

Breeze 5

report-quiz-interactions, report-quiz-question-distribution, report-quiz-question-response, report-quiz-takers, report-quiz-summary

report-bulk-content-slide-views

Breeze 5

report-bulk-slide-views

report-bulk-course-quiz

Breeze 5

Geen vervanging

report-bulk-course-results

Breeze 5

report-quiz-interactions

report-bulk-meeting

Breeze 5

report-bulk-objects door filter-type=meeting

report-bulk-meeting-attendance

Breeze 5

Geen vervanging

report-course-takers

Breeze 5

report-quiz-takers

report-disk-usage

Breeze 5

Geen vervanging

report-meeting-session

Breeze 5

report-meeting-sessions,

filteren op asset-id report-meeting-session-slots

Breeze 5

Geen vervanging

report-principal-list

Breeze 5

acl-field-list, acl-field-update

report-quiz-answer-distribution

Breeze 5

report-quiz-question-answerdistribution

80

Hoofdstuk 6: Actiereferentie

Actie

Verwijderd

Vervangen door

report-quiz-definition-answers

Breeze 5

report-quiz-interactions, report-quiz-question-answerdistribution, report-quiz-question-distribution, report-quiz-question-response

report-quiz-definition-questions

Breeze 5

report-quiz-interactions, report-quiz-question-answerdistribution, report-quiz-question-distribution, report-quiz-question-response

report-quiz-question-totals

Breeze 5

report-quiz-question-distribution

report-survey-question-response

Breeze 5

Geen vervanging

sco-build

Web Services 6 Binnen de functionaliteit van sco-upload.

acl-field-info Beschikbaarheid

Breeze 5, Connect Enterprise Web Services 6 Beschrijving

Retourneert informatie over een principal, account of SCO volgens de definitie in een ACL (toegangsbeheerlijst). De geretourneerde informatie bevat velden en hun waarden. Elk veld heeft een id, een naam die het veld beschrijft. Als u acl-field-info wilt aanroepen, moet u een weergavemachtiging voor de principal, de account of het object hebben. U moet tevens een specifieke waarde opgeven voor acl-id, dit is het object waartoe de principal toegang heeft. De acl-id kan een sco-id, een account-id of een principal-id zijn. U kunt principal-list aanroepen om de account-id of de principal-id op te halen en u kunt sco-shortcuts of sco-contents aanroepen om een sco-id te krijgen. Aanvraag-URL http://server_name/api/xml ?action=acl-field-info &acl-id=integer &session=BreezeSessionCookieValue

acl-field-info

81

Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van de SCO, account of principal waarvoor u veldinformatie wilt. Dit kan een geldige sco-id, account-id of principal-id zijn.

session

Tekenreeks

N

De waarde van het BREEZESESSIONcookie. Gebruik deze parameter als uw omgeving geen cookies ondersteunt.

Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> string ...

Antwoordwaarden Element

Type

Beschrijving

results

Kenmerk

Container

Alle resultaten die de actie retourneert.

status

Leeg, met kenmerken

De status van het antwoord.

Toegestane waarde

Een code die de antwoordstatus aangeeft (zie status).

acl-fields

Container

Informatie over alle velden die de principal, de account of het object beschrijven.

field

Container

Eén veld dat de principal, de account of het object beschrijft.

Geheel getal

De acl-id die is opgegeven in de aanvraag en die een sco-id, principal-id of account-id is.

code

acl-id

82


Element

Kenmerk

Type

Beschrijving

field-id

Tekenreeks

De naam van het veld.

Tekenreeks

De waarde van het veld.

value

Voorbeeldaanvraag https://example.com/api/xml?action=acl-field-info&acl-id=2006258745

Voorbeeldantwoord <status code="ok" /> [email protected] Joy Smith

Zie ook acl-field-list, acl-field-update

acl-field-list Beschikbaarheid

Breeze 5; Connect Enterprise Web Services 6 Beschrijving

Retourneert een lijst met waarden voor alle instanties van een veldnaam in uw Enterprise Server- of in uw Enterprise Hosted-account. Als u bijvoorbeeld een overzicht wilt van de voornamen van alle gebruikers in de account, roept u acl-field-list op met field-id=first-name. U kunt eerst acl-field-info aanroepen voor een overzicht van veldnamen.

acl-field-list

83

Aanvraag-URL http://server_name/api/xml ?action=acl-field-list &field-id=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

field-id

Tekenreeks

J

De naam van een veld in de toegangsbeheerlijst waarvoor u waarden en id's wilt. Er is slechts één veldnaam toegestaan.

session

Tekenreeks

N

De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als uw omgeving geen cookies ondersteunt.

Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> string ...

Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


acl-field-list

Container

Informatie over alle waarden in de account voor het opgegeven veld.

acl

Container

Informatie over een waarde voor het opgegeven veld.

code

84


Element

Kenmerk

Type

Beschrijving

acl-id

Geheel getal

De id van de principal, SCO of account waartoe het veld behoort.

Tekenreeks

De waarde van het veld.

value

Voorbeeldaanvraag https://example.com/api/xml?action=acl-field-list&field-id=first-name

Voorbeeldantwoord <status code="ok"/> John Daryl Mary

Zie ook acl-field-info, acl-field-update

acl-field-update Beschikbaarheid


Werkt de waarde bij van een veld dat bij een principal, SCO of account hoort. De principal, SCO of account hoort bij ten minste één ACL (toegangsbeheerlijst), die de entiteiten vermeldt die een machtiging hebben voor toegang tot de principal, SCO of account. Roep acl-field-info aan om te bepalen welke velden de principal, SCO of account heeft. In het antwoord kunt u de field-id zien die u nodig hebt voor de aanvraag tot acl-fieldupdate:

acl-field-update

85

<status code="ok" /> [email protected] ...

Als u acl-field-update wilt aanroepen, hebt u de modify-machtiging voor de principal, SCO of account nodig. Aanvraag-URL http://server_name/api/xml ?action=acl-field-update &acl-id=integer &field-id=string &value=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van het object, de principal of de account. Dit kan een geldige sco-id, account-id of principal-id zijn.

field-id

Tekenreeks

J

De naam van het veld waarvan u de waarde wilt bijwerken. Het veld kan een door de server gedefinieerd veld of een aangepast veld zijn.

value

Tekenreeks

J

De nieuwe in te stellen waarde.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue />

86



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=acl-field-update&acl-id=2006404141 &field-id=first-name&value=jazz

Voorbeeldantwoord <status code="ok" />

Zie ook acl-field-list

acl-preference-update Beschikbaarheid

Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving

Werkt een gebruikersprofiel bij met nieuwe instellingen voor de taal en de tijdzone. Aanvraag-URL http://server_name/api/xml ?action=acl-preference-update &acl-id=integer &lang=allowedValue &time-zone-id=allowedValue &session=BreezeSessionCookieValue

acl-preference-update

87

Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van de gebruiker van wie de voorkeuren worden bijgewerkt. Dit kan een geldige principal-id zijn.

lang

Toegestane waarde

N

Een afkorting voor de nieuwe taal (zie lang voor geldige waarden).

time-zone-id

Toegestane waarde

N

Een instelling in de vorm van een geheel getal voor de nieuwe tijdzone (zie time-zone-id voor waarden).

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://server.com/api/xml?action=acl-preference-update&acl-id=12345 &lang=fr&time-zone-id=0


88


common-info Beschikbaarheid


Retourneert basisinformatie over de huidige gebruiker en de serveraccount of de gehoste account, inclusief de waarde van het BREEZESESSION-cookie. Als u common-info aanroept zonde u aan te melden, bevat het antwoord de elementen user en account niet, omdat de server geen gebruiker kan identificeren. common-info retourneert echter altijd het BREEZESESSION-cookie, zelfs voordat u zich aanmeldt. Aanvraag-URL http://server_name/api/xml ?action=common-info &domain=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

domain

Tekenreeks

N

Een domeinnaam die een gehoste account identificeert. U kunt zo informatie opvragen over uw gehoste account.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> string datetime url hostname /api/xml?action=common-info

common-info

89

string <user user-id=integer type="user"> string string <user-agent>string


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Algemene informatie over uw verbinding met de server.

locale

Toegestane waarde

Een instelling die definieert hoe in Adobe Connect Enterprise Manager of in uw toepassing informatie aan een gebruiker wordt weergegeven (zie lang voor waarden).

time-zone-id

Toegestane waarde

Een code die de tijdzone van de gebruiker definieert (zie time-zone-id voor waarden).

cookie

Tekenreeks

De waarde van het BREEZESESSIONcookie (een tekenreeks die de server retourneert en waarmee deze gebruiker voor deze aanmeldingssessie wordt geïdentificeerd).

date

Datetime

De datum en het tijdstip waarop de aanroep naar common-info plaatsvond, in de ISO 8601-notatie

code

common

90


Element

Kenmerk

Type

Beschrijving

host

Tekenreeks

De URL van de volledig gekwalificeerde hostnaam van de server. Op een cluster is dit de naam die de cluster identificeert.

local-host

Tekenreeks

De naam van de computer die de actie uitvoert (op één server, dezelfde computernaam als host; op een cluster, de naam van de server die de actie heeft uitgevoerd).

url

Tekenreeks

Het deel van de URL die deze aanroep maakt en die de actienaam identificeert.

version

Tekenreeks

De serverversienaam en het nummer.

account

Leeg, met kenmerk

Informatie over de account waartoe de gebruiker behoort. Wordt geretourneerd als u bent aangemeld bij Connect Enterprise, of als u de aanroep op een gehoste account uitvoert.

Geheel getal

De id van de account waartoe de gebruiker behoort.

Container

Informatie over de gebruiker die een sessie met de server tot stand heeft gebracht. Wordt alleen geretourneerd als de gebruiker die de aanroep maakt, is aangemeld.

user-id

Geheel getal

De id van de gebruiker die een sessie met de server tot stand heeft gebracht.

type

Toegestane waarde

Het type principal dat een sessie heeft (normaliter user, zie toegestane waarden voor principals op type).

Tekenreeks

De volledige naam van de gebruiker die een sessie met de server tot stand heeft gebracht.

account-id

user

name

common-info

91

Element

Kenmerk

Type

Beschrijving

login

Tekenreeks

De aanmeldingsnaam van de gebruiker die zich bij de server heeft aangemeld, meestal het e-mailadres van de gebruiker.

user-agent

Tekenreeks

De id van de webbrowser of de client die een sessie met de server tot stand heeft gebracht.

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

Voorbeeldantwoord <status code="ok" /> breezsi4dundh5srw2fq6 2006-09-08T11:17:04.470-07:00 https:example.com localserver17 /api/xml?action=common-info connect_6000 <user user-id="2006258745" type="user"> Joy Smith [email protected] <user-agent>Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)

custom-fields Beschikbaarheid


Vermeldt alle aangepaste velden die zijn gedefinieerd in een account en de details van de velden. Aangepaste velden bieden informatie over objecten (SCO's) of principals die nog niet is gedefinieerd in Adobe Connect Enterprise Manager. U kunt aangepaste velden maken of hun waarde bijwerken met custom-field-update.

92


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

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> <custom-fields> string


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


custom-fields

Container

De lijst met aangepaste velden die met de query overeenkomen.

field

Container

Details van een aangepast veld.

code

custom-fields

93

Element

Kenmerk

Type

Beschrijving

permission-id

Toegestane waarde

De machtiging die de huidige gebruiker heeft voor toegang tot het aangepaste veld (zie permission-id voor waarden).

object-type

Toegestane waarde

Het type object dat het aangepaste veld beschrijft (zie permission-id voor waarden).

field-id

Tekenreeks

De naam van het veld zoals deze op de server wordt geïdentificeerd.

account-id

Geheel getal

De id van de account waarin het aangepaste veld is gedefinieerd.

display-seq

Geheel getal

De volgorde waarin Enterprise Manager of uw toepassing het aangepaste veld weergeeft ten opzichte van de andere aangepaste velden.

field-type

Toegestane waarde

Het type gegevens dat het aangepaste veld accepteert. Toegestane waarden zijn text, textarea en password.

is-primary

Booleaanse waarde

Geeft aan of het aangepaste veld kan worden verwijderd (true als dit niet kan en false als dit wel kan).

is-required

Booleaanse waarde

Geeft aan of dit aangepaste veld verplicht is. true als deze waarde moet worden opgegeven voor dit veld in elk object dat het veld gebruikt. Anders is het false.

Tekenreeks

De naam van het aangepaste veld zoals dit in Enterprise Manager of in uw toepassing wordt weergegeven.

name

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

Voorbeeldantwoord <status code="ok" /> <custom-fields>

94


First Name Last Name

Zie ook custom-field-update

custom-fields-delete Beschikbaarheid


Verwijdert een aangepast veld. De waarde van is-primary voor een aangepast veld moet false zijn voordat het veld kan worden verwijderd. Als is-primary true is en u de waarde ervan wilt wijzigen, roept u custom-field-update aan. Aanvraag-URL http://server_name/api/xml ?action=custom-fields-delete &field-id=string &object-type=allowedValue &session=BreezeSessionCookieValue

custom-fields-delete

95

Parameters Naam

Type

Vereist

Beschrijving

field-id

Tekenreeks

J

De id van het te verwijderen veld. Roep custom-fields-delete aan om de id te verkrijgen. Deze wordt geretourneerd in het kenmerk field-id van het fieldelement.

object-type

Tekenreeks

J

Het type SCO waarvoor het veld is gedefinieerd (zie type voor waarden).

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=custom-fields-delete&field-id=2006338719 &object-type=object-type-principal


Zie ook custom-field-update

96


custom-field-update Beschikbaarheid


Maakt een nieuw aangepast veld of werkt de waarde van een bestaand veld bij. U kunt maximaal acht aangepaste velden op een principal of SCO definiëren. Als u een aangepast veld wilt maken, roept u custom-field-update aan met ten minste de volgende velden: object-type, permission-id, name, field-type, is-required en is-primary. Als custom-field-update is geslaagd, wordt een field-id geretourneerd. Als u een aangepast veld wilt bijwerken, geeft u de field-id, een object-type en een name op voor elk veld dat een waarde heeft die u wilt wijzigen. Wees voorzichtig wanneer u aangepaste velden definieert omdat het ophalen van deze velden voor een rapport (bijvoorbeeld door report-bulk-users aan te roepen) de prestaties van de server en de database kan beïnvloeden. Aanvraag-URL http://server_name/api/xml ?action=custom-field-update &account-id=integer &object-type=object-type-allowedValue &permission-id=allowedValue &name=string &comments=string &field-type=allowedValue &is-required=boolean &is-primary=boolean &display-seq=integer &field-id=integer &session=BreezeSessionCookieValue

custom-field-update

97

Parameters Naam

Type

Vereist

Beschrijving

account-id

Geheel getal

N

De account-id waarin het veld is gemaakt.

object-type

Tekenreeks

J

Het type SCO waarop dit veld van toepassing is. Vereist om velden te maken en bij te werken. Toegestane waarden: • object-type-principal • object-type-meeting • object-type-sco • object-type-event • object-type-read-only Voorbeeld: object-type=object-type-principal

De waarde object-type-read-only betekent dat in Enterprise Manager de waarde wordt weergegeven, maar dat een gebruiker de waarde niet met Enterprise Manager kan instellen. U kunt deze waarde ook gebruiken in aangepaste toepassingen. permission-id

Tekenreeks

J

De machtiging die een principal nodig heeft op het object om de waarde van het veld in te stellen of weer te geven. De enige toegestane waarde is manage. Vereist om een veld te maken.

name

Tekenreeks

J

Het label voor het veld in de gebruikersinterface. Vereist om een veld te maken.

comments

Tekenreeks

N

Opmerkingen die u voor het aangepaste veld definieert en die als tiptekst in uw gebruikersinterface worden weergegeven. Kan maximaal 60 tekens lang zijn.

field-type

Tekenreeks

J

Het type veld. Toegestane waarden zijn text, textarea en password. Vereist om een veld te maken.

98


Naam

Type

Vereist

Beschrijving

is-required

Booleaanse waarde

J

Geeft aan of dit aangepaste veld is vereist. Gebruik true als een waarde voor dit veld moet worden opgegeven in elk object dat het veld gebruikt. Gebruik anders false. Vereist om een veld te maken.

is-primary

Booleaanse waarde

J

Geeft aan of dit aangepaste veld kan worden verwijderd via de gebruikersinterface (true als het veld niet kan worden verwijderd false als het wel kan worden verwijderd).

display-seq

Geheel getal

N

De volgorde waarin Enterprise Manager of uw toepassing het aangepaste veld weergeeft ten opzichte van de andere aangepaste velden.

field-id

Geheel getal

J

De naam van het veld dat een waarde bevat die u wilt bijwerken. Vereist om een veld bij te werken.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> string string

custom-field-update

99


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


code

Toegestane Een code die de antwoordstatus waarde aangeeft (zie status). Leeg, met kenmerken

Informatie over het aangepaste veld.

field-id

Geheel getal

Een numerieke id voor het veld.

display-seq

Geheel getal

De volgorde waarin het veld in Enterprise Manager of in uw toepassing wordt weergegeven.

object-type

Toegestane Het type object dat het veld beschrijft waarde (zie type voor toegestane waarden).

account-id

Geheel getal

is-primary

Booleaanse Geeft aan of dit aangepaste veld kan waarde worden verwijderd (true als dit niet kan en false als dit wel kan).

permission-id

Toegestane De machtiging die nodig is voor waarde toegang tot het aangepaste veld (zie permission-id voor toegestane waarden).

is-required

Booleaanse Geeft aan of een waarde voor dit waarde aangepaste veld is vereist (true indien ja en false indien nee).

field-type

Toegestane Het type gegevens dat het veld waarde accepteert. Toegestane waarden zijn text, textarea en password.

field

Voor klanten van Enterprise Hosted is dit de id van de account waarin het veld is gedefinieerd.

comments

Tekenreeks De opmerking die in comments in de aanvraag is opgegeven.

name

Tekenreeks De naam van het veld dat in name in de aanvraag is opgegeven.

100


Voorbeeldaanvraag https://example.com/api/xml?action=custom-field-update &object-type=object-type-principal&permission-id=manage &account-id=624520&name=jobtitle&comments=test&field-type=text &is-required=true&is-primary=false&display-seq=1

Voorbeeldantwoord <status code="ok" /> test jobtitle

Zie ook report-bulk-users

group-membership-update Beschikbaarheid


Voegt een of meer principals toe aan een groep of verwijdert een of meer principals uit een groep. Als u meerdere principals en groepen wilt bijwerken, geeft u meerdere trio's met de parameters group-id, principal-id en is-member op. U verkrijgt een group-id door principal-list aan te roepen en het antwoord te filteren met filter-type=group of een andere filterwaarde, zoals filter-type=admins. De geïntegreerde groepen hebben onderscheidende typen, naast group (zie type voor een lijst met waarden). Aanvraag-URL http://server_name/api/xml ?action=group-membership-update &group-id=integer &principal-id=integer &is-member=boolean &session=BreezeSessionCookieValue

group-membership-update

101

Parameters Naam

Type

Vereist

Beschrijving

group-id

Geheel getal

J

De id van de groep waaraan u leden wilt toevoegen of waarvan u de leden wilt wijzigen.

principal-id

Geheel getal

J

De id van de principal waarvan u de lidmaatschapstatus wilt bijwerken. Wordt geretourneerd door principal-info.

is-member

Booleaanse waarde

J

Geeft aan of de principal wordt toegevoegd aan (true) of verwijderd uit (false) de groep.

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container

Element van het hoogste niveau voor het antwoord.

status

Leeg, met kenmerken


Toegestane waarde


code

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


102


learning-path-info Beschikbaarheid


Retourneert een lijst met leerpaden voor een leerobject dat bij een studieprogramma hoort. Een leerobject is een SCO die aan een studieprogramma is toegevoegd. Een leerpad wordt bepaald door regels die aangeven of een student kan doorgaan naar het volgende leerobject. U kunt een leerpad maken door de voorwaarden, voltooiingseisen of vooronderzoeksvereisten te bepalen. Een leerpad kan bijvoorbeeld als regel hebben dat de les Welkom bij AcmeCo moet zijn voltooid vóór Projectbeheer bij AcmeCo. Een aanroep naar learning-path-info vermeldt de modules binnen een studieprogramma en de onderlinge paden tussen deze modules. Als u de volledige inhoud van een studieprogramma wilt zien inclusief inhoud, vergaderingen, enzovoort, roept u sco-expanded-contents aan. Aanvraag-URL http://server_name/api/xml ?action=learning-path-info &curriculum-id=integer &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

curriculum-id

Geheel getal

J

De id van het studieprogramma waartoe het leerobject behoort.

sco-id

Geheel getal

J

De id van de studieprogrammamodule (cursus, presentatie of iets dergelijks) waarvoor u een leerpad wilt.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat.

learning-path-info

103

Antwoordstructuur <status code=allowedValue /> string


Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Informatie over leerpaden in een studieprogramma.

Geheel getal

De numeriek id van het studieprogramma.

code

learning-paths

curriculum-id

current-sco-id Geheel getal

Het leerobject waarvoor u een pad wilt.

target-sco-id

Geheel getal

De id van het leerobject dat de toegang tot het huidige leerobject beperkt (bijvoorbeeld een leerobject dat een voorwaarde is voor een ander leerobject).

path-type

Toegestane waarde

Het type pad tussen het doel en de huidige leerobjecten (bijvoorbeeld of het doel moet worden voltooid als voorwaarde). Zie path-type voor toegestane waarden.

Tekenreeks

De naam van het doelleerobject.

name

Voorbeeldaanvraag https://example.com/api/xml?action=learning-path-info&sco-id=2006334909 &curriculum-id=2006298444

104


Voorbeeldantwoord <status code="ok" /> Security at AcmeCo

Zie ook learning-path-update

learning-path-update Beschikbaarheid


Werkt het leerpad bij van één leerobject in een studieprogramma. Een leerobject is een SCO die aan een studieprogramma is toegevoegd. Aanvraag-URL http://server_name/api/xml ?action=learning-path-update &curriculum-id=integer ¤t-sco-id=integer &target-sco-id=integer &path-type=allowedValue &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

curriculum-id

Geheel getal

J

De id van het studieprogramma waartoe het cursusobject behoort.

current-sco-id

Geheel getal

N

De id van het leerobject dat de machtiging heeft die u wilt bijwerken.

learning-path-update

105

Naam

Type

Vereist

Beschrijving

target-sco-id

Geheel getal

N

De id van het leerobject dat de toegang tot het huidige leerobject beperkt (bijvoorbeeld een cursus die een voorwaarde is).

path-type

Toegestane waarde

J

Het type pad tussen het doelleerobject en het huidige leerobject (zie path-type voor toegestane waarden).

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code="ok" />


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=learning-path-update &curriculum-id=2006298444¤t-sco-id=2007064258 &target-sco-id=2007035246&path-type=completion-required

Voorbeeldantwoord <status code="ok"/>

Zie ook learning-path-info

106


login Beschikbaarheid


Meldt een gebruiker aan bij een Enterprise Server- of een Enterprise Hosted-account. Nadat een gebruiker is aangemeld, moet u in een clienttoepassing het cookie genaamd BREEZESESSION lezen en opslaan. Dit cookie vindt u in de HTTP-headers van het antwoord van login. U moet vervolgens de waarde van dat cookie opnemen in elke nieuwe aanvraag die u voor die gebruiker maakt. Als u de cookiewaarden niet kunt ophalen uit HTTP-antwoordheaders, kunt u common-info aanroepen om de cookiewaarde te verkrijgen voordat de gebruiker zich aanmeldt. Geef vervolgens de waarde door aan login met de verzoekparameter session: https://example.com/api/xml?action=login&login=loginId&password=password &session=value

U kunt tevens de parameter session gebruiken op een API-aanroep die u na de login uitvoert. Als u bijvoorbeeld principal-list wilt aanroepen nadat u zich hebt aangemeld, kunt u het volgende opgeven: https://example.com/api/xml?action=principal-list&session=value

De BREEZESESSION-waarde is slechts één aanmeldingssessie geldig. Uw toepassing moet telkens wanneer de gebruiker zich aanmeldt een nieuwe cookiewaarde opslaan. Wanneer u de actie login aanroept, stuurt u een aanmeldings-id en wachtwoord over een netwerk, tenzij u externe verificatie gebruikt. Gebruik SSL of een andere geschikte beveiligingsmethode om wachtwoorden tijdens de verzending te beschermen. Aanvraag-URL http://server_name/api/xml ?action=login &login=string &password=string &account-id=integer &external-auth=use &domain=string

login

107

Parameters Naam

Type

Vereist

Beschrijving

account-id

Geheel getal

N

De id van uw gehoste account in Enterprise Hosted. Als in uw organisatie Enterprise Server wordt gebruikt, mag u account-id niet gebruiken.

external-auth

Toegestane waarde

N

Een waarde die aangeeft of u een externe netwerkaanmeldings-id stuurt om de gebruiker te representeren bij Connect Enteprise. Als dit het geval is, gebruikt u external-auth=use.

login

Tekenreeks

J/N

De aanmeldingsnaam van de gebruiker. Niet gebruiken als u externe of HTTP-headerverificatie gebruikt.

password

Tekenreeks

J/N

Het gebruikerswachtwoord. Niet gebruiken als u externe of HTTPheaderverificatie gebruikt.

domain

Tekenreeks

N

De domeinnaam van uw account in Enterprise Hosted. Als in uw organisatie Enterprise Server wordt gebruikt, mag u domain niet gebruiken.

session

Tekenreeks

N


Filters


108



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag http://example.com/api/[email protected]&password=happy &session=breeztg8mz53r93vebwur


Zie ook logout

logout Beschikbaarheid


Beëindigt de aanmeldingssessie van een gebruiker en maakt de cookiewaarde die bij de gebruikerssessie hoort ongeldig. Nadat u logout hebt aangeroepen, stelt u de cookiewaarde van BREEZESESSION in op null. U dient de cookiewaarde niet opnieuw te gebruiken nadat de gebruiker is afgemeld. Aanvraag-URL http://server_name/api/xml ?action=logout &session=BreezeSessionCookieValue

logout

109

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag http://example.com/api/xml?action=logout


Zie ook login

permissions-info Beschikbaarheid

Breeze 4 en Breeze 5; Connect Enterprise Web Services 6

110


Beschrijving

Retourneert de lijst met principals (gebruikers of groepen) die machtigingen hebben voor een SCO, principal of account. Als u permissions-info wilt aanroepen, moet u een acl-id opgeven. Dit is de id van een SCO, principal of account waarmee kan worden gewerkt. ACL staat voor access control list ofwel toegangsbeheerlijst, en verwijst naar de lijst met entiteiten die een machtiging hebben. U kunt tevens een principal-id opgeven om de machtigingen op te halen die een bepaalde persoon of groep voor het object heeft. Als u de principal-id wilt bepalen, roept u principal-list aan, wellicht met een filter om de geretourneerde gegevens te beperken. De server definieert twee speciale principals: public-access en logged-in-access. De principal public-access is te combineren met waarden van permission-id om speciale toegangsmachtingen te maken voor vergaderingen, en wel als volgt: ■

principal-id=public-access en permission-id=view-hidden betekenen dat de Acrobat Connect-vergadering openbaar is en dat iedereen die de URL van de vergadering heeft, de ruimte kan betreden.

■

principal-id=public-access

en permission-id=denied betekenen dat de vergadering privé is en dat alleen geregistreerde gebruikers en geaccepteerde gasten de ruimte kunnen betreden.

De principal-id van logged-in-access betekent dat alleen principals die zich bij de server hebben aangemeld, toegang tot de vergadering hebben. Aanvraag-URL http://server_name/api/xml ?action=permissions-info &acl-id=integer &principal-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

permissions-info

111

Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van een SCO, account of principal waarmee een principal kan werken. De acl-id is een sco-id, principal-id of account-id in andere aanroepen.

principal-id

Geheel getal

N

De id van een gebruiker of groep die een machtiging heeft (zelfs indien denied of niet ingesteld) om te werken met een SCO, een account of een andere principal.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <principal principal-id=integer is-primary=boolean type=allowedValue has-children=boolean permission-id=integer> string string ...


Type

Beschrijving

results

Container


status

Leeg, met kenmerken


112

Kenmerk


Element

Kenmerk

Type

Beschrijving

code

Toegestane waarde


permissions

Container

Een lijst met principals die hun machtiging weergeven voor toegang tot de SCO, account of principal.

permission

Leeg, met kenmerken

Informatie over de machtiging die een principal heeft voor een SCO, account of principal. Indien leeg is geen machtiging ingesteld.

principal

Container

Informatie over een principal die het machtigingsniveau van de principal weergeeft voor de SCO, account of principal.

principal-id

Geheel getal

De id van een principal die een machtiging heeft voor een SCO, account of principal.

is-primary

Booleaanse waarde

Een waarde die aangeeft of de principal een primaire groep is (hetzelfde als een geïntegreerde groep).

type

Toegestane waarde

Het type principal (zie type voor toegestane waarden).

has-children

Booleaanse waarde

Een waarde die aangeeft of de principal onderliggende niveaus heeft. Groepen hebben onderliggende niveaus, gebruikers niet, dus indien true is de principal een groep.

permission-id Toegestane

waarde acl-id

Geheel getal

De machtiging die de principal heeft voor de SCO, account of principal (zie permission-id voor waarden). De id van de SCO waarvoor de machtiging is gedefinieerd.

permissions-info

113

Element

Kenmerk

Type

Beschrijving

name

Tekenreeks

De naam van de principal die machtiging heeft voor toegang tot de SCO.

login

Tekenreeks

De aanmeldingsnaam van de principal die machtiging heeft voor toegang tot de SCO.

Voorbeeldaanvraag https://example.com/api/xml?action=permissions-info&acl-id=2006334033

Voorbeeldantwoord <status code="ok" /> <principal principal-id="2006258745" is-primary="false" type="user" has-children="false" permission-id="host"> Joy Smith [email protected] ...

Zie ook permissions-reset, permissions-update

permissions-reset Beschikbaarheid


Stelt alle machtigingen die principals hebben voor een SCO opnieuw in op de machtiging van de bovenliggende SCO. Als voor de bovenliggende SCO geen machtigingen zijn ingesteld, heeft de onderliggende SCO ook geen machtigingen. Aanvraag-URL http://server_name/api/xml ?action=permissions-reset &acl-id=integer &session=BreezeSessionCookieValue

114


Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van een SCO die de machtigingen heeft die u opnieuw wilt instellen.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=code />


Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=permissions-reset&acl-id=2006334033


Zie ook permissions-info, permissions-update

permissions-reset

115

permissions-update Beschikbaarheid


Werkt de machtigingen bij die een principal heeft voor toegang tot een SCO, met een trio van principal-id, acl-id en permission-id. Als u machtigingen wilt bijwerken voor meerdere principals of objecten, geeft u meerdere trio's op. U kunt meer dan 200 machtigingen bijwerken in één aanroep naar permissions-update. Roep permissions-update aan om een gebruiker toegang te verlenen tot een vergadering, cursus, studieprogramma of andere SCO in Acrobat Connect. U kunt bijvoorbeeld permissions-update gebruiken om: ■

Een gebruiker uit te nodigen voor een vergadering als deelnemer, presentator of gast (met respectievelijk de permission-id view, mini-host of host).

■

De deelnemer-, presentator- of gasttoegang van een gebruiker in een vergadering te verwijderen (met de permission-id genaamd remove).

■

Gebruikers voor cursussen in te schrijven (met de permission-id genaamd view).

Als u meerdere trio's gebruikt en een van deze ongeldige gegevens bevat (bijvoorbeeld een onjuiste acl-id of principal-id), retourneert permissions-update een status ok en worden de correcte trio's uitgevoerd, maar de ongeldige niet. Aanvraag-URL http://server_name/api/xml ?action=permissions-update &acl-id=integer &principal-id=integer &permission-id=allowedValue &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

acl-id

Geheel getal

J

De id van een SCO (een sco-id) waarvan u de machtigingen wilt bijwerken.

principal-id

Geheel getal

J

De id van een principal (een gebruiker of groep).

116


Naam

Type

Vereist

Beschrijving

permission-id

Tekenreeks

J

De machtiging om toe te wijzen (zie permission-id voor waarden).

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=code />


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=permissions-update&acl-id=2006334033 &principal-id=2006258745&permission-id=host


Zie ook permissions-info, permissions-reset

permissions-update

117

principal-info Beschikbaarheid


Biedt informatie over een principal (een gebruiker of een groep). U moet een principal-id opgeven. Als u de principal-id wilt vinden, roept u principal-list aan, indien nodig met een filter om het antwoord te beperken. Aanvraag-URL http://server_name/api/xml ?action=principal-info &principal-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

J

De id van een gebruiker van wie of een groep waarover u informatie wilt. U kunt de id verkrijgen door principal-list aan te roepen.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <email>string string string <manager account-id=integer disabled=boolean has-children=boolean is-hidden=boolean is-primary=boolean principal-id=integer type=allowedValue> <ext-login>string

118


string string <email>string string string <x-customfield1>string <x-customfield2>string ... <preferences acl-id=integer lang=allowedValue time-zone-id=allowedValue /> <principal account-id=integer disabled=boolean has-children=boolean is-hidden=boolean is-primary=boolean principal-id=integer type=allowedValue> <description>string <ext-login>string string string <email>string string string <x-customfield1>string <x-customfield2>string ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


contact

Container

Informatie over de contactpersoon voor een principal. Als de principal een gebruiker is, is die informatie gewoonlijk hetzelfde als de informatie in principal.

email

Tekenreeks

Het e-mailadres van de contactpersoon.

first-name

Tekenreeks

De voornaam van de contactpersoon.

code

principal-info

119

Element

Type

Beschrijving

last-name

Tekenreeks

De achternaam van de contactpersoon.

manager

Container

Informatie die de manager van een gebruiker (die tevens een principal is) beschrijft.

principal

Container

Informatie die de principal beschrijft.

account-id

Geheel getal

De id van de account waartoe de principal behoort.

disabled

Datetime

Als de account van de principal geldig is, wordt een null-waarde geretourneerd als "". Als de account is uitgeschakeld, de datum waarop de account is uitgeschakeld.

has-children

Booleaanse waarde

Geeft aan of de principal onderliggende niveaus heeft. Groepen hebben onderliggende niveaus, gebruikers niet, dus geeft dit kenmerk aan of de principal een groep is.

is-hidden

Booleaanse waarde

Geeft aan of de principal verborgen is (true) of niet (false) in Enterprise Manager of in uw toepassing.

is-primary

Booleaanse waarde

Geeft aan of de principal een geïntegreerde groep is (true) of niet (false).

principal-id

Geheel getal

De id van de principal.

type

Toegestane waarde

Het type principal (zie type voor waarden).

description

Tekenreeks

Voor een groep, de groepsnaam.

ext-login

Tekenreeks

Voor een gebruiker, de aanmeldings-id die van een extern netwerk is verzonden. Standaard dezelfde waarde als login, dus wijzig deze als u externe verificatie gebruikt.

120

Kenmerk


Element

Kenmerk

Type

Beschrijving

login

Tekenreeks

De aanmeldings-id van de principal in Connect Enterprise. Deze kan hetzelfde zijn als een e-mailadres.

name

Tekenreeks

Voor een gebruiker is dit de volledige naam, samengesteld uit first-name en last-name.

email

Tekenreeks

Voor een gebruiker is dit het emailadres.

first-name

Tekenreeks

Voor een gebruiker is dit de voornaam.

last-name

Tekenreeks

Voor een gebruiker is dit de achternaam.

x-customfield

Tekenreeks

Een aangepast veld dat voor de gebruiker of de groep is gedefinieerd.

preferences

Leeg, met kenmerken

Informatie over de voorkeuren van de principal.

acl-id

Geheel getal


lang

Toegestane waarde

De taalinstelling die de principal heeft gekozen voor Connect Enterprise-toepassingen.

time-zone-id

Toegestane waarde

De tijdzone-instelling die de principal heeft gekozen voor Connect Enterprise-toepassingen.

Voorbeeldaanvraag https://example.com/api/xml?action=principal-info&principal-id=2006258745

Voorbeeldantwoord <status code="ok" /> <email>[email protected] Bob Jones <manager account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id="2006282569" type="user">

principal-info

121

<ext-login>[email protected] [email protected] jazz doe <email>[email protected] Jazz Doe <x-2007017651>San Francisco <preferences acl-id="2006258745" lang="en" time-zone-id="4" /> <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id="2006258745" type="user"> <ext-login>[email protected] [email protected] Joy Smith <email>[email protected] Joy Smith <x-2007017651>San Francisco

Zie ook principal-list, principal-list-by-field, principal-update

principal-list Beschikbaarheid


Biedt een volledig overzicht van gebruikers en groepen, inclusief primaire groepen. Deze aanroep is nuttig om een principal-id te verkrijgen als u er geen hebt. Wees u er echter van bewust dat een overzicht van alle principals in uw Enterprise Server- of in uw Enterprise Hosted-account wordt geretourneerd, tenzij u een filter gebruikt om het antwoord te beperken. U kunt ook principal-list gebruiken voor een overzicht van groepen in een account door te filteren op de velden type en is-member: https://example.com/api/xml?action=principal-list&filter-type=group &filter-is-member=true

122


Het filter-type=group retourneert echter groepen die u hebt gemaakt, geen geïntegreerde groepen die vooraf op de server zijn gedefinieerd. Geïntegreerde groepen hebben typewaarden die anders zijn dan die van de group, zoals admins en authors (zie type voor een lijst met waarden). U kunt het antwoord filteren met een filter-type, ingesteld op het gewenste type groep, en vervolgens het antwoord parseren voor een principal-id, daarna de principal-id doorgeven als een group-id in een ander verzoek om de principal-list. Aangezien principal-list vaak een groter antwoord retourneert, moet u voorzichtig zijn met het gebruik van filter-like-filters en jokertekens om trage prestaties te voorkomen (zie filter-definition voor meer informatie). Aanvraag-URL http://server_name/api/xml ?action=principal-list &group-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

group-id

Geheel getal

N

De id van een groep. Hetzelfde als de principal-id van een principal die de type-waarde group heeft.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <principal-list> <principal principal-id=integer account-id=integer type=allowedValue has-children=boolean is-primary=boolean is-hidden=boolean> string string <email>string

principal-list

123


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


principal-list

Container

De volledige lijst met principals.

principal

Container

Details over één principal.

principal-id

Geheel getal


account-id

Geheel getal


type

Toegestane waarde


has-children

Booleaanse waarde

Geeft aan of de principal onderliggende niveaus heeft. Groepen hebben onderliggende niveaus, gebruikers niet, dus als has-children true is, is de principal een groep.

is-primary

Booleaanse waarde

Geeft aan of de principal een geïntegreerde groep is (true) of niet (false).

is-hidden

Booleaanse waarde

Geeft aan of de principal wordt weergegeven in Enterprise Manager of uw toepassing (true betekent niet weergegeven en false betekent dat de principal wel wordt weergegeven).

name

Tekenreeks

De volledige naam van de principal.

login

Tekenreeks

De aanmeldings-id van de principal, meestal een e-mailadres.

email

Tekenreeks

Het e-mailadres van de principal.

code

124


Element

Kenmerk

Type

Beschrijving

principal-customfield-values

Container

De volledige lijst met aangepasteveldwaarden die voor de principal zijn gedefinieerd.

field

Container

Details over één aangepast veld dat voor de principal is gedefinieerd (zie veld voor de inhoud).

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

Voorbeeldantwoord <status code="ok" /> <principal-list> <principal principal-id="624526" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> ned mack [email protected] <email>[email protected] <principal principal-id="624550" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> amelie jones [email protected] <email>[email protected] ...

Zie ook principal-info, principal-update, principal-list-by-field

principal-list-by-field Beschikbaarheid


Vermeldt de principals die een bepaalde waarde in een willekeurig veld hebben.

principal-list-by-field

125

Geef in de parameter value de waarde op die u wilt zoeken. De waarde moet de naam van een databaseveld zijn. Het element name is bijvoorbeeld een volledige naam, bestaande uit de velden first-name (bob) en last-name (jansen), dus als u zoekt naar de name (bob jansen), retourneert principal-list-by-field geen waarde, tenzij de volledige naam is gedefinieerd als een databaseveld (in dit geval een aangepast veld). De zoekactie is hoofdlettergevoelig en de querytekenreeks kan spaties bevatten. Jokertekens zijn niet toegestaan in de querytekenreeks. Als u bijvoorbeeld t* invoert, zoekt principal-list-by-field naar de exacte tekenreeks t*. De actie principal-list-by-field zoekt in alle velden die voor de principal zijn gedefinieerd, inclusief aangepaste velden. Aanvraag-URL http://server_name/api/xml ?action=principal-list-by-field &value=string &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

value

Tekenreeks

J

De waarde die u in alle velden wilt zoeken. U hoeft geen veldnaam op te geven.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <principal-list> <principal account-id=integer principal-id=integer type=allowedValue has-children=boolean is-primary=boolean is-hidden=boolean> string string

126



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


principal-list

Container

De hele lijst met principals die overeenkomen met de waarde in een of meer velden.

principal

Container

Een principal die overeenkomt met de waarde.

principal-id

Geheel getal


account-id

Geheel getal


type

Toegestane waarde


has-children

Booleaanse waarde

Geeft aan of de principal onderliggende niveaus heeft. Groepen hebben onderliggende niveaus, gebruikers niet, dus geeft dit kenmerk aan of de principal een groep is.

is-primary

Booleaanse waarde

Geeft aan of de principal een ingebouwde groep is (true) of niet (false).

is-hidden

Booleaanse waarde

Geeft aan of de principal is verborgen in de gebruikersinterface (true) of niet (false).

name

Tekenreeks

De volledige naam van de principal, bestaande uit de velden first-name en last-name.

login

Tekenreeks

De aanmeldings-id van de principal, meestal een emailadres.

code

principal-list-by-field

127

Voorbeeldaanvraag https://example.com/api/xml?action=principal-list-by-field&value=bob

Voorbeeldantwoord <status code="ok" /> <principal-list> <principal account-id="624520" principal-id="2616099" type="user" has-children="false" is-primary="false" is-hidden="false"> Bob Jones [email protected]

Zie ook principal-info, principal-list, principal-update

128


HOOFDSTUK 6

Actiereferentie principals-delete Beschikbaarheid


Hiermee verwijdert u een of meer principals, namelijk gebruikers of groepen. Als u principals wilt verwijderen, moet u beheerdersrechten hebben. Als u meerdere principals wilt verwijderen, geeft u meerdere principal-id-parameters op. Alle principals die u opgeeft, worden verwijderd. De principal-id kan een gebruiker of een groep identificeren. Als u een gebruiker opgeeft, wordt de gebruiker verwijderd uit de groepen waartoe hij of zij behoort. Als u een groep opgeeft, wordt de groep verwijderd, maar niet de gebruikers die ertoe behoren. Aanvraag-URL http://server_name/api/xml ?action=principals-delete &principal-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

J

De id van een gebruiker of een groep die u wilt verwijderen.

session

Tekenreeks

N


Filters


principals-delete

129


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=principals-delete &principal-id=2006339311&principal-id=2006339323


Zie ook principal-info, principal-list, principal-list-by-field, principal-update

principal-update Beschikbaarheid


Hiermee maakt u een gebruiker of groep, of werkt u deze bij. De gebruiker of de groep (dat wil zeggen de principal) wordt gemaakt of bijgewerkt in dezelfde account als de gebruiker die de aanroep uitvoert. Als u een nieuwe principal wilt maken, roept u principal-update aan zonder een op te geven. Voeg de principal-id toe als u wilt bijwerken. Voordat u de metagegevens van een principal bijwerkt, roept u principal-info aan om de bestaande versie te verkrijgen. principal-id

Als er aangepaste velden voor de informatie van een principal zijn, gebruikt u acl-fieldupdate in plaats principal-update om ze bij te werken. U hebt beheerdersrechten nodig om een principal te kunnen maken of bijwerken.

130


Aanvraag-URL http://server_name/api/xml ?action=principal-update &description=string &email=string &first-name=string &has-children=boolean &last-name=string &login=string &name=string &password=string &principal-id=integer &send-email=boolean &type=allowedValue &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

description

Tekenreeks

N

De beschrijving van de nieuwe groep. Alleen gebruiken wanneer u een nieuwe groep maakt.

email

Tekenreeks

N

Het e-mailadres van de gebruiker. Kan afwijken van de login. Zorg dat u een waarde opgeeft wanneer u sendemail=true gebruikt.

first-name

Tekenreeks

J/N

De nieuwe voornaam van de gebruiker. Alleen gebruiken voor gebruikers, niet voor groepen. Vereist om een te gebruiker maken.

has-children

Booleaanse waarde

J

Geeft aan of de principal onderliggende niveaus heeft. Als de principal een groep is, gebruikt u 1 of true. Als de principal een gebruiker is, gebruikt u 0 of false.

last-name

Tekenreeks

J/N

De nieuwe achternaam die u aan de gebruiker toewijst. Vereist om een gebruiker maken. Niet gebruiken voor groepen.

login

Tekenreeks

J/N

De nieuwe aanmeldingsnaam van de principal, normaliter het e-mailadres van de principal. Moet uniek zijn op de server. Vereist om een gebruiker te maken of bij te werken. Niet gebruiken voor groepen.

principal-update

131

Naam

Type

Vereist

Beschrijving

name

Tekenreeks

J/N

De naam van de nieuwe groep. Alleen gebruiken wanneer u een nieuwe groep maakt. Vereist om een groep te maken.

password

Tekenreeks

N

Het nieuwe gebruikerswachtwoord. Alleen gebruiken wanneer u een nieuwe gebruiker maakt.

principal-id

Tekenreeks

J/N

De id van de principal die de informatie bevat die u wilt bijwerken. Vereist om een gebruiker of groep bij te werken, maar niet gebruiken om deze te maken.

send-email

Booleaanse waarde

N

Een vlag die aangeeft of de server een email moet sturen aan de principal met de account- en aanmeldingsgegevens.

type

Tekenreeks

J/N

Het type principal. Alleen gebruiken wanneer u een nieuwe principal maakt (zie type voor waarden).

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <principal principal-id=integer account-id=integer has-children=integer type=integer> string <ext-login>string string


Type

Beschrijving

results

Container


status

Leeg, met kenmerken


132

Kenmerk


Element

Kenmerk

Type

Beschrijving

code

Toegestane waarde


Container

Informatie over de nieuwe principal die u hebt gemaakt.

principal-id

Geheel getal

De id van de nieuwe gebruiker die u hebt gemaakt.

account-id

Geheel getal

De id van de account waartoe de nieuwe gebruiker behoort. Deze waarde is hetzelfde als de account van de huidige gebruiker.

has-children

Booleaanse waarde

Geeft aan of de principal onderliggende niveaus heeft en dat geeft weer aan of de principal een gebruiker of een groep is (1 is een groep, 0 is een gebruiker).

type

Toegestane waarde


login

Tekenreeks

De aanmeldings-id van de principal, meestal een e-mailadres.

ext-login

Tekenreeks

De externe verificatie-id van de principal. Dit is standaard dezelfde waarde als login, tenzij u de waarde uitdrukkelijk instelt op een verificatie-id van uw netwerk.

name

Tekenreeks

De voornaam van de principal. Als de principal een gebruiker is, samengesteld met de velden first-name en last-name.

principal

Voorbeeldaanvraag https://example.com/api/xml?action=principal-update&first-name=jake [email protected]&type=user

Voorbeeldantwoord <status code="ok" /> <principal principal-id="2006403978" account-id="624520" type="user" has-children="0"> [email protected] <ext-login>[email protected] jake doe

principal-update

133

Zie ook principal-info, principals-delete principal-list, principal-list-by-field

report-active-meetings Beschikbaarheid


Retourneert een lijst met Adobe® Acrobat® Connect™ Professional-vergaderingen die momenteel in gang zijn, inclusief het aantal minuten dat de vergadering actief is geweest. Om met report-active-meetings resultaten te retourneren, moet er ten minste één gebruiker in ten minste één vergaderruimte aanwezig zijn. Als er op dit moment vergaderingen zijn gepland, maar er geen gebruikers aan die vergaderingen deelnemen, wordt door report-active-meetings een leeg antwoord geretourneerd. Aanvraag-URL http://server_name/api/xml ?action=report-active-meetings &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <sco sco-id=integer active-participants=integer length-minutes=integer> string string datetime

134



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-activemeetings

Container

De lijst met alle vergaderingen die op dat moment plaatsvinden.

sco

Container

Informatie over één vergadering die op dat moment plaatsvindt.

Geheel getal

De unieke id van een vergadering die op dat moment plaatsvindt.

code

sco-id

activeGeheel getal participants

Het aantal gebruikers dat aanwezig is bij de vergadering die op dat moment plaatsvindt, inclusief gastheren en presentatoren.

Geheel getal

Het aantal minuten dat de vergadering actief is geweest.

name

Tekenreeks

De naam van de vergadering, gedefinieerd toen de vergadering werd gemaakt.

url-path

Tekenreeks

Het deel van de vergaderingURL dat op het domein volgt en dat uniek is voor deze vergadering.

date-begin

Datetime

De datum en tijd waarop de vergadering is begonnen.

length-minutes

Voorbeeldaanvraag https://example.com/api/xml?action=report-active-meetings

Voorbeeldantwoord <status code="ok" /> <sco sco-id="2006778715" active-participants="" length-minutes="1">

report-active-meetings

135

Designing Online Courses /online/ 2006-06-28T14:35:21.307-07:00

report-bulk-consolidated-transactions Beschikbaarheid


Retourneert informatie over principal-to-SCO-transacties in Adobe Connect Enterprise Server of in uw Enterprise Hosted-account. Een transactie is een instantie van een principal die een object (SCO) bezoekt. De SCO kan een Acrobat Connect Professional-vergadering, cursus, document of andere inhoud op de server zijn. Hier volgen voorbeelden van transacties: ■

Als een principal tweemaal aan een vergadering deelneemt, bestaan er twee transacties: één voor elke keer dat de principal aan de vergadering heeft deelgenomen.

■

Als vijf personen aan een vergadering deelnemen, bestaan er vijf transacties: één voor elke gebruiker die aan de vergadering deelneemt.

■

Als een principal driemaal twee cursussen volgt en voor elke cursus pas de derde keer slaagt, zijn er zes transacties: één voor elke poging voor elke cursus.

Met deze aanroep worden alle transacties geretourneerd, probeer dus een filter te gebruiken om het antwoordvolume te reduceren. Als u bijvoorbeeld filter-type=meeting, gebruikt, retourneert de aanroep alle vergaderingtransacties: https://example.com/api/xml?action=report-bulk-consolidated-transactions &filter-type=meeting

Met de vergaderingtransacties in het antwoord (zie het voorbeeldantwoord), kunt u het gebruik van Connect Enterprise-vergaderingen berekenen door de tijden te vergelijken in date-created en date-closed. Zie “Vergadergebruik berekenen” voor uitgebreide stapsgewijze informatie. Aanvraag-URL http://server_name/api/xml ?action=report-bulk-consolidated-transactions &filter-definition=value

136


&sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

session

Tekenreeks

N

Beschrijving De waarde van het BREEZESESSION-cookie. Gebruik

deze parameter als uw omgeving geen cookies ondersteunt.

Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string relativeUrl string <user-name>string <status>allowedValue datetime datetime ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

De hele lijst met transacties die overeenkomen met het verzoek.

code

report-bulkconsolidatedtransactions

report-bulk-consolidated-transactions

137

Element

Kenmerk

row

Type

Beschrijving

Container

De details van één transactie die overeenkomt met het verzoek.

transaction-id Geheel getal

De id van de transactie.

sco-id

Geheel getal

De unieke id van het object (SCO) waarmee de gebruiker heeft gewerkt.

type

Toegestane waarde

Het type SCO (zie type voor toegestane waarden).

principal-id

Geheel getal

De id van de principal die bij de transactie is betrokken.

score

Geheel getal

De feitelijke score als aan de transactie (bijvoorbeeld een quiz) een score is toegewezen. Anders 0.

name

Tekenreeks

De naam die is toegewezen aan de SCO die bij de transactie is betrokken.

url

Tekenreeks

Het bestandsnaamdeel van de URL naar de SCO die bij de transactie is betrokken.

login

Tekenreeks

De aanmeldings-id van de principal.

user-name

Tekenreeks

De volledige naam van de gebruiker die bij de transactie is betrokken (samengesteld uit first-name en last-name).

status

Toegestane waarde

De status van de transactie. Toegestane waarden zijn completed, in-progress, userpassed en user-failed.

date-created

Datetime

De datum en tijd waarop de principal de interactie met de SCO is begonnen en waarop de transactie is gemaakt.

date-closed

Datetime

De datum en tijd waarop de principal de interactie met de SCO heeft voltooid en waarop de transactie is voltooid.

138


Voorbeeldaanvraag https://example.com/api/xml?action=report-bulk-consolidated-transactions &filter-type=meeting

Voorbeeldantwoord <status code="ok" /> Celebrate End of June Meeting /endjune/ [email protected] <user-name>Joy Smith <status>completed 2006-06-30T11:10:37.003-07:00 2006-06-30T11:45:21.397-07:00 Celebrate End of June Meeting /endjune/ [email protected] <user-name>Joy Smith <status>completed 2006-06-30T17:58:29.060-07:00 2006-06-30T17:59:09.970-07:00 ...

Zie ook report-bulk-objects, report-bulk-questions, report-bulk-slide-views, report-bulk-users

report-bulk-objects Beschikbaarheid

Breeze 5; Connect Enterprise Web Services 6

report-bulk-objects

139

Beschrijving

Retourneert informatie over alle objecten (SCO's) op een in licentie verleende Enterprise Server of in een Enterprise Hosted-account. De geretourneerde objecttypen zijn onder meer archive, attachment, authorware, captivate, course, curriculum, external-event, flv, image, meeting, presentation en swf. Aangezien het antwoord waarschijnlijk groot is, past u filters toe om het te reduceren. Als u bijvoorbeeld een lijst wilt retourneren van alle vergaderingen, filtert u op het veld type: http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting

Aanvraag-URL http://server_name/api/xml ?action=report-bulk-objects &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

session

Tekenreeks

N



Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string string datetime datetime datetime <description>datetime ...

140



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

De hele lijst met SCO's op de server, of als u een filter gebruikt, de hele lijst met SCO's die overeenkomen met het filter.

code

report-bulk-objects

Container

Details van een SCO.

sco-id

Geheel getal

De unieke id van de SCO.

type

Toegestane waarde

Het type SCO (zie type).

url

Tekenreeks

De unieke identificatiecode van de training-SCO, die in de URL achter de domeinnaam wordt geplaatst.

name

Tekenreeks

De naam die aan de SCO is toegewezen.

date-created

Datetime

De datum waarop de SCO is gemaakt. Voor een vergadering, de datum en tijd waarop de vergadering begint.

date-end

Datetime

Als de SCO een vergadering of gebeurtenis is, de datum waarop deze is beëindigd.

date-modified

Datetime

De datum waarop de SCO voor het laatst is bijgewerkt.

description

Tekenreeks

De beschrijving van de SCO.

row

Voorbeeldaanvraag http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting &filter-gt-date-created=2006-06-01

report-bulk-objects

141

Voorbeeldantwoord <status code="ok" /> /online/ Designing Online Courses 2006-06-28T14:15:00.000-07:00 2006-06-28T14:30:00.000-07:00 2006-07-13T14:57:54.150-07:00 ...

Zie ook report-bulk-consolidated-transactions, report-bulk-questions, report-bulkslide-views, report-bulk-users

report-bulk-questions Beschikbaarheid


Retourneert informatie over elke quizvraag in de account waarbij u bent aangemeld. Het antwoord bevat een combinatie van de quizvraag, het antwoord, de id van de gebruiker die het antwoord heeft gegeven en de id van de transactie. De actie retourneert alle vraag- en antwoordcombinaties in de account, tenzij u een filter gebruikt om de omvang van het antwoord te beperken. Aanvraag-URL http://server_name/api/xml ?action=report-bulk-questions &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

142


Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string string datetime ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-bulk-questions

Container

De hele lijst met vraag- en antwoordcombinaties die met het verzoek overeenkomen.

row

Container

Details over een vraag- en antwoordcombinatie.

code


De id van de interactie tussen een gebruiker en een quiz.

report-bulk-questions

143

Element

Kenmerk

Type

Beschrijving

score

Geheel getal

De score die aan de vraag is toegewezen.

principal-id

Geheel getal

De id van de gebruiker die de vraag heeft beantwoord of heeft weergegeven.

question

Tekenreeks

De tekst van de vraag, die als een verklaring kan zijn vermeld.

response

Tekenreeks

Het antwoord dat de gebruiker heeft gekozen of ingevoerd.

date-created

Datetime

De datum en tijd waarop de gebruiker de vraag heeft beantwoord.

Voorbeeldaanvraag https://example.com/api/xml?action=report-bulk-questions

Voorbeeldantwoord <status code="ok" /> The capital of California is<1> Sacramento 2006-05-11T15:50:23.643-07:00 The capital of California is<1> san francisco 2006-05-11T17:32:53.970-07:00

Zie ook report-bulk-objects, report-bulk-consolidated-transactions, report-bulkslide-views, report-bulk-users

144


report-bulk-slide-views Beschikbaarheid


Retourneert informatie over elke gelegenheid waarbij een principal een dia bekijkt. De dia kan zich in een willekeurige presentatie bevinden in de account waartoe de gebruiker behoort. Elke diaweergave is een transactie. Een transactie is een interactie tussen een gebruiker en een SCO in Connect Enterprise. In dit geval vindt de transactie plaats tussen een gebruiker en een dia. De actie retourneert alle instanties van principals die dia's in de account weergeven, tenzij u het antwoord filtert. Aanvraag-URL http://server_name/api/xml ?action=report-bulk-slide-views &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

session

Tekenreeks

N



Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <page>integer datetime ...

report-bulk-slide-views

145


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-bulk-slideviews

Container

De hele lijst met diaweergaven die overeenkomen met het verzoek.

row

Container

Details over een diaweergave.

code


De id van de transactie tussen de gebruiker en de dia.

Geheel getal

De id van de gebruiker die de dia heeft weergegeven.

page

Geheel getal

Het paginanummer van de dia in de presentatie.

date-created

Datetime

De datum en tijd waarop de gebruiker de dia heeft weergegeven.

principal-id

Voorbeeldaanvraag https://example.com/api/xml?action=report-bulk-slide-views &filter-principal-id=123456

Voorbeeldantwoord <status code="ok" /> <page>0 2006-05-11T12:02:01.470-07:00 <page>0 2006-05-11T12:02:01.487-07:00 ...

146


Zie ook report-bulk-objects, report-bulk-questions, report-bulk-consolidatedtransactions, report-bulk-users

report-bulk-users Beschikbaarheid


Retourneert informatie over alle gebruikers in een account. Het verschil tussen deze aanroep en principal-list is dat principal-list zowel gebruikers als groepen retourneert, terwijl report-bulk-users alleen gebruikers retourneert. Het antwoord van report-bulk-users kan zeer groot zijn, met name als u aangepaste velden gebruikt, dus vergeet niet dat u het antwoord kunt filteren en sorteren. De volgende aanroep retourneert bijvoorbeeld een lijst met alle gebruikers met de letters Jo in hun naam, gesorteerd in oplopende volgorde op naam: http://myserver.com/api/xml?action=report-bulk-users&sort-name=asc &filter-like-name=Jo

Als u custom-fields=true doorgeeft, retourneert report-bulk-users standaard maximaal acht aangepaste velden die voor gebruikers zijn gedefinieerd. Als u meer dan acht aangepaste velden voor gebruikers hebt gedefinieerd, retourneert report-bulk-users de eerste acht in de lijst van het scherm Gebruikersprofiel aanpassen in Connect Enterprise Manager (bij Beheer > Gebruikers en groepen > Gebruikersprofiel aanpassen). Als u Enterprise Server gebruikt, kunt u een waarde instellen voor REPORT_MAX_CUSTOM_FIELDS in het bestand custom.ini zodat report-bulk-users meer dan acht aangepaste velden retourneert (zie voor meer informatie de de Installatie- en configuratiegids voor Adobe Connect Enterprise). U kunt een willekeurige waarde gebruiken, maar hogere waarden beïnvloeden in hogere mate de prestaties van de database. U kunt deze instelling niet wijzigen in Enterprise Hosted. Aanvraag-URL http://server_name/api/xml ?action=report-bulk-users &custom-fields=boolean &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

report-bulk-users

147

Parameters Naam

Type

Vereist

Beschrijving

custom-fields

Booleaanse waarde

N

Geeft aan of aangepaste velden in het antwoord worden geretourneerd. Retourneert maximaal acht aangepaste velden. Indien true wordt het veld manager niet in het antwoord geretourneerd.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Gebruik filter-type niet met report-bulk-users; gebruik in plaats daarvan filterlike-type.

Antwoordstructuur <status code=allowedValue /> string string <email>string <manager>string allowedValue .. any custom fields .. ...


Type

Beschrijving

results

Container


status

Leeg, met kenmerken


148

Kenmerk


Element

Kenmerk

Type

Beschrijving

code

Toegestane waarde


report-bulk-users

Container

De hele lijst met gebruikers in de account.

row

Container

Details van één gebruiker in de account.

Geheel getal

De id van de gebruiker.

login

Tekenreeks

De aanmeldings-id van de gebruiker, meestal een e-mailadres.

name

Tekenreeks

De volledige naam van de gebruiker, samengesteld uit de voornaam en de achternaam van de gebruiker.

email

Tekenreeks

Het e-mailadres van de gebruiker.

manager

Tekenreeks

De manager van de gebruiker, tevens een geregistreerde gebruiker. Wordt geretourneerd als een manager voor de gebruiker is ingesteld. Wordt niet geretourneerd als custom-fields in de aanvraag true is.

type

Toegestane waarde

Het type gebruiker, user of guest.

principal-id

Voorbeeldaanvraag https://example.com/api/xml?action=report-bulk-users&filter-like-name=john

Voorbeeldantwoord <status code="ok" /> [email protected] John Owens <email>[email protected] guest [email protected]

report-bulk-users

149

John Smith <email>[email protected] guest ...

Zie ook report-bulk-objects, report-bulk-questions, report-bulk-slide-views, report-bulk-consolidated-transactions

report-course-status Beschikbaarheid


Retourneert de cursusstatus voor een principal of een cursus op basis van de parameters die u gebruikt. Deze aanroep retourneert informatie vanuit het perspectief van een persoon of een cursus. Voor een principal geven de resultaten het aantal cursussen aan dat iemand heeft voltooid, gehaald of niet heeft gehaald. Voor een cursus tonen ze het aantal personen dat de cursus heeft voltooid en dat ervoor is geslaagd of gezakt. Hiervoor is een sco-id van een cursus vereist. Wanneer u een principal-id én een sco-id opgeeft, retourneert de aanroep informatie voor een specifieke principal die een specifieke cursus volgt (of heeft gevolgd). Aanvraag-URL http://server_name/api/xml ?action=report-course-status &sco-id=integer &principal-id=integer &session=BreezeSessionCookieValue

150


Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

N

De id van de principal waarvan u de cursusstatus wilt.

sco-id

Geheel getal

J

De unieke id van de cursus waarvan u de status wilt. Als u geen principal-id opgeeft, beschrijven de resultaten de cursus. Als u een principal-id, toevoegt, weerspiegelen de resultaten de status van de principal in die cursus.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> datetime


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

report-course-status

151

Element

Kenmerk

report-course-status

Type

Beschrijving

Container

Informatie over een cursus, of over de voortgang van de principal in die cursus.

total-course- Geheel getal completions

Voor een cursus: het totale aantal gebruikers dat de cursus heeft voltooid. Voor een gebruiker: het aantal keren dat de desbetreffende cursus is voltooid.

total-unique- Geheel getal coursecompletions

Voor een cursus: het aantal unieke gebruikers dat de cursus heeft voltooid. Voor een gebruiker: het aantal unieke keren dat de desbetreffende cursus is voltooid.

num-passed

Geheel getal

Voor een cursus: het aantal keren dat gebruikers voor de cursus zijn geslaagd. Voor een gebruiker: het aantal keren dat de desbetreffende cursus is gevolgd en gehaald.

num-failed

Geheel getal

Voor een cursus: het aantal keren dat gebruikers voor de cursus zijn gezakt. Voor een combinatie van cursus en gebruiker: het aantal keren dat de gebruiker de cursus heeft gevolgd en ervoor is gezakt.

num-enrollees Geheel getal

date-last-taken

Datetime

Het aantal gebruikers dat op een willekeurig moment voor de cursus is ingeschreven. Wordt geretourneerd voor cursussen, maar niet voor combinaties van gebruikers en cursussen. De laatste keer dat een gebruiker een cursus heeft gevolgd of de laatste keer dat de gebruiker de desbetreffende cursus heeft gevolgd.

Voorbeeldaanvraag https://example.com/api/xml?action=report-course-status &sco-id=123456&principal-id=278935

152


Voorbeeldantwoord <status code="ok" /> 2004-07-27T12:53:42.297-07:00

report-curriculum-taker Beschikbaarheid

Connect Enterprise Web Services 6 Beschrijving

Retourneert informatie over de voortgang van een gebruiker in een studieprogramma. Het antwoord bevat een element row voor elke cursus in het studieprogramma, dat informatie bevat zoals de toegang tot de cursus, of bonuspunten zijn toegekend, de score van de gebruiker, het unieke url-path naar de cursus, enzovoort. Aanvraag-URL http://server_name/api/xml ?action=report-curriculum-taker &user-id=integer &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

user-id

Geheel getal

J

De id van de gebruiker van wie u de scores wilt controleren.

sco-id

Geheel getal

J

De unieke id van het studieprogramma waarvan u een overzicht wilt.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren.


153

Antwoordstructuur <status code=allowedValue /> <sco transcript-id=integer path-type=allowedValue asset-id=integer sco-id=integer depth=integer folder-id=integer type=integer icon=allowedValue lang=allowedValue max-retries=integer source-sco-id=integer source-sco-type=allowedValue status=allowedValue score=integer certificate=integer max-score=integer attempts=integer> allowedValue boolean string string datetime boolean


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-curriculumtaker

Container

Informatie over de prestaties van de gebruiker in het hele studieprogramma.

sco

Container

Informatie over het werk van de gebruiker met één cursus of studieprogramma.

transcript-id

Geheel getal

De id van de transcriptie van de gebruiker voor de cursus of het studieprogramma.

path-type

Toegestane waarde

Het leerpad dat een gebruiker moet volgen voordat deze cursus of dit studieprogramma kan worden gevolgd (zie pathtype voor toegestane waarden).

code

154


Element

Kenmerk

Type

Beschrijving

asset-id

Geheel getal

De versie van de cursus of het studieprogramma dat de gebruiker probeert te voltooien. De asset-id wordt verhoogd wanneer voor de cursus of het studieprogramma nieuwe inhoud is geüpload.

sco-id

Geheel getal

De unieke id van de cursus of het studieprogramma.

depth

Geheel getal

Een cursusniveau onder het studieprogramma in de navigatiehiërarchie. Voor een studieprogramma 0; voor een cursus één niveau onder het studieprogramma 1.

folder-id

Geheel getal

De id van de map die de cursus of het studieprogramma bevat. Voor een cursus is dit de id van een studieprogramma; voor een studieprogramma is dit de id van een gebruiker.

type

Geheel getal

Het type cursus of studieprogramma (zie type voor toegestane waarden).

icon

Toegestane waarde

Het type pictogram waarmee de cursus of het studieprogramma wordt geïdentificeerd in Enterprise Manager (zie icon voor waarden).

lang

Toegestane waarde

De taal die bij de cursus of het studieprogramma hoort (zie lang voor waarden).

max-retries

Geheel getal

Het maximum aantal keren dat een gebruiker de cursus of het studieprogramma opnieuw kan volgen. Als een gebruiker de cursus driemaal kan volgen is max-retries 2.


155

Element

Kenmerk

Type

Beschrijving

source-sco-id

Geheel getal

De unieke id van de SCO die gebruikt wordt als sjabloon voor de cursus of het studieprogramma.

source-sco-type

Geheel getal

Het type SCO dat wordt gebruikt als sjabloon voor de cursus of het studieprogramma (zie type voor waarden).

status

Toegestane waarde

De status van de gebruikerspoging om de cursus of het studieprogramma te gebruiken. De toegestane waarden voor cursussen zijn completed, incomplete, user-passed, user-failed en not-attempted. De toegestane waarden voor studieprogramma's en mappen zijn completed en incomplete.

score

Geheel getal

De score die de gebruiker heeft behaald voor de cursus of het studieprogramma.

certificate

Geheel getal

De id van het gebruikerscertificaat.

max-score

Geheel getal

De maximum score die voor de cursus of het studieprogramma mogelijk is.

attempts

Geheel getal

Het aantal keren dat de gebruiker de cursus of het studieprogramma heeft geprobeerd.

access

Toegestane waarde

Het toegangsniveau dat de gebruiker voor de cursus of het studieprogramma heeft (zie access voor toegestane waarden).

credit-granted

Booleaanse waarde

Een waarde die aangeeft of studiepunten zijn toegekend voor de cursus of het studieprogramma.

156


Element

Kenmerk

Type

Beschrijving

name

Tekenreeks

De naam van het leerobject of het studieprogramma.

url-path

Tekenreeks

Het deel van de URL na de domeinnaam die het object op de server op unieke wijze identificeert.

date-modified

Datetime

De datum en tijd waarop de SCO voor het laatst is gewijzigd, uitgedrukt in de ISO 8601notatie.

override

Booleaanse waarde

Een waarde die aangeeft of de transcriptie van de SCO is aangepast.

Voorbeeldaanvraag https://example.com/api/xml?action=report-curriculum-taker &user-id=2006258748&sco-id=2006298444

Voorbeeldantwoord <status code="ok" /> <sco transcript-id="2006905613" path-type="prereq-none" asset-id="2006334911" sco-id="2006334909" depth="0" folder-id="2006258747" type="content" icon="producer" lang="en" max-retries="" source-sco-id="" source-sco-type="" status="user-failed" score="0" certificate="" max-score="0" attempts="5"> access-open false Test Quiz /quiz/ 2006-06-30T15:24:34.897-07:00 2006-05-16T15:22:25.703-07:00 2006-06-30T15:24:34.897-07:00 false


157

report-meeting-attendance Beschikbaarheid


Retourneert een lijst met gebruikers die aan een Acrobat Connect-vergadering hebben deelgenomen. De gegevens worden geretourneerd in row-elementen, één voor elke persoon die heeft deelgenomen. Als de vergadering niet is gestart, of als er geen deelnemers waren, bevat het rapport geen rijen. Het antwoord bevat geen gastheren of gebruikers die zijn uitgenodigd, maar niet hebben deelgenomen. Als u report-meeting-attendance wilt aanroepen, moet u de machtiging publish, mini-host of host hebben voor de vergadering (zie permission-id voor details). Aanvraag-URL http://server_name/api/xml ?action=report-meeting-attendance &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een vergadering.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string <session-name>string

158


<sco-name>string datetime datetime <participant-name>string ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-meetingattendance

Container

De hele lijst met deelnemers aan de vergadering.

row

Container

De gegevens van één deelnemer aan de vergadering.

transcript-id

Geheel getal

De id van de vergaderingtranscriptie.

sco-id

Geheel getal

De unieke id van de vergadering.

principal-id

Geheel getal

De id van de principal die aan de vergadering heeft deelgenomen.

answered-survey

Booleaanse waarde

Geeft aan of de deelnemer aan de vergadering een opiniepeiling over de vergadering heeft beantwoord.

login

Tekenreeks

De aanmeldingsnaam van de deelnemer aan de vergadering.

session-name

Tekenreeks

De naam van de gebruiker die de vergaderruimte heeft betreden, en zo een sessie heeft gemaakt.

code

report-meeting-attendance

159

Element

Kenmerk

Type

Beschrijving

sco-name

Tekenreeks

De naam van de vergadering.

date-created

Datetime

De datum waarop de vergadering is gemaakt.

date-end

Datetime

De datum waarop de vergadering is beëindigd.

participant-name

Tekenreeks

De naam van de deelnemer aan de vergadering zoals deze bij de server is geregistreerd.

Voorbeeldaanvraag https://example.com/api/xml?action=report-meeting-attendance &sco-id=2006778715

Voorbeeldantwoord <status code="ok" /> [email protected] <session-name>Joy Smith <sco-name>Designing Online Courses 2006-06-28T14:35:21.307-07:00 2006-06-28T15:09:05.447-07:00 <participant-name>Joy Smith

report-meeting-concurrent-users Beschikbaarheid


Retourneert het maximum aantal gelijktijdige gebruikers in Acrobat Connect-vergaderingen dat aanwezig was in de laatste 30 dagen, en het aantal keren waarop het maximum is bereikt. Het maximum is het piekaantal gebruikers in een vergadering op één moment, tijdens een vergadering, tijdens meerdere gelijktijdige vergaderingen of tijdens meerdere overlappende vergaderingen.

160


U kunt de tijdsperiode wijzigen in een periode die langer is dan 30 dagen door een parameter length toe te voegen, bijvoorbeeld length=120. Het maximum aantal gebruikers (max-users) wordt bepaald door de accountlicentie en geldt voor de server in het algemeen, niet voor een specifieke vergadering. Deze actie retourneert tevens het aantal keren dat in de huidige maand het maximum is bereikt (max-participants-freq). Aanvraag-URL http://server_name/api/xml ?action=report-meeting-concurrent-users &length=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

length

Geheel getal

N

Het aantal dagen in de tijdsperiode waarin het gelijktijdige vergaderinggebruik moet worden gecontroleerd. Gebruik een waarde groter dan 30. De standaardwaarde is 30.

session

Tekenreeks

N


Filters


report-meeting-concurrent-users

161


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Leeg, met kenmerken

Informatie over het piekaantal gebruikers in vergaderingen die op hetzelfde moment plaatsvinden.

max-users

Geheel getal

Het piekaantal gebruikers in vergaderingen op hetzelfde moment (één vergadering of gelijktijdige vergaderingen) tijdens de tijdsperiode.

max-participantsfreq

Geheel getal

Het aantal keren dat het maximum in de tijdsperiode is bereikt.

code

report-meetingconcurrent-users

Voorbeeldaanvraag https://example.com/api/xml?action=report-meeting-concurrent-users


report-meeting-sessions Beschikbaarheid

Breeze 4 en Breeze 5; Connect Enterprise Web Services 6

162


Beschrijving

Biedt informatie over alle sessies van een Acrobat Connect-vergadering. Een sessie wordt gemaakt wanneer een deelnemer een lege vergadering betreedt. Deelnemers die de vergadering betreden, voegen zich bij deze sessie. De sessie wordt beëindigd wanneer alle deelnemers de vergadering verlaten. Wanneer een nieuwe deelnemer de nu lege vergadering betreedt, wordt een nieuwe sessie gestart. Een vergadering die bijvoorbeeld wekelijks plaatsvindt, heeft elke week een sessie wanneer de vergadering wordt gehouden. U kunt report-meeting-sessions aanroepen voor vergaderingen die reeds hebben plaatsgevonden, actieve vergaderingen of vergaderingen in de toekomst. Vergaderingen in de toekomst hebben waarschijnlijk echter geen sessies. Aanvraag-URL http://server_name/api/xml ?action=report-meeting-sessions &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De id van een vergadering waarvoor u sessie-informatie wilt.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> datetime datetime ...

report-meeting-sessions

163


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-meetingsessions

Container

De hele lijst met sessies van de vergadering.

row

Container

Informatie over één sessie.

sco-id

Geheel getal


asset-id

Geheel getal

De unieke id van de sessie.

version

Geheel getal

Een volg-id voor de sessie, die met 1 begint.

num-participants

Geheel getal

Het aantal deelnemers aan de vergadering, met uitzondering van de gastheer.

date-created

Datetime

De datum en de tijd waarop de sessie is gemaakt toen de deelnemer de vergaderruimte betrad.

date-end

Datetime

De datum en de tijd waarop de sessie is beëindigd toen de deelnemer de vergaderruimte verliet.

code

Voorbeeldaanvraag https://example.com/api/xml?action=report-meeting-sessions &sco-id=2006811328

Voorbeeldantwoord <status code="ok" /> 2006-06-29T11:46:52.210-07:00 2006-06-29T13:34:43.410-07:00

164


report-meeting-summary Beschikbaarheid


Retourneert samenvattende informatie over een specifieke Acrobat Connect-vergadering. De resultaten geven aan hoe veel gebruikers zijn uitgenodigd, hoe veel uitgenodigde deelnemers en gasten aanwezig waren, plus andere informatie over de vergadering. Als u report-meeting-summary wilt gebruiken, hebt u de machtiging publish, host of mini-host nodig voor de vergadering. Met een van deze machtigingen kunt u reportmeeting-summary uitvoeren voor een huidige, voltooide of toekomstige vergadering. De resultaten zijn het nuttigst voor een voltooide vergadering. Een vergadering kan op gezette tijden plaatsvinden (bijvoorbeeld een wekelijkse personeelsvergadering) en telkens wanneer de vergadering wordt gehouden een instantie hebben. Als de vergadering op gezette tijden plaatsvindt, zijn de statistieken die door report-meeting-summary worden geretourneerd cumulatief en van toepassing op alle instanties van de vergadering, niet alleen op de laatste vergadering. Aanvraag-URL http://server_name/api/xml ?action=report-meeting-summary &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een vergadering waarvoor u de machtiging publish of host hebt.

session

Tekenreeks

N


Filters


report-meeting-summary

165

Antwoordstructuur <status code=allowedValue />

Geretourneerde XML-elementen Element

Kenmerk

results

code

report-meetingsummary

Type

Beschrijving

Container


Leeg, met kenmerken


Toegestane waarde

Een code die de antwoordstatus aangeeft (zie ).

Leeg, met kenmerken

Details over de vergadering of de reeks vergaderingen.

num-unique-meetings Geheel getal Het aantal instanties van een

vergadering die op gezette tijdens plaatsvindt. peak-users

Geheel getal Het hoogste aantal gelijktijdige deelnemers in de vergaderruimte tijdens één vergaderinginstantie.

num-invitees

Geheel getal Het aantal uitgenodigde gebruikers.

num-inviteesattended

Geheel getal Het aantal uitgenodigde gebruikers dat heeft deelgenomen.

ispublic

Booleaanse waarde

Geeft aan of de vergadering openbaar is en gasten automatisch kunnen deelnemen (indien 1 of true), of privé is en gasten op toestemming moeten wachten (indien 0 of false).

num-guests-attended Geheel getal Het aantal deelnemers dat de

vergaderruimte als gast heeft betreden in plaats van als geregistreerde deelnemers.

166


Voorbeeldaanvraag https://example.com/api/xml?action=report-meeting-summary&sco-id=2006334033

Voorbeeldantwoord <status code="ok" /> <most-recent-session> 2006-06-28T15:11:15.133-07:00

report-my-courses Beschikbaarheid


Biedt informatie over de cursussen waarvoor de huidige gebruiker is of was ingeschreven. De geretourneerde cursussen omvatten cursussen in het verleden, in de toekomst en cursussen die de gebruiker op dit moment volgt. De lijst met cursussen van vrij groot zijn, vergeet dus niet een filter te gebruiken om het antwoord te beperken. Elke cursus heeft een permission-id dat het toegangsniveau van de gebruiker tot de cursus toont. De toegang is mogelijk view, publish of manage. Aanvraag-URL http://server_name/api/xml ?action=report-my-courses &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


report-my-courses

167

Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <my-courses> string <description>string string datetime datetime datetime string <expired>boolean boolean ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


my-courses

Container

Informatie over alle cursussen waarvoor de gebruiker is ingeschreven.

course

Container

Informatie over één cursus waarvoor de gebruiker is ingeschreven.

sco-id

Geheel getal

De unieke id van de cursus.

type

Toegestane waarde

Het type cursus (zie type voor toegestane waarden).

icon

Toegestane waarde

Het type pictogram waarmee de cursus in de gebruikersinterface wordt geïdentificeerd. Gebruik voor een cursus altijd course.

code

168


Element

Kenmerk

Type


Beschrijving

waarde

Het toegangsniveau van de gebruiker tot de cursus (zie permission-id voor waarden).

name

Tekenreeks

De naam van de cursus.

url

Tekenreeks

De URL waarmee een gebruiker de cursus op de server kan bereiken. Deze waarde omvat de domeinnaam en de cursus-id.

date-created

Datetime

De datum en de tijd waarop de cursus is gemaakt.

date-modified

Datetime

De datum en de tijd waarop de cursus voor het laatst is gewijzigd.

date-begin

Datetime

De datum en de tijd waarop de cursus door de gebruikers kan worden gestart.

date-end

Datetime

De datum en tijd waarop de vergadering wordt gesloten.

url-path

Tekenreeks

Het deel van de cursus-URL na de domeinnaam dat de cursus-id vormt.

expired

Booleaanse waarde

Geeft aan of de cursus is verlopen (true als de cursus is verlopen, false als de cursus niet is verlopen).

completed

Booleaanse waarde

Geeft aan of de gebruiker de cursus heeft voltooid (true indien ja, false indien nee).

Voorbeeldaanvraag https://example.com/api/xml?action=report-my-courses

Voorbeeldantwoord <status code="ok" /> <my-courses> Test Course example.com/test/ 2006-05-03T10:21:46.810-07:00 2006-05-03T10:22:30.803-07:00 2006-05-03T10:15:00.000-07:00 /test/

report-my-courses

169

<expired>false false

report-my-events Beschikbaarheid


Biedt informatie over elke gebeurtenis waaraan de gebruiker heeft deelgenomen of zal deelnemen. De gebruiker kan een gastheer van of een deelnemer aan de gebeurtenis zijn. De geretourneerde gebeurtenissen bevinden zich in de map my-events van de gebruiker. Voor informatie over alle gebeurtenissen in uw Enterprise Server- of uw Enterprise Hostedaccount, roept u sco-shortcuts aan om de sco-id van de map events te verkrijgen. Roep vervolgens sco-contents aan met de sco-id om alle gebeurtenissen te vermelden. Aanvraag-URL http://server_name/api/xml ?action=report-my-events &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <my-events> <event sco-id=integer type="event" icon="event"

170


permission-id=allowedValue> string <domain-name>string string datetime datetime <expired>boolean datetime/duration> ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


my-events

Container

De hele lijst met gebeurtenissen waarvoor de gebruiker zich nu of in het verleden heeft geregistreerd.

event

Container

Informatie over één gebeurtenis.

sco-id

Geheel getal

De unieke id van de gebeurtenis.

type

Toegestane waarde

Het type object. Voor een gebeurtenis is dit altijd event.

icon

Toegestane waarde

Een pictogram waarmee het object wordt geïdentificeerd. Voor een gebeurtenis is dit altijd event.

permission-id

Toegestane waarde

De machtiging die de gebruiker heeft voor de gebeurtenis (zie permission-id voor waarden).

name

Tekenreeks

De naam van de gebeurtenis.

domain-name

Tekenreeks

De domeinnaam van de gebeurtenisURL, die na http:// (of https://) komt en vóór de domeinnaam staat.

url-path

Tekenreeks

Het deel van de gebeurtenis-URL na de domeinnaam.

code

report-my-events

171

Element

Kenmerk

Type

Beschrijving

date-begin

Datum

De datum waarop de gebeurtenis begint, in ISO 8601-notatie.

date-end

Datum

De datum waarop de gebeurtenis stopt, in ISO 8601-notatie.

expired

Booleaanse waarde

Een waarde die aangeeft of de gebeurtenis is beëindigd. Als de gebeurtenis op dit moment plaatsvindt, is de waarde false.

duration

Tijd

De geplande hoeveelheid tijd die de gebeurtenis volgens de planning in beslag neemt. Gebruikt de tijdportie van een ISO 8601-datumnotatie.

Voorbeeldaanvraag https://example.com/api/xml?action=report-my-events

Voorbeeldantwoord <status code="ok" /> <my-events> <event sco-id="2006334107" type="event" icon="event" permission-id="host"> Meet the Famous Author <domain-name>example.com /author/ 2006-05-12T18:00:00.000-07:00 2006-05-12T20:00:00.000-07:00 <expired>true 02:00:00.000

report-my-meetings Beschikbaarheid


Biedt informatie over alle Acrobat Connect-vergaderingen waarvoor de gebruiker een gastheer, uitgenodigde deelnemer of geregistreerde gast is. De vergadering kan in het verleden, het heden of de toekomst worden gepland.

172


Aanvraag-URL http://server_name/api/xml ?action=report-my-meetings &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> <my-meetings> <meeting sco-id=integer type="meeting" icon="meeting" permission-id=allowedValue active-participants=integer> string <description>string <domain-name>domain url date date <expired>boolean time ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


report-my-meetings

173

Element

Kenmerk

Type

Beschrijving

code

Toegestane waarde


my-meetings

Container

Informatie over alle vergaderingen waarvoor de gebruiker is of was uitgenodigd.

meeting

Container

Details over een van de vergaderingen van een gebruiker.

sco-id

Geheel getal


type

Toegestane waarde

Het type object dat is geretourneerd (voor deze aanroep altijd meeting).

icon

Toegestane waarde

Het pictogram dat de vergadering in Enterprise Manager op visuele wijze identificeert (voor deze aanroep altijd meeting).

permission-id

Toegestane waarde

Het toegangsniveau van de gebruiker tot de vergadering (zie permission-id voor waarden).

activeparticipants

Geheel getal

Het aantal deelnemers dat de vergadering op dit moment heeft, inclusief gastheren en presentatoren.

name

Tekenreeks

De naam van de vergadering.

domain-name

Tekenreeks

Het domeinnaamgedeelte van de URL naar de vergaderruimte.

url-path

Tekenreeks

Het deel van de vergaderruimte-URL waarmee de vergadering wordt geïdentificeerd en dat na de domeinnaam komt.

date-begin

Datetime

De datum en tijd waarop de vergadering begint (of is begonnen).

date-end

Datetime

De datum en tijd waarop de vergadering stopt (of is gestopt).

174


Element

Kenmerk

Type

Beschrijving

expired

Booleaanse waarde

Geeft aan of de vergadering is gestopt (true als de vergadering is gestopt, false als de vergadering niet is gestopt).

duration

Tijd

De feitelijke tijdsduur van de vergadering. Dit kan langer of korter zijn dan de geplande tijd van de vergadering.

Voorbeeldaanvraag https://example.com/api/xml?action=report-my-meetings

Voorbeeldantwoord <status code="ok" /> <my-meetings> <meeting sco-id="2006334033" type="meeting" icon="meeting" permission-id="host" active-participants="0"> How to Write a Novel <domain-name>example.com /novel/ 2006-05-11T11:30:00.000-07:00 2006-05-11T12:30:00.000-07:00 <expired>true 01:00:00.000 <meeting sco-id="2006743452" type="meeting" icon="meeting" permission-id="host" active-participants="0"> Intro to Film <domain-name>example.com /film/ 2006-06-09T14:00:00.000-07:00 2006-06-09T20:00:00.000-07:00 <expired>true 06:00:00.000

report-my-meetings

175

report-my-training Beschikbaarheid


Retourneert een lijst met alle cursussen en studieprogramma's waarvoor een gebruiker of groep is ingeschreven. Als u geen principal-id gebruikt, is de lijst voor de huidige gebruiker. Als u een principal-id toevoegt, is de lijst voor de opgegeven principal. Het antwoord bevat een lijst row-elementen. Cursussen in de lijst hebben de kenmerken en icon=course, terwijl studieprogramma's type=curriculum en icon=curriculum hebben. type=content

Aanvraag-URL http://server_name/api/xml ?action=report-my-training &principal-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

N

De unieke id van een gebruiker van wie of de unieke id van een groep waarvan u de cursussen en studieprogramma's wilt vermelden. Als u geen waarde opgeeft, wordt het antwoord voor de huidige gebruiker geretourneerd.

session

Tekenreeks

N


Filters


176


Antwoordstructuur <status code=allowedValue /> string string datetime datetime datetime string <expired>boolean boolean ...


Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


report-my-training

Container

De hele lijst cursussen en studieprogramma's waarvoor de gebruiker is ingeschreven.

row

Container

Informatie over één cursus of studieprogramma waarvoor de gebruiker is ingeschreven.

sco-id

Geheel getal

De unieke id van de cursus of het studieprogramma.

type

Toegestane waarde

Het type object (zie type voor toegestane waarden).

code

report-my-training

177

Element

Kenmerk

Type

Beschrijving

icon

Toegestane waarde

Het type pictogram waarmee het object in Connect Enterprise Manager wordt geïdentificeerd (zie icon voor toegestane waarden). Als content het type is, wordt met de waarde icon de inhoud beschreven.

permission-id

Toegestane waarde

De machtiging van de principal voor het object (zie permission-id voor toegestane waarden).

name

Tekenreeks

De naam van de cursus of het studieprogramma.

description

Tekenreeks

De beschrijving van de cursus of het studieprogramma.

url

Tekenreeks

Het deel van de URL naar de cursus of het studieprogramma dat de domeinnaam en de unieke naam bevat, zonder http:// of https://.

date-created

Datetime

De datum en de tijd waarop de cursus of het studieprogramma is gemaakt.

date-modified

Datetime

De datum en de tijd waarop de cursus of het studieprogramma voor het laatst is gewijzigd.

date-begin

Datetime

De begindatum en -tijd van de cursus of het studieprogramma, in het verleden of in de toekomst.

date-end

Datetime

De einddatum en -tijd van de cursus of het studieprogramma, in het verleden of in de toekomst.

sco-tag

Tekenreeks

Een niet-unieke id voor de cursus of het studieprogramma zoals deze in de gebruikersinterface wordt weergegeven, bijvoorbeeld ECON101.

178


Element

Kenmerk

Type

Beschrijving

url-path

Tekenreeks

De unieke naam van de cursus of het studieprogramma in de URL van de cursus of het studieprogramma.

expired

Booleaanse waarde

Een waarde die aangeeft of de einddatum van de cursus of het studieprogramma voorbij is (true indien ja, false indien nee).

completed

Booleaanse waarde

Een waarde die aangeeft of de gebruiker of de groep de cursus heeft voltooid.

Voorbeeldaanvraag https://example.com/api/xml?action=report-my-training &principal-id=2006258745

Voorbeeldantwoord <status code="ok" /> Intro to Psychology example.com/psychology/ 2006-05-03T10:21:46.810-07:00 2006-05-03T10:22:30.803-07:00 2006-05-03T10:15:00.000-07:00 /psychology/ <expired>false true A Day in the Life example.com/day/ 2006-06-12T14:47:59.903-07:00 2006-06-12T14:47:59.903-07:00 2006-06-12T14:45:00.000-07:00 /day/ <expired>false false

report-my-training

179

report-quiz-interactions Beschikbaarheid


Biedt informatie over alle interacties tussen gebruikers en een bepaalde quiz. Een interaction identificeert alle antwoorden die een gebruiker op een quizvraag geeft. Als een gebruiker dezelfde vraag meer dan eens beantwoordt, maken alle antwoorden deel uit van dezelfde interactie en hebben ze dezelfde interaction-id. Dit rapport biedt informatie over elk antwoord dat alle gebruikers op vragen in een quiz hebben gegeven. U kunt het antwoord filteren met alle toegestane filters, om het antwoord zinvoller te maken. U kunt bijvoorbeeld alle antwoorden opvragen die een bepaalde gebruiker heeft gegeven: https://example.com/api/xml?action=report-quiz-interactions &sco-id=2006334909&filter-like-name=Joy%20Smith

U kunt ook alleen de antwoorden van een bepaalde gebruiker op een specifieke vraag opvragen: https://example.com/api/xml?action=report-quiz-interactions &sco-id=2006334909&filter-name=Joy%20Smith &filter-like-description=What%20is%20the%20capital%20of%20California

Aanvraag-URL http://server_name/api/xml ?action=report-quiz-interactions &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een presentatie of cursus die een quiz bevat.

session

Tekenreeks

N


Filters


180


Antwoordstructuur <status code=allowedValue /> string <sco-name>string datetime <description>string integer ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-quizinteractions

Container

Informatie over alle interacties tussen alle gebruikers en de quiz.

row

Container

Informatie over één gebruiker, één quizvraag en één antwoord. Meerdere row-elementen kunnen deel uitmaken van dezelfde interactie.

display-seq

Geheel getal

Het volgnummer van deze vraag in de quiz.

transcript-id

Geheel getal

De id van een gebruikerspoging de quiz af te leggen, met één gebruiker, één poging en meerdere vragen en antwoorden. Telkens wanneer de gebruiker de quiz aflegt, verandert transcript-id.

code

report-quiz-interactions

181

Element

Kenmerk

Type

Beschrijving

interaction-id

Geheel getal

De id van alle antwoorden die een gebruiker op één vraag van een quiz geeft.

sco-id

Geheel getal

De unieke id van een presentatie of cursus die de quiz bevat.

score

Geheel getal

De score van de gebruiker op deze vraag.

name

Tekenreeks

De naam van de gebruiker.

sco-name

Geheel getal

De naam van de presentatie of de cursus die de quiz bevat.

date-created

Datetime

De datum waarop de presentatie of cursus is gemaakt.

description

Tekenreeks

De quizvraag die de gebruiker heeft beantwoord.

response

Tekenreeks

Het antwoord dat de gebruiker heeft gegeven.

Voorbeeldaanvraag https://example.com/api/xml?action=report-quiz-interactions &sco-id=2006334909&filter-name=Joy Smith &filter-like-description=governor

Voorbeeldaanvraag <status code="ok" /> Joy Smith <sco-name>California Quiz 2006-05-11T15:50:23.643-07:00 <description> The governor of California is a former actor. true Joy Smith

182


<sco-name>California Quiz 2006-05-11T17:32:53.970-07:00 <description> The governor of California is a former actor. false Joy Smith <sco-name>California Quiz/sco-name> 2006-05-12T11:55:24.940-07:00 <description> The governor of California is a former actor. true

report-quiz-question-answer-distribution Beschikbaarheid


Retourneert informatie over het aantal gebruikers dat een specifiek antwoord op een quizvraag heeft gekozen. De combinatie van een quizvraag en alle antwoorden van een gebruiker op de vraag wordt een interaction genoemd. Als een gebruiker de vraag meer dan eens beantwoordt, maken alle antwoorden deel uit van dezelfde interactie en hebben deze dezelfde interaction-id. Gebruik report-quiz-interactions om een interaction-id te bepalen en te op te geven in de aanvraag. De interaction-id komt niet overeen met het vraagnummer in de quiz (bijvoorbeeld vraag 1, vraag 2 enzovoort). Aanvraag-URL http://server_name/api/xml ?action=report-quiz-question-answer-distribution &interaction-id=integer &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

report-quiz-question-answer-distribution

183

Parameters Naam

Type

Vereist

Beschrijving

interaction-id

Geheel getal

N

De id die alle antwoorden van een gebruiker op één quizvraag beschrijft.

sco-id

Geheel getal

J


session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-quiz-questionanswerdistribution

Container

De lijst met vragen en antwoorden.

row

Container

Informatie over één gebruiker, één vraag en één antwoord.

Geheel getal

Het volgnummer van de vraag in de quiz.

code

display-seq

184


Element

Kenmerk

Type

Beschrijving

interaction-id Geheel getal

response

De id van alle antwoorden van een gebruiker op één quizvraag. Als de gebruiker de vraag meerdere keren beantwoordt, hebben alle antwoorden dezelfde interaction-id.

score

Geheel getal

De score die de gebruiker voor de vraag heeft verdiend.

asset-id

Geheel getal

De id van de versie van de quiz waarin de gebruiker de vraag heeft beantwoord. De asset-id verandert wanneer u een nieuwe inhoudsversie uploadt.

num-selected

Geheel getal

Bij multiplechoice-of waar/nietwaar-quizvragen is dit het volgnummer van het geselecteerde antwoord.

Tekenreeks

Het antwoord dat de gebruiker op de vraag heeft gegeven.

Voorbeeldaanvraag https://example.com/api/xml ?action=report-quiz-question-answer-distribution&sco-id=2006334909

Voorbeeldantwoord <status code="ok" /> san francisco Sacramento false ...

report-quiz-question-answer-distribution

185

HOOFDSTUK 6

Actiereferentie report-quiz-question-distribution Beschikbaarheid


Retourneert informatie over het aantal juiste en onjuiste antwoorden op de vragen in een quiz. Deze aanroep kan u helpen bepalen hoe een groep een quizvraag over het algemeen heeft beantwoord. Aangezien deze aanroep informatie retourneert over alle vragen in een quiz, wilt u wellicht de resultaten filteren voor een specifieke vraag of groep vragen. Aanvraag-URL http://server_name/api/xml ?action=report-quiz-question-distribution &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een presentatie die een quiz bevat.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> string <description>string ...

186



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-quiz-questiondistribution

Container

Informatie over alle vragen in een quiz.

row

Container

Informatie over één vraag in de quiz.

display-seq

Geheel getal

De reeks in de quiz waarin deze vraag valt.

interaction-id

Geheel getal

De id van de quizvraag.

num-correct

Geheel getal

Het aantal juiste antwoorden op deze vraag.

num-incorrect

Geheel getal

Het aantal onjuiste antwoorden op deze vraag.

total-responses

Geheel getal

Het totale aantal antwoorden op deze vraag.

percentagecorrect

Geheel getal

Het percentage van het totale aantal antwoorden dat correct is.

score

Geheel getal

De score die aan de quizvraag is toegewezen.

name

Tekenreeks

De naam van de quizvraag, gedefinieerd toen de vraag in Quiz Manager werd gemaakt.

description

Tekenreeks

De definitie van de quizvraag, gedefinieerd toen de vraag in Quiz Manager werd gemaakt.

code

Voorbeeldaanvraag https://example.com/api/xml?action=report-quiz-question-distribution &sco-id=2006334909&filter-like-description=The capital of California

report-quiz-question-distribution

187

Voorbeeldantwoord <status code="ok" /> The capital of California is<1> <description>The capital of California is<1>

report-quiz-question-response Beschikbaarheid


Biedt een lijst met antwoorden die gebruikers op de vragen in een quiz hebben gegeven. Zonder te filteren retourneert u met deze actie alle antwoorden van gebruikers op vragen in de quiz. U kunt echter het antwoord filteren voor een specifieke gebruiker of interactie of voor een specifiek antwoord (zie de filtersyntaxis in filter-definition). Een interaction is een combinatie van één gebruiker en één vraag. Als een gebruiker dezelfde vraag meer dan eens beantwoordt, maken alle antwoorden deel uit van dezelfde interactie en hebben ze dezelfde interaction-id. Aanvraag-URL http://server_name/api/xml ?action=report-quiz-question-response &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

188


Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J


session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> <user-name>string string datetime


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-quiz-questionresponse

Container

Informatie over alle antwoorden op alle vragen in de quiz.

row

Container

Informatie over één antwoord.

principal-id

Geheel getal

De id van de gebruiker die de quizvraag heeft beantwoord.

interaction-id

Geheel getal

De id van één antwoord op één vraag.

code

report-quiz-question-response

189

Element

Kenmerk

Type

Beschrijving

user-name

Tekenreeks

De naam van de gebruiker zoals deze op de server is geregistreerd.

response

Tekenreeks

Het antwoord van de gebruiker op de vraag, inclusief een woord of zin, true, false of een letterkeuze.

date-created

Datetime

De datum en tijd waarop de gebruiker heeft geantwoord.

Voorbeeldaanvraag https://example.com/api/xml?action=report-quiz-question-response &sco-id=2006334909&filter-interaction-id=2006334913

Voorbeeldantwoord <status code="ok" /> <user-name>Joy Smith Sacramento 2006-05-11T15:50:23.643-07:00 <user-name>Joy Smith san francisco 2006-05-11T17:32:53.970-07:00 Sacramento 2006-05-12T11:55:24.940-07:00

report-quiz-summary Beschikbaarheid


Biedt een overzicht van gegevens van een quiz, inclusief het aantal keren dat de quiz is genomen, de gemiddelde, hoge en lage scores, en andere informatie.

190


Aanvraag-URL http://server_name/api/xml ?action=report-quiz-summary &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J


session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Bevat informatie over de quiz.

code

report-quiz-summary

report-quiz-summary

191

Element

Kenmerk

Type

Beschrijving

Leeg, met kenmerken

Overzichtsinformatie over de quiz. Kan meer dan één rowelement retourneren als maxpossiblescore voor andere transcripties anders is.

num-questions

Geheel getal

Het aantal vragen in de quiz.

average-score

Geheel getal

De gemiddelde score van alle gebruikers die de quiz hebben afgelegd.

low-score

Geheel getal

De laagste score die een gebruiker voor de quiz heeft behaald.

high-score

Geheel getal

De hoogste score die een gebruiker voor de quiz heeft behaald.

numtaken

Geheel getal

Het totale aantal keren dat de quiz is afgelegd.

numdistincttaken

Geheel getal

Het aantal keren dat de quiz door verschillende principals is afgelegd. Als een principal de quiz meer dan eens aflegt, wordt slechts één keer geteld.

maxpossiblescore

Geheel getal

De hoogst mogelijk score van de quiz.

asset-id

Geheel getal

De id van de laatste versie van de SCO die naar de server is geüpload.

row

Voorbeeldaanvraag https://server.com/api/xml?action=report-quiz-summary&sco-id=2006123456

192


asset-id="2006334911" />

report-quiz-takers Beschikbaarheid


Biedt informatie over de gebruikers die de quiz hebben afgelegd of over de objecten (SCO's) die een principal heeft gebruikt. U kunt deze actie op verschillende manieren gebruiken. Als u informatie wilt over alle gebruikers die de quiz hebben afgelegd, gebruikt u een sco-id om de quiz te identificeren. Als u informatie wilt over een specifieke principal die een specifieke quiz aflegt, gebruikt u een sco-id én een principal-id. U kunt ook report-quiz-takers gebruiken om informatie op te vragen over alle SCO's die een principal heeft weergegeven door een principal-id zonder een sco-id door te geven. Als u het volume van het antwoord wilt reduceren, kunt u alle toegestane filters gebruiken, of kunt u een parameter type doorgeven om de verbruiksinformatie te retourneren over slechts één type SCO (cursussen, inhoud of vergaderingen, zie de volgende tabel). Type

Beschrijving

type=course

Vermeldt alle cursussen die de gebruiker heeft gevolgd.

type=presentation

Vermeldt alle inhoud die de gebruiker heeft weergegeven.

type=meeting

Vermeldt alle vergaderingen waaraan de gebruiker heeft deelgenomen.

Aanvraag-URL http://server_name/api/xml ?action=report-quiz-takers &sco-id=integer &principal-id=integer &type=allowedValue &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue

report-quiz-takers

193

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J


principal-id

Geheel getal

N

De id van de principal waarvan u de quizresultaten wilt.

type

Toegestane waarde

N

Het type inhoud waarvan u de resultaten wilt. Toegestane waarden zijn course, presentation en meeting.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerk die het bevat. Antwoordstructuur <status code=allowedValue /> string string datetime <principal-name>string boolean


Type

Beschrijving

results

Container


status

Leeg, met kenmerken


194

Kenmerk


Element

Kenmerk

Type

Beschrijving

code

Toegestane waarde


report-quiz-takers

Container

Informatie over alle gebruikers die de quiz hebben afgelegd.

row

Container

Informatie over één gebruiker die de quiz heeft afgelegd.

transcript-id Geheel getal

De id van de transcriptie waarin de quizscore van de gebruiker is vastgelegd.

sco-id

Geheel getal

De unieke id van de presentatie, de cursus of de vergadering die de quiz bevat.

principal-id

Geheel getal

De id van de gebruiker die de quiz heeft afgelegd.

status

Toegestane waarde

Geeft aan of de gebruiker voor de laatste poging van de quiz is geslaagd of gezakt. Toegestane waarden zijn user-passed en userfailed.

score

Geheel getal

De score van de gebruiker voor zijn of haar laatste poging om de quiz af te leggen.

asset-id

Geheel getal

De id van de versie van de quiz die de gebruiker heeft geprobeerd af te leggen.


waarde

Het toegangsniveau van de gebruiker tot de quiz (zie permission-id voor details).

attempts

Geheel getal

Het aantal keren dat de gebruiker de quiz heeft afgelegd.

time-taken

Geheel getal

De hoeveelheid tijd in milliseconden die gebruiker aan de quiz heeft besteed.

certificate

Geheel getal

De unieke id van een gebruikerstranscriptie.

report-quiz-takers

195

Element

Kenmerk

Type

Beschrijving

answeredsurvey

Booleaanse waarde

Geeft aan of de gebruiker een opiniepeiling of quiz in een vergadering heeft beantwoord.

version

Geheel getal

Het revisienummer van de quiz.

name

Tekenreeks

De naam van de quiz.

login

Tekenreeks

De aanmeldingsnaam van de gebruiker op de server.

date-created

Datetime

De datum en tijd waarop de gebruiker de laatste poging de quiz af te leggen, heeft uitgevoerd.

principal-name

Tekenreeks

De volledige naam van de gebruiker die de quiz aflegt.

override

Booleaanse waarde

Een instelling die aangeeft of een trainingsmanager de gebruikerscore van de quiz kan wijzigen.

Voorbeeldaanvraag https://example.com/api/xml?action=report-quiz-takers&sco-id=2006334909

Voorbeeldantwoord <status code="ok" /> California State Quiz [email protected] 2006-05-16T11:14:47.000-07:00 <principal-name>Joy Smith false

196


report-quotas Beschikbaarheid


Retourneert informatie over de quota die gelden voor uw Connect Enterprise-account. Voor Connect Enterprise gelden verschillende quota, bijvoorbeeld het aantal gebruikers dat tegelijkertijd is toegestaan voor een training, of het aantal auteurs. Hoewel bepaalde quota’s door uw serverlicentie worden bepaald, kunt u de limiet van uw licentie overschrijden. In het antwoord van report-quotas is de soft-limit het aantal dat door uw licentie wordt gedefinieerd, terwijl de limit het daadwerkelijke aantal is waarvoor de server een actie weigert. De waarde bij limit is hetzelfde als de waarde bij soft-limit of enigszins hoger. Aanvraag-URL http://server_name/api/xml ?action=report-quotas &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> datetime datetime

report-quotas

197


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-quotas

Container

Informatie over alle quota die voor de account zijn ingesteld.

quota

Container

Informatie over één quotum.

acl-id

Geheel getal

De id van de account waarvoor het quotum is gedefinieerd.

quota-id

Toegestane waarde

De naam van het quotum, gedefinieerd door de server, dat op -quota eindigt.

used

Geheel getal

Het aantal dat deze telling voor dit quotum gebruikt.

limit

Geheel getal

De limiet waarbij de server een actie beëindigt, gelijk aan of enigszins hoger dan soft-limit. De waarde is een geheel getal of unlimited.

soft-limit

Geheel getal

De limiet die door uw serverlicentie wordt bepaald.

date-begin

Datetime

De datum en de tijd waarop het quotum op de server van kracht werd.

date-end

Datetime

De datum waarop het quotum verloopt.

code

Voorbeeldaanvraag https://example.com/api/xml?action=report-quotas


198


2004-03-09T09:45:41.047-08:00 3000-01-01T00:00:00.000-08:00 2006-05-31T17:00:00.943-07:00 2006-06-30T17:00:00.943-07:00 ...

report-sco-slides Beschikbaarheid


Retourneert informatie over de dia's in een presentatie. De informatie bevat bijvoorbeeld het aantal keren dat elke dia is bekeken en wanneer elke dia voor het laatst is bekeken. Aanvraag-URL http://server_name/api/xml ?action=report-sco-slides &sco-id=integer &asset-id=integer &sort-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

sco-id

Vereist

Geheel getal J

De unieke id van een presentatie.

asset-id

Geheel getal N

Het versienummer van een presentatie dat telkens wordt verhoogd wanneer een presentatie wordt geüpload.

session

Tekenreeks


N

Beschrijving

Filters

U kunt het antwoord sorteren op de elementen of de kenmerken die het bevat.

report-sco-slides

199

Antwoordstructuur <status code=allowedValue /> datetime ...


Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


report-sco-slides

Container

Informatie over alle dia's in een presentatie die aangeeft hoe vaak en hoe recent een dia is bekeken.

row

Container

Informatie over één dia in de presentatie.

slide

Geheel getal

Het nummer van de dia in de presentatie.

name

Geheel getal

De naam van de dia in de presentatie.

asset-id

Geheel getal

Het versienummer van de presentatie. Telkens wanneer een presentatie wordt gepubliceerd, heeft deze een nieuwe asset-id.

views

Geheel getal

Het aantal keren dat de dia is bekeken.

Datetime

De datum en de tijd waarop de dia voor het laatst is bekeken.

code

date-created

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

200


Voorbeeldantwoord <status code="ok" /> 2006-05-16T11:14:54.453-07:00 2006-05-16T11:14:59.593-07:00 2006-05-12T11:55:52.330-07:00 2006-05-12T11:55:55.487-07:00 2006-05-12T11:56:00.233-07:00

Zie ook report-sco-views

report-sco-views Beschikbaarheid


Geeft aan hoe vaak en hoe recent een SCO is bekeken. Aanvraag-URL http://server_name/api/xml ?action=report-sco-views &sco-id=integer &session=BreezeSessionCookieValue

report-sco-views

201

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een SCO waarvan u de weergaven wilt controleren.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> string string


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Informatie over hoe vaak en hoe recent de presentatie is bekeken.

sco-id

Geheel getal

De unieke id van de presentatie.

type

Toegestane waarde

Het type inhoudsobject (SCO). Toegestane waarden zijn content, curriculum, event, folder, link, meeting en tree.

code

report-sco-views

202


Element

Kenmerk

Type

Beschrijving

is-folder

Booleaanse waarde

Een waarde die aangeeft of de SCO een map is (indien 1) of een ander type object (indien 0).

views

Geheel getal

Het aantal keren dat de gebruikers de SCO hebben bekeken.

name

Tekenreeks

De naam van de SCO.

last-viewed-date

Datetime

De datum en de tijd waarop de SCO voor het laatst is bekeken.

Voorbeeldaanvraag https://server.com/api/xml?action=report-sco-views&sco-id=2006334909

Voorbeeldantwoord <status code="ok" /> Quiz on California 2006-05-12T11:55:24.940-07:00

report-user-trainings-taken Beschikbaarheid


Retourneert een lijst met alle cursussen en studieprogramma's die een gebruiker heeft afgelegd, ongeacht het feit of de gebruiker de training heeft voltooid. Elke cursus of elk studieprogramma wordt geretourneerd in een apart row-element en heeft de meest recente transcriptie van de gebruikerscores. Aanvraag-URL http://server_name/api/xml ?action=report-user-trainings-taken &principal-id=integer &session=BreezeSessionCookieValue

report-user-trainings-taken

203

Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

J

De id van een gebruiker van wie u een lijst met trainingen wilt.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> string <description>string string datetime boolean ...


Type

Beschrijving

results

Container


status

Leeg, met kenmerken


code

Toegestane waarde


type

Toegestane waarde

Het type SCO. Toegestane waarden zijn user-content, content en my-content.

204

Kenmerk


Element

Kenmerk

Type

Beschrijving

report-usertrainings-taken

Container

Een lijst met alle trainingen die de gebruiker heeft geprobeerd af te leggen.

row

Container

Informatie over een cursus of een studieprogramma dat de gebruiker heeft afgelegd, ongeacht of de gebruiker ervoor is geslaagd.


De id van de record van de meest recente score van de gebruiker voor deze training.

max-retries

Geheel getal

Het maximum aantal keren dat de gebruiker de training kan herhalen.

sco-id

Geheel getal

De id van de trainings-SCO.

type

Toegestane waarde

Het type trainings-SCO (zie type voor toegestane waarden).

icon

Toegestane waarde

Het type pictogram dat de cursus of het studieprogramma in Enterprise Manager identificeert. Biedt naast het type informatie over de cursus of het studieprogramma (zie icon voor toegestane waarden).

status

Toegestane waarde

De status van het werk van de gebruiker met de SCO. Toegestane waarden voor een cursus of presentatie zijn userpassed, user-failed, completed, incomplete, not-attempted en review. Een studieprogramma of map kan alleen completed of incomplete zijn.

certificate

Geheel getal

De id van de record die aangeeft dat de gebruiker voor de training is geslaagd of deze heeft voltooid.

score

Geheel getal

De score die de gebruiker heeft behaald bij de meest recente poging om de training uit te voeren.

report-user-trainings-taken

205

Element

Kenmerk

Type


waarde

Beschrijving De machtiging die aan de gebruiker is toegewezen voor de cursus of het studieprogramma (zie permission-id voor toegestane waarden).

Geheel getal

Het aantal pogingen dat de gebruiker voor deze training heeft uitgevoerd.

name

Tekenreeks

De naam van de trainings-SCO.

description

Tekenreeks

De beschrijving van de trainingsSCO.

url-path

Tekenreeks

De unieke id van de SCO die in de URL achter de domeinnaam staat.

date-taken

Datetime

De datum waarop interactie van de gebruiker met de trainings-SCO plaatsvond (presentatie bekeken, quiz afgelegd enzovoort).

from-curriculum

Booleaanse waarde

Een waarde die aangeeft of deze cursus deel uitmaakte van een studieprogramma.

attempts

Voorbeeldaanvraag https://example.com/api/xml?action=report-user-trainings-taken &principal-id=2006258745&principal-id=4797406

Voorbeeldantwoord <status code="ok" /> All About Web Communities <description>test /p33096345/ 2006-06-12T15:06:02.947-07:00 false ...

206


report-user-training-transcripts Beschikbaarheid


Retourneert een lijst met transcripties voor trainingen die een gebruiker heeft gevolgd. Een transcriptie is de record van een score die de gebruiker voor een trainings-SCO heeft behaald. De training kan bestaan uit cursussen, studieprogramma's, vergaderingen en gebeurtenissen. Het antwoord kan meer dan één transcriptie bevatten voor een SCO als de gebruiker de training meer dan eens heeft geprobeerd. Een gebruiker kan de eerste keer voor een training zakken en de tweede keer slagen. Elke poging heeft een eigen transcriptie en beide transcripties worden in het rapport opgenomen. Aanvraag-URL http://server_name/api/xml ?action=report-user-training-transcripts &principal-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

principal-id

Geheel getal

J

De id van een gebruiker van wie u de transcripties wilt.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> string


207

string string datetime <principal-name>string <sco-tag>string ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


report-user-trainingtranscripts

Container

Informatie over alle transcripties voor de gespecificeerde gebruiker.

row

Container

Informatie over een poging die de gebruiker heeft gedaan om de training te volgen.

code

208


De id van de transcriptie waarin de score van de gebruiker is vastgelegd. Er bestaat een aparte transcriptie voor elke poging van de gebruiker voor het nemen van de SCO.

sco-id

Geheel getal

De id van de SCO, die een vergadering, inhoud, cursus, studieprogramma, gebeurtenis of seminar kan zijn.

principal-id

Geheel getal


status

Toegestane waarde

De status van het werk van de gebruiker met de SCO (zie status, kenmerk voor toegestane waarden).

score

Geheel getal

De score die de gebruiker voor de SCO heeft behaald. Als de SCO geen score heeft, zoals bij een vergadering, heeft score de waarde 0.


Element

Kenmerk

Type

Beschrijving

max-score

Geheel getal

De maximale score die mogelijk is voor de cursus of het studieprogramma.

certificate

Geheel getal

De id van de record van de cursussen en studieprogramma's die de gebruiker heeft gevolgd of waarvoor hij is geslaagd.

type

Toegestane waarde

Het type SCO. Toegestane waarden zijn user-content, content en my-content.

icon

Toegestane waarde

De naam van het pictogram waarmee de cursus of het studieprogramma in Enterprise Manager wordt geïdentificeerd.

name

Tekenreeks

De naam van de cursus of het studieprogramma.

url-path

Tekenreeks

De unieke identificatiecode van de cursus of het studieprogramma die in de URL achter de domeinnaam staat.

login

Tekenreeks

De aanmeldings-id van de gebruiker bij Enterprise Server of Enterprise Hosted.

date-taken

Datetime

De datum waarop interactie tussen de gebruiker en de cursus of het studieprogramma plaatsvond (presentatie bekeken, quiz afgelegd enzovoort).

principal-name

Tekenreeks

De naam van de gebruiker die interactie met de SCO heeft.

sco-tag

Tekenreeks

Een beschrijvend label voor de SCO in aanvulling op de naam (bijvoorbeeld een korte cursusnaam).

Voorbeeldaanvraag https://example.com/api/xml?action=report-user-training-transcripts &principal-id=2006258745


209

Voorbeeldantwoord <status code="ok" /> Test Course /test/ [email protected] 2006-06-30T15:23:55.070-07:00 <principal-name>Joy Smith Test Course /test/ [email protected] 2006-07-14T16:55:28.440-07:00 <principal-name>Joy Smith

sco-contents Beschikbaarheid


Retourneert een lijst met SCO's binnen een andere SCO. De insluitende SCO kan een map, vergadering of studieprogramma zijn. In het algemeen kunnen de ingesloten SCO's van elk type zijn, namelijk vergaderingen, cursussen, studieprogramma's, inhoud, gebeurtenissen, mappen, boomstructuren of koppelingen (zie de lijst in type). Het type ingesloten SCO moet echter geldig zijn voor de insluitende SCO. Studieprogramma's bevatten bijvoorbeeld cursussen en vergaderingen bevatten vergaderinginhoud. Aangezien mappen SCO's zijn, omvat de geretourneerde lijst SCO's en submappen op het volgende hiërarchische niveau, maar niet de inhoud van de submappen. Als u de inhoud van de submap wilt opnemen, roept u sco-expanded-contents aan.

210


Aanvraag-URL http://server_name/api/xml ?action=sco-contents &sco-id=integer &filter-definition=value &sort-definition=value &session=value

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een map waarvan u de inhoud wilt vermelden. U kunt de sco-id verkrijgen door sco-shortcuts aan te roepen.

session

Tekenreeks

N

De waarde van het BREEZESESSION-cookie. Gebruik


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Antwoordstructuur <status code=allowedValue /> <scos> <sco sco-id=integer source-sco-id=integer folder-id=integer type=allowedValue icon=allowedValue display-seq=integer is-folder=boolean byte-count=integer ref-count=integer> string string <description>string string datetime string <sco-tag>string

sco-contents

211


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


scos

Container

De lijst met objecten in de map.

sco

Container

Eén object in de map.

Geheel getal

De unieke id van een object in de map.

code

sco-id

source-sco-id Geheel getal

folder-id

Geheel getal

De id van een map, doorgegeven als sco-id in de aanvraag.

type

Toegestane waarde

Het type object (zie type voor waarden). SCO's die inhoud hebben, hebben het type content in plaats van een specifieker type zoals presentation.

icon

Toegestane waarde

De naam van het pictogram waarmee het object wordt geïdentificeerd. Verschaft meer detail over het type object in type.

display-seq

Geheel getal

De volgorde waarin het object in Enterprise Manager of in uw toepassing wordt weergegeven.

is-folder

Booleaanse waarde

Een waarde die aangeeft of het object een map is (indien 1) of niet (indien 0).

byte-count

Geheel getal

De omvang van de inhoud. Voor mappen is deze inhoud 0.

ref-count

Geheel getal

Het aantal SCO's waarnaar deze SCO verwijst.

Tekenreeks

De naam van het object op de server.

name

212

De unieke id van een inhoud-SCO die in een cursus of studieprogramma is gebruikt.


Element

Kenmerk

Type

Beschrijving

url-path

Tekenreeks

De unieke id achter de domeinnaam in de URL naar de SCO.

description

Tekenreeks

De beschrijving van het object.

date-modified

Datetime

De datum waarop het object voor het laatst is bijgewerkt.

date-begin

Datetime

De begindatum van een cursus of vergadering (wordt alleen voor een cursus of vergadering geretourneerd).

date-end

Datetime

De einddatum van een cursus of vergadering (wordt alleen voor een cursus of vergadering geretourneerd).

domain-name

Tekenreeks

De domeinnaam waarmee u toegang krijgt tot de vergadering of de gebeurtenis (wordt alleen voor vergaderingen en gebeurtenissen geretourneerd).

duration

Datetime

De duur van een cursus of vergadering (wordt alleen voor een cursus of vergadering geretourneerd).

sco-tag

Tekenreeks

Een korte beschrijving van de SCO.

Voorbeeldaanvraag https://example.com/api/xml?action=sco-contents&sco-id=2006258748

Voorbeeldantwoord <status code="ok" /> <scos> <sco sco-id="2007035246" source-sco-id="2006334909" folder-id="2006258748" type="content" icon="course" display-seq="0" is-folder="0"> Java 101 /java101/ 2006-07-20T17:15:00.000-07:00 2006-07-20T17:21:38.860-07:00

Zie ook sco-expanded-contents, sco-shortcuts

sco-contents

213

sco-delete Beschikbaarheid


Verwijdert een of meer objecten (SCO's). Als de sco-id die u opgeeft naar een map verwijst, wordt de hele inhoud van de opgegeven map verwijderd. Als u meerdere SCO's wilt verwijderen, geeft u meerdere sco-id-parameters op. U kunt een aanroep zoals sco-contents gebruiken om de ref-count van de SCO te controleren. Dit is het aantal andere SCO’s dat naar deze SCO verwijst. Als de SCO geen verwijzingen heeft, kunt u de SCO veilig verwijderen en claimt de server de ruimte weer. Als de SCO verwijzingen heeft, kan de verwijdering tot gevolg hebben dat de SCO’s die naar de SCO verwijzen niet meer werken, of dat de server de ruimte niet meer claimt, of beide. Als een cursus bijvoorbeeld naar een quizpresentatie verwijst en u de presentatie verwijdert, functioneert de cursus niet meer. Nog een voorbeeld. Als voor een vergadering een inhoud-SCO (zoals een presentatie of video) is gebruikt, is er in de vergadering een verwijzing naar de SCO. Met het verwijderen van de content-SCO wordt geen schijfruimte vrijgemaakt, omdat de vergadering er nog steeds naar verwijst. Om een SCO te kunnen verwijderen, hebt u ten minste de machtiging manage nodig (zie permission-id voor details). Gebruikers die tot de geïntegreerde groep authors behoren, hebben de machtiging manage voor hun eigen inhoudsmap en kunnen dus inhoud uit de map verwijderen. Aanvraag-URL http://server_name/api/xml ?action=sco-delete &sco-id=integer &session=value

214


Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een SCO.

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=sco-delete&sco-id=2007171127


Zie ook sco-info, sco-move, sco-nav, sco-expanded-contents

sco-delete

215

sco-expanded-contents Beschikbaarheid


Vermeldt alle SCO's in een map, inclusief de inhoud van submappen, studieprogramma's en alle typen insluitende SCO's. Als u geen filter gebruikt, wordt de lijst met SCO's geretourneerd in dezelfde volgorde als waarin deze in Connect Enterprise Manager wordt weergegeven. Als u een filter gebruikt of een sorteerbewerking uitvoert, wordt de lijst geretourneerd volgens het gebruikte filter dat of de gebruikte sorteerbewerking. Aanvraag-URL http://server_name/api/xml ?action=sco-expanded-contents &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een map.

session

Tekenreeks

N


Filters

U kunt het antwoord filteren of sorteren op de elementen of de kenmerken die het bevat. Filters die naar gedeeltelijke overeenkomsten zoeken en die worden gemaakt met filterlike (zoals filter-like-name), worden niet aanbevolen met sco-expanded-contents omdat ze mogelijk de serverprestaties beïnvloeden. Antwoordstructuur <status code=allowedValue /> <expanded-scos> <sco depth=integer sco-id=integer folder-id=integer type=allowedValue icon=allowedValue lang=allowedValue source-sco-id=integer display-seq=integer source-sco-type=integer>

216


string string datetime datetime ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


expanded-scos

Container

De lijst met alle SCO's die de map bevat.

sco

Container

Details van één SCO in de map. Deze SCO kan een map zijn, of een ander type object.

depth

Geheel getal

De diepte in de inhoudsstructuur waarin het object staat, met het object van het hoogste niveau op 1.

sco-id

Geheel getal

De unieke id van de SCO. Als de SCO is een map is, is deze gelijk aan folder-id.

folder-id

Geheel getal

De id van de map waartoe de SCO behoort.

type

Toegestane waarde

Het type inhoudsobject (zie type).

icon

Toegestane waarde

De naam van het pictogram waarmee dit object visueel wordt geïdentificeerd.

lang

Toegestane waarde

De taal waarin informatie over de SCO wordt weergegeven (zie lang voor waarden).

code

sco-expanded-contents

217

Element

Kenmerk

Type

Beschrijving

source-sco-id

Geheel getal

De id van een SCO op basis waarvan deze SCO is gemaakt, zoals een vergaderingssjabloon of cursusinhoud.

display-seq

Geheel getal

De volgorde waarin Enterprise Manager (of uw toepassing, als u deze waarde gebruikt) een lijst met SCO's weergeeft. De waarden zijn niet noodzakelijkerwijs uniek, dus kunnen meerdere SCO's dezelfde displayseq-waarde hebben. In dit geval moet de toepassing de weergavevolgorde definiëren. De standaardwaarde is 0.

source-sco-type Geheel getal

Een geheel getal dat het type SCO aanduidt op basis waarvan deze SCO is gemaakt.

Voorbeeldaanvraag https://example.com/api/xml?action=sco-expanded-contents&sco-id=624529

Voorbeeldantwoord <status code="ok" /> <expanded-scos> <sco depth="0" sco-id="624529" folder-id="624520" type="folder" icon="folder" lang="en" source-sco-id="" display-seq="0" source-sco-type=""> Shared Meetings /f624529/ 2004-03-09T09:45:41.060-08:00 2005-03-18T10:19:38.950-08:00 <sco depth="1" sco-id="2598379" folder-id="624529" type="meeting" icon="meeting" lang="en" source-sco-id="-8888" display-seq="0" source-sco-type="3"> Monday Night Football /r68075204/ <description>Monday Night Football 2004-05-17T15:30:00.000-07:00 2004-05-18T00:15:00.000-07:00 2004-05-17T15:50:39.733-07:00 2006-08-16T00:34:52.930-07:00

218


sco-info Beschikbaarheid


Biedt informatie over een SCO in Connect Enterprise. Het object kan elk geldig type SCO hebben. Zie type voor een lijst met toegestane SCO-typen. Het antwoord omvat de account waartoe de SCO behoort, de datums waarop de SCO is gemaakt en voor het laatst is gewijzigd, de eigenaar, de URL waarmee de SCO wordt bereikt en andere gegevens. Voor sommige typen SCO omvat het antwoord tevens informatie over een sjabloon op basis waarvan deze SCO is gemaakt. Aanvraag-URL http://server_name/api/xml ?action=sco-info &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een SCO op de server.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <sco account-id=integer disabled=datetime display-seq=integer folder-id=integer icon=allowedValue lang=allowedValue max-retries=integer sco-id=integer source-sco-id=integer type=allowedValue version=integer> datetime datetime datetime

sco-info

219

datetime <description>string string string <passing-score>integer datetime <section-count>integer <source-sco> <source-sco account-id=integer display-seq=integer folder-id=integer icon=allowedValue lang=allowedValue max-retries=integer sco-id=integer source-sco-id=integer type=allowedValue version=integer> datetime datetime string string


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Informatie over de SCO.

account-id

Geheel getal

De id van de account waartoe de SCO behoort.

disabled

Datetime

Een lege waarde als de SCO niet is uitgeschakeld. Indien uitgeschakeld, de datum en tijd waarop de SCO is uitgeschakeld.

code

sco

220


Element

Kenmerk

Type

Beschrijving

display-seq

Geheel getal

De volgorde waarin Enterprise Manager (of uw toepassing, als u deze waarde gebruikt) een lijst met SCO's weergeeft. De waarden zijn niet noodzakelijkerwijs uniek, dus kunnen meerdere SCO's dezelfde displayseq-waarde hebben. In dit geval moet de toepassing de weergavevolgorde definiëren. De standaardwaarde is 0.

folder-id

Geheel getal

De id van de map waartoe de SCO behoort.

icon

Toegestane waarde

Het type pictogram dat wordt gebruikt als visuele identificatie voor de SCO (zie icon).

lang

Toegestane waarde

Een afkorting voor de nieuwe taal (zie type voor waarden).

max-retries

Geheel getal

Het aantal keren dat de gebruiker de SCO mag afleggen.

sco-id

Geheel getal


source-sco-id Geheel getal

De unieke id van een sjabloon waarvan de SCO is afgeleid.

type

Toegestane waarde

Het inhoudstype van de SCO (zie type voor waarden). type is een categorie van hoog niveau. icon biedt meer details over het type inhoud.

version

Geheel getal

Het versienummer van de SCO. Wordt verhoogd wanneer het object wordt gewijzigd, of naar de server wordt geüpload.

date-begin

Datetime

Als de SCO een vergadering is, de datum en tijd waarop de vergadering begint.

date-created

Datetime

De datum en tijd waarop de SCO is gemaakt (of waarop inhoud is geüpload).

date-end

Datetime

Als de SCO een vergadering is, de datum en tijd waarop de vergadering stopt.

sco-info

221

Element

Kenmerk

Type

Beschrijving

date-modified

Datetime

De datum en tijd waarop de SCO voor het laatst is gewijzigd.

description

Tekenreeks

De beschrijving van de SCO die is ingevoerd toen de SCO werd gemaakt.

name

Tekenreeks

De naam van de SCO.

url-path

Tekenreeks

Het pad naar de SCO op de server.

passing-score

Geheel getal

De minimale score die de gebruiker moet behalen om voor een trainingscursus te slagen.

duration

Geheel getal

De duur in milliseconden die nodig om de SCO weer te geven of af te spelen.

section-count

Geheel getal

Het aantal secties in de cursusinhoud, zoals het aantal dia's, pagina's, hoofdstukken, interacties of andere inhoudsoorten.

source-sco

Container

Informatie over SCO's die sjablonen zijn voor of inhoud leveren aan de SCO waarin u bent geïnteresseerd. De SCO's die een bron kunnen hebben, zijn vergaderingen, cursussen of evenementen.

source-sco

Container

Details over een SCO die een sjabloon is voor of inhoud biedt aan de SCO waarin u bent geïnteresseerd. Heeft extra elementen en kenmerken, net als het element sco.

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

Voorbeeldantwoord <status code="ok" /> <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258750" icon="meeting" lang="en" max-retries="" sco-id="2006320683" source-sco-id="-1625529" type="meeting" version="0"> 2006-05-04T11:15:00.000-07:00 2006-05-04T11:27:47.087-07:00 2006-05-04T12:15:00.000-07:00

222


2006-05-04T11:27:47.087-07:00 Technology and Law Review Meeting /tlawreview/ <source-sco> <source-sco account-id="624520" display-seq="0" folder-id="-625529" icon="meeting" lang="en" max-retries="" sco-id="-1625529" source-sco-id="-8888" type="meeting" version="0"> 2004-10-05T00:49:30.217-07:00 2005-01-04T15:03:25.937-08:00 Default Meeting Template /defaultMeetingTemplate/

sco-move Beschikbaarheid


Verplaatst een SCO van de ene map naar de andere. Als u een SCO naar een map wilt verplaatsen, moet de huidige gebruiker een machtiging hebben om inhoud in de doelmap te maken. In het algemeen hebben gebruikers standaard een machtiging voor hun eigen map (zoals my-meetings, my-courses, my-events, mycontent en my-meeting-templates). Om SCO's te verplaatsen naar een gedeelde map, zoals content, courses en meetings, moet een gebruiker de machtiging Beheren hebben of een beheerder zijn. Aanvraag-URL http://server_name/api/xml ?action=sco-move &folder-id=integer &sco-id=integer &session=BreezeSessionCookieValue

sco-move

223

Parameters Naam

Type

Vereist

Beschrijving

folder-id

Geheel getal

J

De id van de doelmap.

sco-id

Geheel getal

J

De unieke id van de SCO die u wilt verplaatsen.

session

Tekenreeks

N


Filters



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=sco-move&sco-id=2006744233 &folder-id=2006258748


Zie ook sco-nav

224


sco-nav Beschikbaarheid


Beschrijft de maphiërarchie die een SCO bevat. De aanroep sco-nav is nuttig voor het maken van een navigatiestructuur, navigatiepad of ander type hiërarchie voor de gebruikersinterface. Het antwoord bevat een lijst met scoelementen, één voor de SCO waarvoor u een query uitvoert en één voor elk van de insluitende mappen tot aan de map op het hoogste niveau. De map op het hoogste niveau is één van de lijsten met mappen die door sco-shortcuts wordt geretourneerd. In elk sco-element, geeft het kenmerk depth aan hoeveel hiërarchische niveaus de SCO is verwijderd van de SCO die u in uw aanvraag opgeeft. Een depth van 0 geeft de SCO aan waarvoor u de query uitvoert, een depth van 1 geeft de map aan die de SCO bevat enzovoort. Aanvraag-URL http://server_name/api/xml ?action=sco-nav &sco-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

sco-id

Geheel getal

J

De unieke id van een SCO waarvoor u een maphiërarchie tot aan het hoofdniveau wilt.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <sco-nav> <sco sco-id=integer type=allowedValue icon=allowedValue depth=integer>

sco-nav

225

string ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


sco-nav

Container

De hele navigatiestructuur van de map op het hoogste niveau naar de SCO.

sco

Container

Informatie over één SCO in de hiërarchie.

sco-id

Geheel getal


type

Toegestane waarde

Het type SCO (zie type voor waarden).

icon

Toegestane waarde

Het pictogram waarmee de SCO visueel wordt weergegeven (zie icon voor waarden).

depth

Geheel getal

Een cijfer dat het niveau van een SCO in de maphiërarchie aangeeft ten opzichte van de SCO die in de aanvraag is doorgegeven (0 voor de doorgegeven SCO, 1 voor één niveau erboven, enzovoort). De waarden worden hoger naarmate u in de hiërarchie verder omhoog gaat in de richting van de topniveaumap.

Tekenreeks

De naam van de SCO.

code

name

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


226


<sco-nav> <sco sco-id="624522" type="folder" icon="folder" depth="2"> User Content <sco sco-id="2006258747" type="folder" icon="folder" depth="1"> [email protected] <sco sco-id="2006334909" type="content" icon="producer" depth="0"> Test Quiz

Zie ook sco-move

sco-search Beschikbaarheid


Biedt een lijst met alle SCO's die overeenkomen met de zoektekst. De actie sco-search zoekt naar de titel en het overzicht van SCO's voor de querytekenreeks. Als de SCO een presentatie is of tekst bevat, wordt met sco-search tevens in de inhoud gezocht. Met deze actie wordt alleen in bepaalde typen inhoud gezocht, zoals presentaties en vergaderingsarchieven. Er wordt niet gezocht in andere typen inhoud, zoals FLV-, SWF- en PDF-bestanden. De query is niet hoofdlettergevoelig en u kunt jokertekens gebruiken. De toegestane jokertekens zijn: ■

Een asterisk (*) voor een willekeurig teken of willekeurige tekens.

■

Een vraagteken (?) voor een willekeurig teken.

U kunt ook de functies and en or gebruiken om meerdere resultaten te retourneren. Zet een spatie tussen de functie en de zoektermen: https://example.com/api/xml?action=sco-search&query=quiz or test

Als u bijvoorbeeld naar quizortest zoekt, interpreteert de server dit als een letterlijke tekenreeks en worden alleen exacte resultaten weergegeven.

sco-search

227

Aanvraag-URL http://server_name/api/xml ?action=sco-search &query=querystring &filter-definition=value &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

query

Querytekenreeks

J

Een tekenreeks die u wilt zoeken. Als u een van deze speciale tekens in de querytekenreeks wilt gebruiken, zet u een backslash voor het teken: + - && || ! ( ) { } [ ] ^ " ~ * ? : \

De querytekenreeks is niet hoofdlettergevoel en gebruikt geen jokertekens. session

Tekenreeks

N


Filters

U kunt het antwoord filteren op een element of kenmerk dat het bevat. Antwoordstructuur <status code=allowedValue /> <sco-search-info> <sco sco-id=integer folder-id=integer type=allowedValue icon=allowedValue byte-count=integer> string string datetime datetime integer allowedValue string

228



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


sco-search-info

Container

De lijst met objecten (SCO's) die overeenkomen met de zoekquery.

sco

Container

Details over een object dat overeenkomt met de zoekopdracht.

sco-id

Geheel getal


folder-id

Geheel getal

De id van de map waarin de SCO is opgeslagen.

type

Toegestane waarde

Het type inhoud dat aan de SCO is toegewezen (zie type voor waarden).

icon

Toegestane waarde

Het pictogram waarmee de SCO visueel in een gebruikersinterface wordt geïdentificeerd.

byte-count

Geheel getal

De grootte van de SCO, uitgedrukt in bytes.

name

Tekenreeks

De bestandsnaam van de SCO.

url-path

Tekenreeks

De unieke identificatiecode die na de domeinnaam in de URL van de SCO komt.

date-created

Datetime

De datum waarop de SCO is gemaakt.

date-modified

Datetime

De datum waarop de SCO is gewijzigd.

hit

Geheel getal

Het volgnummer van deze instantie van de querytekenreeks in de SCO.

hit-type

Toegestane waarde

Het type inhoud waarin de zoekterm is gevonden. Toegestane waarden zijn metadata en slide.

code

sco-search

229

Element

Kenmerk

Type

Beschrijving

hit-url

Tekenreeks

Een relatieve URL naar de plaats waar de zoekterm in de inhoud is gevonden, bijvoorbeeld naar een specifieke dia. Moet worden toegevoegd aan het url-path.

thumbnail-path

Tekenreeks

Een relatieve URL naar een afbeelding van de SCO die de zoekterm bevat.

Voorbeeldaanvraag https://example.com/api/xml?action=sco-search&query=quiz

Voorbeeldantwoord <status code="ok" /> <sco-search-info> <sco sco-id="5677964" folder-id="2562850" type="content" icon="producer" byte-count="5985"> Final Quiz /p46125962/ 2005-05-09T14:24:36.390-07:00 2005-05-09T14:24:36.390-07:00 0 metadata <sco sco-id="5677964" folder-id="2562850" type="content" icon="producer" byte-count="5985"> Final Quiz /p46125962/ 2005-05-09T14:24:36.390-07:00 2005-05-09T14:24:36.390-07:00 7 slide slide=7 ...

230


sco-shortcuts Beschikbaarheid


Verschaft informatie over de mappen die relevant zijn voor de huidige gebruiker. Het gaat bijvoorbeeld om een map met de huidige vergaderingen van de gebruiker, een map met de inhoud van de gebruiker en mappen die hier in de navigatiehiërarchie boven liggen. Als u de URL van een SCO wilt bepalen, voegt u het url-path dat wordt geretourneerd door sco-info, sco-contents, of sco-expanded-contents aaneen met de domain-name die wordt geretourneerd door sco-shortcuts. U kunt bijvoorbeeld deze twee tekenreeksen aaneenschakelen: ■

http://test.server.com

(de domain-name die wordt geretourneerd door sco-

shortcuts) ■

(het url-path dat wordt geretourneerd door sco-info, sco-contents of sco-expanded-contents)

/f2006123456/

Het resultaat is deze URL: http://test.server.com/f2006123456/

U kunt tevens sco-contents aanroepen met de sco-id van een map die wordt geretourneerd door sco-shortcuts om de inhoud van de map te zien. Aanvraag-URL http://server_name/api/xml ?action=sco-shortcuts &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

session

Tekenreeks

N


Filters


sco-shortcuts

231

Antwoordstructuur <status code=code /> <shortcuts> <sco tree-id=integer sco-id=integer type=allowedValue> <domain-name>string ...


Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


shortcuts

Container

Informatie over alle mappen die betrekking hebben op de huidige gebruiker.

sco

Container

Informatie over één van de mappen van de huidige gebruiker.

tree-id

Geheel getal

De id van de navigatiestructuur die de map bevat. Verschillende mappen kunnen dezelfde tree-id hebben.

sco-id

Geheel getal

De unieke id van de map.

type

Toegestane waarde

Het type map. De toegestane waarden worden in de volgende tabel weergegeven.

Tekenreeks

De domeinnaam van de map.

code

domain-name

232


De waarden die geretourneerd kunnen worden in het kenmerk type van het element sco (alleen voor deze aanroep, sco-shortcuts) identificeren Connect Enterprise-mappen. Elk maptype is toegewezen aan een map in Adobe Connect Enterprise Manager en vereist een bepaald machtigingsniveau voor toegang. Deze niveaus worden in de volgende tabel beschreven. Type waarde

Beschrijving

account-custom

Aangepaste inhoud voor een account, zoals een aangepaste aanmeldingspagina, banner enzovoort.

content

De map Gedeelde inhoud. Vereist het privilege Beheerder of de machtiging Beheren.

courses

De map Gedeelde training. Vereist het privilege Beheerder of de machtiging Beheren.

events

De map Gedeelde gebeurtenissen. Vereist het privilege Beheerder of de machtiging Beheren.

meetings

De map Gedeelde vergaderingen. Vereist het privilege Beheerder of de machtiging Beheren.

my-courses

De map Mijn training. Individuele gebruikers hebben standaard de machtiging Beheren.

my-content

De map Mijn inhoud. Individuele gebruikers hebben standaard de machtiging Beheren.

my-events

De map Mijn gebeurtenissen. Individuele gebruikers hebben standaard de machtiging Beheren.

my-meetings

De map Mijn vergaderingen. Individuele gebruikers hebben standaard de machtiging Beheren.

my-meeting-templates

De map Mijn sjablonen. Individuele gebruikers hebben standaard de machtiging Beheren.

seminars

De map Gedeelde seminars. Vereist het privilege Beheerder of de machtiging Beheren.

shared-meeting-templates

De map Gedeelde sjablonen. Ontleent de machtigingen aan Gedeelde vergaderingen.

user-content

Bevat de inhoudsmappen van de gebruiker.

user-courses

Bevat de cursusmappen van de gebruiker.

user-events

Bevat de gebeurtenismappen van de gebruiker.

user-meetings

Bevat de vergaderingenmappen van de gebruiker.

sco-shortcuts

233

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

Voorbeeldantwoord <status code="ok" /> <shortcuts> <sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com <sco tree-id="4930293" sco-id="2006258749" type="my-events"> <domain-name>http://example.com ...

Zie ook sco-info, sco-expanded-contents

sco-update Beschikbaarheid


Creëert metagegevens voor een SCO of werkt bestaande metagegevens die een SCO beschrijven bij. Roep sco-update aan om de metagegevens alleen te creëren voor SCO's die inhoud representeren, zoals vergaderingen. U moet tevens de inhoudsbestanden uploaden met sco-upload of Connect Enterprise Manager. U moet een folder-id of een sco-id opgeven, maar niet beide. Als u een folder-id doorgeeft, creëert sco-update een nieuwe SCO en wordt een sco-id geretourneerd. Als de SCO reeds bestaat en u een sco-id doorgeeft, worden de metagegevens die de SCO beschrijven door sco-update bijgewerkt. Nadat u een nieuwe SCO hebt gemaakt met sco-update, roept u permissions-update aan om de gebruikers en groepen te bepalen die er toegang toe hebben.

234


Aanvraag-URL http://server_name/api/xml ?action=sco-update &author-info-1=string &author-info-2=string &author-info-3=string &date-begin=datetime &date-end=datetime &description=string &email=string &first-name=string &folder-id=integer &lang=allowedValue &last-name=string &name=string &sco-id=integer &sco-tag=string &source-sco-id=integer &type=allowedValue &url-path=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

author-info-1

Tekenreeks

N

Informatie over de auteur. Wordt alleen voor presentaties gebruikt. Kan worden gebruikt voor de naam van de auteur of voor andere informatie.

author-info-2

Tekenreeks

N

Extra informatie over de auteur. Wordt alleen voor presentaties gebruikt. Kan worden gebruikt voor de functietitel van de auteur of voor andere informatie.

author-info-3

Tekenreeks

N

Extra informatie over de auteur. Wordt alleen voor presentaties gebruikt. Kan worden gebruikt voor de bedrijfsnaam van de auteur of voor andere informatie.

date-begin

Datetime

N

De geplande begindatum en -tijd, in de ISO 8601-notatie. Wordt alleen gebruikt voor vergaderingen en cursussen.

date-end

Datetime

N

De geplande einddatum en -tijd, in de ISO 8601-notatie. Wordt alleen gebruikt voor vergaderingen en cursussen.

sco-update

235

Naam

Type

Vereist

Beschrijving

description

Tekenreeks

N

Een beschrijving van de SCO die in de gebruikersinterface wordt weergegeven.

email

Tekenreeks

N

Het e-mailadres van de contactpersoon voor een presentatie (wordt alleen met presentatie-SCO's gebruikt).

first-name

Tekenreeks

N

De voornaam van de contactpersoon voor een presentatie (wordt alleen met presentatie-SCO's gebruikt).

folder-id

Geheel getal

J/N

De id van de map waarin de nieuwe SCO wordt opgeslagen. Vereist voor een nieuwe SCO, maar niet te gebruiken voor een bestaande SCO.

lang

Toegestane waarde

N

Een afkorting voor de taal die bij de SCO hoort (zie lang voor waarden). Indien niet opgegeven, wordt de standaardwaarde gebruikt voor de map waarin de SCO is gemaakt.

last-name

Tekenreeks

N

De achternaam van de contactpersoon voor een presentatie (wordt alleen met presentatie-SCO's gebruikt).

name

Tekenreeks

J/N

De naam van de SCO met of zonder spaties. Vereist om een SCO te maken.

sco-id

Geheel getal

J/N

De unieke id van een SCO die u wilt bijwerken. Gebruik sco-id of folder-id, maar niet beide. Vereist om een bestaande SCO bij te werken.

sco-tag

Tekenreeks

N

Een label voor informatie die u over een cursus wilt opnemen. Alleen te gebruiken voor cursussen.

source-sco-id

Geheel getal

N

De unieke id van een sjabloon die u kunt gebruiken om een vergadering of stuk inhoud te maken op basis waarvan u een cursus samenstelt.

type

Toegestane waarde

N

Het type van de nieuwe SCO (zie type voor toegestane waarden). De standaardwaarde is content.

236


Naam

Type

Vereist

Beschrijving

url-path

Tekenreeks

N

Het aangepaste deel van de URL naar de vergaderruimte die na de domeinnaam komt. Het url-path moet uniek zijn binnen de map. Indien niet opgegeven wordt door de server een waarde toegewezen.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <sco folder-id=integer lang=allowedValue type=allowedValue sco-id=integer version=integer account-id=integer icon=integer> string <description>string string


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


Container

Informatie over een nieuwe SCO die u zojuist hebt gemaakt, inclusief de sco-id. Wordt alleen geretourneerd als u een SCO maakt.

folder-id

Geheel getal

De id van de map waarin de nieuwe SCO is opgeslagen.

lang

Toegestane waarde

Een code voor de taal die bij de SCO hoort (zie lang voor waarden).

code

sco

sco-update

237

Element

Kenmerk

Type

Beschrijving

type

Toegestane waarde

Het type van de nieuwe SCO (zie type voor waarden).

sco-id

Toegestane waarde

De unieke id van de nieuwe SCO.

version

Geheel getal

Het versienummer van de nieuwe SCO. Wanneer de SCO voor het eerst wordt gemaakt, heeft version de waarde 0.

account-id

Geheel getal

De id van de account waarin de nieuwe SCO is opgeslagen.

icon

Geheel getal

Het type pictogram waarmee een nieuwe SCO in Enterprise Manager wordt geïdentificeerd (zie icon voor waarden).

url-path

Tekenreeks

Het deel van de SCO-URL dat na de domeinnaam komt en dat de SCO op unieke wijze identificeert.

description

Tekenreeks

Een tekstbeschrijving van de SCO.

name

Tekenreeks

De naam van de SCO.

Voorbeeldaanvraag https://example.com/api/xml?action=sco-update&folder-id=2006258747 &description=test&name=More About Web Communities&type=content &lang=en

Voorbeeldantwoord <status code="ok" /> <sco folder-id="2006258747" account-id="624520" type="content" lang="en" icon="content" sco-id="2006752036" version="0"> /p53884157/ <description>test More About Web Communities

Zie ook sco-upload

238


sco-upload Beschikbaarheid


Hiermee wordt een bestand naar de server geüpload en indien nodig samengesteld. Als u een nieuw bestand toevoegt, roept u eerst sco-update aan en geeft u de geretourneerde sco-id door aan sco-upload. Als u de inhoud van een bestand uploadt dat reeds op de server bestaat, kunt u sco-upload rechtstreeks aanroepen. U moet sco-upload aanroepen binnen een HTML-element form. Het element form moet een coderingstype multipart/form-data hebben. Het HTML-formulier moet tevens een element input met name=file hebben, zoals in het volgende voorbeeld:

What files are you sending?

Met dit formulier wordt één bestand geüpload. Als u meerdere bestanden wilt uploaden (bijvoorbeeld een PPT- en een PPC-bestand), moet u extra input-elementen gebruiken met name=file, bijvoorbeeld:

PPT files you are sending
PPC files you are sending

Roep na de upload sco-info aan voor de status van de SCO. De status is aanvankelijk in-progress, wat betekent dat de inhoud wordt samengesteld. Wanneer de status active wordt, is het samenstellen van de inhoud voltooid en hebben de gebruikers toegang tot de inhoud.

sco-upload

239

Aanvraag-URL http://server_name/api/xml ?action=sco-upload &file=formElementName &sco-id=integer &summary=string &title=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

file

Formulierelementnaam

J

Het te uploaden bestand, verzonden van een input-element met name=file in een HTML-formulier. Het HTMLformulier moet tevens een coderingstype multipart/form-data hebben, gedefinieerd in het element form.

sco-id

Geheel getal

J

De id van de SCO die u wilt uploaden, geretourneerd door sco-update.

summary

Tekenreeks

N

Een korte beschrijving van de SCO die in Enterprise Manager of uw toepassing wordt weergegeven.

title

Tekenreeks

N

De titel van de SCO.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Antwoordstructuur <status code=allowedValue /> <path>string

240



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


files

Container

Informatie over alle geüploade bestanden. Gedeactiveerd en wordt mogelijk uit een toekomstige versie verwijderd.

file

Container

Informatie over één bestand. Gedeactiveerd en wordt mogelijk uit een toekomstige versie verwijderd.

path

Tekenreeks

Het pad naar het nieuwe, geüploade bestand. Alleen voor intern gebruik door Adobe. Gedeactiveerd en wordt mogelijk uit een toekomstige versie verwijderd.

code

Voorbeeldaanvraag

Dit verzoek wordt gemaakt door een bestand te uploaden via een HTML-formulier: http://example.com/api/xml?action=sco-upload&sco-id=2006768386

Voorbeeldantwoord <status code="ok" /> <path>624520/2006768386-10/input/WhatMakesAGreatFilm.ppt

Zie ook sco-update

sco-upload

241

user-accounts Beschikbaarheid


Verschaft een lijst met de accounts waartoe de gebruiker behoort. De actie user-accounts wordt alleen gebruikt wanneer een gebruiker tot meer dan één account op de server behoort en gebruikt dezelfde aanmeldings-id en hetzelfde wachtwoord voor elke account. In dit geval mislukt hoogstwaarschijnlijk de aanmelding van een gebruiker met het statusbericht too-much-data. Deze actie is nuttig wanneer u een lijst met gebruikersaccounts wilt ophalen en de gebruiker wilt laten kiezen bij welke account hij of zij zich aanmeldt. Aanvraag-URL http://server_name/api/xml ?action=user-accounts &login=string &password=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

login

Tekenreeks

J

De aanmeldingsnaam van de gebruiker, dit kan bijvoorbeeld het e-mailadres van de gebruiker zijn.

password

Tekenreeks

J

Het gebruikerswachtwoord.

session

Tekenreeks

N


Filters

U kunt resultaten niet filteren of sorteren. Standaard wordt op account-name gesorteerd. Antwoordstructuur <status code=allowedValue /> <users> <user user-id=integer account-id=integer> string

242


datetime ...


Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


users

Container

Informatie over de accounts waartoe de gebruiker behoort.

user

Container

Informatie over een gebruiker en een account.

user-id

Geheel getal

De id van de gebruiker op de server.

account-id

Geheel getal

De id van de account waartoe de gebruiker behoort.

name

Tekenreeks

De naam van de account waartoe de gebruiker behoort.

date-expired

Datetime

De datum en tijd waarop de aanmelding van de gebruiker verloopt.

code

Voorbeeldaanvraag https://sample.com/api/[email protected] &password=bigdog

Voorbeeldantwoord <status code="ok" /> <users> <user user-id="2006258745" account-id="624520"> Test Account 2999-12-31T16:00:00.000-08:00

user-accounts

243

user-transcript-update Beschikbaarheid


Hiermee vervangt u de score van een onderdeel in een studieprogramma. U kunt bijvoorbeeld user-transcript-update gebruiken om een gebruiker een score te geven voor externe training. Deze actie werkt alleen voor onderdelen binnen een studieprogramma en u hebt de machtiging manage nodig voor het studieprogramma. Aanvraag-URL http://server_name/api/xml ?action=user-transcript-update &curriculum-id=integer &sco-id=integer &status=allowedValue &score=integer &principal-id=integer &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

curriculum-id

Geheel getal

N

De id van het studieprogramma.

sco-id

Geheel getal

J

De unieke id van een SCO met een score die u wilt vervangen.

status

Toegestane waarde

J

Een waarde die de status aangeeft. van de poging van de gebruiker om deze SCO te gebruiken Toegestane waarden zijn completed, incomplete, user-passed, user-failed en not-attempted.

score

Geheel getal

J

Een waarde in de vorm van een geheel getal die de score voorstelt die de gebruiker voor deze SCO heeft behaald.

principal-id

Geheel getal

J

De id van de gebruiker van wie de transcriptie wordt vervangen.

session

Tekenreeks

N


244


Filters



Type

Beschrijving

results

Kenmerk

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=user-transcript-update &curriculum-id=2006298444&sco-id=2006298445&status=user-passed &principal-id=2006258745&score=100


Zie ook learning-path-info, learning-path-update

user-update-pwd Beschikbaarheid


Wijzigt het wachtwoord van de gebruiker wanneer het huidige wachtwoord en twee exemplaren van het nieuwe wachtwoord worden opgegeven.

user-update-pwd

245

Een beheerder kan regels maken voor geldige wachtwoorden op de server. Deze regels omvatten bijvoorbeeld het aantal en het type tekens dat een wachtwoord moet bevatten. Als een gebruiker een nieuw wachtwoord instelt dat niet aan de regels voldoet, ontvangt de toepassing een fout waarin wordt aangegeven dat de waarde van de parameter password (het nieuwe wachtwoord) ongeldig is. Wanneer u user-update-pwd aanroept, stuurt u een wachtwoord via HTTP, of bij voorkeur via HTTPS. Zorg ervoor dat u HTTPS of een andere geschikte beveiligingsmethode gebruikt om wachtwoorden tijdens het verzenden te beveiligen. Aanvraag-URL http://server_name/api/xml ?action=user-update-pwd &user-id=integer &password-old=string &password=string &password-verify=string &session=BreezeSessionCookieValue

Parameters Naam

Type

Vereist

Beschrijving

user-id

Geheel getal

J


password-old

Tekenreeks J/N

Het huidige gebruikerswachtwoord. Vereist voor standaardgebruikers, maar niet voor beheerders.

password

Tekenreeks J

Het nieuwe wachtwoord.

password-verify

Tekenreeks J

Een tweede exemplaar van het nieuwe wachtwoord, ter verificatie.

session

Tekenreeks N


Filters


246



Kenmerk

Type

Beschrijving

results

Container


status

Leeg, met kenmerken


Toegestane waarde


code

Voorbeeldaanvraag https://example.com/api/xml?action=user-update-pwd &user-id=2006258745&password-old=hello&password=newone &password-verify=newone


user-update-pwd

247

248


HOOFDSTUK 7

7

Filter- en sorteringsreferentie Dit hoofdstuk vormt een referentie voor filters en sorteringswaarden waarmee u het volume van de antwoorden van XML-handelingen kunt reduceren in Adobe® Connect™ Enterprise Web Services.

filter-definition Beschrijving

Een filter is een speciaal type parameter dat het volume van het antwoord reduceert. Wanneer u filter-definition in de syntaxis van een aanvraag-URL ziet, vervangt u deze door een filterdefinitie. U maakt een filterdefinitie als volgt: begin met het sleutelwoord filter, voeg (desgewenst) een wijzigingstoets toe, daarna een veldnaam (indien toegestaan) en vervolgens een waarde met gebruik van de volgende syntaxis: filter-modifier-field=value

In de volgende tabel ziet u de wijzigingstoetsen die u kunt toevoegen: Filter

Beschrijving

filter-field=value

Retourneert alle items waarvoor de gegevens in field precies overeenkomen met value.

filter-like-field=value

Retourneert alle items met de reeks value in field, ook als field geen exacte overeenkomst is.

filter-out-field=value

Filtert of sluit alle items met value in field uit.

filter-rows=value

Beperkt de resultaten tot het aantal rijen dat is opgegeven in value.

filter-start=value

Start de resultaten bij het indexnummer dat is opgegeven in value.

249

Filter

Beschrijving

filter-gt-datefield=value

Selecteert alle items met een datum na value. Dit werkt alleen met datumvelden. De waarde moet een datum in de ISO 8601-notatie zijn.

filter-lt-datefield=value

Selecteert alle items met een datum vroeger dan value. Dit werkt alleen met datumvelden. De waarde moet een datum in de ISO 8601notatie zijn.

filter-gte-datefield=value

Selecteert alle items met een waarde in field die groter is dan of gelijk is aan value. Dit werkt alleen met datumvelden. De waarde moet een datum in de ISO 8601-notatie zijn.

filter-lte-datefield=value

Selecteert alle items met een waarde in field die groter is dan of gelijk is aan value. Dit werkt alleen met datums. Voor de datum wordt een ISO 8601notatie gebruikt.

filter-ismember=value

Selecteert alle principals die leden zijn van een groep; de groep is opgegeven in een afzonderlijke parameter. Accepteert de Booleaanse waarden true of false.

De value is niet hoofdlettergevoelig. Zo komen deze beide filters bijvoorbeeld overeen met een vergadering met de naam August All Hands Meeting: &filter-name=August All Hands Meeting &filter-name=august all hands meeting

Voor sommige wijzigingstoetsen is een veldnaam vereist waarop de resultaten worden gefilterd, zoals bijvoorbeeld name. Andere filters accepteren geen veldnaam. Voor filters die veldnamen accepteren, variëren de toegestane velden voor verschillende handelingen. Controleer een specifieke handeling in Hoofdstuk 6, “Actiereferentie” om te leren welke veldnamen u kunt gebruiken in filters. U kunt de volgende jokertekens gebruiken in filterwaarden: ■

*

om overeenkomsten met een willekeurige reeks tekens te zoeken

■

?

om overeenkomsten met één enkel teken te zoeken

U bereikt de beste resultaten met alleen een jokerteken aan het einde van de waardereeks. is bijvoorbeeld veel sneller dan filter-like-name=%john%.

filter-like-name=john%

Filter voor exacte overeenkomsten filter-name=Goals Review

Zoekt items met Goals Review (met willekeurig hoofdlettergebruik) in de naam.

250

Hoofdstuk 7: Filter- en sorteringsreferentie

Filter voor bijna overeenkomende items filter-like-name=Goals

Zoekt naar items met Goals (met willekeurig hoofdlettergebruik) in de naam, zoals Goals Review en Quarterly Goals. Als u filter-like gebruikt, verloopt het filteren trager. U bereikt betere resultaten als u een filter voor een exacte overeenkomst gebruikt (zoals filter-field). Als u de exacte tekenreeks kent, dient u deze te gebruiken in een filter in plaats van een filter dat naar bijna overeenkomende items zoekt. Filters om items mee uit te sluiten filter-out-name=Status

Sluit alle items uit met Status (met willekeurig hoofdlettergebruik) in de naam. Overeenkomende items zoeken en items uitsluiten filter-like-name=Goals&filter-out-status=active

Zoekt items die overeenkomen met Goals (met willekeurig hoofdlettergebruik) in de naam en die niet meer actief zijn. Een overeenkomende begindatum zoeken filter-gt-date-begin=2005-05-01&sort-name=asc

Zoekt naar alle items met een begindatum van 1 mei 2005 en sorteert de items in oplopende volgorde op naam. Een overeenkomend datumbereik zoeken filter-gt-date-begin=2005-05-01&filter-lt-date-begin=2005-05-31

Geeft alle items als resultaat met een begindatum na 1 mei 2005 en vóór 31 mei 2005. Zie ook sort-definition

sort-definition Als u sort-definition in een aanvraag-URL ziet in deze referentie, maakt u een sorteringsfilter met een veldnaam en een waarde die beschrijven hoe u de resultaten wilt sorteren. In deze syntaxis: sort-field=value

Vervang sort door een van de volgende exacte waarden: sort (voor een enkelvoudige sortering), sort1 (voor de primaire sortering van twee sorteringen) of sort2 (voor een secundaire sortering van de resultaten die sort1 als resultaat heeft gegeven).

sort-definition

251

De variabele field definieert het veld waarop u sorteert. De velden die u kunt gebruiken, verschillen per aanroep. Raadpleeg dus de API-referentie voor de aanroep die u uitvoert. De value is altijd asc (voor oplopend) of desc (voor aflopend); zo worden de resultaten geordend. Alle onderdelen van een sorteringsfilter worden in de volgende tabel vermeld: Type sortering

Veld

Waarde

Beschrijving

sort

Verschilt per aanroep.

asc of desc

Sorteert de resultaten op basis van het opgegeven veld, in oplopende of aflopende volgorde.

sort1


asc of desc

Sorteert de resultaten op een veld, hetzij oplopend of aflopend, en geeft de resultaten door aan de volgende sorteerbewerking.

sort2


asc of desc

Wanneer de resultaten van de primaire sorteerbewerking gelijkwaardig zijn, zoals dezelfde naam of groep, voert u een secundaire sorteerbewerking uit op het opgegeven veld, in oplopende of aflopende volgorde.

Enkelvoudige voorbeelden van sort-field=value (met één sorteringsniveau) zien er als volgt uit: sort-name=asc sort-date=desc

De volgende tabel verschaft meer informatie over het gebruik van de sorteringswaarden asc en desc. Waarde

Beschrijving

asc

Oplopende volgorde. Begin voor een alfabetische lijst met A en sluit af met Z. Voor lijsten die op nummer of op datum zijn gesorteerd, begint u met het laagste nummer of de vroegste datum.

desc

Aflopende volgorde. Begin voor een alfabetische lijst met Z en sluit af met A. Voor lijsten die op nummer of op datum zijn gesorteerd, begint u met het hoogste nummer of de meest recente datum.

252


Op basis van uw resultaten kan het nodig zijn dat zowel primaire als secundaire sorteerbewerkingen met sort1 en sort2 worden gebruikt. Als u bijvoorbeeld principal-list aanroept om een lijst met principals weer te geven, kunt u een primaire sorteerbewerking uitvoeren op het veld type en vervolgens een secundaire sorteerbewerking op het veld name. (Op deze manier worden alle principals van een bepaald type bij elkaar gegroepeerd en vervolgens op naam gesorteerd in iedere groep). Twee sorteringsniveaus worden als volgt aangegeven: sort1-type=asc&sort2-name=desc

Zie ook filter-definition

sort-definition

253

254


HOOFDSTUK 8

8

Algemene referentie In dit referentiegedeelte worden XML-elementen en -kenmerken beschreven die door meerdere handelingen worden gebruikt in Adobe® Connect™ Enterprise Web Services. Er wordt naar de in dit hoofdstuk beschreven elementen gerefereerd vanuit de verzoeken antwoordtabellen die handelingen beschrijven in de Web Services XML API. Alle namen en waarden van parameters, elementen en kenmerken zijn hoofdlettergevoelig. Zo is name bijvoorbeeld niet hetzelfde als Name en is sco-id niet gelijk aan sco-ID. U moet deze waarden precies zo opgeven als ze worden weergegeven in deze referentie.

access Beschrijving

Een kenmerk dat het toegangsniveau van een gebruiker tot een cursus of studieprogramma beschrijft. Waarden Waarde

Beschrijving

access-blocked

De cursus of het studieprogramma is beperkt en gebruikers kunnen de cursus of het studieprogramma niet afleggen.

access-hidden

De cursus of het studieprogramma is beperkt, gebruikers kunnen de cursus of het studieprogramma niet afleggen en de cursus of het studieprogramma is verborgen in Adobe Connect Enterprise Manager (of de gebruikersinterface van een aangepaste toepassing, als u deze waarde gebruikt).

access-open

De cursus of het studieprogramma is open en gebruikers kunnen de cursus of het studieprogramma afleggen.

access-optional

De cursus of het studieprogramma is optioneel.

access-pass

De gebruiker heeft de cursus of het studieprogramma al afgelegd en is ervoor geslaagd.

255

veld Beschrijving

Een element met informatie over een aangepast veld dat is gedefinieerd voor een object of principal. Kenmerken Kenmerk

Type

permission-id

Toegestane waarde De machtiging die is vereist om toegang te krijgen tot het aangepaste veld. Zie permission-id voor geldige waarden.

object-type

Toegestane waarde Een definitie voor een geldig object op de server (zie type voor waarden).

field-id

Reeks

Een stuk tekst dat het aangepaste veld identificeert. Enterprise Manager geeft de field-id niet weer, maar deze id wordt door verschillende handelingen geretourneerd.

account-id

Geheel getal

Een door de server toegewezen id voor de gebruiker die momenteel is aangemeld.

display-seq

Geheel getal

De volgorde waarin het aangepaste veld wordt weergegeven in de gebruikersinterface of die door de handeling wordt geretourneerd.

field-type

Reeks

Het type gegevens dat het veld accepteert. Toegestane waarden zijn text, textarea en password.

is-primary

Booleaanse waarde Bepaalt of het aangepaste veld kan worden verwijderd. true betekent dat het veld niet kan worden verwijderd. false betekent dat het veld wel kan worden verwijderd.

is-required

Booleaanse waarde Bepaalt of het aangepaste veld is vereist. true geeft aan dat een waarde moet worden opgegeven voor dit veld in elke principal of SCO die het veld gebruikt. false betekent dat er geen waarden zijn vereist voor dit veld.

acl-id

Geheel getal

De id van een aangepast veld in een ACL.

custom-seq

Geheel getal

Het volgnummer dat aan het aangepaste veld is toegewezen in de gebruikersinterface.

256

Hoofdstuk 8: Algemene referentie

Beschrijving

Kenmerk

Type

Beschrijving

type

Reeks

Het type van het aangepaste veld (zie type voor waarden).

principal-id

Geheel getal

De id van de principal waarvoor het aangepaste veld is gedefinieerd.

icon Beschrijving

Het symbool aan de hand waarvan een SCO wordt geïdentificeerd in Enterprise Manager. Waarden Waarde

Beschrijving

archive

Een archief van een Adobe Acrobat® Connect Professionalvergadering.

attachment

Een stuk inhoud dat is geüpload als een bijlage.

authorware

Een stuk multimedia-inhoud dat is gemaakt met Macromedia® Authorware® van Adobe.

captivate

Een demo of film die is gemaakt met Adobe Captivate™.

course

Een trainingscursus.

curriculum

Een studieprogramma.

external-event

Een externe training die aan een studieprogramma kan worden toegevoegd.

flv

Een Macromedia Flash®-videobestand (van Adobe).

html

Een HTML-bestand.

image

Een afbeelding.

lms-plugin

Een stuk inhoud uit een extern leerbeheersysteem.

logos

Een aangepast logo dat wordt gebruikt in een vergaderruimte of in Enterprise Manager.

meeting-template

Een aangepaste weergave voor een vergadering.

mp3

Een MP3-bestand.

pdf

Een Adobe PDF-bestand.

pod

Een visueel vak met functionaliteit in een schermindeling voor een vergaderruimte.

icon

257

Waarde

Beschrijving

presentation

Een presentatie die is gemaakt met een eerdere versie van Adobe Breeze®-software.

producer

Een presentatie die is gemaakt met Adobe Presenter.

seminar

Een seminar dat is gemaakt met Adobe Acrobat Connect Professional Seminars.

session

Een instantie van een herhaalde Acrobat Connect Professionalvergadering.

swf

Een Adobe Macromedia Flash-bestand.

lang Beschrijving

Een uit twee of drie letters bestaande code die een taal aangeeft volgens de ISO 639specificaties. ISO 639-1 beschrijft uit twee letters bestaande codes en ISO 639-2 beschrijft uit drie letters bestaande codes. De taalcode beïnvloedt de weergave in een Connect Enterprisetoepassing, zoals een vergaderruimte of een Enterprise Manager-display. Waarden Uit twee letters bestaande waarde

Uit drie letters bestaande waarde

Taal

en

eng

Engels

fr

fre

Frans (gebruik niet fra)

de

ger

Duits (gebruik niet deu)

ja

jpn

Japans

ko

kor

Koreaans

object-type Beschrijving

Een kenmerk dat het type van een Connect Enterprise-object beschrijft.

258


Waarden Waarde

Betekenis

object-type-account

Een account die principals en SCO's bevat.

object-type-action

Een handeling in de Web Services XML API.

object-type-event

Een Acrobat Connect Professional-gebeurtenis.

object-type-hidden

Een SCO die niet zichtbaar is Enterprise Manager (of in uw toepassing, als u deze waarde gebruikt).

object-type-meeting

Een Acrobat Connect Professional-vergadering.

object-type-principal

Een gebruiker of groep.

object-type-readonly

Een instelling die aangeeft dat Enterprise Manager enkele gegevens weergeeft, maar dat een gebruiker de gegevens niet kan instellen in Enterprise Manager.

object-type-sco

Een SCO die een vergadering, cursus, studieprogramma, stuk inhoud, map of een ander object op de server vertegenwoordigt.

path-type Beschrijving

Het kenmerk path-type beschrijft het type leerpad tussen twee objecten in een studieprogramma, dus bijvoorbeeld of een bepaald object moet zijn voltooid als voorwaarde om het volgende object te kunnen afleggen. Waarden Waarde

Betekenis

completion-none

De huidige SCO is geen voltooiingsvereiste voor het studieprogramma.

completion-required

De huidige SCO is een voltooiingsvereiste.

prereq-none

Het huidige leerobject kent geen voorwaarden.

prereq-required

De huidige SCO beschikt over een voorwaarde waaraan moet worden voldaan.

prereq-hidden

Het doelleerobject is vereist als een voorwaarde. Het huidige leerobject is verborgen totdat het doelleerobject is voltooid.

prereq-suggested

De huidige SCO heeft een voorwaarde die wordt aanbevolen, maar die niet is vereist.

path-type

259

Waarde

Betekenis

preass-blocked

Er bestaat een evaluatietest voor de huidige SCO. Als de ingeschreven persoon voor deze test slaagt, wordt dit onderdeel vergrendeld. Het onderdeel is beschikbaar als de ingeschreven persoon voor deze test zakt.

preass-none

Er bestaan geen evaluatietests voor de huidige SCO.

preass-hidden

Er bestaat een evaluatietest voor de huidige SCO. Als de gebruiker slaagt, kan de huidige SCO worden verborgen voor de gebruiker. Als de gebruiker zakt, wordt de huidige SCO zichtbaar en kan de gebruiker zich inschrijven.

preass-optional

Er bestaat een evaluatietest voor de huidige SCO. Als de gebruiker slaagt voor deze test, is de huidige SCO niet meer vereist voor voltooiing van het studieprogramma.

permission-id Beschrijving

De parameter (of het kenmerk) permission-id definieert een machtiging. Afhankelijk van de context van de handeling of het antwoord, kan de machtiging een machtiging zijn van een principal voor een SCO of een machtiging die is vereist om een handeling uit te voeren. Waarden Machtiging

Beschrijving

admin

De principal heeft volledige toegang tot een account en kan gebruikers maken, alle mappen weergeven of een willekeurige SCO starten. De principal kan echter geen inhoud publiceren of als gastheer van een Acrobat Connect Professional-vergadering fungeren.

view

De principal kan de SCO weergeven, maar niet wijzigen. De principal kan een cursus afleggen, een vergadering bijwonen als deelnemer of de inhoud van een map bekijken.

host

Alleen beschikbaar voor vergaderingen. De principal is de gastheer van een vergadering en kan de vergadering maken of fungeren als gastheer, zelfs zonder view-machtigingen voor de bovenliggende map van de vergadering.

mini-host

Alleen beschikbaar voor vergaderingen. De principal is de presentator van een vergadering en kan inhoud presenteren, een scherm delen, tekstberichten verzenden, vragen beantwoorden, tekstnotities maken, audio en video uitzenden en inhoud van webkoppelingen presenteren.

260


Machtiging

Beschrijving

remove

Alleen beschikbaar voor vergaderingen. De principal beschikt niet over deelnemer-, presentator- of gastheermachtigingen voor het bijwonen van de vergadering. Als een gebruiker al een livevergadering bijwoont, wordt de gebruiker pas uit deze vergadering verwijderd als er een time-out voor de sessie optreedt.

publish

Beschikbaar voor andere SCO's dan vergaderingen. De principal kan de SCO publiceren of bijwerken. Tot de publish-machtigingen behoort view en deze machtigingen staan de principal toe om rapporten met betrekking tot de SCO weer te geven. Voor een map staat publish de principal niet toe om nieuwe submappen te maken of machtigingen in te stellen.

manage

Beschikbaar voor andere SCO's dan vergaderingen of cursussen. De principal kan de machtigingen voor de SCO weergeven, verwijderen, verplaatsen, bewerken of instellen. Voor een map kan de principal submappen maken of rapporten met mapinhoud weergeven.

denied

Beschikbaar voor andere SCO's dan vergaderingen. De principal mag de SCO niet weergeven, openen of beheren.

status Beschrijving

Een statuscode die door Connect Enterprise wordt geretourneerd als reactie op alle handelingen in de Web Services XML API. Antwoordenstructuur <status code=allowedValue >

of <status code=allowedValue>

status

261

Kenmerken


code

Waarde

Beschrijving

invalid

Geeft aan dat een aanroep om een bepaalde reden ongeldig is. Raadpleeg het element invalid voor nadere informatie.

no-access

Geeft aan dat u niet over de machtiging beschikt om de handeling aan te roepen. Het kenmerk subcode verschaft nadere informatie.

no-data

Geeft aan dat er geen gegevens beschikbaar zijn (in antwoord op een handeling die normaliter tot het retourneren van gegevens zou leiden). Dit betekent meestal dat er geen item is met de door u opgegeven id. U kunt deze fout oplossen door de opgegeven id te wijzigen in de id van een bestaand item.

ok

Geeft aan dat de handeling voltooid is.

too-much-data

Geeft aan dat de handeling één resultaat zou moeten hebben opgeleverd, maar dat er in feite meerdere resultaten zijn geretourneerd. Als er bijvoorbeeld meerdere gebruikers zijn met dezelfde gebruikersnaam en hetzelfde wachtwoord en u de handeling login aanroept met gebruik van die gebruikersnaam en dat wachtwoord als de parameters, kan het systeem niet bepalen als welke gebruiker u zich wilt aanmelden en dus wordt de fout too-much-data geretourneerd.

Deze waarde (indien aanwezig) verschaft meer informatie over de status van het antwoord. De waarden voor subcode worden bijvoorbeeld gebruikt om onderscheid te maken tussen de verschillende situaties waarin code is ingesteld op no-access. subcode

Waarde

Beschrijving

account-expired

De account van de klant is verlopen.

denied

Op basis van de opgegeven aanmeldingsgegevens beschikt u niet over de machtiging om de handeling aan te roepen.

no-login

De gebruiker is niet aangemeld. U kunt deze fout oplossen door u aan te melden (met gebruik van de handeling login) voordat u de aanroep uitvoert. Zie login voor nadere informatie.

no-quota

De accountlimiet is bereikt of overschreden.

not-available

De vereiste is bron is niet beschikbaar.

not-secure

U moet SSL gebruiken om deze handeling aan te roepen.

pending-activation De account is nog niet geactiveerd. pending-license

262

De gebruiksrechtovereenkomst van de account is nog niet afgesloten.


Waarde

Beschrijving

sco-expired

De cursus of het bijhouden van inhoud is verlopen.

sco-not-started

De vergadering of de cursus is niet begonnen.

Het element invalid

Een element dat informatie verschaft en de statuscode invalid beschrijft. Element

Kenmerk

Type

Beschrijving

Leeg, met kenmerken

Informatie over waarom de aanroep ongeldig was.

field

Reeks

De naam van de aangevraagde parameter die onjuist was of die ontbreekt.

type

Toegestane waarde

Het type van het onjuiste of ontbrekende veld.

subcode

Toegestane waarde

Een code die aangeeft waarom het verzoek ongeldig is (de volgende tabel bevat de waarden).

invalid

De volgende tabel bevat de toegestane waarden voor subcode wanneer de code invalid is. Waarde

Beschrijving

duplicate

De aanroep heeft geprobeerd een gedupliceerd item toe te voegen in een context waarin elk item uniek moet zijn.

format

Een doorgegeven parameter heeft niet de goede indeling.

illegal-operation

De gewenste bewerking schendt de integriteitsregels (verplaatst een map bijvoorbeeld naar zichzelf).

missing

Een vereiste parameter ontbreekt.

no-such-item

De aangevraagde gegevens bestaan niet.

range

De waarde valt buiten het toegestane waardenbereik.

Geretourneerd door

Alle handelingen in de Connect Enterprise Web Services XML API. Voorbeelden

Dit is een geslaagd antwoord: <status code="ok" />

status

263

Dit is een ongeldig antwoord: <status code="invalid">

status, kenmerk Beschrijving

Een kenmerk dat de vorderingen van een gebruiker in een cursus- of studieprogramma-SCO beschrijft. Dit kenmerk wordt geretourneerd door handelingen die trainingsrapporten verschaffen. Een studieprogramma of map kan alleen de status completed of incomplete hebben. De volgende tabel bevat de toegestane waarden voor status wanneer deze worden geretourneerd in een row-element dat een cursus beschrijft. Waarde

Beschrijving

user-passed

De SCO heeft score-interacties waarvoor de gebruiker is geslaagd.

user-failed

De SCO heeft score-interacties. De gebruiker heeft deze beantwoord, maar is gezakt.

completed

De gebruiker heeft alle inhoud van de SCO weergegeven, maar de inhoud bevat geen score-interacties.

incomplete

De gebruiker heeft niet alle inhoud van de SCO weergegeven.

not-attempted

De gebruiker is nog niet begonnen met het weergeven van alle inhoud van de SCO.

review

De gebruiker is geslaagd voor de cursus, heeft deze voltooid of heeft alle beschikbare pogingen opgebruikt.

Voorbeeld <status code="ok" /> Test Course /test/ [email protected] 2006-06-30T15:23:55.070-07:00 <principal-name>Joy Smith
264


time-zone-id Beschrijving

Instellingen die de tijdzones beschrijven die u kunt gebruiken met time-zone-id. Waarden Tijdzone-instelling

Waarde

(GMT-12:00) Internationale datumgrens in westelijke richting

0

(GMT-11:00) Midway Island, Samoa

1

(GMT-10:00) Hawaii

2

(GMT-09:00) Alaska

3

(GMT-08:00) Pacific Time (VS en Canada); Tijuana

4

(GMT-07:00) Mountain Time (VS en Canada)

10

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

13

(GMT-07:00) Arizona

15

(GMT-06:00) Central Time (VS en Canada)

20

(GMT-06:00) Saskatchewan

25

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

30

(GMT-06:00) Centraal-Amerika

33

(GMT-05:00) Eastern Time (VS en Canada)

35

(GMT-05:00) Indiana (Oost)

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

73

(GMT-02:00) Mid-Atlantic

75

(GMT-01:00) Azoren

80

(GMT-01:00) Kaapverdië

83

time-zone-id

265

Tijdzone-instelling

Waarde

(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lissabon, Londen

85

(GMT) Casablanca, Monrovia

90

(GMT+01:00) Belgrado, Bratislava, Boedapest, Ljubljana, Praag

95

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

100

(GMT+01:00) Brussel, Kopenhagen, Madrid, Parijs

105

(GMT+01:00) Amsterdam, Berlijn, Bern, Rome, Stockholm, Wenen

110

(GMT+01:00) West-Centraal Afrika

113

(GMT+02:00) Boekarest

115

(GMT+02:00) Caïro

120

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

125

(GMT+02:00) Athene, Istanboel, Minsk

130

(GMT+02:00) Jeruzalem

135

(GMT+02:00) Harare, Pretoria

140

(GMT+03:00) Moskou, St. Petersburg, Wolgograd

145

(GMT+03:00) Koeweit, Riyad

150

(GMT+03:00) Nairobi

155

(GMT+03:00) Bagdad

158

(GMT+03:30) Teheran

160

(GMT+04:00) Abu Dhabi, Muscat

165

(GMT+04:00) Bakoe, Tbilisi, Erevan

170

(GMT+04:30) Kabul

175

(GMT+05:00) Jekaterinenburg

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

266


Tijdzone-instelling

Waarde

(GMT+07:00) Krasnojarsk

207

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

210

(GMT+08:00) Kuala Lumpur, Singapore

215

(GMT+08:00) Taipei

220

(GMT+08:00) Perth

225

(GMT+08:00) Irkoetsk, Ulaan Bataar

227

(GMT+09:00) Seoul

230

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

235

(GMT+09:00) Jakoetsk

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

270

(GMT+10:00) Guam, Port Moresby

275

(GMT+11:00) Magadan, Salomonseilanden, Nieuw-Caledonië

280

(GMT+12:00) Fiji-eilanden, Kamchatka, Marshalleilanden

285

(GMT+12:00) Auckland, Wellington

290

(GMT+13:00) Nuku'alofa

300

type Beschrijving

Een retourelement of -kenmerk dat het type van een SCO of principal op de server definieert. De toegestane waarden voor type verschillen van die voor SCO's en principals.

type

267

SCO-typen

Een SCO kan inhoud zijn, een Adobe Acrobat Connect Professional-vergadering, een gebeurtenis, cursus, studieprogramma, map of boomstructuur of een willekeurig ander object in Connect Enterprise. Alle Connect Enterprise-objecten zijn SCO's. In het algemeen gesproken, kan een SCO een van de volgende waarden hebben voor type. Waarde

Beschrijving

content

Een bestand dat kan worden weergegeven en dat is geüpload naar de server, zoals een FLV-bestand, een HTML-bestand, een afbeelding, een pod enz.

course

Een cursus, onderdeel van een studieprogramma.

curriculum

Een studieprogramma.

event

Een gebeurtenis.

folder

Een map met inhoud op de vaste schijf van de server.

link

Een verwijzing naar een andere SCO. Deze koppelingen worden door studieprogramma's gebruikt om te koppelen naar andere SCO's. Wanneer inhoud aan een studieprogramma wordt toegevoegd, wordt er een koppeling gemaakt van het studieprogramma naar de inhoud.

meeting


session

Een instantie van een herhaalde Acrobat Connect Professionalvergadering.

tree

De hoofdmap in een mapstructuur. De hoofdmap in een structuur wordt behandeld als een onafhankelijke hiërarchie; u kunt de bovenliggende map van een structuur niet bepalen vanuit de structuur.

De inhoudsobjecten die door sommige handelingen worden geretourneerd (bijvoorbeeld report-bulk-objects) hebben de waarden voor type die worden vermeld in de volgende tabel. Waarde

Beschrijving

archive

Een gearchiveerd exemplaar van een live Acrobat Connect Professional-vergadering of -presentatie.

attachment

Een stuk inhoud dat is geüpload als een bijlage.

authorware

Een stuk multimedia-inhoud dat is gemaakt met Macromedia Authorware van Adobe.

captivate

Een demo of film die is gemaakt met Adobe Captivate.

268


Waarde

Beschrijving

course

Een cursus.

curriculum

Een studieprogramma, inclusief cursussen, presentaties en andere inhoud.

external-event

Een externe training die aan een studieprogramma kan worden toegevoegd.

flv

Een Macromedia Flash-videobestand van Adobe.

image

Een afbeelding, bijvoorbeeld in de GIF- of JPEG-indeling.

meeting


presentation

Een presentatie.

swf

Een Adobe Macromedia Flash-bestand.

Principal-typen

De voor principals toegestane waarden voor type worden weergegeven in de volgende tabel. Waarde

Beschrijving

admins

De geïntegreerde groep Beheerders, voor serverbeheerders.

authors

De geïntegreerde groep Auteurs, voor auteurs.

course-admins

De geïntegreerde groep Trainingsmanagers, voor trainingsmanagers.

event-admins

De geïntegreerde groep Gebeurtenismanagers, voor iedereen die een Acrobat Connect Professional-vergadering kan maken.

event-group

De groep gebruikers die is uitgenodigd voor een gebeurtenis.

everyone

Alle Connect Enterprise-gebruikers.

external-group

Een groep die is geverifieerd via een extern netwerk.

external-user

Een gebruiker die is geverifieerd via een extern netwerk.

group

Een groep die een gebruiker of beheerder maakt.

guest

Een niet-geregistreerde gebruiker die een Acrobat Connect Professional-vergaderruimte betreedt.

learners

De geïntegreerde groep Studenten, voor gebruikers die cursussen afleggen.

live-admins

De geïntegreerde groep Gastheren van vergaderingen, voor gastheren van Acrobat Connect Professional-vergaderingen.

type

269

Waarde

Beschrijving

seminar-admins

De geïntegreerde groep Seminargastheren, voor gastheren van seminars.

user

Een geregistreerde gebruiker op de server.

Aangepaste veldtypen

Wanneer type wordt gebruikt met een aangepast veld, kan het de volgende waarden hebben. Waarde

Beschrijving

required

Een verplicht aangepast veld voor de account.

optional

Een optioneel veld dat tijdens zelfregistratie wordt weergegeven.

optional-no-self-reg

Een optioneel veld dat tijdens zelfregistratie wordt verborgen.

270


BIJLAGE A

A

Een voorbeeldtoepassing Deze gids bevat een voorbeeldtoepassing, firstapp genaamd. Deze toepassing is beschikbaar in de map documentation/samples op de product-cd. De voorbeeldtoepassing is geschreven in Java en JSP, maakt gebruik van een model-view-controller-architectuur en kan worden uitgevoerd op een willekeurige webtoepassingsserver met een J2EE-servletcontainer. Aan de hand van de voorbeeldtoepassing wordt uitgelegd hoe de vergaderingsfuncties van Connect Enterprise in een aangepaste Java-toepassing of in een Java-portal kunnen worden geïmplementeerd en hoe een gebruiker zich kan aanmelden, hoe de vergaderingen van een gebruiker kunnen worden weergegeven en hoe vergaderingen kunnen worden gemaakt, bijgewerkt en verwijderd. U kunt de code van de voorbeeldtoepassing opnieuw gebruiken, wijzigen of uitbreiden. Alle voorbeeldbestanden waarnaar in deze bijlage wordt verwezen, bevinden zich in het voorbeeldbestand firstapp.zip. Het Lees mij-bestand bij de voorbeeldtoepassing bevat aanwijzingen voor het installeren en uitvoeren van de voorbeeldtoepassing. Tijdens het samenstellen en ontwerpen van uw toepassing dient u de volgende belangrijke aspecten over de Adobe Connect Enterprise Web Services XML API te onthouden: Aanroepen naar de XML API moeten vaak in een bepaalde volgorde worden uitgevoerd. U moet bijvoorbeeld eerst de principal-id van een gebruiker en de sco-id van een vergadering opvragen voordat u permissions-update aanroept om van de gebruiker een presentator van een vergadering te maken. De aanroepvolgorde van verschillende taken worden in de eerste hoofdstukken van deze handleiding beschreven. De volgorde van API-aanroepen

Een waarde kan een bepaalde parameternaam hebben in de ene aanroep en een andere parameternaam in een andere aanroep. Zo kan de unieke id van een SCO bijvoorbeeld een sco-id zijn wanneer deze wordt gebruikt met sco-info, maar een acl-id in permissions-update. In beide aanroepen is het dezelfde waarde. U kunt dit het beste leren aan de hand van de API-referentie in deze gids. Verschillende parameternamen voor dezelfde waarde

271

SCO's zijn niet objectgericht Een SCO is een inhoudsobject op de server dat kan worden gedeeld (zie “SCO's zoeken” voor een volledige definitie). Een SCO kan een vergadering, presentatie, cursus, afbeelding, map of een willekeurig object op de server zijn. SCO's zijn opgeslagen in mappen in een navigatiehiërarchie. Er is echter geen objectgerichte structuur voor SCO's en een type SCO is geen subtype van een ander type. Vergeet dit niet wanneer u uw toepassing ontwerpt.

Een adapterklasse samenstellen O P ME R K I NG

Raadpleeg de voorbeeldbestanden XMLApiAdapter.java, login.jsp en mymeetings.jsp.

Een adapterklasse is bijzonder handig wanneer u een aangepaste toepassing ontwerpt om Connect Enterprise aan te roepen. U maakt een instantie van de klasse voor iedere gebruikersaanmeldingssessie en de adapter verzorgt de verbinding met de server, het aanmelden van de gebruiker, het indienen van verzoeken bij de XML API en het parseren van XML-antwoorden.

Constructoren schrijven voor de adapterklasse De volgende constructor (uit het voorbeeldtoepassingsbestand XMLApiAdapter.java) maakt een instantie van de adapterklasse die een gebruiker vertegenwoordigt die toegang wil tot Connect Enterprise. U gebruikt deze constructor als u al over de cookiewaarde BREEZESESSION beschikt (zie “Aanmelden vanuit een toepassing”). De constructor roept ook de methode createXPaths aan om geldige XPath-instanties te maken die u in andere methoden kunt gebruiken: public XMLApiAdapter(String baseUrl, String breezesession) throws XMLApiException { this.setBaseUrl(baseUrl); this.breezesession = breezesession; createXPaths(); }

De tweede constructor accepteert de aanmeldings-id en het wachtwoord van een gebruiker en ook een BREEZESESSION-cookiewaarde: public XMLApiAdapter(String baseUrl, String login, String password, String breezesession) throws XMLApiException { this(baseUrl, breezesession);

272

Bijlage A: Een voorbeeldtoepassing

this.setLogin(login); this.setPassword(password); }

U kunt de BREEZESESSION-cookiewaarde opvragen voordat de gebruiker zich aanmeldt door common-info aan te roepen.

Een instantie van de adapter maken De volgende code (uit mymeetings.jsp) maakt een instantie van de XMLApiAdapter-klasse die een bij Connect Enterprise aangemelde gebruiker vertegenwoordigt. De huidige waarde van breezesession, die de BREEZESESSION-cookiewaarde bevat, wordt vervolgens opgeslagen in het JSP-kenmerk session, zodat andere bestanden er toegang tot hebben. <%! XMLApiAdapter breeze = null; %> <% ... breeze = new XMLApiAdapter(breezeBase, login, password, breezesession); breeze.getBreezesession(); session.setAttribute("breezesession", breeze); ... %>

De gebruiker aanmelden OPMERKING

Zie de voorbeeldbestanden XMLApiAdapter.java en login.jsp.

Uw toepassing heeft een methode nodig waarmee gebruikers worden aangemeld bij Connect Enterprise. Een aanmeldingsmethode dient een verbinding met de server te openen, de handeling login aan te roepen en het XML-antwoord op te halen. De methode moet ook de waarde van de BREEZESESSION-cookie lezen in de antwoordheader en deze waarde opslaan. Dit is de eenvoudigste vorm van de handeling login: https://example.com/api/[email protected] &password=jazz

Wellicht dient u ook de parameters session, account-id of domain toe te voegen aan de handeling login (zie “Aanmelden vanuit een toepassing” voor meerdere manieren om loginaan te roepen).

De gebruiker aanmelden

273

Een gelukte aanmelding geeft het volgende antwoord als resultaat, met de statuscode ok: <status code="ok" />

De basisaanvraag-URL samenstellen De aanmeldingsmethode dient eerst de basisaanvraag-URL samen te stellen om naar de server te verzenden. In dit voorbeeld stelt de methode breezeUrl een URL samen die er als volgt uitziet: http://example.com/api/xml?action=

Deze methode voegt bovendien een naam voor de handeling en een queryreeks toe die u ernaar toe stuurt. Hier volgt de volledige methode: protected URL breezeUrl(String action, String queryString) throws MalformedURLException { return new URL(getBaseUrl() + "/api/xml?" + "action=" + action + (queryString != null ? ('&' + queryString) : "")); }

De aanmeldingsgegevens van de gebruiker verzenden De login-methode roept de handeling login aan, opent de verbinding met de server, leest de BREEZESESSION-cookie in de antwoordheader en controleert of de statuscode ok in het antwoord staat: protected void login() throws XMLApiException { try { if (breezesession != null) logout(); URL loginUrl = breezeUrl("login", "login=" + getLogin() + "&password=" + getPassword()); URLConnection conn = loginUrl.openConnection(); conn.connect(); InputStream resultStream = conn.getInputStream(); Document doc = new SAXBuilder(false).build(resultStream); String breezesessionString = (String) (conn .getHeaderField("Set-Cookie")); StringTokenizer st = new StringTokenizer(breezesessionString, "=");

274


String sessionName = null; if (st.countTokens() > 1) sessionName = st.nextToken(); if (sessionName != null&& sessionName.equals("BREEZESESSION")) { String breezesessionNext = st.nextToken(); int semiIndex = breezesessionNext.indexOf(';'); breezesession = breezesessionNext.substring(0, semiIndex); } Element root = doc.getRootElement(); String status = getStatus(root); if (breezesession == null || !"ok".equalsIgnoreCase(status)) throw new XMLApiException("Could not log into Connect Enterprise."); } catch (IOException ioe) { throw new XMLApiException(IO_ERROR, ioe); } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } }

XML-aanvragen verzenden OPMERKING

Zie de voorbeeldbestanden XMLApiAdapter.java en createmeeting.jsp.

Als een gebruiker zich heeft aangemeld, is het nuttig om een generieke aanvraagmethode te hebben waarmee een aanvraag naar de server wordt verzonden wanneer u een naam van een handeling en een queryreeks verschaft. De request-methode in het voorbeeld accepteert een handeling en een queryreeks en stuurt de BREEZESESSION-cookiewaarde terug naar de server in de antwoordheader: protected Element request(String action, String queryString) throws XMLApiException { try { if (breezesession == null) login(); URL url = breezeUrl(action, queryString); URLConnection conn = url.openConnection(); conn.setRequestProperty("Cookie", "BREEZESESSION=" + breezesession); conn.connect();

XML-aanvragen verzenden

275

InputStream resultStream = conn.getInputStream(); Document doc = new SAXBuilder(false).build(resultStream); return doc.getRootElement(); } catch throw } catch throw }

(IOException ioe) { new XMLApiException("A communication error occurred", ioe); (JDOMException jde) { new XMLApiException("A parsing error occurred", jde);

}

XML-antwoorden parseren OPMERKING

Zie het voorbeeldbestand XMLApiAdapter.java.

Wanneer u een XML-aanvraag naar Connect Enterprise verzendt, retourneert de server een XML-antwoord. U dient het antwoord te parseren en waarden te extraheren, inclusief statuscodes. U kunt het antwoord parseren door door XML-elementen te bladeren met gebruik van XPath (raadpleeg de XPath-zelfstudie op w3schools.com voor nadere informatie). Ter illustratie ziet u hier het antwoord van sco-shortcuts: <status code="ok" /> <shortcuts> <sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com <sco tree-id="4930293" sco-id="2006258749" type="my-events"> <domain-name>http://example.com ...

Waarden extraheren De methode getShortcuts roept sco-shortcuts aan en parseert het antwoord met gebruik van XPath. Hier wordt geïllustreerd hoe u een lijst met sco-elementen en de sco-id van ieder element kunt extraheren:

276


public List getShortcuts() throws XMLApiException { try { Element e = request("sco-shortcuts", null); List scosXml = XPath.selectNodes(e, "//sco"); List scos = new ArrayList(); XPath id = XPath.newInstance("./@sco-id"); for (Iterator i = scosXml.iterator(); i.hasNext();) { Element s = (Element) i.next(); SCO sco = getSco(id.valueOf(s)); if(null != sco) scos.add(sco); } return scos; } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } }

Een statuscode extraheren Uw toepassing moet zowel gelukte als niet-gelukte antwoorden voor statuscodes parseren. Als een gebruiker bijvoorbeeld een handeling aanroept, maar niet over de vereiste machtigingen beschikt, heeft het foutantwoord een status-element met de kenmerken code en subcode: <status code="no-access" subcode="denied" />

Deze regels in de createXPaths-methode parseren voor de waarden code en subcode: codePath = XPath.newInstance("//status/@code"); subcodePath = XPath.newInstance("//status/@subcode");

In het voorbeeld wordt de methode createXPaths aangeroepen wanneer u een instantie van XMLApiAdapter maakt. De methode getStatus gebruikt vervolgens codePath en subcodePath om de door een koppelteken van elkaar gescheiden waarden voor code en subcode te retourneren: 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(); }

XML-antwoorden parseren

277

Gebruikersinformatie weergeven O P ME R K I NG

Raadpleeg de voorbeeldbestanden XMLApiAdapter.java, UserInfo.java en header.jsp.

Tijdens de aanmeldingssessie van een gebruiker kunt u informatie over deze gebruiker weergeven in de gebruikersinterface, zoals bijvoorbeeld een gebruikersnaam.

U kunt eenvoudige gegevens over de gebruiker opvragen door common-info aan te roepen nadat de gebruiker zich heeft aangemeld: https://example.com/api/xml?action=common-info

Het antwoord beschikt over een user-element met informatie die u kunt weergeven of in variabelen kunt opslaan voor later gebruik: <user user-id="2006258745" type="user"> Joy Smith [email protected]

Als u common-info aanroept voordat de gebruiker zich aanmeldt, hoeft het antwoord geen user-element te bevatten.

Informatie over de gebruiker opvragen In het voorbeeld roept de getUserInfo-methode common-info aan en parseert deze methode het antwoord voor de waarden name, login en user-id. Deze methode slaat vervolgens informatie op over de gebruiker in een instantie van de klasse UserInfo, een standaard beanklasse met getter- en settermethoden. public UserInfo getUserInfo(String login, String password) throws XMLApiException { try { Element e = request("common-info", "login=" + login + "&password=" + password); XPath name = XPath.newInstance("//user/name"); XPath log = XPath.newInstance("//user/login"); XPath id = XPath.newInstance("//user/@user-id"); UserInfo user = new UserInfo(); user.setLogin(log.valueOf(e)); user.setName(name.valueOf(e));

278


user.setUserId(id.valueOf(e)); return user; } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } }

De vergaderingen van een gebruiker vermelden O P ME R K I NG

Zie de voorbeeldbestanden XMLApiAdapter.java en SCO.java.

Het is mogelijk dat u de vergaderingen van een gebruiker wilt vermelden in uw toepassing. U kunt de vergaderingen kiezen die u wilt vermelden en de gegevens die u wilt weergeven op basis van het ontwerp van uw toepassing. De volgende illustratie bevat een voorbeeld van een vergaderingenlijst:

Als u de vergaderingen van een gebruiker wilt weergeven met gebruik van de XML API, roept u report-my-meetings aan met of zonder een filter. Zonder een filter geeft reportmy-meetings alle vergaderingen van een gebruiker als resultaat: https://example.com/api/xml?action=report-my-meetings

U kunt filter-expired=false toevoegen om alleen de vergaderingen als resultaat te geven die momenteel aan de gang zijn en die voor de toekomst zijn gepland: https://example.com/api/xml?action=report-my-meetings&filter-expired=false

De vergaderingen van een gebruiker vermelden

279

Zelfs met een filter kan het antwoord mogelijk meerdere meeting-elementen bevatten die u moet doorlopen en waaruit u gegevens moet extraheren. Een meeting-element ziet er als volgt uit: <meeting sco-id="2007063179" type="meeting" icon="meeting" permission-id="host" active-participants="0"> September All Hands Meeting <description>For all company employees <domain-name>example.com /sept15/ 2006-09-15T09:00:00.000-07:00 2006-09-15T18:00:00.000-07:00 <expired>false 09:00:00.000

De vergaderingenlijst ophalen Als u de vergaderingenlijst wilt ophalen in Java, schrijft u een methode zoals bijvoorbeeld getMyMeetings. Deze methode vermeldt de vergaderingen van een gebruiker met een filter als argument. Als u geen filter wilt gebruiken, kunt u null doorgeven als het filterargument. Een vergadering is een SCO en dus roept getMyMeetings de getSco-methode aan om waarden te extraheren uit het antwoord en deze op te slaan in een instantie van SCO.java. public List getMyMeetings(String filter) throws XMLApiException { try { Element meetingDoc = request("report-my-meetings", filter); List list = XPath.selectNodes(meetingDoc, "//meeting"); Iterator meetings = list.iterator(); List result = new ArrayList(); while (meetings.hasNext()) { Element m = (Element) meetings.next(); SCO meeting = getSco(m); result.add(meeting); } return result; } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } }

Het SCO-object omvat de gegevens over de SCO, zodat u deze gemakkelijk kunt ophalen van een webpagina (zoals bijvoorbeeld HTML of JSP) in uw toepassing.

280


Vergaderingen maken en bijwerken O P ME R K I NG

Zie de voorbeeldbestanden XMLApiAdapter.java en SCO.java.

U kunt gebruikers ook toestaan vergaderingen te maken in uw toepassing. Als u een vergadering wilt maken, roept u sco-update aan met de folder-id van een vergaderingenmap en type=meeting: https://example.com/api/xml?action=sco-update &folder-id=2006258750&description=For all company employees &name=Company All Hands Meeting&type=meeting&lang=en &date-begin=2006-06-16T23:00&date-end=2006-06-16T23:30

Het antwoord retourneert de sco-id van de vergadering die u kunt extraheren en opslaan: <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258750" icon="meeting" lang="en" max-retries="" sco-id="2006743452" source-sco-id="-1625529" type="meeting" version="1">

Het verschil tussen het aanroepen van sco-update voor het maken of het bijwerken van een vergadering is als volgt: ■

Geef een folder-id door om een vergadering te maken.

■

Geef een sco-id door om een bestaande vergadering bij te werken. Als een vergadering al bestaat, beschikt deze alleen over een sco-id.

Een vergadering maken In een toepassing moet u eerst van de gebruiker de informatie verzamelen die u nodig hebt om de vergadering te maken of bij te werken, zoals de naam, datum en tijd van de vergadering. Gewapend met deze informatie gebruikt u bijvoorbeeld de methode updateSco om de handeling sco-update aan te roepen. Zorg er in sco-update voor dat u het type van de SCO instelt op meeting. U kunt desgewenst ook een taalcode voor de vergaderruimte instellen, zoals lang=en, bijvoorbeeld: https://example.com/api/xml?action=sco-update&folder-id=2006258750 &description=nov&name=Nov%20All%20Hands%20Meeting&type=meeting&lang=en &date-begin=2006-11-11T09:00&date-end=2006-11-11T17:00

De updateSCO-methode toont hoe u de sco-update-aanroep in Java kunt implementeren als u eenmaal informatie over de vergadering hebt gekregen van de gebruiker:

Vergaderingen maken en bijwerken

281

public String updateSCO(String action, SCO sco) throws XMLApiException { try { StringBuffer sb = new StringBuffer(); Map data = sco.getUpdateFields(); if (CREATE.equals(action)) sb.append("folder-id=" + sco.getFolderId()); else sb.append("sco-id=" + sco.getId()); Iterator iter = data.keySet().iterator(); while (iter.hasNext()) { String key = (String) iter.next(); if (key.indexOf("sco-id") != -1) continue; if (key.indexOf("folder-id") != -1) continue; String value = (String) data.get(key); sb.append("&" + key + "=" + value); } if (null == data.get("type")) throw new XMLApiException("SCO type not defined"); Element e = request("sco-update", sb.toString()); XPath scoId = XPath.newInstance("//results/sco/@sco-id"); if (scoId.valueOf(e) == null) return null; else return scoId.valueOf(e); } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); } catch (ParseException pe) { throw new XMLApiException(PARSE_ERROR, pe); } }

Toegang tot een vergadering instellen Als u eenmaal een sco-id hebt, heeft een vergadering toegang nodig. De gebruiker die de vergadering maakt, is standaard de gastheer en deze gebruiker bepaalt of het een openbare of een persoonlijke vergadering is. Deze waarden worden ingesteld aan de hand van een combinatie van permission-id en principal-id in permissions-update. Gebruik bijvoorbeeld deze aanroep voor een openbare vergadering: https://example.com/api/xml?action=permissions-update&acl-id=2006334033 &principal-id=public-access&permission-id=view-hidden

Als een gebruiker deze waarden kiest, roept de setPermissions-methode permissionsupdate aan om toegang tot de vergadering in te stellen:

282


public void setPermissions(String aclId, String principalId, String permissionId) throws XMLApiException { request("permissions-update", "acl-id=" + aclId + "&principal-id=" + principalId + "&permission-id=" + permissionId); }

Vergaderinggegevens weergeven OPMERKING

Raadpleeg de voorbeeldbestanden XMLApiAdapter.java, SCO.java, mymeetings.jsp en showmeeting.jsp.

De meeste informatie die u over een vergadering wilt weergeven, is afkomstig van sco-info: https://example.com/api/xml?action=sco-info&sco-id=2006334909

Het antwoord bevat vele waarden die u kunt weergeven, zoals bijvoorbeeld: <status code="ok" /> <sco account-id="624520" disabled="" display-seq="0" folder-id="2006258747" icon="producer" lang="en" max-retries="" sco-id="2006334909" source-sco-id="" type="content" version="1"> 2006-05-11T12:00:02.000-07:00 2006-05-16T15:22:25.703-07:00 Test Quiz /quiz/ <passing-score>10 15100.0 <section-count>6

Informatie opvragen over een SCO De Java-methode getSco roept sco-info aan en parseert het resultaat, waarbij de waarden worden opgeslagen in variabelen, zodat u deze kunt weergeven in een gebruikersinterface: public SCO getSco(String scoId) throws XMLApiException { try { Element e = scoInfo(scoId); if(!"ok".equalsIgnoreCase(codePath.valueOf(e))) return null; Element sco = (Element) XPath.selectSingleNode(e, "//sco"); ...

Vergaderinggegevens weergeven

283

De URL voor de vergaderruimte samenstellen U dient ook de URL voor de vergaderruimte te maken. U kunt dit doen met een aanroep naar sco-info en een tweede aanroep naar sco-shortcuts: https://example.com/api/xml?action=sco-info&sco-id=2006258750 https://example.com/api/xml?action=sco-shortcuts

Extraheer het url-path uit het sco-info antwoord. Extraheer vervolgens de domain-name uit het sco-shortcuts-antwoord en voeg de twee waarden samen: <status code="ok" /> <shortcuts> <sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com ..

Het is ook mogelijk één aanroep uit te voeren naar report-my-meetings als de gebruiker zich heeft aangemeld en de vergadering zich in de map my-meetings van de gebruiker bevindt: https://example.com/api/xml?action=report-my-meetings

In dit geval extraheert u zowel de domain-name als het url-path uit het report-mymeetings antwoord. De Java-methode scoUrl stelt de URL samen door eerst sco-info aan te roepen om het url-path op te halen en vervolgens sco-shortcuts aan de roepen om de domain-name op te halen. In dit geval worden twee aanroepen gebruikt, zodat u niet hoeft aan te nemen dat de vergadering zich in de map my-meetings van de huidige gebruiker bevindt: 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); } }

284


Index

A aangepaste toepassingen 16 gegevensstroom 16 talen 8 aangepaste velden voor gebruikers 40 maken 39 typen 270 veld, element 256 aanmelden aanvraag-URL samenstellen 274 met account-id 26 basistechniek 24 cookiebeheer 23, 24 met domeinnaam 26 bij Enterprise Hosted 25 bij Enterprise Server 24 en gebruikers bijwerken 39 Java-voorbeeld 274 met session-parameter 25 vanuit een toepassing 23, 273 aanvraag-URL's Java-voorbeeld 274 aanvragen in XML-document 31 access, kenmerk 255 account-id 26 acl-field-info 81 acl-field-list 83 acl-field-update 85 acl-preference-update 87 acties acl-field-info 81 acl-field-list 83 acl-field-update 85 acl-preference-update 87 afmelden 34 common-info 89

custom-field-update 97 custom-fields 92 custom-fields-delete 95 group-membership-update 65, 101 learning-path-info 103 learning-path-update 105 login 107 logout 109 nieuw of verwijderd 79 permissions-info 110 permissions-reset 114 permissions-update 116 principal-info 118 principal-list 122 principal-list-by-field 125 principal-update 130 principals-delete 129 report-active-meetings 134 report-bulk-consolidated-transactions 49, 136 report-bulk-objects 139 report-bulk-questions 142 report-bulk-slide-views 145 report-bulk-users 147 report-course-status 150 report-curriculum-taker 66, 153 report-meeting-attendance 158 report-meeting-concurrent-users 160 report-meeting-sessions 162 report-meeting-summary 165 report-my-courses 167 report-my-events 170 report-my-meetings 49, 172 report-my-training 65, 176 report-quiz-interactions 49, 180 report-quiz-question-answer-distribution 183 report-quiz-question-distribution 186 report-quiz-question-response 188

285

report-quiz-summary 190 report-quiz-takers 193 report-quotas 60, 197 report-sco-slides 199 report-sco-views 201 report-user-training-transcripts 66, 207 report-user-trainings-taken 66, 203 sco-contents 210 sco-delete 214 sco-expanded-contents 216 sco-info 219 sco-move 223 sco-nav 225 sco-search 227 sco-shortcuts 231 sco-update 49, 234 sco-upload 239 user-accounts 242 user-transcript-update 244 user-update-pwd 245 actions common-info 36 principal-update 38, 39 adapterklasse constructoren 272 een instantie maken 273 samenstellen 272 Adobe Connect Enterprise Web Services 13 Adobe Connect Enterprise-bronnen 9 Adobe Developer Center 7 Adobe-bronnen, downloaden 8 afgewezen, machtiging 67 afmelden Java-voorbeeld 34 antwoorden parseren 276 parseren met XPath 32 parseren om fouten op te sporen 33 statuscode 33 statuscode extraheren 277 waarden extraheren 276 antwoorden parseren Java-voorbeeld 276 API-aanroepen eerste aanroep 18 volgorde 271 archieven, vergadering 61

286

Index

B beheren, machtiging 67 berekenen, vergadergebruik 59 bestanden downloaden 47 uploaden 239 bestanden uploaden 239 BREEZESESSION in adapterklasse 272 from common-info 63 via common-info 25 met cookiebeheer 24 at logout 34 ongeldig maken 34 opslaan in JSP-sessie 273 in response header 25, 63 uit common-info 64 bronnen Adobe 7 Connect Enterprise 9 datum/tijdnotaties 10 Microsoft SQL Server 11 online 9 SCORM 11 webservices 10 XML 10 XPath 10 XSLT 10 bronnen voor ontwikkelaars 7

C common-info 89 browsertest 18 example 36 Java-voorbeeld 278 voor aanmelding 107 Connect Enterprise Web Services 13 Connect Enterprise-bronnen 9 conventies, typografische 11 cookiebeheer 23, 24 cursusmap 66 cursussen alle beschikbare weergeven 69 alle gebruikers weergeven 75 definitie 65 één gebruiker inschrijven 71 gebruikers uitschrijven 73 groep inschrijven 74

groep uitschrijven 75 meerdere gebruikers inschrijven 72 overzicht in studieprogramma 76 scores rapporteren 77 weergeven voor gebruiker 69 zoeken naar sco-id 68 cursussenmap 44 custom-field-update 97 custom-fields 92 custom-fields-delete 95

D datum/tijdnotaties 10 deelnemers gelijktijdig 60 toevoegen 54 downloaden Adobe-bronnen 8 bestanden 47

E e-mail, verzenden naar nieuwe gebruikers 38 één gebruiker inschrijven 71 externe verificatie vergaderingen starten 63 verificatiefilter 28

F filters definitie 20 syntaxis 249 verificatie 28 voorbeeld van aanroep 20 voorbeelden 20 firstapp, voorbeeld 9, 271 Flash Media Server 17 foutbericht parseren 33 foutrespons, parseren 277

G gasten, vermelden 37 gebeurtenissenmap 44 gebruik, vergadering 59

gebruikers alle groepen vermelden 42 bijwerken 39 hoogste score rapporteren 77 inschrijven 70 inschrijvingen weergeven 75 lidmaatschap van groep controleren 41, 42 maken 38 maken zonder e-mailadres 38 principal-id zoeken 36 toevoegen aan groepen 40 toevoegen aan vergaderingen 51 training weergeven 69 uitnodigen voor vergaderingen 56 uitschrijven uit cursussen of studieprogramma's 73 vergaderingen weergeven 51 vergaderuitnodigingen verzenden 57 verwijderen uit vergaderingen 58 voortgang van studieprogramma weergeven 76 gebruikers bijwerken 39 gebruikers uitschrijven uit cursussen of studieprogramma's 73 gebruikersinformatie ophalen 278 weergeven 278 gedeelde mappen 44 Gedeelde training, map 66 gegevensstroom aangepaste toepassingen 16 Connect Enterprise-toepassingen 16 diagram 14 gecodeerd of ongecodeerd 14 geïntegreerde groepen 36 gelijktijdige deelnemers aan vergaderingen 60 groepen controleren of gebruikers deel uitmaken van 41, 42 gebruikers toevoegen 40 geïntegreerd 36 inschrijven voor cursussen of studieprogramma's 74 lijst van, voor gebruiker 42 maken 40 principal-id zoeken 36 uitschrijven uit cursussen of studieprogramma's 75 group-membership-update gedefinieerde 101 in trainingstoepassingen 65

Index

287

H

M

handelingen aanmelden 274 common-info 18, 278 principal-update 38 report-my-meetings 280 sco-info 283 sco-sneltoetsen 44, 276 sco-update 281 HeaderAuthenticationFilter 28 huidige gebruiker, principal-id van 36

machtigingen 47 controleren voor principal 48 controleren voor SCO 48 definitie 260 ingeschreven persoon 66 instelling voor vergaderingen 282 Trainingsbibliotheek 66 machtigingen voor ingeschreven personen 66 Machtigingen voor trainingsbibliotheek 66 maken aangepaste velden 39 aangepaste vergaderingen 55 gebruikers 38 groepen 40 nieuwe gebruiker zonder e-mailadres 38 nieuwe gebruikers 38 openbare vergaderingen 54 privé-vergaderingen 55 URL voor vergaderruimte 52 vergaderingen 53 meerdere gebruikers inschrijven 72 Microsoft SQL Server 11, 17 my-content, map 44 my-courses, map 44 my-events, map 44 my-meeting-templates, map 44 my-meetings, map 44

I icon, kenmerk 257 inhoudsmap 44 interacties 180 invalid, statuscode 33

J Javascript, URL van vergaderruimte openen 63, 64

K kenmerken access 255 icon 257 lang 258 object-type 258 permission-id 52, 67, 260 status 264 time-zone-id 265 type 267 koppelingen naar Connect Enterprise-bronnen 9

N nieuwe acties 79 no-access, statuscode 33 no-data, statuscode 33

O L lang, kenmerk 258 learning-path-info 103 learning-path-update 105 login actie 107 logout actie 109

288

Index

object-type, kenmerk 258 onderdelen 17 Flash Media Server 17 SQL Server-database 17 webtoepassingsserver 17 ongecodeerde gegevensstroom 14 ontwikkelomgeving 8 openbare vergaderingen gebruikers verwijderen uit 58 maken 53 opiniepeilingen, resultaten 62

P

R

parameters met verschillende namen 47, 271 parseren, antwoorden fouten opsporen 33 met XPath 32 permission-id 260 afgewezen 67 manage 67 voor vergaderingen 52 view 67 permissions-info 110 permissions-reset 114 permissions-update 116 in trainingstoepassingen 65 in vergadertoepassingen 49 presentatoren, toevoegen 54 principal-id van huidige gebruiker 36 zoeken 35 principal-info 118 principal-list browsertest 19 gedefinieerde 122 principal-list-by-field 125 principal-update example 38, 39 gedefinieerde 130 voorbeeld 38 principals alle vermelden 37 definitie 35 machtigingen controleren 48 principal-id zoeken 35 typen 269 verwijderen 129 principals verwijderen 129 principals-delete 129 privé-vergaderingen gebruikers verwijderen uit 58 maken 53

report-active-meetings 134 report-bulk-consolidated-transactions gedefinieerde 136 in vergadertoepassingen 49 report-bulk-objects 139 report-bulk-questions 142 report-bulk-slide-views 145 report-bulk-users 147 report-course-status 150 report-curriculum-taker gedefinieerde 153 in trainingstoepassingen 66 report-meeting-attendance 158 report-meeting-concurrent-users 160 report-meeting-sessions 162 report-meeting-summary 165 report-my-courses 167 report-my-events 170 report-my-meetings gedefinieerde 172 Java-voorbeeld 280 in vergadertoepassingen 49 report-my-training gedefinieerde 176 in trainingstoepassingen 65 report-quiz-interactions gedefinieerde 180 in vergadertoepassingen 49 report-quiz-question-answer-distribution 183 report-quiz-question-distribution 186 report-quiz-question-response 188 report-quiz-summary 190 report-quiz-takers 193 report-quotas deelnemers aan vergaderingen controleren 60 gedefinieerde 197 report-sco-slides 199 report-sco-views 201 report-user-training-transcripts gedefinieerde 207 in trainingstoepassingen 66 report-user-trainings-taken gedefinieerde 203 in trainingstoepassingen 66 request URLs example 18 responses Set-Cookie 25, 34, 63 resultaten van opiniepeilingen 62

Q quizscores rapporteren 77 quizscores, rapporteren 77

Index

289

S SCO's definitie 35, 43 informatie opvragen over 46, 283 kenmerken 43 machtigingen controleren 48 niet objectgericht 272 typen 43, 268 URL maken 46 zoeken 43 zoeken zonder sco-id 45 SCO's (Shareable Content Objects). Zie SCO's sco-contents 210 sco-delete 214 sco-expanded-contents 216 sco-id definitie 43 zoeken voor cursus of studieprogramma 68 zoeken voor vergadering 49 sco-info gedefinieerde 219 Java-voorbeeld 283 sco-move 223 sco-nav 225 sco-search 227 sco-shortcuts 231 sco-sneltoetsen Java-voorbeeld 276 voorbeeld 44 sco-update gedefinieerde 234 Java-voorbeeld 281 in vergadertoepassingen 49 sco-upload 239 scores, rapporteren 77 SCORM 11 seminarsmap 44 Server, Flash Media 17 sessie, gedefinieerd 163 session, parameter 25 Set-Cookie after login 25, 63 after logout 34 shared-meeting-templates, map 45 sorteren definitie 20 syntaxis 251 voorbeeld van aanroep 20 SQL Server 11, 17

290

Index

status, element 261 status, kenmerk 264 statuscode, Java-voorbeeld 33, 277 statuskenmerk 70 studieprogramma's alle beschikbare weergeven 69 alle gebruikers weergeven 75 definitie 65 één gebruiker inschrijven 71 gebruikers uitschrijven 73 groep inschrijven 74 groep uitschrijven 75 informatie weergeven 75 meerdere gebruikers inschrijven 72 overzicht van alle cursussen in 76 resterend werk weergeven 76 scores rapporteren 77 status weergeven 70 voltooid werk weergeven 76 weergeven voor gebruiker 69 zoeken naar sco-id 68

T talen en aangepaste toepassingen 8 technische ondersteuning 10 time-zone-id, kenmerk 265 toegangsbeheerlijst (ACL) 47 toepassingen aangepast 8 aangepaste 16 Connect Enterprise 16 training, aanbevolen aanroepen 65 vergadering, aanbevolen aanroepen 49 voorbeeld 9, 271 toepassingsserver, web 17 toevoegen, gastheer 54 too-much-data, statuscode 33 training alle cursussen of studieprogramma's weergeven 69 cursussen 65 cursussen zoeken 67 interacties 180 machtigingen 66 machtigingen voor ingeschreven personen 66 studieprogramma's 65 studieprogramma's zoeken 67 weergeven voor gebruiker 69 trainingstoepassingen, aanbevolen aanroepen 65

transacties 59 type aangepaste velden 270 element 267 kenmerk 267 principals 269 SCO's 43, 268 typografische conventies 11

U uitnodigingen 57 URL voor vergaderruimte 52, 284 URL's aanvraag 274 maken voor SCO 46 vergaderruimte 52, 284 URLs request 18 user-accounts 242 user-content, map 44 user-courses, map 44 user-events, map 44 user-meetings, map 44 user-transcript-update 244 user-update-pwd 245

V veld, element 256 velden, aangepaste. Zie aangepaste velden vergaderarchieven 61 vergadergebruik, berekenen 59 vergaderingen aangepast 55 archieven weergeven 61 bijwerken 281 deelnemers toevoegen 54 deelnemers verwijderen 58 dubbele aanmeldingen voorkomen 63, 64 gastheer toevoegen 54 gebruik berekenen 59 gebruiker toevoegen 51 gebruikers uitnodigen 56 gelijktijdige deelnemers 60 machtigingen instellen 282 maken 53, 281 maken in Java 281 maken met sjabloon 55 openbaar 53, 54

presentator toevoegen 54 privé 53 resultaten van opiniepeilingen ophalen 62 sessies 163 starten met externe verificatie 63 starten voor deelnemer 63 starten voor gast 64 tijd per gebruiker 60 uitnodigingen verzenden 57 URL voor vergaderruimte maken 52, 284 vermelden in Java 279 vermelden voor gebruiker 280 weergeven 283 weergeven voor gebruiker 51 zoeken naar sco-id 49 vergaderingenmap 44 vergadertoepassingen, aanbevolen aanroepen 49 verificatie, extern 28, 63 vermelden gasten 37 principals 37 vergaderingen (Java-voorbeeld) 279 voorbeeldtoepassing 9, 271

W Web Services 13 web.xml, bestand voor instellen verificatiefilter 29 webtoepassingsserver 17 weergeven alle cursussen of studieprogramma's 69 cursussen in studieprogramma 76 gebruikersinformatie 278 informatie over een studieprogramma 75 status van cursus of studieprogramma 70 vergaderarchieven 61 vergaderingen 51 weergeven, machtiging 67

X XML-aanvragen, Java-voorbeeld 275 XML-bronnen 10 XML-document, aanvragen 31 XPath antwoorden parseren 32 bronnen 10 Java-voorbeeld 32 XSLT 10

Index

291

Z zip-bestanden, downloaden 47 zoeken principal-id 35 SCO zonder sco-id 45 vergadering sco-id 49

292

Index

2006 Adobe Systems Incorporated. Alle rechten voorbehouden. Werken met Adobe Connect Enterprise Web Services Als deze handleiding wordt

Recommend Documents