ADOBE ACROBAT CONNECT PRO 7 WEB SERVICES GEBRUIKEN

Transcriptie

1 ADOBE ACROBAT CONNECT PRO 7 WEB SERVICES GEBRUIKEN

2 2008 Adobe Systems Incorporated. Alle rechten voorbehouden. Adobe Acrobat Connect Pro 7 Web Services gebruiken Beschermd door V.S. Patenten ; ; ; ; ; ; ; ; ; en Patenten aangevraagd in de V.S. en in andere landen. 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, Adobe Connect, Adobe Captivate, Acrobat Connect, Authorware, Breeze en Flash zijn gedeponeerde handelsmerken of handelsmerken van Adobe Systems Incorporated in de Verenigde Staten en/of andere landen. Bijgewerkte informatie / aanvullende informatie over code van derden is beschikbaar op Op de akoestische echo-opheffing van RealDuplex berust copyright SPIRIT. Dit product bevat software die is ontwikkeld door de Apache Software Foundation ( Dit product bevat BSAFE- en/of TIPEM-software van RSA Security, Inc. Compressie en decompressie van Flash-video wordt mogelijk gemaakt door On2 TrueMotion-videotechnologie On2 Technologies, Inc. Alle rechten voorbehouden. Dit product bevat software die is ontwikkeld door de OpenSymphony Group ( Voor gedeelten is een licentie verleend door Nellymoser ( Voor de MPEG Layer-3-audiocompressietechnologie is een licentie verschaft door Fraunhofer IIS en THOMSON multimedia ( Sorenson Spark -technologie voor compressie en decompressie van video is onder licentie verstrekt door Sorenson Media, Inc. Thomson: de licentiehouder mag de gecomprimeerde MP3-audio in de software niet gebruiken voor in real-time uitgevoerde uitzendingen (via een aardse verbinding, satelliet, kabel of andere media), voor uitzendingen via internet of andere netwerken, zoals bijvoorbeeld, maar niet uitsluitend, intranetten, en voor toepassingen waarin audio tegen betaling of op aanvraag beschikbaar is voor andere apparaten dan computers (d.w.z. mobiele telefoons of set-topapparaten). De licentiehouder accepteert dat het gebruik van de software voor andere apparaten dan computers, zoals beschreven in dit document, onderhevig is aan de betaling van licentieroyalty's of andere bedragen aan derde partijen die houder kunnen zijn van de intellectuele eigendomsrechten met betrekking tot de MP3-technologie en dat Adobe geen royalty's of andere bedragen heeft betaald met betrekking tot de intellectuele eigendomsrechten van derde partijen voor dergelijk gebruik. Als de licentiehouder een MP3-decoder nodig heeft voor dergelijk gebruik op andere apparaten dan computers, is de licentiehouder verantwoordelijk voor het verkrijgen van de vereiste MP3-technologielicentie. 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 , bestaande uit commerciële computersoftware en documentatie bij commerciële computersoftware, zoals deze begrippen worden genoemd in 48 C.F.R of 48 C.F.R , al naar gelang hetgeen van toepassing is. Conform 48 C.F.R of 48 C.F.R tot en met , 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, CA , 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 uit 1974 (38 USC 4212) en lid 503 van de Rehabilitation Act uit 1973, zoals geamendeerd, en de bepalingen in 41 CFR deel 60-1 tot en met 60-60, en De clausule en regels betreffende positieve discriminatie die zijn opgenomen in de voorafgaande zin zullen worden opgenomen via verwijzing.

3 iii Inhoudsopgave Voordat u begint Tips en training Ontwikkelomgeving Aanvullend leermateriaal Conventies Hoofdstuk 1: Architectuur Gegevensstroom De API voor het eerst aanroepen Hoofdstuk 2: Aanmelding en aanvragen Aanmelden vanuit een toepassing Een aanvraag verzenden in een XML-document Een antwoord parseren met XPath Een foutbericht parseren Een gebruiker afmelden Hoofdstuk 3: Grondbeginselen Een principal-id zoeken Principals of gasten vermelden Gebruikers maken Gebruikers bijwerken Aangepaste velden maken Groepen maken SCO's zoeken Bestanden downloaden Machtigingen controleren Hoofdstuk 4: Vergaderingen Vergaderingen zoeken Vergaderingen weergeven URL's voor vergaderruimtes maken Vergaderingen maken Aangepaste vergaderingen maken Gebruikers uitnodigen voor vergaderingen Gebruikers verwijderen uit vergaderingen Vergadergebruik berekenen Vergaderquota's controleren Vergaderarchieven ophalen Resultaten van opiniepeilingen ophalen Vergaderingen starten met externe verificatie Compatibiliteitsinstellingen configureren

4 iv Hoofdstuk 5: Training Machtigingen voor trainingsbibliotheek Cursussen en studieprogramma's zoeken Een cursus maken De training van een gebruiker weergeven Eén gebruiker inschrijven Een groot aantal gebruikers inschrijven Informatie over een studieprogramma weergeven Scores rapporteren Hoofdstuk 6: Actiereferentie Nieuwe en verwijderde acties account-expiry-info acl-field-info acl-field-list acl-field-update acl-preference-update common-info custom-fields custom-fields-delete custom-field-update expiry-settings-info expiry-settings-update group-membership-update learning-path-info learning-path-update limited-administrator-permissions info limited-administrator-permissions-update login logout meeting-disclaimer-info meeting-disclaimer-update meeting-feature-update permissions-info permissions-reset permissions-update principal-info principal-list principal-list-by-field principals-delete principal-update quota-threshold-info quota-threshold-exceeded quota-threshold-update report-active-meetings report-bulk-consolidated-transactions report-bulk-objects report-bulk-questions report-bulk-slide-views

5 v report-bulk-users report-course-status report-curriculum-taker report-meeting-attendance report-meeting-concurrent-users report-meeting-sessions report-meeting-summary report-my-courses report-my-events report-my-meetings report-my-training report-quiz-interactions report-quiz-question-answer-distribution report-quiz-question-distribution report-quiz-question-response report-quiz-summary report-quiz-takers report-quotas report-sco-slides report-sco-views report-user-trainings-taken report-user-training-transcripts sco-contents sco-delete sco-expanded-contents sco-info sco-move sco-nav sco-search sco-search-by-field sco-shortcuts sco-update sco-upload user-accounts user-transcript-update user-update-pwd Hoofdstuk 7: Filter- en sorteringsreferentie filter-definition sort-definition

6 vi Hoofdstuk 8: Algemene referentie access feature-id field icon lang object-type path-type permission-id quota-id status status attribute time-zone-id type Hoofdstuk 9: Een voorbeeldtoepassing Een adapterklasse samenstellen De gebruiker aanmelden XML-aanvragen verzenden XML-antwoorden parseren Gebruikersinformatie weergeven De vergaderingen van een gebruiker vermelden Vergaderingen maken en bijwerken Vergaderinggegevens weergeven

7 1 Voordat u begint Adobe Acrobat Connect Pro en Adobe Acrobat Connect Pro Server 7 beschikken over webservices die clients kunnen oproepen om gegevens uit te wisselen met Acrobat Connect Pro-accounts. In deze gids wordt uitgelegd hoe een toepassing XML API-aanroepen verzendt naar Acrobat Connect Pro en het XMLantwoord interpreteert. Deze gids is bedoeld voor ontwikkelaars die aangepaste toepassingen willen samenstellen voor Acrobat Connect Pro of die Acrobat Connect Pro willen integreren met een ander systeem, zoals een LMS of een LDAPdirectoryservice. 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 werken met 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 plug-ins. U vindt hier zelfstudiemateriaal, SDK's, scripthandleidingen en voorbeeldcode plus forums, RSS-feeds, onlineseminars en andere bronnen van technische informatie. 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 uit te wisselen, 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, plug-ins 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 plug-ins van externe ontwikkelaars, waarmee u taken kunt automatiseren, workflows kunt aanpassen, speciale professioneel ogende effecten tot stand kunt brengen, enz.

8 2 Ontwikkelomgeving U kunt in Acrobat Connect Pro 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. Het volgende kan 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 Acrobat Connect Pro retourneert te vergemakkelijken. Een functie voor het weergeven van HTTP-headers voor aanvragen en antwoorden in een browser. Dergelijke functies zijn wijd beschikbaar op internet. Aanvullend leermateriaal Op internet vindt u vele nuttige bronnen die informatie verschaffen over Acrobat Connect Pro, webservices en XML en over andere technologieën die door Acrobat Connect Pro worden gebruikt. Acrobat Connect Pro Acrobat Connect Pro Resource Center Het bronnencentrum op de Adobe-website wordt regelmatig bijgewerkt met zelfstudies, simulaties, informatie over beste werkwijzen en koppelingen naar procedures. Acrobat Connect Pro Developer Center Het centrum voor ontwikkelaars is bijzonder nuttig voor ontwikkelaars. Het wordt regelmatig bijgewerkt met zelfstudies en artikelen over het samenstellen van toepassingen voor Acrobat Connect Pro. Acrobat Connect Pro Documentation Center In het documentatiecentrum hebt u toegang tot alle productinformatie over Acrobat Connect Pro en kunt u deze downloaden of weergeven. Acrobat Connect Pro Support Center Als u technische ondersteuning nodig hebt, vindt u in het ondersteuningscentrum de meest recente informatie, zoals technische notities, Acrobat Connect Pro-presentaties en details over het ondersteuningsprogramma. U kunt ook de ondersteuningsforums raadplegen voor discussies met gelijkgestemden over technische problemen. Acrobat Connect Pro Licensed Support Center Het ondersteuningscentrum voor gebruikers met een licentie beschikt over documentatie en andere bronnen voor klanten die over een licentie voor Adobe Connect Pro Server 7 beschikken. 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 XSLtransformaties. U gebruikt deze transformaties om XML-gegevens 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 datumen tijdnotatie ISO 8601.

9 3 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 ( 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 Acrobat Connect Pro. Microsoft SQL Server Acrobat Connect Pro 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. 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: &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: Syntaxiselementen in blauw verwijzen naar definities die u samenstelt, met een hyperlink naar de syntaxis van de definitie.

10 4 Hoofdstuk 1: Architectuur Welkom bij Adobe Acrobat Connect Pro Web Services, de webservicelaag die zich boven Adobe Acrobat Connect Pro Server 7 en de Acrobat Connect Pro-suite van toepassingen bevindt. Web Services biedt u de mogelijkheid portals of webtoepassingen te maken waarin Acrobat Connect Pro-functiesen -rapportagegegevens worden geïntegreerd met systemen van derden, zoals portals en CRM- en ERP-systemen. Training Events Presenter Meeting API's en SDK's Acrobat Connect Pro Server Via de XML API van Acrobat Connect Pro 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 een integraal deel vormt van uw bedrijfsprocessen. U kunt dan met Web Services een toepassing schrijven voor het synchroniseren van de gebruikers in uw systeem en in Acrobat Connect Pro. 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 Acrobat Connect Progebruikers en vervolgens binnen de opslagplaats voor gebruikers van Acrobat Connect Pro de gevraagde updates uit te voeren, zoals gebruikers of groepen toevoegen of verwijderen. Dit is slechts één voorbeeld van een aangepaste toepassing. Bezoek het Acrobat Connect Pro Developer Center voor meer voorbeelden.

11 5 Gegevensstroom In het volgende diagram worden de gegevensstromen tussen clienttoepassingen en Acrobat Connect Pro weergegeven. De aangepaste toepassingen die u schrijft, gebruiken de paden die lopen van 1 naar 2 en van A naar B. Acrobat Connect Pro-toepassingen (zoals Adobe Acrobat Connect Pro, Acrobat Connect Pro Training of Acrobat Connect Pro Events) kunnen alle gegevensstroompaden gebruiken. Clienttoepassing Acrobat Connect Pro Server Webbrowser 1 A C RTMPS:443 Certificeringsinstantie 2 B D Web Services API Web-/ toepassingsserver Flash Player 3 RTMP: Flash Media Server 3a RTMPT:80 4a SQL-database De gegevensstroom tussen Acrobat Connect Pro en clienttoepassingen De gegevensstroom kan gecodeerd zijn met SSL of ongecodeerd. 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 Adobe Acrobat Connect Pro vergadering- of inhouds-url aan via poort (de verbindingspaden kunnen variëren). 2 De webserver reageert met een inhoudsoverdracht of voorziet de clientbrowser van informatie waarmee deze toegang kan krijgen tot Adobe Acrobat Connect Pro. 3 Adobe Flash Player vraagt een verbinding aan naar Adobe Flash Media Server via RTMP:1935 en 4 Flash Media Server antwoordt en er wordt een permanente verbinding geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser. 3a (alternatief) 4a (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. Flash Media Server antwoordt en er wordt een verbinding door een tunnel geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser.

12 6 Gecodeerd Als de gegevensstroom gecodeerd is, worden er als volgt beveiligde verbindingen via HTTPS en RTMPS (Real Time Messaging Protocol via SSL) tot stand gebracht. A B C D De clientwebbrowser vraagt een beveiligde vergadering- of inhouds-url aan via een gecodeerde verbinding op (de verbindingspaden kunnen variëren). De web- of toepassingsserver reageert met de overdracht van gecodeerde inhoud of voorziet de client van informatie voor het maken van een gecodeerde verbinding met Acrobat Connect Pro. Flash Player vraagt een gecodeerde verbinding aan naar Flash Media Server via RTMPS:443. Flash Media Server antwoordt en er wordt een permanente verbinding geopend voor het stroomsgewijs verzenden van vergaderverkeer naar de browser. Aangepaste toepassingen Acrobat Connect Pro Web Services biedt een XML API, dus uw toepassing moet in staat zijn te communiceren met Acrobat Connect Pro Server 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 Acrobat Connect Pro-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 Acrobat Connect Prowebtoepassingsserver, de SQL-database en weer terug. De gegevensstroom tussen een aangepaste toepassing en Acrobat Connect Pro loopt als volgt: 1 Een gebruiker opent uw aangepaste toepassing vanuit een webbrowser. 2 De toepassing roept de XML API aan via of 3 De Acrobat Connect Pro-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 web- of 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 inhouds-url. Nu opent de gebruiker een Acrobat Connect Pro-toepassing om een vergaderruimte binnen te gaan en komt er een gegevensstroom op gang tussen de Acrobat Connect Pro-toepassing en de server. Acrobat Connect Pro-toepassingen De Acrobat Connect Pro-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, 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 Adobe Connect Pro voor meer informatie). Stroomsgewijze communicatie in real-time vanaf Flash Media Server vindt plaats via RTMP-poort Deze stroomsgewijze communicatie kan bestaan uit audio, video (webcam en FLV), het delen van bestanden en chat. Ook de status van de vergadering wordt bijgehouden via RTMP-poort Onderdelen van Acrobat Connect Pro Acrobat Connect Pro is opgebouwd uit twee serveronderdelen en elke server maakt gebruik van een SQL-database.

13 7 De webtoepassingsserver De webtoepassingsserver is het brein van Acrobat Connect Pro. 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 Acrobat Connect Pro Central 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 houdt geen status bij, wat betekent dat schaling vrijwel lineair is. Flash Media Server Flash Media Server zorgt voor de spierkracht van Acrobat Connect Pro. Flash Media Server verzendt audio- en videogegevens en intensieve media-inhoud stroomsgewijs via RTMP. Wanneer er een vergadering wordt opgenomen en afgespeeld, audio- en videogegevens worden gesynchroniseerd of inhoud wordt geconverteerd en gecodeerd voor schermdeling in real-time, 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. De SQL-database Acrobat Connect Pro maakt gebruik van de Microsoft SQL Server-database voor permanente opslag van metagegevens over transacties en toepassingen, waaronder gegevens over gebruikers, groepen, 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 De API voor het eerst aanroepen Acrobat Connect Pro 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 door de API-servlet wordt afgehandeld. Een aanvraag-url heeft een handelingnaam en parameters in naam-waardeparen. Hier ziet u een voorbeeld: Als u toegang hebt tot een Acrobat Connect Pro-account waarmee u API-aanroepen kunt testen, kunt u experimenten uitvoeren. Het wordt zelfs aangeraden 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 HTTP-headers 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 HTTP-headers in. 2 Open een browser en ga naar de aanmeldingspagina van Acrobat Connect Pro. 3 Meld u niet aan, maar verwijder het gedeelte van de URL na de domeinnaam en voeg een aanroep toe voor 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" /> <common locale="en" time-zone-id="85"> <cookie>breezbryf9ur23mbokzs8</cookie> <date> t01:21: :00</date> <host> <local-host>abc123def789</local-host>

14 8 <url>/api/xml?action=common-info</url> <version>connect_700_r641</version> <user-agent> Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;.NET CLR ) </user-agent> </common> 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 aangevraagd via common-info, voegt de browser deze waarde toe bij uw volgende aanvraag aan de aanvraagheader. 1 Meld u aan bij Acrobat Connect Pro in een webbrowser. Wijzig de URL in de browser zodanig dat deze principallist aanroept: 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 ) 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"> <name>joe harrison</name> <login>jharrison@example.com</login> < >jharrison@example.com</ > </principal> <principal principal-id="624550" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>bob jones</name> <login>bjones@example.com</login> < >bjones@example.com</ > </principal>... </principal-list> 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: filter-name=jazz doe (hiermee worden alleen de resultaten geretourneerd die exact overeenkomen met de tekst jazz doe) filter-like-name=jazz (hiermee worden alle resultaten geretourneerd die de tekst jazz bevatten) filter-out-type=user (hiermee worden alle resultaten geretourneerd die niet van het type user zijn)

15 9 Dit zijn slechts een paar filtertypen. Meer voorbeelden kunt u vinden bij filter-definition. Zoek een actie op in de referentielijst (in ''Actiereferentie'' op pagina 53) om na te gaan of het antwoord van een actie 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: sort-name=asc (hiermee sorteert u gegevens in oplopende volgorde op name) 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 sort-definition. 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: &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: Nu wordt slechts één groep geretourneerd: <status code="ok" /> <principal-list> <principal principal-id=" " account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>developers</name> <login>developers</login> </principal> </principal-list> 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 ''Actiereferentie'' op pagina 53 ''Aanmelding en aanvragen'' op pagina 10 voor informatie over de manier waarop gebruikers kunnen worden aangemeld vanuit toepassingen ''Grondbeginselen'' op pagina 18 om te leren welke drie basisconcepten ten grondslag liggen aan de API ''Vergaderingen'' op pagina 29 als u vergaderingen wilt maken en beheren vanuit een toepassing ''Training'' op pagina 43 als u een trainingstoepassing maakt

16 10 Hoofdstuk 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 Acrobat Connect Pro Web Services of die is geïntegreerd met een systeem van derden, moet een gebruiker aanmelden bij Adobe Acrobat Connect Pro Server 7 of bij een Adobe Acrobat Connect Pro-account op een hostserver. In zijn meest eenvoudige vorm bestaat het aanmeldingsproces uit het aanroepen van de actie 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 Acrobat Connect Pro plaatsvindt of extern wordt uitgevoerd. Afhankelijk van de omgeving en de serverconfiguratie waarmee u werkt, kunt u ook een combinatie van deze opties gebruiken. Cookiebeheer Wanneer een gebruiker zich aanmeldt, retourneert Acrobat Connect Pro een cookie waarmee de sessie van de gebruiker 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 afmeldt, zorgt de server ervoor dat het cookie verloopt en moet u het cookie ongeldig maken. In uw ontwikkelomgeving 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. Een server met een licentie of een account op een hostserver Mogelijk beschikt uw organisatie over een Acrobat Connect Pro Server met een licentie binnen de firewall of over een Acrobat Connect Pro-account op een hostserver 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, kunt u in combinatie met de actie login bepaalde parameters gebruiken waarmee u kunt voorkomen dat gebruikers-id's en wachtwoorden via internet worden verzonden. Rechtstreekse of externe verificatie Of u nu een account op een hostserver hebt of beschikt over een licentie, in beide gevallen is verificatie noodzakelijk. U kunt uw toepassing rechtstreeks laten verifiëren door Acrobat Connect Pro, maar u kunt gebruikers ook op uw eigen netwerk verifiëren, een id in een HTTP-aanvraagheader plaatsen en deze header naar Acrobat Connect Pro verzenden. Hoe het aanmeldingsproces verloopt, is afhankelijk van de vraag of u rechtstreekse of externe verificatie gebruikt. Aanmelden bij Acrobat Connect Pro Server De standaardtechniek voor het aanmelden van een gebruiker bij Acrobat Connect Pro 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. Opmerking: wanneer u een gebruikerswachtwoord naar Acrobat Connect Pro Server verzendt, kunt u het beste SSL gebruiken om ervoor te zorgen dat de wachtwoorden gecodeerd zijn tijdens de overdracht, zelfs als u Acrobat Connect Pro Server met een licentie binnen uw eigen firewall gebruikt.

17 11 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: &password=football 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: 2 Extraheer de waarde van het cookie uit het antwoord: <cookie>breezxq66rt43poai3if8</cookie> 3 Meld de gebruiker aan en geef daarbij de waarde van het cookie op: &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: &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 een Acrobat Connect Pro-account op een hostserver Ook als u zich rechtstreeks wilt aanmelden bij een Acrobat Connect Pro-account 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. Als u een Acrobat Connect Pro-account op een hostserver hebt, kunt u niet gebruikmaken van eenmalige aanmelding of externe verificatie. U moet de verificatiereferenties van de gebruiker voor de Acrobat Connect Pro-account op de hostserver doorgeven en niet de referenties voor een extern netwerk. Opmerking: het is belangrijk dat u SSL inschakelt voor de Acrobat Connect Pro-account op de hostserver omdat u gebruikers-id's, wachtwoorden en accountgegevens via internet naar uw Acrobat Connect Pro-account op een hostserver bij Adobe verzendt. Met een account-id aanmelden bij een Acrobat Connect Pro-account op een hostserver 1 Voordat u de gebruiker aanmeldt, roept u common-info aan met de domeinnaam van uw Acrobat Connect Proaccount op de hostserver in de aanvraag-url of de parameter domain: Parseer het antwoord om de waarden van cookie en account-id op te vragen:

18 12 <cookie>sbreezzd2dfr2ua5gscogv</cookie>... <account account-id="295153" /> 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: &password=happy&account-id=295153&session=sbreezzd2dfr2ua5gscogv 5 Parseer het antwoord om na te gaan of de statuscode ok is. 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. Raadpleeg Aanmelden met cookiebeheer of Aanmelden met de session-parameter voor meer informatie. Met een domeinnaam aanmelden bij een Acrobat Connect Pro-account op een hostserver 1 Voordat u de gebruiker aanmeldt, roept u common-info aan met de domeinnaam van uw Acrobat Connect Proaccount op de hostserver in de aanvraag-url of de parameter domain: Parseer het antwoord om de waarden van cookie en host op te vragen: <cookie>breezxq66rt43poai3if8</cookie>... <host> 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 van de gebruiker voor de Acrobat Connect Pro-account op de hostserver gebruikt en geen externe id. 5 Roep login aan, waarbij u de referenties van de gebruiker en de parameters domain en session toevoegt: &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 Parseer het antwoord om na te gaan of de statuscode ok is. 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 Opmerking: de instructies in deze sectie zijn alleen van toepassing op Acrobat Connect Pro 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 Acrobat Connect Pro Server, zonder expliciet een gebruikers-id en wachtwoord voor Acrobat Connect Pro Server door te geven. (Raadpleeg de Installatie- en configuratiegids voor Adobe Acrobat Connect Pro voor gedetailleerde instructies voor het installeren en configureren van HTTP-headerverificatie.)

19 13 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ïdentificeerd of configureert u een proxyserver om de header toe te voegen. Het verificatiefilter op Acrobat Connect Pro (met de naam HeaderAuthenticationFilter) converteert uw gebruikersidentificatie naar een aanmeldings-id voor Acrobat Connect Pro en verifieert de gebruiker. Verificatieserver Proxyserver Verificatiefilter Acrobat Connect Pro Server SQL-database Verificatiefilters zetten externe verificatiereferenties om in Acrobat Connect Pro-referenties. Externe verificatie wordt toegevoegd aan de standaardverificatie van Acrobat Connect Pro. Iedere gebruiker die toegang wil tot Acrobat Connect Pro Server heeft geldige aanmeldingsgegevens en een geldig wachtwoord voor Acrobat Connect Pro Server nodig. Wanneer u een aanmeldingsaanvraag naar Acrobat Connect Pro Server verzendt met een externe-verificatiereferentie, wordt de volgende procedure uitgevoerd: Het verificatiefilter onderschept de aanvraag en controleert of er een gebruiker op Acrobat Connect Pro 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 Acrobat Connect Pro 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 Acrobat Connect Pro Server. Als de gebruiker zich met succes aanmeldt, werkt Acrobat Connect Pro 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 Acrobat Connect Pro Server een ext-login-veld met overeenkomende gegevens en hoeft de gebruiker zich niet aan te melden bij Acrobat Connect Pro. Als de gebruiker zich niet kan aanmelden, heeft hij of zij geen toegang tot toepassingen, inhoud of vergaderingen van Acrobat Connect Pro Server. Hier volgen de stappen die u moet uitvoeren om login aan te roepen wanneer u HTTP-headerverificatie gebruikt. Aanmelden bij Acrobat Connect Pro Server met HTTP-headerverificatie 1 Configureer uw netwerkservers en Acrobat Connect Pro Server voor HTTP-headerverificatie volgens de instructies in de Installatie- en configuratiegids voor Acrobat Connect Pro. 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: <filter-mapping> <filter-name>headerauthenticationfilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <!-- <filter-mapping> <filter-name>ntlmauthenticationfilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> -->

20 14 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 en willekeurige Acrobat Connect Pro-toepassingen gebruikt Gebruik in het element filter voor HeaderAuthenticationFilter commentaarcodes om het element init-param uit te schakelen met de param-value /api/: <!-- <init-param> <param-name>ignore-pattern-0</param-name> <param-value>/api/</param-value> </init-param> --> Als uw toepassing alleen de XML API gebruikt Wijzig het element filter-mapping voor uw filtertype om het URLpatroon /api/* te gebruiken in plaats van /*: <filter-mapping> <filter-name>headerauthenticationfilter</filter-name> <url-pattern>/api/*</url-pattern> </filter-mapping> Voeg vervolgens in het element filter voor uw filtertype commentaarcodes toe rond alle init-paramelementen met de param-name ignore-pattern-x: <filter> <filter-name>headerauthenticationfilter</filter-name> <filter-class> com.macromedia.airspeed.servlet.filter.headerauthenticationfilter </filter-class> <!-- <init-param> <param-name>ignore-pattern-0</param-name> <param-value>/api/</param-value> </init-param>... <init-param> <param-name>ignore-pattern-4</param-name> <param-value>/servlet/testbuilder</param-value> </init-param> --> </filter> 4 Configureer Acrobat Connect Pro 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 Acrobat Connect Pro voor nadere informatie). Het veld ext-login heeft standaard dezelfde waarde als login, de aanmeldings-id van Acrobat Connect Pro Server. 5 Als uw systeem de gebruiker eenmaal heeft geverifieerd, maakt u een login-aanvraag. Voeg de parameter externalauth=use toe, maar niet de parameter login of password: 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 HTTP-headerwaarde in te stellen. Zie de Installatie- en configuratiegids voor Acrobat Connect Pro voor informatie over deze zaken. 7 Parseer het antwoord om na te gaan of de statuscode ok is. 8 Verwerk de cookiewaarde BREEZESESSION die in de antwoordheader is geretourneerd. Dit kunt u op twee manieren doen.

21 15 Als u een clientbibliotheek gebruikt die cookies beheert 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 de cookies zelf beheert Haal de waarde van het BREEZESESSION-cookie op uit de antwoordheader: Sla deze waarde op en stuur deze weer terug naar de server in de parameter session van alle volgende acties die u aanroept voor dezelfde gebruiker, zolang de sessie van de gebruiker geldig is: Zorg ervoor dat u de cookiewaarde niet opnieuw gebruikt wanneer de sessie van de gebruiker is beëindigd. Een aanvraag verzenden in een XML-document 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 param-elementen voor de actienaam en elke parameter: <params> <param name="action">login</param> <param name="login">jon@doe.com</param> <param name="password">foobar</param> </params> 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. 2 Schrijf code die een HTTP-POST-aanvraag naar Acrobat Connect Pro verzendt en een XML-antwoord ontvangt. De specifieke code die u moet schrijven, is afhankelijk van de programmeertaal en de ontwikkelomgeving die ugebruikt. 3 Verzend in de code die u schrijft het XML-document naar Acrobat Connect Pro in de hoofdtekst van de HTTP-POSTaanvraag. Neem het XML-document op in de aanvraag. Zorg ervoor dat u een content-type-header instelt op text/xml of application/xml. Een antwoord parseren met XPath Wanneer u een XML-antwoord van Acrobat Connect Pro ontvangt, moet u het kunnen parseren om de benodigde XMLelementen 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 meerdere acties aanroept. Maak een instantie van de Xpath-klasse, zodat u de Xpathexpressies kunt gebruiken. Roep de acties aan, lees het XML-antwoord 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);

22 16 } 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. 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. no-data Hiermee wordt aangegeven dat er voor de actie geen gegevens beschikbaar zijn om te retourneren, terwijl de actie gewoonlijk wel gegevens retourneert. too-much-data Geeft aan dat de actie één resultaat zou moeten hebben opgeleverd, maar dat er in feite meerdere resultaten zijn geretourneerd. 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"> <invalid field="has-children" type="long" subcode="missing" /> </status> 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 status in de API-referentie. Uw toepassing moet statuscodes en subcodes kunnen lezen en verwerken.

23 17 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(); } 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 Acrobat Connect Pro 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 29 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 :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: 2 Parseer het antwoord om na te gaan of de statuscode ok is en of 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; }

24 18 Hoofdstuk 3: Grondbeginselen Nu u de architectuur van Adobe Acrobat Connect Pro begrijpt en weet hoe u een API-aanroep in een browser kunt testen, kunt u XML API-aanvragen verzenden en de antwoorden analyseren. U dient drie belangrijke concepten te begrijpen om te kunnen werken met Acrobat Connect Pro Web Services: Principals, dit zijn gebruikers en groepen. SCO's, dit zijn Shareable Content Objects (inhoudsobjecten voor gemeenschappelijk gebruik), en deze vertegenwoordigen vergaderingen, cursussen en vrijwel alle inhoud die kan worden gemaakt in Acrobat Connect Pro. 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 acties principals kunnen uitvoeren op objecten. In dit hoofdstuk worden de standaardtaken beschreven die u met Web Services kunt uitvoeren, ongeacht de Acrobat Connect Pro-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. Acrobat Connect Pro beschikt bovendien over de volgende geïntegreerde groepen: Beheerders, Beperkte beheerders, Auteurs, Trainingsmanagers, Gebeurtenismanagers, Studenten, 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. Opmerking: uw account bepaalt welke geïntegreerde groepen beschikbaar zijn. Elke Acrobat Connect Pro-gebruiker en -groep heeft een principal-id. In sommige API-aanroepen 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 actie controleren in ''Actiereferentie'' op pagina 53. De principal-id van een gebruiker of groep opvragen 1 Roep principal-list aan met een filter: doe U kunt het beste filter-name, filter-login of filter- 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=" " account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>jazz doe</name> <login>jazzdoe@example.com</login> < >jazzdoe@newcompany.com</ > </principal>

25 19 De principal-id van de huidige gebruiker opvragen 1 Roep common-info aan nadat de gebruiker zich heeft aangemeld: 2 Parseer de gebruikerselementen in het antwoord voor de user-id: <user user-id=" " type="user"> <name>jazz doe</name> <login>jazz@doe.com</login> </user> Hier wordt de principal-id de user-id genoemd, omdat deze altijd een gebruiker vertegenwoordigt die is geverifieerd voor Acrobat Connect Pro. Een groep kan zich niet aanmelden bij de server. U kunt de user-idwaarde doorgeven als een principal-id in andere acties. Principals of gasten vermelden Een principal met het type user is een geregistreerde Acrobat Connect Pro-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: Deze aanroep geeft alle Acrobat Connect Pro-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=" " account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>jazz doe</name> <login>jazzdoe@example.com</login> < >jazzdoe@newcompany.com</ > </principal> Alle gasten op de server vermelden 1 Roep report-bulk-users aan en filter op een type gast: 2 Parseer de row-elementen in het antwoord: <row principal-id=" "> <login>joy@acme.com</login> <name>joy@acme.com</name> < >joy@acme.com</ > <type>guest</type> </row> Alle gebruikers vermelden die rapporteren aan een bepaalde manager Als u principal-info aanroept met een principal-id, wordt de principal weergegeven in het antwoord. Als de principal een gebruiker is aan wie een manager is toegewezen in Acrobat Connect Pro, bevat het antwoord ook gegevens over de manager van de principal in een manager-element: <manager account-id="624520" disabled="" has-children="false" is-hidden="false" isprimary="false" principal-id=" "type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name>

26 20 <first-name>jazz</first-name> <last-name>doe</last-name> <x >23456</x > <x >chicago</x > </manager> U kunt de principal-id van de manager gebruiken met principal-list om alle gebruikers te vermelden die aan de manager zijn toegewezen. 1 Roep principal-list aan en filter daarbij op manager-id: 2 Parseer het antwoord voor de principal-elementen: <principal principal-id=" " account-id="624520" type="user" haschildren="false" is-primary="false" is-hidden="false" manager-id=" "> <name>pat Lee</name> <login>plee@mycompany.com</login> < >plee@mycompany.com</ > </principal> Gebruikers maken U hebt beheerdersrechten nodig om een nieuwe gebruiker te maken. Het is verstandig een gebruiker te maken die deel uitmaakt van de groep admins van uw toepassing om API-aanroepen te kunnen uitvoeren waarvoor beheerdersrechten zijn vereist. Een nieuwe gebruiker maken en een welkomst 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: &first-name=jazz&last-name=doe&login=jazz99@doe.com&password=hello &type=user&send- =true&has-children=0& =jazz99@doe.com Het type moet user zijn, has-children moet 0 of false zijn, send- moet true zijn en voor moet een geldig adres zijn opgegeven. De server verzendt een welkomst met aanmeldingsgegevens naar het adres van de gebruiker. 3 Parseer het principal-element in het antwoord voor de principal-id van de gebruiker: <principal type="user" principal-id=" " has-children="0" account-id="624520"> <login>jammdoe@example.com</login> <ext-login>jammdoe@example.com</ext-login> <name>jamm doe</name> </principal> Een nieuwe gebruiker maken zonder een adres te gebruiken als aanmeldings-id 1 Navigeer in Acrobat Connect Pro Central naar Beheer > Gebruikers en groepen > Aanmeldings- en wachtwoordbeleid bewerken. Controleer of adres 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 &last-name=doe&login=jazz& =jazzdoe@company.com &password=nothing&type=user&has-children=0

27 21 4 Parseer het antwoord voor de principal-id van de nieuwe gebruiker: <principal type="user" principal-id=" " has-children="0" account-id="624520"> <login>jazzdoe@example.com</login> <ext-login>jazzdoe@example.com</ext-login> <name>jazz doe</name> </principal> 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 , login, first-name en last-name. Als u aangepaste velden hebt gedefinieerd voor de principal en deze wilt bijwerken, gebruikt u acl-field-update. 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. Standaardgebruikersinformatie 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 vragen (zie Een principalid zoeken ). 3 Roep principal-update aan om de gebruiker bij te werken: &principal-id= & =jazzdoe@newcompany.com 4 Parseer het antwoord om na te gaan of de statuscode ok is. Aangepaste veldwaarden voor een gebruiker bijwerken 1 Meld u aan als een gebruiker met beheerdersrechten. 2 Roep custom-fields aan om de field-id van het aangepaste veld op te vragen: 3 Vraag de principal-id, sco-id of account-id op die u wilt bijwerken. Deze waarde is de acl-id die u doorgeeft aan acl-field-update. 4 Roep acl-field-update aan om de waarde van het aangepaste veld bij te werken: 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. Als u het aangepaste veld hebt gedefinieerd, kunt u standaard de waarde instellen door de waarde te bewerken in Acrobat Connect Pro Central 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.

28 22 Een aangepast veld definiëren en dit instellen voor een gebruiker 1 Maak eerst het veld met 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 Acrobat Connect Pro-principals. 2 Parseer het field-element in het antwoord voor de veld-id: <field field-id=" " object-type="object-type-principal" display-seq="9" account-id="624520" is-primary="false" permission-id="manage" is-required="true" field-type="text"> <comments>test</comments> <name>country</name> </field> 3 Vraag 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, waarbij u een field-id, de principal-id van de gebruiker als acl-id en een waarde doorgeeft: &acl-id= &field-id= &value=san%20francisco 5 Parseer het antwoord om na te gaan of de statuscode ok is. 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 aan als de beheerder van uw toepassing. 2 (Optioneel) Als de gebruiker nog niet bestaat, maakt u deze met gebruik van principal-update: &first-name=jazzwayjazz&last-name=doe&login=jazz@doe.com &password=nothing&type=user&has-children=0 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: 5 Parseer het antwoord voor de principal-id: <principal principal-id=" " account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>joy Black</name> <login>joy@acme.com</login> < >joy@acme.com</ > </principal> 6 Roep principal-list nogmaals aan om de principal-id van de groep op te vragen: 7 Roep group-membership-update aan met is-member=true om de gebruiker aan de groep toe te voegen: &group-id= &principal-id= &is-member=true De principal-id is de principal-id van de gebruiker.

29 23 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: &filter-is-member=true&filter-like-name=bob 2 Parseer het antwoord voor een principal-element. 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"> <name>bill Jones</name> <login>bjones@acme.com</login> < >bjones@acme.com</ > <is-member>true</is-member> </principal> </principal-list> Als de gebruiker geen groepslid is, is het element principal-list leeg: <status code="ok" /> <principal-list /> Controleren welke gebruikers deel uitmaken van een groep 1 Als u de principal-id van de groep wilt opvragen, roept u principal-list aan met filters: &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=" " account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>developers</name> <login>developers</login> <is-member>false</is-member> </principal> 3 Roep principal-list nogmaals aan met de principal-id als een group-id en filter-is-member=true: &filter-is-member=true 4 Parseer het antwoord voor de principal-elementen: <principal principal-id=" " account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>bob Jones</name> <login>bobjones@acme.com</login> <is-member>true</is-member> </principal> Alle groepen vermelden waarvan een gebruiker deel uitmaakt 1 Roep principal-list aan met de principal-id van de gebruiker en filter-is-member=true: &principal-id= &filter-is-member=true

30 24 2 Parseer het antwoord voor de principal-elementen: <principal principal-id=" " account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>bob Jones</name> <login>bobjones@acme.com</login> <is-member>true</is-member> </principal> SCO's zoeken Alle objecten in Acrobat Connect Pro 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 Acrobat Connect Pro-account op een hostserver 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 acties zien: <sco account-id="624520" disabled="" display-seq="0" folder-id=" " icon="producer" lang="en" max-retries="" sco-id=" " 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 acties een sco-id genoemd, maar kan in andere acties 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 en een URL-pad (zoals /f /). 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. 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" /> <sneltoetsen> <sco tree-id="624530" sco-id=" " type="my-meeting-templates"> <domain-name> </sco> <sco tree-id="624530" sco-id=" " type="my-meetings">

31 25 <domain-name> </sco> <sco tree-id="624529" sco-id="624529" type="meetings"> <domain-name> </sco> <sco tree-id="624530" sco-id="624530" type="user-meetings"> <domain-name> </sco>... </shortcuts> 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: inhoud, cursussen, vergaderingen, gebeurtenissen, seminars Dit zijn gedeelde mappen, zoals Gedeelde vergaderingen, Gedeelde training, enzovoort. De Acrobat Connect Pro-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. user-content, user-meetings, user-courses, user-events 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). my-courses, my-events, my-meetings, my-meeting-templates, my-content 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. shared-meeting-templates Dit is een submap van de map Gedeelde vergaderingen die vergaderingssjablonen bevat en de machtigingen van de map Gedeelde vergaderingen overneemt. U kunt de inhoud van een willekeurige map weergeven om informatie over een specifieke SCO op te vragen. Wanneer u een SCO zoekt, maar niet over een sco-id beschikt, navigeert u met sco-shortcuts 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 Acrobat Connect Pro op te vragen: 2 Parseer het antwoord voor een type hoofdmap dat de SCO logisch gezien moet bevatten, dus bijvoorbeeld mycourses voor een cursus die de gebruiker heeft gemaakt. 3 Parseer het resulterende sco-element voor een sco-id: <sco tree-id=" " sco-id=" " type="my-courses"> <domain-name> </sco> 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: &sco-id= &filter-name=all About Web Communities U kunt kiezen uit verschillende typen filters: Een exacte-overeenkomstfilter op name of url-path (zoals filter-name of filter-url-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, datecreated 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.

32 26 5 Parseer het antwoord voor de sco-id: <sco depth="1" sco-id=" " folder-id=" " type="folder" icon="folder" lang="en" source-sco-id=" " display-seq="0" source-sco-type="14"> <name>a Day in the Life Resources</name> <url-path>/f /</url-path> <date-created> t14:47: :00</date-created> <date-modified> t14:47: :00</date-modified> </sco> Informatie opvragen over een SCO 1 Roep sco-info aan met de sco-id: 2 Parseer het antwoord voor name, url-path of een willekeurige andere waarde: <sco account-id="624520" disabled="" display-seq="0" folder-id=" " icon="curriculum" lang="en" max-retries="" sco-id=" " source-sco-id="" type="curriculum" version="0"> <date-begin> t14:45: :00</date-begin> <date-created> t14:47: :00</date-created> <date-modified> t14:47: :00</date-modified> <name>a Day in the Life</name> <url-path>/day/</url-path> </sco> De URL samenstellen voor een SCO 1 Roep sco-shortcuts aan: 2 Parseer het antwoord voor de domain-name-waarde in een willekeurig sco-element: <sco tree-id="624530" sco-id=" " type="my-meetings"> <domain-name> </sco> 3 Roep sco-info aan met de sco-id: 4 Parseer het antwoord voor het url-path-element: <sco account-id="624520" disabled="" display-seq="0" folder-id=" " icon="producer" lang="en" max-retries="" sco-id=" " source-sco-id="" type="content" version="1"> <date-created> t12:00: :00</date-created> <date-modified> t15:22: :00</date-modified> <name>test Quiz</name> <url-path>/quiz/</url-path> <passing-score>10</passing-score> <duration> </duration> <section-count>6</section-count> </sco> Zowel voor als achter het url-path staan schuine strepen. U kunt het url-path ontlenen aan report-mymeetings, report-my-training of aan andere aanroepen die het pad retourneren. 5 Voeg het url-path samen met de domain-name:

33 27 Bestanden downloaden U kunt ZIP-bestanden downloaden van Acrobat Connect Pro 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: U kent waarschijnlijk de domeinnaam van uw server al (bijvoorbeeld voorbeeld.nl). Als dat niet het geval is, kunt u de domeinnaam opvragen door sco-shortcuts aan te roepen. Een ZIP-bestand downloaden van de server 1 Roep sco-shortcuts aan: 2 Extraheer de waarde voor domain-name uit het antwoord: 3 Roep sco-info aan met de sco-id van het ZIP-bestand: 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=" " source-sco-id="" type="folder" version="1"> <date-created> t10:21: :00</date-created> <date-modified> t10:21: :00</date-modified> <name>joy@acme.com</name> <url-path>/f /</url-path> </sco> 5 Stel de download-url samen, bijvoorbeeld: Vergeet niet de afsluitende schuine streep voor de waarde uit het url-path te verwijderen voordat u.zip toevoegt (de waarde moet bijvoorbeeld /quiz.zip zijn, en niet /quiz/.zip).

34 28 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: De id van een principal (een principal-id). De ID van een SCO, account of principal waarop een actie 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: &principal-id= 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" /> <permission acl-id=" " permission-id="view" principal-id=" " /> 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: 2 Doorloop de principal-elementen en parseer deze voor permission-id-waarden: <principal principal-id=" " is-primary="false" type="user" has-children="false" permission-id="view"> <name>jay Arnold</name> <login>jay@example.com</login> </principal> De geldige machtigingswaarden worden vermeld in permission-id.

35 29 Hoofdstuk 4: Vergaderingen Met aangepaste toepassingen kunnen Adobe Acrobat Connect Pro-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 ''Een voorbeeldtoepassing'' op pagina 201). Als gebruikers op de URL van een vergaderruimte klikken, openen ze Acrobat Connect Pro, waarin de vergaderruimte wordt gehost. Acrobat Connect Pro Server verzendt dan audio, video en intensieve media-inhoud stroomsgewijs naar de gebruikers van de vergaderruimte. Adobe raadt de volgende acties aan voor vergadertoepassingen: report-my-meetings De vergaderingen van een gebruiker weergeven. sco-update 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 beheerdersmachtigingen nodig, zoals wordt vermeld in de taakinstructies. Maak een Acrobat Connect Pro-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. 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 mappenstructuur. De sco-id van een vergadering zoeken 1 Roep sco-shortcuts aan: 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> </sco> De mapnaam moet meetings, user-meetings or 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 voor een minder uitgebreid antwoord: &filter-type=meeting&filter-name=intro to Film Hoe specifieker de filters die u instelt, hoe beter. Nuttige filters zijn bijvoorbeeld filter-name, filterurl-path of een datumfilter. Wees voorzichtig met het gebruik van filter-like-name, omdat dit invloed kan hebben op de systeemprestaties.

36 30 U kunt ook sco-expanded-contents aanroepen om submappen en hun inhoud weer te geven. scocontents is echter beter voor de serverprestaties, als u de sco-id kent van de map die de vergadering bevat. 4 Parseer het antwoord voor de sco-id van de vergadering: <sco sco-id=" " source-sco-id=" " folder-id=" " type="meeting" icon="meeting" display-seq="0" is-folder="0"> <name>intro to Film</name> <url-path>/day/</url-path> <date-begin> t14:00: :00</date-begin> <date-end> t20:00: :00</date-end> <date-modified> t14:07: :00</date-modified> <duration>06:00:00.000</duration> </sco> Alle vergaderingen op de server vermelden 1 Roep report-bulk-objects aan met type=meeting: Het antwoord heeft een row-element voor elke vergadering, waarin de URL, de naam en de datums van de vergadering worden weergegeven: <row sco-id=" " type="meeting"> <url>/monday/</url> <name>monday Staff Meeting</name> <date-created> t14:15: :00</date-created> <date-end> t02:15: :00</date-end> <date-modified> t17:38: :00</date-modified> </row> Vergaderingen weergeven U wilt in uw toepassing misschien lijsten met Acrobat Connect Pro-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 zijn of haar vergaderingen 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: U kunt een filter toevoegen om het antwoord te reduceren. U kunt bijvoorbeeld vergaderingen uitsluiten die al zijn geëindigd. &filter-expired=false 3 Parseer het antwoord voor waarden uit de meeting-elementen: <meeting sco-id=" " type="meeting" icon="meeting" permission-id="host" active-participants="0"> <name>september All Hands Meeting</name> <domain-name>example.com</domain-name> <url-path>/sept15/</url-path> <date-begin> t09:00: :00</date-begin> <date-end> t18:00: :00</date-end> <expired>false</expired> <duration>09:00:00.000</duration> </meeting>

37 31 4 Maak de URL voor de vergaderruimte door of domain-name en url-path samen te voegen. Een gebruiker toevoegen aan een vergadering en vergaderingen weergeven 1 Meld u aan als de beheerder 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"). 4 Roep permissions-update aan om de gebruiker toe te voegen aan de vergadering: &acl-id= &principal-id= &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 beheerder en meld u aan als de gebruiker die u zojuist hebt toegevoegd aan de vergadering. 6 Geef de huidige vergaderingen van de gebruiker weer: &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: 2 Parseer het antwoord voor de waarden van domain-name en url-path: <meeting sco-id=" " type="meeting" icon="meeting" permission-id="host" active-participants="0"> <name>september All Hands Meeting</name> <domain-name>example.com</domain-name> <url-path>/sept15/</url-path> <date-begin> t09:00: :00</date-begin> <date-end> t18:00: :00</date-end> <expired>false</expired> <duration>09:00:00.000</duration> </meeting> 3 Voeg de twee waarden samen en voeg of toe aan het begin: Als u HTTPS gebruikt en u niet expliciet toevoegt, wordt voor de URL standaard en krijgt de gebruiker mogelijk geen toegang tot de vergaderruimte. De URL maken voor een vergaderruimte waarvoor de gebruiker geen gastheer is 1 Haal de sco-id van de vergadering op (zie "De sco-id van een vergadering zoeken"). 2 Roep sco-info aan met de sco-id: 3 Parseer het antwoord voor het url-path: <sco account-id="624520" disabled="" display-seq="0" folder-id="624530"

38 32 icon="folder" lang="en" max-retries="" sco-id=" " source-sco-id="" type="folder" version="1"> <date-created> t10:21: :00</date-created> <date-modified> t10:21: :00</date-modified> <url-path>/f /</url-path> </sco> 4 (Optioneel) Als u de domeinnaam van uw Acrobat Connect Pro Server-account kent, maakt u de URL met of gevolgd door de domain-name en het url-path. 5 Als u de domeinnaam niet kent, roept u common-info aan: 6 Parseer het antwoord voor de waarde van het host-element. Vergaderingen maken Een gebruiker die een Acrobat Connect Pro-vergadering wil maken, moet een beheerder 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, beveiligd of privé zijn. Voor het maken van al deze 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 Beveiligd, gelijkwaardig aan Alleen geregistreerde gebruikers en geaccepteerde gasten kunnen de ruimte binnengaan principal-id=public-access&permission-id=remove Als een vergadering beveiligd 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. Privé, gelijkwaardig aan Alleen geregistreerde gebruikers en geaccepteerde gasten kunnen de ruimte binnengaan. Gasten kunnen zich niet aanmelden op de aanmeldingspagina. principal-id=public-access&permission-id=denied Een openbare vergadering maken en gastheer, presentator en deelnemers toevoegen 1 Roep principal-list aan om te controleren of de gebruiker die de Acrobat Connect Pro-vergadering maakt lid is van de groep live-admins: &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: 3 Parseer het antwoord voor het sco-element met type=my-meetings: <sco tree-id="624530" sco-id=" " type="my-meetings"> <domain-name> </sco> 4 Roep sco-update aan om de vergaderruimte te maken: &type=meeting&name=october All Hands Meeting &folder-id= &date-begin= t09:00 &date-end= t17:00&url-path=october

39 33 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=" " lang="en" account-id="624520" type="meeting" icon="meeting" sco-id=" " version="0"> <date-begin> t09:00</date-begin> <date-end> t17:00</date-end> <url-path>/october/</url-path> <name>october All Hands Meeting</name> </sco> 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: &principal-id=public-access&permission-id=view-hidden 7 Roep permissions-update aan om een gastheer, een presentator en deelnemers toe te voegen: &principal-id= &acl-id= &permission-id=host 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. 8 Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken"). Een privévergadering maken en gastheer, presentator en deelnemers toevoegen 1 Meld u aan als de beheerder van uw toepassing. 2 Volg de stappen voor het maken van een openbare vergadering, maar stel de vergaderingsmachtiging in op privé: &principal-id=public-access&permission-id=denied 3 Roep nogmaals permissions-update aan om een gastheer, een presentator en gasten toe te voegen. 4 Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken"). Aangepaste vergaderingen maken Tijdens het maken van een Acrobat Connect Pro-vergadering kunt u een vergaderruimtesjabloon 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 Acrobat Connect Pro Central 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 Meld u aan als de beheerder van uw toepassing. 2 Roep sco-shortcuts aan: 3 Parseer het antwoord voor de sco-id van een map die vergadersjablonen bevat: <sco tree-id="624529" sco-id=" " type="shared-meeting-templates"> <domain-name> </sco> <sco tree-id="624530" sco-id=" " type="my-meeting-templates">

40 34 <domain-name> </sco> 4 Roep sco-contents aan en geef de sco-id van de map met vergadersjablonen door: 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: &name=august%20all%20hands%20meeting&folder-id= &date-begin= t09:00&date-end= t17:00 &url-path=august&source-sco-id= Ga verder met het instellen van machtigingen voor de vergadering en het toevoegen van deelnemers, een gastheer en een presentator (zie "Vergaderingen maken''). 8 Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken"). Gebruikers uitnodigen voor vergaderingen Als u een Acrobat Connect Pro-vergadering hebt gemaakt en deelnemers en presentatoren hebt toegevoegd, kunt u uitnodigingen verzenden via . 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 adres van de gastheer, de URL van de vergaderruimte, de datum en tijd van de vergadering en de naam en het adres van de deelnemer (of de presentator). U kunt een bericht maken met elke techniek die geschikt is voor uw gebruikersinterface. Haal specifieke informatie over de vergadering op door de volgende stappen te volgen. Een bericht verzenden naar deelnemers van een vergadering 1 Roep sco-info aan met de sco-id van de vergadering: 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=" " icon="meeting" lang="en" max-retries="" sco-id=" " source-sco-id=" " type="meeting" version="0"> <date-begin> t09:00: :00</date-begin> <date-created> t15:30: :00</date-created> <date-end> t18:00: :00</date-end> <date-modified> t15:30: :00</date-modified> <name>august All Hands Meeting</name> <url-path>/august/</url-path> </sco> 3 Maak de URL van de vergaderruimte (zie "URL's voor vergaderruimtes maken''). 4 Roep permissions-info aan om de principal-id-waarden van de presentatoren of deelnemers op te vragen, waarbij u filtert op permission-id: &acl-id= &filter-permission-id=mini-host Voor een lijst van presentatoren gebruikt u permission-id=mini-host. Voor deelnemers gebruikt u permission-id=view. 5 Parseer het antwoord voor de gewenste principal-id-waarden: <principal principal-id=" " is-primary="false" type="user" has-children="false" permission-id="view"> <name>jazz doe</name> <login>jazzdoe@example.com</login>

41 35 </principal> 6 Roep principal-info aan met de principal-id: &principal-id= Extraheer de name- en -waarden uit het antwoord: <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id=" " type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name> < >jazzdoe@newcompany.com</ > <first-name>jazz</first-name> <last-name>doe</last-name> <x >e3612</x > <x >san Francisco</x > </principal> 8 Roep permissions-info aan, waarbij u filtert op een permission-id host: &filter-permission-id=host 9 Parseer het antwoord voor de principal-id: <principal principal-id=" " is-primary="false" type="user" has-children="false" permission-id="host"> <name>jazz doe</name> <login>jazzdoe@example.com</login> </principal> 10 Roep principal-info aan met de principal-id: &principal-id= Parseer het principal-element van het antwoord voor de name en login (of name en ): <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id=" " type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name> < >jazzdoe@newcompany.com</ > <first-name>jazz</first-name> <last-name>doe</last-name> <x >e3612</x > <x >san Francisco</x > </principal> Dit zijn de gegevens voor de afzender van het bericht, namelijk de gastheer van de vergadering. Gebruikers verwijderen uit vergaderingen Het komt soms voor dat een gebruiker als deelnemer of presentator is uitgenodigd voor een Acrobat Connect Provergadering, maar later moet worden verwijderd van de deelnemerlijst. 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 De machtiging van de gebruiker wordt verwijderd en de gebruiker kan alleen deelnemen als gast en met goedkeuring van de gastheer van de vergadering.

42 36 Als u de toegangsmachtiging van een gebruiker wilt verwijderen, roept u permissions-update 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 hij of zij 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: U hoeft echter niet te weten welke specifieke machtiging de principal heeft voordat u de machtiging verwijdert. 2 Haal de sco-id van de vergadering op (zie "De sco-id van een vergadering zoeken"). 3 Vraag de principal-id van de gebruiker aan (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: &acl-id= &principal-id= &permission-id=remove Vergadergebruik berekenen Als u gebruikers en Acrobat Connect Pro-vergaderingen hebt gemaakt, dient u wellicht het gebruik van de vergadering te 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, dit is de interactie 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. Doorgebrachte tijd in vergaderingen per gebruiker berekenen 1 Roep report-bulk-consolidated-transactions aan, waarbij u filtert op vergaderingen en een andere waarde, zoals een datum, om de vergadering te identificeren: &filter-type=meeting&filter-gt-date-created= 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. Deze aanroep geeft alleen de gebruikers als resultaat die zich als deelnemers hebben aangemeld bij de vergadering en niet de gebruikers die zich hebben aangemeld als gasten. 2 Parseer de row-elementen in het antwoord voor date-created en date-closed: <row transaction-id=" " sco-id=" " type="meeting" principalid=" " score="0"> <name>thursday Meeting</name> <url>/thursday/</url> <login>jazz@doe.com</login> <user-name>jazzwayjazz doe</user-name> <status>completed</status> <date-created> t12:33: :00</date-created> <date-closed> t12:34: :00</date-closed> </row>

43 37 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 datetime-waarden uit het antwoord worden omgezet in een GregorianCalendar-object. Zet vervolgens elke GregorianCalendar-datum om in milliseconden, bereken het verschil tussen de maak- en sluittijd en zet het verschil om in minuten. 4 Herhaal dit voor alle vergadertransacties die aan uw criteria voldoen en tel de vergadergebruikstijden bij elkaar op. Vergaderquota's controleren Het aantal gebruikers dat gelijktijdig kan deelnemen aan een vergadering is afhankelijk van uw Acrobat Connect Prolicentie. Als u uw quotum voor het aantal gelijktijdige vergaderdeelnemers wilt controleren, roept u report-quotas aan en zoekt u in het antwoord naar het quotum concurrent-user-per-meeting-quota: <quota acl-id="624529" quota-id="concurrent-user-per-meeting-quota" used="0" limit="unlimited" soft-limit=" "> <date-begin> t09:45: :00</date-begin> <date-end> t16:00: :00</date-end> </quota> Een quotum heeft zowel een limiet als een zachte limiet. De zachte limiet is de limiet voor gelijktijdige gebruikers die voor de account is aangeschaft. De zachte limiet is gelijk aan de limiet, tenzij u een Burst Pack aanschaft voor vergaderingen. In dat geval kunnen op overschotbasis meer deelnemers aan de vergadering deelnemen dan volgens de limiet is toegestaan. Zonder een Burst Pack wordt de limiet voor gelijktijdige deelnemers strikt nageleefd en worden deelnemers afgewezen als het maximumaantal deelnemers is bereikt. Als 20 deelnemers uw limiet is, wordt deelnemer 21 meegedeeld dat de vergaderruimte vol is. Alle accounts zorgen ervoor dat de tijdens het maken van de account ingestelde quota's worden nageleefd. Meer deelnemers worden alleen toegestaan als er een Burst Pack is aangeschaft. Bovendien gelden Burst Packs alleen voor vergaderingen, niet voor trainingen of seminars. Quotum voor gelijktijdig gebruik controleren 1 Roep report-quotas aan om uw quotum voor gelijktijdige gebruikers van vergaderingen te controleren: 2 Parseer het antwoord voor het quota-element met een quota-id-waarde concurrent-user-per-meeting-quota. 3 Extraheer de waarde van soft-limit, de limiet die wordt bepaald door uw Acrobat Connect Pro-licentie. 4 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: 5 Parseer het antwoord voor het report-meeting-concurrent-users-element. Lees de waarde van het max-userskenmerk en vergelijk dit met de waarde van soft-limit: <status code="ok" /> <report-meeting-concurrent-users max-users="18" max-participants-freq="3" />

44 38 Vergaderarchieven ophalen Een Acrobat Connect Pro-vergadering kan over een of meerdere opgenomen archieven beschikken. 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 en geeft het type inhoud aan. Archieven voor een vergaderruimte weergeven 1 Haal de sco-id van de vergadering op (zie "De sco-id van een vergadering zoeken"). 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: &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=" " source-sco-id="" folder-id=" " type="content" icon="archive" display-seq="0" is-folder="0"> <name>en - Monday Night Football_0</name> <url-path>/p /</url-path> <date-begin> t15:51: :00</date-begin> <date-end> t15:54: :00</date-end> <date-modified> t15:55: :00</date-modified> <duration>00:02:580,250</duration> </sco> Resultaten van opiniepeilingen ophalen Voor toegang tot de resultaten van een opiniepeiling die tijdens een vergadering is gehouden, gebruikt u report-quizinteractions. Deze actie geeft alle opiniepeilingresultaten als resultaat, 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. A B A. antwoord 0 B. 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 Haal de sco-id van de vergadering op (zie "De sco-id van een vergadering zoeken").

45 39 3 Roep report-quiz-interactions aan met de sco-id van de vergadering: &sco-id= (Optioneel) Voeg een filter toe om het antwoord te beperken, zoals: filter-response om alle gebruikers te zien die een bepaald antwoord hebben gegeven filter-interaction-id= om alle antwoorden op een opiniepeiling te zien (een vergadering kan meerdere opiniepeilingen hebben) 5 Parseer het antwoord voor response, name of een andere waarde: <row display-seq="1" transcript-id=" " interaction-id=" " sco-id=" " score="0"> <name>jazz doe</name> <sco-name>thursday Meeting</sco-name> <date-created> t12:29: :00</date-created> <description>what is your favorite color?</description> <response>4</response> </row> Vergaderingen starten met externe verificatie Als een gebruiker zich heeft aangemeld bij uw netwerk en u de gebruiker met een externe verificatiereferentie hebt geverifieerd voor Acrobat Connect Pro Server, kunt u de gebruiker toestemming geven deel te nemen aan een vergadering als deelnemer of gast zonder dat hij of zij zich een tweede keer hoeft aan te melden bij Acrobat Connect Pro. 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 Acrobat Connect Pro (zie Aanmelden met HTTP-headerverificatie voor meer informatie). 2 Vraag op een van de volgende twee 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: <cookie>breezma6zor9rdfps8h6a</cookie> 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 nadere informatie). 4 Voeg een session-parameter en de waarde van het BREEZESESSION-cookie toe aan de URL van de vergaderruimte: 5 Open de URL van de vergaderruimte waaraan session is toegevoegd. U kunt dit bijvoorbeeld doen met een JavaScript onclick-opdracht: <a href= onclick="javascript:window.open(' 829r9ozv5rd','Breeze', 'toolbar=no,menubar=no,width=800,height=600,resizable=yes'); return false"> 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 Acrobat Connect Pro (zie Aanmelden met HTTP-headerverificatie voor meer informatie). 2 Vraag op een van de volgende twee 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: <cookie>breezma6zor9rdfps8h6a</cookie> Haal de waarde van het BREEZESESSION-cookie op uit de antwoordheader na het aanroepen van login: Set-Cookie: BREEZESESSION=breezqw4vtfarqxvf9pk2; domain=.macromedia.com;path=/

46 40 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: 5 Open de URL van de vergaderruimte waaraan de guestname-parameter is toegevoegd. U kunt dit bijvoorbeeld doen met een JavaScript onclick-opdracht: <a href= onclick="javascript:window.open(' 'Breeze', 'toolbar=no,menubar=no,width=800,height=600,resizable=yes'); return false"> Compatibiliteitsinstellingen configureren Voor bepaalde bedrijven dient het systeem zodanig te worden geconfigureerd dat aan overheidsvoorschriften en industrienormen op het gebied van communicatie wordt voldaan. Met Acrobat Connect Pro kunt u op vele manieren toezicht houden op de communicatiegegevens. U kunt bijvoorbeeld het gebruik van pods uitschakelen, Acrobat Connect Pro instellen op het altijd of nooit opnemen van vergaderingen, transcripties van chatsessies genereren, een kennisgeving weergeven dat opnamen worden gemaakt, enzovoort. U kunt ook op meerdere manieren toezicht houden op de gebruikerstoegang. U kunt bijvoorbeeld onderscheid maken tussen geverifieerde en niet-geverifieerde gebruikers, de toegang tot vergaderruimten beperken op basis van rollen en de toegang van gasten tot ruimten blokkeren. Zie het Adobe Acrobat Connect Pro Handboek voor meer informatie. Wijzigingen in de instellingen voor deze functies treden in werking wanneer een nieuwe vergadering wordt gestart of wanneer de server wordt vernieuwd. Standaard wordt de server elke tien minuten vernieuwd. De volgende vergadering die begint nadat de server is vernieuwd, bevat de nieuwe instellingen. Het wijzigen van bepaalde instellingen via de XML API kan het gebruik van andere functies beïnvloeden. Wanneer de deelnemerlijst wordt uitgeschakeld (fid-meeting-people-list), kunnen gebruikers bijvoorbeeld geen brainstormruimten maken. U kunt daarom de functie voor brainstormruimten beter ook uitschakelen, om verwarring te voorkomen. Pods uitschakelen Het uitschakelen van pods beïnvloedt de schermindeling van een vergaderruimte en u ziet dan wellicht meer witruimte dan u lief is. Beheerders kunnen het formaat van de resterende pods veranderen om de witruimte te vullen (de aanbevolen methode) of nieuwe sjablonen voor vergaderruimten maken. De gastheer kan het formaat van de pods ook handmatig na het begin van een vergadering aanpassen. Als een pod met blijvende gegevens, zoals de pod Chat, tussen verschillende sessies van een vergadering wordt uitgeschakeld en daarna weer wordt ingeschakeld, gaat de inhoud van de oude pod verloren. De chat- en notitiepods uitschakelen 1 Vraag de account-id op van de account waarin de vergadering plaatsvindt. 2 Meld u aan met gebruik van de beheerdersaccount. 3 Roep meeting-feature-update aan, geef fid-meeting-chat en fid-meeting-note als argumenten door aan de parameter feature-id en stel het kenmerk enable voor beide parameters in op false. 4 Vernieuw de server of begin een nieuwe vergadering om de wijziging te zien. Gebruik de volgende code om de chat- en notitiepods uit te schakelen:

47 41 Chattranscripties beheren U hebt de sco-id van de chatsessie nodig om een chattranscriptie op te vragen. Gebruik een combinatie van XML API's om de sco-id van een specifieke transcriptie op te vragen. U kunt de transcriptie vervolgens opvragen uit de volgende Acrobat Connect Pro-map: [RootInstall]/content/account-id/transcript-sco-id/output/. Chattranscripties opvragen 1 Vraag de sco-id van de chattranscriptiestructuur op door sco-shortcuts aan te roepen: [ 2 Parseer het antwoord voor de tree-id van de chattranscripties: <sneltoetsen> <sco tree-id="10026" sco-id=" " type="chat-transcripts"> <domain-name> </sco>... </shortcuts> 3 Vraag de lijst met transcripties voor een bepaalde vergadering op door sco-contents aan te roepen met de tree-id van de chattranscriptie en het filter source-sco-id: Als u Acrobat Connect Pro wilt configureren voor het genereren van chattranscripties, selecteert u Chattranscripties voor alle vergaderingen genereren in Acrobat Connect Pro Central of roept u meeting-feature-update aan met feature-id fidchat-transcripts. [ In het zojuist vermelde voorbeeld is de sco-id van de chattranscriptiestructuur en is de sco-id van de vergadering. (U kunt de sco-id van de vergadering ontlenen aan de URL van de pagina met informatie over de vergadering.) De als resultaat gegeven lijst met SCO's vertegenwoordigt de chattranscripties voor de vergadering. 4 Zoek de chattranscriptie in de Acrobat Connect Pro-map [RootInstall]/content/account-id/transcript-sco-id/output/. Afdwingen dat vergaderingen worden opgenomen U kunt Acrobat Connect Pro instellen op het opnemen van alle vergaderingen. Adobe raadt u aan een disclaimer weer te geven als u vergaderingen opneemt, zodat gebruikers weten dat dit het geval is. Afdwingen dat vergaderingen worden opgenomen 1 Schakel de instelling uit waarmee gastheren de opnamefunctie besturen (fid-archive) en stel automatische opnamen in (fid-archive-force) door meeting-feature-update aan te roepen. Geef de twee feature-idargumenten door: 2 Zie ''Disclaimers instellen'' op pagina Vernieuw de server of begin een nieuwe vergadering om de wijziging te zien. Disclaimers instellen U kunt een disclaimer weergeven wanneer een gebruiker zich bij een vergadering voegt. In een disclaimer staat vaak boilerplate-informatie over uw bedrijf. Gebruikers ontvangen zo informatie over de status en de gebruiksvoorwaarden van de vergadering. In een disclaimer kan gebruikers bijvoorbeeld worden verteld dat de vergadering wordt opgenomen en dat gebruikers zich alleen bij de vergadering kunnen voegen als ze de disclaimerkennisgeving accepteren. Standaard is deze optie uitgeschakeld.

48 42 Een disclaimer instellen 1 Roep meeting-disclaimer-update aan en stel de tekst voor de disclaimer in: note that this meeting is being recorded. 2 Roep meeting-feature-update aan om de disclaimer te activeren: 3 Vernieuw de server of begin een nieuwe vergadering om de wijziging te zien. Instellingen voor delen bepalen U hebt controle over de instellingen die bepalen welke informatie een gebruiker tijdens een vergadering kan delen met andere gebruikers. Roep meeting-feature-update aan en geef de desbetreffende functie-id('s) door om een instelling voor delen in of uit te schakelen. Roep bijvoorbeeld de volgende code aan om het delen van het scherm uit te schakelen: In de volgende tabel ziet u een overzicht van de functie-id's voor instellingen voor delen. Zie ''feature-id'' op pagina 188 voor een volledige lijst met functie-id's. Instelling voor delen Een computerscherm delen of het scherm besturen; een document of whiteboard delen Een document uploaden naar de pod Delen Bestanden uploaden en beheren met gebruik van de pod voor het delen van bestanden Een whiteboard delen Webpagina's weergeven aan aanwezigen Functie-id fid-meeting-desktop-sharing fid-meeting-shared-upload fid-meeting-file-share fid-meeting-white-board fid-meeting-web-links

49 43 Hoofdstuk 5: Training Een aangepaste trainingstoepassing of een aangepast portal kan gebruikmaken van Adobe Acrobat Connect Pro Training voor het weergeven van beschikbare trainingscursussen, 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. Acrobat Connect Pro Training beschikt over twee typen trainingsmodules: cursussen en studieprogramma's. Een cursus is inhoud (bijvoorbeeld een presentatie) met een aantal ingeschreven studenten 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 studenten een leerpad volgen. Een studieprogramma bevat voornamelijk Acrobat Connect Pro Training-cursussen, maar kan ook andere onderdelen bevatten, zoals inhoud en vergaderingen. Net zoals bij cursussen kunt u rapporten genereren om de vorderingen 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 Acrobat Connect Pro Training zijn objecten, cursussen en studieprogramma's allemaal SCO's met elk een unieke sco-id. 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: permissions-update Om gebruikers aan te melden bij cursussen en te controleren of ze de juiste machtigingen hebben voor toegang tot de cursus. group-membership-update Om gebruikers toe te voegen aan groepen als u een groep wilt inschrijven. report-my-training 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-curriculum-taker Om meer informatie op te halen over de voortgang van een gebruiker binnen een studieprogramma. report-user-trainings-taken Om de meest recente status van alle cursussen en studieprogramma's van een gebruiker weer te geven. report-user-training-transcripts Om een lijst 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 Acrobat Connect Pro Central ziet, wordt ook wel de trainingsbibliotheek genoemd. Gedeelde training wordt courses genoemd in het antwoord van sco-shortcuts: <sco tree-id="123456" sco-id="123456" type="courses"> <domain-name>example.com</domain-name> </sco> Elke map, elke cursus en elk trainingsprogramma in de bibliotheek is een SCO. Tijdens het navigeren door de trainingsbibliotheek, ziet u de sco-id van de huidige cursus of het huidige studieprogramma in de URL van de browser. U kunt de sco-id ook opvragen door sco-contents of sco-expanded-contents aan te roepen voor een map in de trainingsbibliotheek.

50 44 Alle cursussen, studieprogramma's en inhoudsobjecten in de trainingsbibliotheek hebben machtigingen waarmee wordt gedefinieerd welke gebruikers er toegang tot hebben. Houd bij het ontwerpen van uw toepassing rekening met deze machtigingsniveaus: Machtigingen voor ingeschreven personen 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 voor trainingsbibliotheek 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 voor hun eigen trainingsmappen, terwijl beheerders de machtiging Beheren hebben voor alle mappen in de trainingsbibliotheek. Een beheerder kan een gebruiker de machtiging Beheren geven voor een afzonderlijke cursus of map of voor een afzonderlijk studieprogramma met permissions-update of kan de machtigingen van een gebruiker controleren met permissions-info. 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: view De gebruiker heeft toegang tot de cursus of het studieprogramma en de machtiging is Ingeschreven. 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 beheerder van uw toepassing. Deze waarden van permission-id gelden voor trainingsmappen: manage De gebruiker kan machtigingen voor cursussen, studieprogramma's en inhoud in een map toevoegen, verwijderen, wijzigen of toewijzen. De gebruiker kan de inhoud van de map ook weergeven met sco-contents of scoexpanded-contents. denied De gebruiker kan geen machtigingen voor de inhoud van de map toevoegen, verwijderen, wijzigen of toewijzen, maar kan de inhoud van de map wel weergeven. Cursussen en studieprogramma's zoeken Voor de meeste XML API-acties die werken met cursussen en studieprogramma's is de sco-id 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 Acrobat Connect Pro Central, of u kunt de XML API gebruiken, waarin de map Gedeelde 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 Acrobat Connect Pro Central werkt, kunt u de sco-id van een cursus of studieprogramma vinden door er naartoe 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.

51 45 De sco-id van een cursus of studieprogramma zoeken 1 Roep sco-shortcuts aan: 2 Parseer het antwoord voor de sco-id van de map courses: <sco tree-id="624528" sco-id="624528" type="courses"> <domain-name> </sco> 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: &filter-name=sales Training 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 Acrobat Connect Pro Central en deze doorgeven aan sco-contents. 4 Parseer het antwoord voor de sco-id van uw gespecialiseerde trainingsmap: <sco sco-id=" " 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: &sco-id= &filter-name=java 201 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"). 6 Parseer de sco-elementen in het antwoord voor de sco-id van de cursus of het studieprogramma: <sco depth="2" sco-id=" " folder-id=" " type="content" icon="course" lang="en" source-sco-id=" " display-seq="1" source-sco-type="0"> <name>all About Web Communities</name> <url-path>/p /</url-path> <description>web 2.0 course</description> <date-created> t14:48: :00</date-created> <date-modified> t14:48: :00</date-modified> </sco> Alle beschikbare cursussen of studieprogramma's weergeven 1 Vraag de sco-id op van een gespecialiseerde trainingsmap die u hebt gemaakt (zie "De sco-id van een cursus of studieprogramma zoeken"). U kunt de sco-id ook opvragen door naar de map te bladeren in Acrobat Connect Pro Central, 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: Het wordt aangeraden om de gespecialiseerde trainingsmappen in één niveau op te slaan. Op die manier kunt u sco-contents aanroepen in plaats van sco-expanded-contents. Dit komt de prestaties ten goede.

52 46 3 Parseer het antwoord voor name, url-path of andere waarden die u wilt weergeven: <sco sco-id=" " source-sco-id=" " folder-id=" " type="content" icon="course" display-seq="0" is-folder="0"> <name>java 101</name> <url-path>/java101/</url-path> <date-begin> t17:15: :00</date-begin> <date-modified> t17:21: :00</date-modified> </sco> Een cursus maken U kunt een cursus maken in Acrobat Connect Pro Central of in Acrobat Connect Pro Web Services. Als u Web Services gebruikt, maakt u eerst een lege SCO en voegt u daar inhoud aan toe. 1 Roep sco-update aan om een nieuwe SCO voor de cursus te maken: 2 Parseer het antwoord voor de sco-id van de nieuwe cursus. 3 Voeg inhoud toe aan de nieuwe SCO met gebruik van de sco-id die door sco-update als resultaat is gegeven: 4 Gebruikers inschrijven voor de cursus (zie ''Eén gebruiker inschrijven'' en ''Een groot aantal gebruikers inschrijven''). 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 waarvoor 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: 3 Parseer het antwoord voor name, url of andere waarden die u wilt weergeven: <row sco-id=" " type="content" icon="course" permission-id="view"> <name>java 101</name> <url>example.com/java101/</url> <date-created> t17:21: :00</date-created> <date-modified> t17:21: :00</date-modified> <date-begin> t17:15: :00</date-begin> <url-path>/java101/</url-path> <expired>false</expired> <completed>false</completed> </row> De status van alle cursussen en studieprogramma's van een gebruiker weergeven 1 Vraag de principal-id van de gebruiker op (zie "Een principal-id zoeken"). 2 Roep report-user-trainings-taken aan: &principal-id=

53 47 3 Parseer het antwoord voor status: <row transcript-id=" " max-retries="" sco-id=" " type="content" icon="course" status="completed" certificate=" " score="0" permission-id="" attempts="1"> <name>programming in Perl</name> <description>info about Perl</description> <url-path>/p /</url-path> <date-taken> t17:10: :00</date-taken> <from-curriculum>false</from-curriculum> </row> 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 attribute in de referentie. Eén gebruiker inschrijven U kunt gebruikers het beste toegang tot training geven door 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 het Adobe Acrobat Connect Pro Handboek voor gedetailleerde informatie). 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 (ofwel een reeks APIaanroepen) schrijven waarmee een nieuwe gebruiker wordt gemaakt en de gebruiker wordt ingeschreven voor een cursus. Wanneer u gebruikers inschrijft voor een training met gebruik van de XML API (en in het bijzonder het aanroepen van permissions-update), wordt geen melding verzonden. Gebruik Acrobat Connect Pro Central voor het inschrijven van gebruikers als u inschrijvingsmeldingen wilt verzenden. Eén gebruiker inschrijven voor een cursus of studieprogramma 1 Vraag de sco-id van de cursus op (zie "De sco-id van een cursus of studieprogramma zoeken"). 2 Vraag 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: &acl-id= &principal-id= &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: 5 Parseer de row-elementen in het antwoord voor waarden die u wilt weergeven: <row sco-id=" " type="content" icon="course" permission-id="view"> <name>java 101</name> <url>example.com/java101/</url> <date-created> t17:21: :00</date-created> <date-modified> t17:21: :00</date-modified> <date-begin> t17:15: :00</date-begin> <url-path>/java101/</url-path> <expired>false</expired> <completed>false</completed> </row>

54 48 Een nieuwe gebruiker inschrijven met een workflow 1 Call Roep principal-update aan om de nieuwe gebruiker te maken en een welkomst bericht te verzenden: &last-name=doe&login=jazz@doe.com&password=hello&type=user &send- =true&has-children=0& =jazz@doe.com Voor het verzenden van de moet send- =true zijn. 2 Meld de gebruiker aan bij de server: &password=hello&session=breezma6zor9rdfps8h6a Zie ''Aanmelden vanuit een toepassing'' voor andere manieren voor het aanroepen van login. 3 Call Roep group-membership-update aan met is-member=true om de gebruiker toe te voegen aan de groep: &group-id= &principal-id= &is-member=true 4 Roep permissions-update aan om de gebruiker in te schrijven voor een studieprogramma: &acl-id= &principal-id= &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: 6 Parseer de row-elementen in het antwoord voor waarden die u wilt weergeven: <row sco-id=" " type="curriculum" icon="curriculum" permission-id="view"> <name>a Day in the Life</name> <url>example.com/day/</url> <date-created> t14:47: :00</date-created> <date-modified> t14:47: :00</date-modified> <date-begin> t14:45: :00</date-begin> <url-path>/day/</url-path> <expired>false</expired> <completed>false</completed> </row> 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, 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. Een groot aantal gebruikers (meer dan 1000) rechtstreeks inschrijven voor een cursus 1 Vraag de sco-id van de cursus op (zie "De sco-id van een cursus of studieprogramma zoeken"). 2 Vraag de principal-id op van elke gebruiker die u wilt inschrijven. Dit kunt u op de volgende manieren doen: Roep principal-list aan met filters om de gebruikers weer te geven die u wilt inschrijven: &filter-type=sales Lees de waarden uit een bestand.

55 49 3 Schrijf een methode waarmee permissions-update wordt aangeroepen met meerdere combinaties (trio's) van aclid, principal-id en permission-id: &acl-id= &principal-id= &permission-id=view&aclid= &principal-id= &permission-id=view... De acl-id is de sco-id van de cursus. De permission-id voor het inschrijven van gebruikers is view. De principal-id is uniek in elk trio. Als er trio's zijn met onjuiste gegevens, retourneert permissions-update de status ok en worden de juiste trio's wel en de ongeldige trio's niet uitgevoerd. 4 Roep permissions-info aan om te controleren of de gebruikers zijn ingeschreven: &acl-id= &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 Vraag de sco-id van de cursus op (zie "De sco-id van een cursus of studieprogramma zoeken"). 2 Vraag 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: &filter-account-id= Lees de waarden uit een bestand. 3 Schrijf een methode waarmee permissions-update wordt aangeroepen met meerdere combinaties (trio's) van aclid, principal-id en permission-id: &acl-id= &principal-id= &permission-id=denied&aclid= &principal-id= &permission-id=denied... De permission-id om gebruikers uit te schrijven uit de cursus is denied. 4 Roep permissions-info aan om te controleren of de gebruikers zijn verwijderd: &acl-id= &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: &has-children=1&name=developersc5 Met Acrobat Connect Pro Central 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 Acrobat Connect Pro Central of een API-aanroep gebruiken, maar u kunt slechts 200 gebruikers tegelijk toevoegen. Met de XML API Roep group-membership-update aan, waarbij u meerdere combinaties (trio's) van groupid, principal-id en is-member=true gebruikt: &group-id= &principal-id= &is-member=true &group-id= &principal-id= &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.

56 50 Met Acrobat Connect Pro Central 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 Vraag de sco-id van de cursus op (zie De sco-id van een cursus of studieprogramma zoeken) met gebruik van 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: &acl-id= &principal-id= &permission-id=view Een grote groep gebruikers (meer dan 1000) uitschrijven voor een cursus 1 Roep permissions-info aan op de cursus, waarbij u filtert op de permission-id view: &acl-id= &filter-permission-id=view&filter-type=group 2 Parseer het antwoord voor de principal-id van de groep: <principal principal-id=" " is-primary="false" type="group" has-children="true" permission-id="view"> <name>developers</name> <login>developers@acme.com</login> </principal> 3 Roep permissions-update aan met de permission-id denied om de toegang van de groep tot de cursus te verwijderen: &acl-id= &principal-id= &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 op de permission-id view: &acl-id= &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. 2 Parseer het antwoord voor principal-id, name en andere waarden die u nodig hebt: <principal principal-id=" " is-primary="false" type="user" has-children="false" permission-id="view"> <name>joy Smith</name> <login>joy@acme.com</login> </principal>

57 51 Een lijst van alle trainingsmodules in een studieprogramma weergeven Een studieprogramma is een type map en u kunt de inhoud van een studieprogramma weergeven met sco-contents of sco-expanded-contents. 1 Vraag 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: &sco-id= Parseer het antwoord voor de sco-id, folder-id en depth: <sco depth="1" sco-id=" " folder-id=" " type="link" icon="course" lang="en" source-sco-id=" " display-seq="0" source-sco-type="0"> <name>all About Web Communities</name> <url-path>/l /</url-path> <description>test</description> <date-created> t14:48: :00</date-created> <date-modified> t14:48: :00</date-modified> </sco> Het antwoord retourneert een platte lijst met sco-elementen, waaronder het studieprogramma en alle SCO's in dit studieprogramma. U kunt een hiërarchie samenstellen met gebruik van de sco-id-, folder-id- en depthwaarden. De SCO met type=curriculum is het studieprogramma dat de cursussen bevat. Het voltooide en resterende werk van een gebruiker in een studieprogramma weergeven 1 Vraag de sco-id van het studieprogramma op (zie "De sco-id van een cursus of studieprogramma zoeken"). 2 Vraag de principal-id van de gebruiker op (zie "Een principal-id zoeken"). 3 Roep report-curriculum-taker aan, waarbij u de principal-id doorgeeft als een user-id: &user-id= &sco-id= Parseer het antwoord voor het status-kenmerk van elk sco-element en andere waarden die u wilt weergeven in uw toepassing: <sco transcript-id=" " path-type="prereq-none" asset-id="" sco-id=" " depth="1" folder-id=" " type="15" icon="course" lang="en" max-retries="" source-sco-id=" " source-sco-type="0" status="user-passed" score="0" certificate="" max-score="0" attempts="0"> <access>access-open</access> <credit-granted>true</credit-granted> <name>all About Web Communities</name> <url-path>/l /</url-path> <description>test</description> <date-created> t15:06: :00</date-created> <date-modified> t14:48: :00</date-modified> <date-taken> t15:06: :00</date-taken> <override>false</override> </sco> 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.

58 52 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 student heeft om de cursus te voltooien of te halen (zie het handboek van Acrobat Connect Pro voor informatie over herkansingen voor cursussen in de beoordelingsmodus op de server en op de client). Dit betekent dat een student een cursus meerdere keren kan proberen en meerdere scores kan halen. U wilt in uw toepassing wellicht alleen de hoogste score van de student weergeven. De hoogste score van een gebruiker voor een cursus of quiz rapporteren 1 Vraag de principal-id van de gebruiker op (zie "De principal-id van de huidige gebruiker opvragen"). 2 Vraag de sco-id van de cursus of quiz op (zie "De sco-id van een cursus of studieprogramma zoeken"). 3 Roep report-user-training-transcripts aan, waarbij u filtert op de sco-id en sorteert op de score: &principal-id= &filter-sco-id= &sort-score=desc 4 Parseer het antwoord voor de hoogste score, die in het eerste row-element in de lijst moet staan: <row transcript-id=" " sco-id=" " principal-id=" " status="user-passed" score="20" max-score="20" certificate=" " type="content" icon="producer"> <name>java Data Type Quiz</name> <url-path>/quiz/</url-path> <login>bob@acme.com</login> <date-taken> t11:55: :00</date-taken> <principal-name>bob Smith</principal-name> </row>

59 53 Hoofdstuk 6: Actiereferentie In dit hoofdstuk vindt u een referentie voor elke actie in de Adobe Acrobat Connect Pro Web Services XML API. U kunt al deze acties aanroepen in Adobe Acrobat Connect Pro Server 7. De namen van alle acties, parameters, elementen en kenmerken zijn hoofdlettergevoelig. Met andere woorden, name is niet hetzelfde als Name 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 release zijn enkele nieuwe acties toegevoegd. Nieuwe acties voor compatibiliteit om functies in of uit te schakelen in vergaderruimten: meeting-feature-update meeting-disclaimer-info meeting-disclaimer-update Nieuwe acties voor machtigingen om de verschillende mogelijkheden van beheerders in te stellen: limited-administrator-permissions info limited-administrator-permissions-update Nieuwe actie voor zoeken om op veld te kunnen zoeken: sco-search-by-field Nieuwe acties voor het beheer van de systeemcapaciteit om beheerders in staat te stellen gebruikers en licenties te beheren: account-expiry-info expiry-settings-update expiry-settings-info quota-threshold-update quota-threshold-info quota-threshold-exceeded Verbeterde actie voor inschrijving om gebruikers zichzelf te laten inschrijven voor training: acl-field-update

60 54 account-expiry-info Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Geeft de verloopdatum van een account als resultaat. Aanvraag-URL &account-id=integer &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van een account waarvan u wilt weten wanneer deze verloopt. Als u geen account-id verschaft, wordt de verloopdatum voor de huidige gebruiker als resultaat gegeven. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Antwoordenstructuur <status code="ok"/> <Account account-id=integer> <name>string</name> <date-expired>datetime</date-expired> </Account> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Account Container Informatie over alle velden die de account beschrijven. account-id Geheel getal De id van de account. name Reeks De naam van de account. date-expired Datetime De datum waarop de account verloopt. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok"/> <Account account-id="7"> <name>enterprise Account</name>

61 55 <date-expired> t18:15: :30</date-expired> </Account> Zie ook expiry-settings-info, expiry-settings-update 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, dat wil zeggen 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 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 te bepalen en u kunt sco-shortcuts of sco-contents aanroepen om een sco-id op te vragen. Aanvraag-URL &acl-id=integer &session=breezesessioncookievalue 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <acl-fields> <field acl-id=integer field-id=string> <value>string</value> </field>... </acl-fields>

62 56 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code 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. acl-id Geheel getal De acl-id die is opgegeven in de aanvraag en die een sco-id, principal-id of account-id is. field-id Reeks De naam van het veld. value Reeks De waarde van het veld. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <acl-fields> <field acl-id=" " field-id=" "> </field> <field acl-id=" " field-id="first-name"> <value>joy</value> </field> <field acl-id=" " field-id="last-name"> <value>smith</value> </field> </acl-fields> Zie ook acl-field-list, acl-field-update acl-field-list Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Geeft een lijst met waarden als resultaat voor alle instanties van een veldnaam in uw Acrobat Connect Pro Server-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.

63 57 Aanvraag-URL &field-id=string &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving field-id Reeks J De naam van een veld in de toegangsbeheerlijst waarvoor u waarden en id's wilt. Er is slechts één veldnaam toegestaan. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <acl-field-list> <acl acl-id=integer> <value>string</value> </acl>... </acl-field-list> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). acl-field-list Container Informatie over alle waarden in de account voor het opgegeven veld. acl Container Informatie over één waarde voor het opgegeven veld. acl-id Geheel getal De id van de principal, SCO of account waartoe het veld behoort. value Reeks De waarde van het veld. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <acl-field-list> <acl acl-id="381223"> <value>john</value> </acl> <acl acl-id="381302"> <value>daryl</value> </acl> <acl acl-id="381405">

64 58 <value>mary</value> </acl> </acl-field-list> Zie ook acl-field-info, acl-field-update acl-field-update Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Werkt de waarde bij van een veld dat bij een SCO of een account hoort. Opmerking: gebruik de actie principal-update als u een standaardveld voor een principal (een gebruiker of een groep) wilt bijwerken. Gebruik de actie acl-field-update als u een aangepast veld voor een principal wilt bijwerken. De SCO of de account hoort bij ten minste één ACL (toegangsbeheerlijst), die de principals vermeldt die een machtiging hebben voor toegang tot de SCO of de account. Roep acl-field-info aan om te bepalen welke velden de SCO of de account heeft. In het antwoord kunt u de fieldid zien die u nodig hebt voor de aanvraag tot acl-field-update: <status code="ok" /> <acl-fields> <field acl-id=" " field-id=" "> <value>joy@acme.com</value> </field>... </acl-fields> U kunt meerdere combinaties (trio's) opgeven van acl-id, field-id en value. Voer de aanvraag in dat geval uit met een HTTP POST-methode in plaats van met GET. De GET-methode heeft beperkingen die ertoe kunnen leiden dat de aanvraag wordt afgebroken. Met POST kunt u ongeveer 50 trio's aan de aanvraag toevoegen. Als u acl-field-update wilt aanroepen, hebt u de modify-machtiging voor de SCO of de account nodig. Aanvraag-URL &acl-id=integer &field-id=string &value=string &session=breezesessioncookievalue

65 59 Parameters Naam Type Vereist Beschrijving acl-id Geheel getal J De id van de SCO of de account. Dit kan een geldige sco-id of account-id zijn. field-id Reeks 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. Een aangepast veld heeft een veld-id die begint met x-, zoals x value Reeks J De in te stellen waarde. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &field-id=name&value=java 101 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 &acl-id=integer &lang=allowedvalue &time-zone-id=allowedvalue &session=breezesessioncookievalue

66 60 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &lang=fr&time-zone-id=0 Voorbeeldantwoord <status code="ok" /> common-info Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert basisinformatie over de huidige gebruiker en de Acrobat Connect Pro Server- of de Acrobat Connect Proaccount op de hostserver, inclusief de waarde van het BREEZESESSION-cookie. Als u common-info aanroept zonder u aan te melden, bevat het antwoord de elementen user en account niet, omdat de server geen gebruiker kan identificeren. Ook zonder aanmelding geeft common-info een BREEZESESSION-cookiewaarde als resultaat. Het antwoord bevat ook host-, local-host- en admin-host-elementen. Als Acrobat Connect Pro wordt gehost op een cluster, is host de clusternaam, is local-host de naam van de server in de cluster die de aanroep naar common-info uitvoert en is admin-host de naam van de beveiligde host op een cluster die ondersteuning biedt voor SSL. Uw toepassing kan de waarde van admin-host gebruiken om HTTP URL's om te zetten in veiliger HTTPS URL's.

67 61 Aanvraag-URL &domain=string &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving domain Reeks N Een domeinnaam die een Acrobat Connect Pro-account op een hostserver identificeert. U kunt zo informatie opvragen over uw account op de hostserver. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <common locale=allowedvalue time-zone-id=integer> <cookie>string</cookie> <date>datetime</date> <host>url</host> <local-host>hostname</local-host> <admin-host>hostname</admin-host> <url>/api/xml?action=common-info</url> <version>string</version> <account account-id=integer /> <user user-id=integer type="user"> <name>string</name> <login>string</login> </user> <user-agent>string</user-agent> </common> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). common Container Algemene informatie over uw verbinding met de server. locale Toegestane waarde Een instelling die definieert hoe in Acrobat Connect Pro Central 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 Reeks De waarde van het BREEZESESSION-cookie (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.

68 62 Element Kenmerk Type Beschrijving host Reeks Als Acrobat Connect Pro wordt uitgevoerd op een server, is dit de URL van de volledig gekwalificeerde hostnaam van de server. Op een cluster is dit de naam die de cluster identificeert. local-host Reeks De naam van de computer die de actie uitvoert (op één server is dit dezelfde naam als host, op een cluster is het de naam van de server die de actie heeft uitgevoerd). admin-host Reeks De naam van de beveiligde host op een cluster die ondersteuning biedt voor SSL. url Reeks Het deel van de URL die deze aanroep uitvoert en die de actienaam identificeert. version Reeks De versienaam en het versienummer van de server. account Leeg, met kenmerk Informatie over de account waartoe de gebruiker behoort. Wordt geretourneerd als u bent aangemeld bij Acrobat Connect Pro, of als u de aanroep op een Acrobat Connect Pro-account op een hostserver uitvoert. account-id Geheel getal De id van de account waartoe de gebruiker behoort. user 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 bij type). name Reeks De volledige naam van de gebruiker die een sessie met de server tot stand heeft gebracht. login Reeks De aanmeldingsnaam van de gebruiker die zich bij de server heeft aangemeld, meestal het adres van de gebruiker. user-agent Reeks De id van de webbrowser of de client die een sessie met de server tot stand heeft gebracht. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <common locale="en" time-zone-id="4"> <cookie>breezsi4dundh5srw2fq6</cookie> <date> t11:17: :00</date> <host> <local-host>localserver17</local-host> <admin-host>securehost.com</admin-host> <url>/api/xml?action=common-info</url> <version>connect_6000</version> <account account-id="624520" /> <user user-id=" " type="user"> <name>joy Smith</name> <login>joy@acme.com</login> </user> <user-agent>mozilla/4.0 (compatibel; MSIE 6.0; Windows NT 5.1; SV1;.NET CLR )</user-agent> </common>

69 63 custom-fields Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Acrobat Connect Pro Central. U kunt aangepaste velden maken of hun waarde bijwerken met custom-field-update. Aanvraag-URL &filter-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren op een element of kenmerk dat het bevat. Antwoordenstructuur <status code=allowedvalue /> <custom-fields> <field permission-id=allowedvalue object-type=allowedvalue field-id=string account-id=integer display-seq=integer field-type=allowedvalue is-primary=boolean is-required=boolean> <name>string</name> </field> </custom-fields> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). custom-fields Container De lijst met aangepaste velden die met de query overeenkomen. field Container Details van een aangepast veld. 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 Reeks De naam van het veld, zoals deze op de server is geïdentificeerd.

70 64 Element Kenmerk Type Beschrijving account-id Geheel getal De id van de account waarin het aangepaste veld is gedefinieerd. display-seq Geheel getal De volgorde waarin Acrobat Connect Pro Central 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 een waarde voor dit veld moet worden opgegeven in elk object dat het veld gebruikt. Anders is het false. name Reeks De naam van het aangepaste veld zoals dit in Acrobat Connect Pro Central of in uw toepassing wordt weergegeven. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <custom-fields> <field permission-id="manage" object-type="object-type-principal" field-id="first-name" account-id="624520" display-seq="1" field-type="text" is-primary="true" is-required="true"> <name>first Name</name> </field> <field permission-id="manage" object-type="object-type-principal" field-id="last-name" account-id="624520" display-seq="2" field-type="text" is-primary="true" is-required="true"> <name>last Name</name> </field> </custom-fields> Zie ook custom-field-update custom-fields-delete Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 &field-id=string &object-type=allowedvalue &session=breezesessioncookievalue

71 65 Parameters Naam Type Vereist Beschrijving field-id Reeks 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 field-element. object-type Reeks J Het type SCO waarvoor het veld is gedefinieerd (zie type voor waarden). session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook custom-field-update custom-field-update Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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.

72 66 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 &account-id=integer &object-type=object-type-allowedvalue &permission-id=allowedvalue &name=string &comments=string &field-type=allowedvalue &is-required=boolean &is-primary=boolean &display-seq=integer &field-id=integer &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De account-id waarin het veld is gemaakt. object-type Reeks 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 de waarde in Acrobat Connect Pro Central wordt weergegeven, maar dat een gebruiker de waarde niet met Acrobat Connect Pro Central kan instellen. U kunt deze waarde ook gebruiken in aangepaste toepassingen. permission-id Reeks 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 Reeks J Het label voor het veld in de gebruikersinterface. Vereist om een veld te maken. comments Reeks 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 Reeks J Het type veld. Toegestane waarden zijn text, textarea en password. Vereist om een veld te maken. 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).

73 67 Naam Type Vereist Beschrijving display-seq Geheel getal N De volgorde waarin Acrobat Connect Pro Central 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <field field-id=integer display-seq=integer object-type=allowedvalue account-id=integer is-primary=boolean permission-id=allowedvalue is-required=boolean field-type=string> <comments>string</comments> <name>string</name> </field> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). field 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 Acrobat Connect Pro Central of uw toepassing het veld weergeeft. object-type Toegestane waarde Het type object dat het veld beschrijft (zie type voor toegestane waarden). account-id Geheel getal Voor klanten van Acrobat Connect Pro-accounts op een hostserver is dit de id van de account waarin het veld is gedefinieerd. is-primary permission-id is-required field-type Booleaanse waarde Toegestane waarde Booleaanse waarde Toegestane waarde Geeft aan of dit aangepaste veld kan worden verwijderd (true als dit niet kan en false als dit wel kan). De machtiging die nodig is voor toegang tot het aangepaste veld (zie permission-id voor toegestane waarden). Geeft aan of een waarde voor dit aangepaste veld is vereist (true indien ja en false indien nee). Het type gegevens dat het veld accepteert. Toegestane waarden zijn text, textarea en password. comments Reeks De opmerking die in comments in de aanvraag is opgegeven. name Reeks De naam van het veld dat in name in de aanvraag is opgegeven.

74 68 Voorbeeldaanvraag &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" /> <field field-id=" " object-type="object-type-principal" display-seq="1" account-id="624520" is-primary="false" permission-id="manage" is-required="true" field-type="text"> <comments>test</comments> <name>jobtitle</name> </field> Zie ook report-bulk-users expiry-settings-info Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Geeft informatie over de huidige instellingen voor kennisgevingen met betrekking tot het verlopen van accounts als resultaat (dit zijn de waarschuwingen die gebruikers ontvangen voordat een account verloopt). Een gebruiker wordt x dagen vóór het verlopen van zijn of haar account gewaarschuwd. Deze actie geeft heel eenvoudig de waarde x als resultaat. Aanvraag-URL &account-id=integer &session=string Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account. Als u geen account-id verschaft, wordt de verloopdatum voor de huidige account als resultaat gegeven. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Antwoordenstructuur <status code=allowedvalue /> <expiry-num-of-days> <value>30</value> </expiry-num-of-days>

75 69 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). expiry-num-of-days Container Informatie over de huidige instellingen voor meldingen met betrekking tot het verlopen van accounts. value Geheel getal De gebruiker wordt dit aantal dagen vóór het verlopen van de account gewaarschuwd. De standaardwaarde is 30. Als de account van een gebruiker bijvoorbeeld verloopt op 31 december, wordt de gebruiker gewaarschuwd op 1 december. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <expiry-num-of-days> <value>30</value> </expiry-num-of-days> Zie ook expiry-settings-update expiry-settings-update Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Werkt informatie over de huidige instellingen voor kennisgevingen met betrekking tot het verlopen van accounts bij (dit zijn de meldingen die gebruikers ontvangen voordat een account verloopt). Een gebruiker wordt x dagen vóór het verlopen van zijn of haar account gewaarschuwd. Deze actie werkt heel eenvoudig de waarde x bij. Aanvraag-URL &account-id=integer &session=string

76 70 Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account. Als u geen account-id verschaft, wordt de verloopdatum voor de huidige account bijgewerkt. expiry-num-of-days Geheel getal J De gebruiker wordt dit aantal dagen vóór het verlopen van de account gewaarschuwd. De standaardwaarde is 30, mogelijke waarden zijn 30, 60 en 90. Als bijvoorbeeld de waarde 30 voor deze parameter wordt ingesteld, wordt een gebruiker 30 dagen vóór het verlopen van zijn of haar account gewaarschuwd. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook account-expiry-info, expiry-settings-info group-membership-update Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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, principalid 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).

77 71 Aanvraag-URL &group-id=integer &principal-id=integer &is-member=boolean &session=breezesessioncookievalue 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Element van het hoogste niveau voor het antwoord. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &principal-id= &is-member=true Voorbeeldantwoord <status code="ok" /> learning-path-info Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert een lijst met leerpaden voor een leerobject dat bij een studieprogramma hoort.

78 72 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, voltooiingsvereisten of plaatsingsvereisten 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 &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <learning-paths> <learning-path curriculum-id=integer current-sco-id=integer target-sco-id=integer path-type=allowedvalue> <name>string</name> </learning-path> </learning-paths> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). learning-paths Container Informatie over leerpaden in een studieprogramma. curriculum-id Geheel getal De numerieke id van het studieprogramma. current-sco-id Geheel getal Het leerobject waarvoor u een pad wilt.

79 73 Element Kenmerk Type Beschrijving 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. name Reeks De naam van het doelleerobject. Voorbeeldaanvraag &curriculum-id= Voorbeeldantwoord <status code="ok" /> <learning-paths> <learning-path curriculum-id=" " current-sco-id=" " target-sco-id=" " path-type="completion-required"> <name>security at AcmeCo</name> </learning-path> </learning-paths> Zie ook learning-path-update learning-path-update Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Werkt het leerpad bij van één leerobject in een studieprogramma. Een leerobject is een SCO die aan een studieprogramma is toegevoegd. Aanvraag-URL &curriculum-id=integer &current-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 leerobject behoort. current-sco-id Geheel getal N De id van het leerobject dat de machtiging heeft die u wilt bijwerken.

80 74 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code="ok" /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Element van het hoogste niveau voor het antwoord. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &curriculum-id= &current-sco-id= &target-sco-id= &path-type=completion-required Voorbeeldantwoord <status code="ok" /> Zie ook learning-path-info limited-administrator-permissions info Beschikbaarheid Acrobat Connect Pro 7 Beschrijving Geeft een lijst met machtigingen als resultaat die kunnen worden in- of uitgeschakeld voor de groep Beperkte beheerders en of die machtiging momenteel al dan niet is ingeschakeld. Zie limited-administrator-permissions-update voor meer informatie over Beperkte beheerders. Aanvraag-URL &session=breezesessioncookievalue

81 75 Parameters Naam Type Vereist Beschrijving session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code="ok" /> <permissions> <permission> <enabled>boolean</enabled> <name>string</name> </permission> </permissions> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). permissions Container Een lijst met machtigingen. permission Container Een lijst met informatie over de machtiging. enabled Booleaanse waarde Een waarde die aangeeft of de machtiging al (true) dan niet (false) is ingeschakeld. name Reeks De naam van de machtiging. Voorbeeldaanvraag &session=breeze6qdeheiso93efb5 Voorbeeldantwoord <status code="ok" /> <permissions> <permission> <enabled>true</enabled> <name>edit-account-info</name> </permission> <permission> <enabled>false</enabled> <name>view-disk-usage-and-reports</name> </permission> <permission> <enabled>true</enabled> <name>reset-password</name> </permission>

82 76 <permission> <enabled>true</enabled> <name>view-user-data</name> </permission> <permission> <enabled>true</enabled> <name>add-users-groups-webui</name> </permission> <permission> <enabled>false</enabled> <name>add-users-groups-csv</name> </permission> <permission> <enabled>true</enabled> <name>set-content-meeting-permissions</name> </permission> <permission> <enabled>true</enabled> <name>user-profile-fields</name> </permission> <permission> <enabled>true</enabled> <name>change-login-pw-policy</name> </permission> <permission> <enabled>false</enabled> <name>delete-users-groups</name> </permission> <permission> <enabled>true</enabled> <name>modify-current-users-groups</name> </permission> <permission> <enabled>false</enabled> <name>customization</name> </permission> <permission> <enabled>false</enabled> <name>compliance</name> </permission> <permission> <enabled>false</enabled> <name>chargebacks</name> </permission> <permission> <enabled>false</enabled> <name>view-system-usage-reports</name> </permission> <permission> <enabled>false</enabled> <name>quota-threshold-notifications</name> </permission> </permissions>

83 77 limited-administrator-permissions-update Beschikbaarheid Acrobat Connect Pro 7 Beschrijving Werkt de machtigingen bij die kunnen worden ingeschakeld voor Beperkte beheerders. De functie Beperkte beheerders geeft uw onderneming meer controle over beheerders en over hun bevoegdheden. Uw onderneming kan onderscheid maken tussen systeembeheerders die alle aspecten van het systeem bepalen en Beperkte beheerders die toegang hebben tot een bepaald gedeelte van het systeem en dat ook beheren. Elke Acrobat Connect Pro-installatie beschikt over één groep Beperkte beheerders. Gebruikers in de groep Beheerders kunnen de machtigingen van Beperkte beheerders bewerken. Aanvraag-URL &view-disk-usage-and-reports=boolean &reset-password=boolean &view-user-data=boolean &add-users-groups-webui=boolean &add-users-groups-csv=boolean &user-profile-fields=boolean &change-login-pw-policy=boolean &delete-users-groups=boolean &modify-current-users-groups=boolean &customization=boolean &edit-account-info=boolean &set-content-meeting-permissions=boolean &compliance=boolean &chargebacks=boolean &view-training-reports=boolean &reset-to-default=value Parameters Geen minstens één parameter door als u deze opdracht gebruikt. De volgende beschrijvingen geven aan of de machtiging standaard is ingesteld op true. Naam Type Vereist Beschrijving view-disk-usage-and-reports Booleaanse waarde N De waarde true stelt beperkte beheerders in staat schijfgebruik en rapporten weer te geven. De standaardwaarde is true. reset-password Booleaanse waarde N De waarde true stelt beperkte beheerders in staat het wachtwoord voor een gebruiker opnieuw in te stellen. Maakt deel uit van de set view-user-data. De standaardwaarde is true. view-user-data Booleaanse waarde N Superset, de waarde true stelt beperkte beheerders in staat om gebruikersgegevens weer te geven. Door deze parameter in te stellen op enable, schakelt u alle parameters in deze set in. (Zie alle parameters die deel uitmaken van de set view-user-data.) De standaardwaarde is true. add-users-groups-webui Booleaanse waarde N De waarde true stelt beperkte beheerders in staat om gebruikers en groepen toe te voegen met gebruik van de beheerconsole. Maakt deel uit van de set view-user-data. De standaardwaarde is true. add-users-groups-csv Booleaanse waarde N De waarde true stelt beperkte beheerders in staat om gebruikers en groepen toe te voegen door een CSV-bestand te importeren. Maakt deel uit van de set view-user-data. user-profile-fields Booleaanse waarde N De waarde true stelt beperkte beheerders in staat gebruikersprofielvelden te wijzigen.

84 78 Naam Type Vereist Beschrijving change-login-pw-policy Booleaanse waarde N De waarde true stelt beperkte beheerders in staat het aanmeldings- en wachtwoordbeleid te wijzigen. delete-users-groups Booleaanse waarde N De waarde true stelt beperkte beheerders in staat gebruikers of groepen te verwijderen. Maakt deel uit van de set view-user-data. modify-current-users-groups Booleaanse waarde N De waarde true stelt beperkte beheerders in staat de huidige gebruikers en groepen te wijzigen. Maakt deel uit van de set view-user-data. De standaardwaarde is true. customization Booleaanse waarde N De waarde true stelt beperkte beheerders in staat de kleuren van de webpagina's, vergaderingen en aanmeldingspagina van de account aan te passen. edit-account-info Booleaanse waarde N De waarde true stelt beperkte beheerders in staat om accountgegevens te bewerken. set-content-meeting-permissions Booleaanse waarde N De waarde true stelt beperkte beheerders in staat de machtigingen voor inhoud of vergaderingen in te stellen. De standaardwaarde is true. compliance Booleaanse waarde N De waarde true stelt beperkte beheerders in staat om wijzigingen aan te brengen in de compatibiliteitsinstellingen (instellingen voor het inschakelen van pods, delen, opnamen en training). chargebacks Booleaanse waarde N De waarde true geeft beperkte beheerders toegang tot de kostenplaatsinstellingen voor deze account. view-training-reports Booleaanse waarde N De waarde true stelt beperkte beheerders in staat om trainingsrapporten weer te geven. reset-to-default Booleaanse waarde N De waarde true stelt de door Adobe ingestelde standaardmachtigingen weer in. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Het voorbeeld: &session=breezghd9nxdhh768vpob &view-user-data=true &view-user-data=false &reset-password=true &reset-password=false &modify-current-users-groups=true &modify-current-users-groups=false &add-users-groups-webui=true &add-users-groups-webui=false

85 79 &add-users-groups-csv=false &delete-users-groups=false &user-profile-fields=true &user-profile-fields=false &change-login-pw-policy=true &change-login-pw-policy=false &chargebacks=false &edit-account-info=true &edit-account-info=false &quota-threshold-notifications=false &customization=false &view-disk-usage-and-reports=false &view-system-usage-reports=false &compliance=false &set-content-meeting-permissions=true &set-content-meeting-permissions=false Voorbeeldantwoord <status code="ok"/> login Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Meldt een gebruiker aan bij Acrobat Connect Pro Server. 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 aanvraagparameter session: &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: 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.

86 80 Aanvraag-URL &login=string &password=string &account-id=integer &external-auth=use &domain=string Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van uw Acrobat Connect Pro-account op een hostserver. Gebruik account-id niet als uw onderneming een exemplaar van Acrobat Connect Pro Server met licentie uitvoert. external-auth Toegestane waarde N Een waarde die aangeeft of u een externe netwerkaanmeldings-id stuurt om de gebruiker te representeren bij Acrobat Connect Pro. Als dit het geval is, gebruikt u external-auth=use. aanmelden Reeks J/N De aanmeldingsnaam van de gebruiker. Niet gebruiken als u externe of HTTP-headerverificatie gebruikt. password Reeks J/N Het gebruikerswachtwoord. Niet gebruiken als u externe of HTTP headerverificatie gebruikt. domain Reeks N De domeinnaam van uw Acrobat Connect Pro-account op een hostserver. Gebruik domain niet als uw onderneming een exemplaar van Acrobat Connect Pro Server met licentie uitvoert. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &session=breeztg8mz53r93vebwur Voorbeeldantwoord <status code="ok" /> Zie ook logout

87 81 logout Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook login

88 82 meeting-disclaimer-info Beschikbaarheid Acrobat Connect Pro 7 Beschrijving Verschaft informatie over de tekst van de disclaimer die wordt weergegeven wanneer een gebruiker een vergadering betreedt. Zie meeting-disclaimer-update voor meer informatie over de disclaimer. Aanvraag-URL &account-id=integer &session=string Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account waarvoor de disclaimertekst moet worden opgehaald. Als er geen id wordt gebruikt, wordt de account waarbij u momenteel bent aangemeld, bijgewerkt. session Reeks N Een reeks, de waarde van het BREEZESESSION-cookie. Filters Filter kunnen niet worden gebruikt met deze actie. Antwoordenstructuur <status code=allowedvalue /> <disclaimer> string </disclaimer> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). disclaimer Reeks De tekst van de disclaimer. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <disclaimer> Deze vergadering wordt wellicht opgenomen voor compatibiliteitsdoeleinden. Klik op OK om akkoord te gaan met de voorwaarden van de vergadering. </disclaimer>

89 83 meeting-disclaimer-update Beschikbaarheid Acrobat Connect Pro 7 Beschrijving Werkt de tekst bij van de disclaimer die wordt weergegeven wanneer een gebruiker een vergadering betreedt. U kunt een disclaimer laten weergeven wanneer een gebruiker een vergadering betreedt om aan de voorschriften of normen op communicatiegebied te voldoen. In een disclaimer staat vaak boilerplate-informatie over uw bedrijf. Gebruikers ontvangen zo informatie over de status en de gebruiksvoorwaarden van de vergadering. In een disclaimer kan gebruikers bijvoorbeeld worden verteld dat de vergadering wordt opgenomen en dat gebruikers zich alleen bij de vergadering kunnen voegen als ze de disclaimerkennisgeving accepteren. Als de disclaimer is geactiveerd, wordt de kennisgeving in alle vergaderingen weergegeven. Activeer de disclaimer via de beheerconsole of door gebruik van de actie meeting-feature-update, met de parameter fid-meeting-disclaimer ingesteld op enabled. Aanvraag-URL &account-id=integer &disclaimer=string &session=string Parameters Waarde Type Vereist Beschrijving account-id Geheel getal N De id van de account waarvoor de disclaimertekst moet worden bijgewerkt. Als er geen id wordt gebruikt, wordt de account waarbij u momenteel bent aangemeld, bijgewerkt. disclaimer Reeks J De tekst van de disclaimer die wordt weergegeven wanneer een gebruiker een vergadering start. De disclaimer kan een gebruiker bijvoorbeeld op de hoogte stellen van het feit dat een vergadering wordt opgenomen. De disclaimer kan uit maximaal 1500 tekens bestaan. De tekst van de disclaimer kan met XML compatibele HTML-tags bevatten. Een voorbeeld: <b>deze vergadering wordt opgenomen.</b> session Reeks N De waarde van het BREEZESESSION-cookie. Antwoordenstructuur <status code=code /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag note that this meeting is being recorded.

90 84 Voorbeeldantwoord <status code="ok" /> meeting-feature-update Beschikbaarheid Acrobat Connect Pro 7 Web Services Beschrijving Schakelt de functies van een vergadering in of uit. Deze actie wordt gebruikt voor het beheer van functies, zoals het opnemen van vergaderingen of het bestuur van pods. Zie Compatibiliteitsinstellingen configureren voor nadere informatie over het gebruik van deze actie. U kunt meerdere feature-id- en enable-paren toevoegen aan het einde van de aanvraag-url. Aanvraag-URL name/api/xml?action=meeting-feature-update &account-id=integer &feature-id=value &enable=value Parameters Naam Type Vereist Beschrijving account-id Geheel getal J De id van uw Acrobat Connect Pro-account op een hostserver. De id voor bedrijfsinstallaties is 7. Voor installaties met een licentie gebruikt u commoninfo om de id op te vragen. feature-id Geheel getal J De id van de functie die u wilt in- of uitschakelen. Zie feature-id voor beschikbare id's. enable Booleaanse waarde J De opgegeven functie inschakelen (true) of niet inschakelen (false). Antwoordenstructuur <status code=code /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag In het volgende voorbeeld wordt de chatpod uitgeschakeld.

91 85 Voorbeeldantwoord <status code="ok" /> permissions-info Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert de lijst met principals (gebruikers of groepen) die machtigingen hebben om te handelen op 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 acties kunnen worden uitgevoerd. ACL staat voor access control list, ofwel toegangsbeheerlijst, en verwijst naar de lijst met entiteiten die een machtiging hebben. Met alleen een acl-id, geeft permissions-info een lijst met alle principals in de account als resultaat en wordt de machtiging van elke principal weergegeven in de principal of SCO die is opgegeven in de acl-id: Als u de machtigingen van een bepaalde principal voor een principal of SCO in een account wilt raadplegen, roept u permissions-info aan met een acl-id en een filter op principal-id: Als u de machtigingen van een principal voor een account wilt controleren, roept u permissions-info aan met zowel een acl-id (die een account-id opgeeft) als een principal-id: Aanvraag-URL &acl-id=integer &principal-id=integer &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving acl-id Geheel getal J De id van een SCO, account of principal waarop een principal acties kan uitvoeren. De acl-id is een sco-id, principal-id of account-id in andere aanroepen. principal-id Geheel getal N De id van een principal die een machtiging heeft (ook in geval van denied) om acties uit te voeren op een object. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat.

92 86 Antwoordenstructuur <status code=allowedvalue /> <permissions> <principal principal-id=integer is-primary=boolean type=allowedvalue has-children=boolean permission-id=integer training-group-id=integer> <name>string</name> <login>string</login> </principal></permissions>... <permission acl-id=integer permission-id=allowedvalue principal-id=integer /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). permissions Container Een lijst met principals die hun machtiging weergeven voor toegang tot de SCO, account of principal. 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 De machtiging die de principal heeft voor de SCO, account of principal (zie permission-id voor waarden). acl-id Geheel getal De id van de SCO waarvoor de machtiging is gedefinieerd. name Reeks De naam van de principal die machtiging heeft voor toegang tot de SCO. aanmelden Reeks De aanmeldingsnaam van de principal die machtiging heeft voor toegang tot de SCO. permission Leeg, met kenmerken Informatie over de machtiging die een principal heeft voor een SCO, account of principal. Er is geen machtiging gedefinieerd als hier niets is ingevuld. acl-id Geheel getal De id van het object waarvoor de principal een machtiging heeft. permission-id Toegestane waarde De machtiging van de principal om te handelen op het object (zie permission-id voor waarden). principal-id Geheel getal De id van de principal die de machtiging heeft om acties uit te voeren op het object. traininggroup-id Geheel getal De id van de trainingsgroep. Voorbeeldaanvraag

93 87 Voorbeeldantwoord <status code="ok" /> <permissions> <principal principal-id=" " is-primary="false" type="user" has-children="false" permission-id="host" training-group-id=" "> <name>joy Smith</name> </principal>... </permissions> Zie ook permissions-reset, permissions-update permissions-reset Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 &acl-id=integer &session=breezesessioncookievalue 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=code /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status).

94 88 Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook permissions-info, permissions-update permissions-update Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Pro. U kunt bijvoorbeeld permissions-update gebruiken om: Een gebruiker uit te nodigen voor een vergadering als deelnemer, presentator of gastheer (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 de trio's 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 &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). permission-id Reeks J De machtiging om toe te wijzen (zie permission-id voor waarden). session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

95 89 Antwoordenstructuur <status code=code /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &principal-id= &permission-id=host Voorbeeldantwoord <status code="ok" /> Zie ook permissions-info, permissions-reset principal-info Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt informatie over één 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

96 90 Antwoordenstructuur <status code=allowedvalue /> <contact> < >string</ > <first-name>string</first-name> <last-name>string</last-name> </contact> <manager account-id=integer disabled=boolean has-children=boolean is-hidden=boolean is-primary=boolean principal-id=integer type=allowedvalue> <ext-login>string</ext-login> <login>string</login> <name>string</name> < >string</ > <first-name>string</first-name> <last-name>string</last-name> <x-customfield1>string</x-customfield1> <x-customfield2>string</x-customfield2>... </manager> <preferences acl-id=integer lang=allowedvalue time-zone-id=allowedvalue /> <principal account-id=integer disabled=boolean has-children=boolean is-hidden=boolean is-primary=boolean principal-id=integer type=allowedvalue> <description>string</description> <ext-login>string</ext-login> <login>string</login> <name>string</name> < >string</ > <first-name>string</first-name> <last-name>string</last-name> <x-customfield1>string</x-customfield1> <x-customfield2>string</x-customfield2>... </principal> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Element van het hoogste niveau voor het antwoord. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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. Reeks Het adres van de contactpersoon. first-name Reeks De voornaam van de contactpersoon. last-name Reeks 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.

97 91 Element Kenmerk Type Beschrijving 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, is dit 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 Acrobat Connect Pro Central 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 Reeks Voor een groep, de groepsnaam. ext-login Reeks Voor een gebruiker is dit de aanmeldings-id die van een extern netwerk is verzonden. Standaard dezelfde waarde als login, dus wijzig deze als u externe verificatie gebruikt. login Reeks De aanmeldings-id van de principal in Acrobat Connect Pro. Deze kan hetzelfde zijn als een adres. name Reeks Voor een gebruiker is dit de volledige naam, samengesteld uit firstname en last-name. Reeks Voor een gebruiker is dit het adres. first-name Reeks Voor een gebruiker is dit de voornaam. last-name Reeks Voor een gebruiker is dit de achternaam. x-customfield Reeks 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 De id van de principal. lang Toegestane waarde De taalinstelling die de principal heeft gekozen voor Acrobat Connect Pro-toepassingen. time-zone-id Toegestane waarde De tijdzone-instelling die de principal heeft gekozen voor Acrobat Connect Pro-toepassingen. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <contact> < >bob@acme.com</ > <first-name>bob</first-name> <last-name>jones</last-name> </contact> <manager account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id=" " type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name>

98 92 <first-name>jazz</first-name> <last-name>doe</last-name> <x >san Francisco</x > </manager> <preferences acl-id=" " lang="en" time-zone-id="4" /> <principal account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id=" " type="user"> <name>joy Smith</name> <first-name>joy</first-name> <last-name>smith</last-name> <x >san Francisco</x > </principal> Zie ook principal-list, principal-list-by-field, principal-update principal-list Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Acrobat Connect Pro Server- of Acrobat Connect Pro-account op een hostserver 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: &filter-is-member=true filter-type=group retourneert echter groepen die u hebt gemaakt, maar geen geïntegreerde groepen die vooraf op de server zijn gedefinieerd. Geïntegreerde groepen hebben andere type-waarden dan group, zoals admins en authors (zie type voor een lijst met waarden). U kunt het antwoord filteren met een filter-type-parameter, ingesteld op het gewenste type groep, en vervolgens het antwoord parseren voor een principal-id en daarna de principal-id doorgeven als een group-id in een ander verzoek om de principal-list. Aanvraag-URL &group-id=integer &filter-definition=value &sort-definition=value &session=breezesessioncookievalue

99 93 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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Opmerking: filteren op het element login is nuttig, maar bijzonder traag en leidt tot teruglopende prestaties. U kunt ook filteren op een speciale veldnaam, manager-id, om bijvoorbeeld een lijst met principals als resultaat te geven die rapporteren aan een bepaalde manager: &filter-manager-id= Als u filter-manager-id gebruikt, heeft elk principal-element in het antwoord een manager-id-kenmerk: <status code="ok" /> <principal-list> <principal principal-id=" " account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false" manager-id=" "> <name>pat Lee</name> <login>plee@mycompany.com</login> < >plee@mycompany.com</ > </principal> </principal-list> Antwoordenstructuur <status code=allowedvalue /> <principal-list> <principal principal-id=integer account-id=integer type=allowedvalue has-children=boolean is-primary=boolean is-hidden=boolean manager-id=integer training-group-id=integer> <name>string</name> <login>string</login> < >string</ > </principal> </principal-list> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status).

100 94 Element Kenmerk Type Beschrijving principal-list Container De volledige lijst met principals. principal Container Details over één principal. principal-id Geheel getal De id van de principal. account-id Geheel getal De id van de account waartoe de principal behoort. type Toegestane waarde Het type principal (zie type voor waarden). 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 Acrobat Connect Pro Central of uw toepassing (true betekent dat de principal niet wordt weergegeven en false betekent dat de principal wel wordt weergegeven). manager-id Geheel getal De principal-id van de manager aan wie de principal rapporteert. Wordt alleen als resultaat gegeven als u filtermanager-id opneemt in de aanvraag. training-group-id= Geheel getal De id van de trainingsgroep. name Reeks De volledige naam van de principal. login Reeks De aanmeldings-id van de principal, meestal een adres. Reeks Het adres van de principal. principal-customfield-values Container De volledige lijst met aangepaste-veldwaarden die voor de principal zijn gedefinieerd. field Container Details over één aangepast veld dat voor de principal is gedefinieerd (zie field voor de inhoud). Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <principal-list> <principal principal-id="624526" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false" training-groupid=""> <name>ned mack</name> <login>nmack@acme.com</login> < >nmack@acme.com</ > </principal> <principal principal-id="624550" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false" training-groupid=""> <name>amelie jones</name> <login>amelie@example.com</login> < >amelie@example.com</ > </principal>... </principal-list>

101 95 Zie ook principal-info, principal-update, principal-list-by-field principal-list-by-field Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Vermeldt de principals die een bepaalde waarde in een aangepast veld hebben. Gebruik deze actie om een query uit te voeren op aangepaste velden voor principals. Gebruik principal-list om een lijst op te halen met de aangepaste velden die voor de principal zijn gedefinieerd. Typ de waarde van een aangepast databaseveld in de value-parameter. Het name-element dat door principal-list als resultaat wordt gegeven, is bijvoorbeeld een volledige naam die is samengesteld uit de databasevelden first-name (bob) en last-name (jones). Als u zoekt naar bob jones, geeft principal-list-by-field geen waarde als resultaat, tenzij de volledige naam als een databaseveld is gedefinieerd (in dit geval een aangepast veld gedefinieerd op principals). 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 aangepaste databasevelden die voor de principal zijn gedefinieerd, maar zoekt niet in principal-velden. Aanvraag-URL &value=string &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving value Reeks J De waarde die u in alle velden wilt zoeken. U hoeft geen veldnaam op te geven. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <principal-list> <principal account-id=integer principal-id=integer type=allowedvalue has-children=boolean is-primary=boolean is-hidden=boolean> <name>string</name> <login>string</login>

102 96 </principal> </principal-list> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). principal-list Container De hele lijst met principals die overeenkomen met de waarde in een of meer aangepaste velden. principal Container Een principal die overeenkomt met de waarde. principal-id Geheel getal De id van de principal. account-id Geheel getal De id van de account waartoe de principal behoort. type Toegestane waarde Het type principal (zie type voor waarden). has-children Booleaanse waarde Geeft aan of de principal onderliggende niveaus heeft. Groepen hebben onderliggende niveaus, gebruikers niet, en dus geeft dit kenmerk aan of de principal een groep is. 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 is verborgen in de gebruikersinterface (true) of niet (false). name Reeks De volledige naam van de principal, bestaande uit de velden firstname en last-name. login Reeks De aanmeldings-id van de principal, meestal een adres. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <principal-list> <principal account-id="624520" principal-id=" " type="user" has-children="false" is-primary="false" is-hidden="false"> <name>bob Jones</name> </principal> </principal-list> Zie ook principal-info, principal-list, principal-update

103 Hoofdstuk 6 ADOBE ACROBAT CONNECT PRO principals-delete Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &principal-id= &principal-id= Voorbeeldantwoord <status code="ok" />

104 98 Zie ook principal-info, principal-list, principal-list-by-field, principal-update principal-update Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Hiermee maakt u een principal (een gebruiker of groep) of werkt u een standaardveld voor een principal bij. 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 principal-id 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. Als een principal aangepaste velden heeft, gebruikt u acl-field-update in plaats van principal-update om ze bij te werken. U hebt beheerdersrechten nodig om een principal te kunnen maken of bijwerken. Aanvraag-URL &description=string & =string &first-name=string &has-children=boolean &first-name=string &login=string &name=string &password=string &principal-id=integer &send- =boolean &type=allowedvalue &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving description Reeks N De beschrijving van de nieuwe groep. Alleen gebruiken wanneer u een nieuwe groep maakt. Reeks N Het adres van de gebruiker. Kan afwijken van de login. Zorg dat u een waarde opgeeft wanneer u send- =true gebruikt. first-name Reeks J/N De nieuwe voornaam van de gebruiker. Alleen gebruiken voor gebruikers, niet voor groepen. Vereist om een gebruiker te 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 Reeks J/N De nieuwe achternaam die u aan de gebruiker toewijst. Vereist om een gebruiker te maken. Niet gebruiken voor groepen. login Reeks J/N De nieuwe aanmeldingsnaam van de principal, meestal het adres van de principal. Moet uniek zijn op de server. Vereist om een gebruiker te maken of bij te werken. Niet gebruiken voor groepen. name Reeks J/N De naam van de nieuwe groep. Alleen gebruiken wanneer u een nieuwe groep maakt. Vereist om een groep te maken.

105 99 Naam Type Vereist Beschrijving password Reeks N Het wachtwoord van de nieuwe gebruiker. Alleen gebruiken wanneer u een nieuwe gebruiker maakt. principal-id Reeks 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 een gebruiker of groep te maken. send- Booleaanse waarde N Een vlag die aangeeft of de server een moet sturen aan de principal met de account- en aanmeldingsgegevens. type Reeks J/N Het type principal. Alleen gebruiken wanneer u een nieuwe principal maakt (zie type voor waarden). session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <principal principal-id=integer account-id=integer has-children=integer type=integer> <login>string</login> <ext-login>string</ext-login> <name>string</name> </principal> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). principal Container Informatie over de net gemaakte principal. principal-id Geheel getal De id van de net gemaakte gebruiker. account-id Geheel getal De id van de account waartoe de nieuwe gebruiker behoort. Deze waarde is het zelfde 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 Het type principal (zie type voor waarden). login Reeks De aanmeldings-id van de principal, meestal een adres. ext-login Reeks 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 Reeks De naam van de principal. Als de principal een gebruiker is, wordt deze samengesteld door samenvoeging van de parameters first-name en last name in de aanvraag. Voorbeeldaanvraag &last-name=doe&has-children=0&login=jakedoe@example.com&type=user

106 100 Voorbeeldantwoord <status code="ok" /> <principal principal-id=" " account-id="624520" type="user" has-children="0"> <name>jake doe</name> </principal> Zie ook principal-info, principal-list, principal-list-by-field, acl-field-update quota-threshold-info Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Verschaft de lijst met quota waarvoor capaciteitsmeldingen worden verschaft en met de actuele drempelinstellingen. Elke Acrobat Connect Pro-account heeft systeemquota die bijvoorbeeld bepalen hoeveel zetels beschikbaar zijn voor gastheren van vergaderingen, studenten, enzovoort. Elk quotum heeft een drempel. Wanneer deze drempel wordt overschreden, laat het systeem de beheerders weten dat het quotum bijna is bereikt. De drempel- en meldingsinstellingen verschillen per quotum. Aanvraag-URL &account-id=integer &session=integer Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account waarvan u de quotumdrempel wilt weten. Als u geen id opgeeft, wordt de account waarbij de gebruiker momenteel is aangemeld, gebruikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Antwoordenstructuur <status code=allowedvalue /> <Principals> <Principal principal-id="integer" type="string"/> </Principals> <Quotas> <Quota acl-id="integer" quota-id="string" threshold-pct="integer" loginnotif="boolean" -notif="boolean" monthly- s="boolean" limit="integer" used="integer"/>

107 101 <Quota acl-id="integer" quota-id="string" threshold-pct="integer" loginnotif="boolean" -notif="boolean" monthly- s="boolean" limit="intger" used="integer"/> </Quotas> <Trees> <Tree tree-id="integer" type="string"/> </Trees> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Principals Container Vermeldt de principals die de groepen opgeven waarvoor meldingen met betrekking tot de systeemcapaciteit worden verschaft. Principal Container Informatie over de principal waarvoor een melding met betrekking tot systeemcapaciteit wordt verschaft. principal-id Geheel getal De principal-id die de groep bepaalt. type Reeks Het type groep. Afhankelijk van de licentie, kan dit een van de volgende waarden zijn: authors live-admins, geeft aan dat het de groep Gastheren van vergadering is Quota Container Geeft een overzicht weer van de quota. Quota Container Informatie over het quotum en de bijbehorende instellingen. acl-id Geheel getal De ACL-id van het quotum. quota-id Geheel getal De id van het quotum. Zie ''quota-id'' op pagina 194 voor mogelijke waarden. threshold-pct Geheel getal De in procenten uitgedrukte drempelwaarde. login-notif Booleaanse waarde Geeft aan of beheerders bij het aanmelden worden gewaarschuwd dat een drempel is overschreden (true) of niet (false). -notif Booleaanse waarde Geeft aan of beheerders via worden gewaarschuwd dat een drem pel is overschreden (true) of niet (false). monthly- s Booleaanse waarde Geeft aan of beheerders maandelijkse drempelrapporten ontvangen via e mail (true) of niet (false). limit Geheel getal De beperking van het aantal lidmaatschapszetels. used Geheel getal Aantal verbruikte lidmaatschapszetels. Trees Container Verschaft informatie over de structuurtypenquota (het quotum voor het aantal gelijktijdige gebruikers per vergadering). Tree Container Informatie over de structuur. tree-id Geheel getal De id van de structuur. type Reeks Het type structuur, dit kan een van de volgende waarden zijn: meetings user-meetings Voorbeeldaanvraag

108 102 Voorbeeldantwoord <status code="ok" /> <Principals> <Principal principal-id="20013" type="authors"/> <Principal principal-id="10051" type="live-admins"/> </Principals> <Quotas> <Quota acl-id="7" quota-id="training-user" threshold-pct="90" login-notif="true" -notif="true" monthly- s="true" limit="10" used="0"/> <Quota acl-id="20013" quota-id="num-of-members-quota" threshold-pct="10" loginnotif="true" -notif="true" monthly- s="true" limit="10" used="3"/> </Quotas> <Trees/> quota-threshold-exceeded Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Retourneert informatie over systeemquotumdrempels die zijn overschreden. Elke Acrobat Connect Pro-account heeft systeemquota die bijvoorbeeld bepalen hoeveel zetels beschikbaar zijn voor gastheren van vergaderingen, studenten, enzovoort. Elk quotum heeft een drempel. Wanneer deze drempel wordt overschreden, laat het systeem de beheerders weten dat het quotum bijna is bereikt. De drempel is afhankelijk van het quotum. Zie het Acrobat Connect Pro Handboek voor meer informatie over automatische meldingen. Aanvraag-URL &account-id=integer &acl-id=integer &quota-id=string &num-of-days=integer &session=string Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account. Geef account-id of acl-id op, maar niet allebei. Als u geen account-id of acl-id opgeeft, worden resultaten geretourneerd voor de account waarbij de huidige gebruiker is aangemeld. Als u account-id opgeeft, worden resultaten geretourneerd voor alle quotumdrempels die in de account zijn bereikt. acl-id Geheel getal N De id van de SCO, account of principal waarvoor u drempelinformatie wilt. Dit kan een geldige sco-id, account-id of principal-id zijn. Als u geen waarde opgeeft voor acl-id, wordt de waarde voor account-id gebruikt. De waarde die voor acl-id wordt gebruikt, is afhankelijk van de quotum-id die wordt gebruikt. Zie ''quota-id'' op pagina 194 voor nadere informatie.

109 103 Naam Type Vereist Beschrijving quota-id Reeks N De id van het systeemquotum waarover u meer informatie wilt. Zie ''quota-id'' op pagina 194 voor beschikbare waarden. num-of-days Geheel getal N Het aantal dagen vanaf de huidige dag waarvoor records worden opgehaald. Als u geen waarde opgeeft, worden alle vorige records voor de opgegeven quota opgehaald. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Antwoordenstructuur <status code=allowedvalue /> <Records> <Record acl-id="integer" quota-id="string" peak-used="integer" count="integer" threshold-pct="integer" sco-id="integer"> <record-date>date</record-date> </Record> </Records> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Records Container Geeft een overzicht van de als resultaat gegeven records. Record Container Vermeldt informatie over de als resultaat gegeven record. acl-id Geheel getal De id van de als resultaat gegeven ACL. quota-id Reeks De id van het als resultaat geretourneerde quotum. Zie ''quota-id'' op pagina 194 voor beschikbare waarden. peak-used Geheel getal De piekwaarde van het quotum op de opgegeven dag. Dit kenmerk is null voor training- en groepquota. count Geheel getal Het aantal malen dat de quotumdrempel op de opgegeven dag is overschreden. Dit kenmerk is null voor training- en groepquota. threshold-pct Geheel getal Percentagedrempel op moment dat de drempel werd overschreden. sco-id Geheel getal De id van de vergadering waarvoor de drempel is overschreden. Dit kenmerk is alleen van toepassing op de quotum-id concurrentusers-per-meeting. Voor andere quota is het null. Record-date Datum Datum waarop de drempel is overschreden (UTC), in de notatie MM/DD/JJJJ. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <Records>

110 104 <Record acl-id="20013" quota-id="num-of-members-quota" peak-used="" count="" threshold-pct="10" sco-id=""> <record-date>11/20/2007</record-date> </Record> </Records> quota-threshold-update Beschikbaarheid Acrobat Connect Pro Server 7 Beschrijving Hiermee worden de drempelinstellingen van de opgegeven quota bijgewerkt. Elke Acrobat Connect Pro-account heeft systeemquota die bijvoorbeeld bepalen hoeveel zetels beschikbaar zijn voor gastheren van vergaderingen, trainers, trainingsmanagers, enzovoort. Elk quotum heeft een drempel. Wanneer deze drempel wordt overschreden, laat het systeem de beheerders weten dat het quotum bijna is bereikt. De instellingen voor de drempels en meldingen verschillen per quotum en u kunt de instellingen met gebruik van deze actie configureren. Aanvraag-URL &account-id=integer &acl-id=integer &quota-id=string &threshold-pct=integer &login-notif=boolean & -notif=boolean &monthly- s=boolean Parameters Naam Type Vereist Beschrijving account-id Geheel getal N De id van de account waarvoor de quotuminstellingen worden bijgewerkt. acl-id Geheel getal J De id van de SCO, account of principal waarvoor u drempelinformatie wilt. Dit kan een geldige sco-id, account-id of principal-id zijn. Als u geen waarde opgeeft voor acl-id, wordt de waarde voor account-id gebruikt. De waarde die voor acl-id wordt gebruikt, is afhankelijk van de quotum-id die wordt gebruikt. Zie ''quota-id'' op pagina 194 voor nadere informatie. quota-id Reeks J De id van het quotum waarvoor instellingen worden bijgewerkt. Zie ''quota-id'' op pagina 194 voor beschikbare waarden. threshold-pct Geheel getal J De in procenten uitgedrukte drempel voor het quotum. Hoe lager de waarde, hoe vaker beheerders op de hoogte worden gesteld wanneer de drempel wordt overschreden (als meldingen zijn ingeschakeld). login-notif Booleaanse waarde J Geeft aan of beheerders bij het aanmelden worden gewaarschuwd dat een drempel is overschreden (true) of niet (false). -notif Booleaanse waarde J Geeft aan of beheerders via worden gewaarschuwd dat een drempel is overschreden (true) of niet (false). monthly- s Booleaanse waarde J Geeft aan of beheerders maandelijkse drempelrapporten ontvangen via (true) of niet (false). session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt.

111 105 Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook quota-threshold-info, quota-threshold-exceeded report-active-meetings Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert een lijst met Adobe Acrobat Connect Pro-vergaderingen die momenteel aan de 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 &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

112 106 Antwoordenstructuur <status code=allowedvalue /> <report-active-meetings> <sco sco-id=integer active-participants=integer length-minutes=integer> <name>string</name> <url-path>string</url-path> <date-begi>datetime</date-begin> </sco> <report-active-meetings> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-active-meetings Container De lijst met alle vergaderingen die op dat moment plaatsvinden. sco Container Informatie over één vergadering die op dat moment plaatsvindt. sco-id Geheel getal De unieke id van een vergadering die op dat moment plaatsvindt. active-participants Geheel getal Het aantal gebruikers dat aanwezig is bij de vergadering die op dat moment plaatsvindt, inclusief gastheren en presentatoren. length-minutes Geheel getal Het aantal minuten dat de vergadering actief is geweest. name Reeks De naam van de vergadering, gedefinieerd toen de vergadering werd gemaakt. url-path Reeks Het deel van de vergadering-url dat op het domein volgt en dat uniek is voor deze vergadering. date-begin Datetime De datum en tijd waarop de vergadering is begonnen. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-active-meetings> <sco sco-id=" " active-participants="" length-minutes="1"> <name>designing Online Courses</name> <url-path>/online/</url-path> <date-begin> t14:35: :00</date-begin> </sco> <report-active-meetings>

113 107 report-bulk-consolidated-transactions Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert informatie over principal-to-sco-transacties op uw Acrobat Connect Pro-server of in uw Acrobat Connect Proaccount op een hostserver. Een transactie is een instantie van een principal die een SCO bezoekt. De SCO kan een Acrobat Connect Pro-vergadering, -cursus of -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: &filter-type=meeting Uit het antwoord kunt u het Acrobat Connect Pro-vergadergebruik berekenen door de tijden bij date-created en date closed te vergelijken (zie ''Vergadergebruik berekenen''). Deze aanroep naar report-bulk-consolidatedtransactions met filter-type=meeting retourneert alleen gebruikers die als deelnemers zijn aangemeld bij de vergadering. Gebruikers die als gast deelnemen, worden niet als resultaat gegeven. Aanvraag-URL &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-bulk-consolidated-transactions> <row transaction-id=integer sco-id=integer type=allowedvalue principal-id=integer score=integer> <name>string</name>

114 108 <url>relativeurl</url> <login>string</login> <user-name>string</user-name> <status>allowedvalue</status> <date-created>datetime</date-created> <date-closed>datetime</date-closed> </row>... </report-bulk-consolidated-transactions> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-bulk-consolidated-transactions Container De hele lijst met transacties die overeenkomen met het verzoek. row 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 de transactie (bijvoorbeeld een quiz) een score heeft toegewezen. Anders 0. name Reeks De naam die is toegewezen aan de SCO die bij de transactie is betrokken. url Reeks Het gedeelte met de bestandsnaam van de URL naar de SCO die bij de transactie is betrokken. login Reeks De aanmeldings-id van de principal. user-name Reeks 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, user-passed 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.

115 109 Voorbeeldaanvraag &filter-type=meeting Voorbeeldantwoord <status code="ok" /> <report-bulk-consolidated-transactions> <row transaction-id=" " sco-id=" " type="meeting" principal-id=" " score="0"> <name>celebrate End of June Meeting</name> <url>/endjune/</url> <user-name>joy Smith</user-name> <status>completed</status> <date-created> t11:10: :00</date-created> <date-closed> t11:45: :00</date-closed> </row> <row transaction-id=" " sco-id=" " type="meeting" principal-id=" " score="0"> <name>celebrate End of June Meeting</name> <url>/endjune/</url> <user-name>joy Smith</user-name> <status>completed</status> <date-created> t17:58: :00</date-created> <date-closed> t17:59: :00</date-closed> </row>... </report-bulk-consolidated-transactions> 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 Beschrijving Retourneert informatie over alle objecten (SCO's) op een in licentie verleende Acrobat Connect Pro Server of in een Acrobat Connect Pro-account op een hostserver. De geretourneerde objecttypen zijn onder meer archive, attachment, authorware, captivate, course, curriculum, external-event, flv, image, meeting, presentation en swf. Aangezien het antwoord waarschijnlijk omvangrijk is, past u filters toe om het te reduceren. Als u bijvoorbeeld een lijst wilt retourneren van alle vergaderingen op de server, filtert u op het veld type: Aanvraag-URL &filter-definition=value &sort-definition=value &session=breezesessioncookievalue

116 110 Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-bulk-objects> <row sco-id=integer type=allowedvalue> <url>string</url> <name>string</name> <date-created>datetime</date-created> <date-end>datetime</date-end> <date-modified>datetime</date-modified> <description>datetime</description> </row>... </report-bulk-objects> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-bulk-objects Container De hele lijst met SCO's op de server. Als u een filter gebruikt: de hele lijst met SCO's die overeenkomen met het filter. row Container Details van een SCO. sco-id Geheel getal De unieke id van de SCO. type Toegestane waarde Het type SCO (zie type). url Reeks De unieke identificatiecode van de training-sco, die in de URL achter de domeinnaam wordt geplaatst. name Reeks De naam die aan de SCO is toegewezen. date-created Datetime De datum waarop de SCO is gemaakt. Voor een vergadering is dit de datum en tijd waarop de vergadering begint. date-end Datetime Als de SCO een vergadering of gebeurtenis is, is dit de datum waarop deze is beëindigd. date-modified Datetime De datum waarop de SCO voor het laatst is bijgewerkt. description Reeks De beschrijving van de SCO. Voorbeeldaanvraag &filter-gt-date-created=

117 111 Voorbeeldantwoord <status code="ok" /> <report-bulk-objects> <row sco-id=" " type="meeting"> <url>/online/</url> <name>designing Online Courses</name> <date-created> t14:15: :00</date-created> <date-end> t14:30: :00</date-end> <date-modified> t14:57: :00</date-modified> </row>... </report-bulk-objects> Zie ook report-bulk-consolidated-transactions, report-bulk-questions, report-bulk-slide-views, report-bulk-users report-bulk-questions Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur

118 112 <status code=allowedvalue /> <report-bulk-questions> <row transaction-id=integer score=integer principal-id=integer> <question>string</question> <response>string</response> <date-created>datetime</date-created> </row>... </report-bulk-questions> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-bulk-questions Container De hele lijst met vraag- en antwoordcombinaties die met het verzoek overeenkomen. row Container Details over een vraag- en antwoordcombinatie. transaction-id Geheel getal De id van de interactie tussen een gebruiker en een quiz. 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 Reeks De tekst van de vraag, die als een verklaring kan zijn vermeld. response Reeks Het antwoord dat de gebruiker heeft gekozen of ingevoerd. date-created Datetime De datum en tijd waarop de gebruiker de vraag heeft beantwoord. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-bulk-questions> <row transaction-id=" " score="10" principal-id=" "> <question>the capital of California is<1></question> <response>sacramento</response> <date-created> t15:50: :00</date-created> </row> <row transaction-id=" " score="0" principal-id=" "> <question>the capital of California is<1></question> <response>san francisco</response> <date-created> t17:32: :00</date-created> </row> </report-bulk-questions> Zie ook report-bulk-objects, report-bulk-consolidated-transactions, report-bulk-slide-views, report-bulk-users

119 113 report-bulk-slide-views Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Acrobat Connect Pro. 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 &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-bulk-slide-views> <row transaction-id=integer principal-id=integer> <page>integer</page> <date-created>datetime</date-created> </row>... </report-bulk-slide-views> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-bulk-slide-views Container De hele lijst met diaweergaven die overeenkomen met het verzoek. row Container Details over een diaweergave.

120 114 Element Kenmerk Type Beschrijving transactionid Geheel getal De id van de transactie tussen de gebruiker en de dia. principal-id Geheel getal De id van de gebruiker die de dia heeft weergegeven. pagina Geheel getal Het paginanummer van de dia in de presentatie. date-created Datetime De datum en tijd waarop de gebruiker de dia heeft weergegeven. Voorbeeldaanvraag &filter-principal-id= Voorbeeldantwoord <status code="ok" /> <report-bulk-slide-views> <row transaction-id=" " principal-id="123456"> <page>0</page> <date-created> t12:02: :00</date-created> </row> <row transaction-id=" " principal-id="123456"> <page>0</page> <date-created> t12:02: :00</date-created> </row>... </report-bulk-slide-views> Zie ook report-bulk-objects, report-bulk-questions, report-bulk-consolidated-transactions, report-bulk-users report-bulk-users Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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: &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 velden in de lijst van het scherm Gebruikersprofiel aanpassen in Acrobat Connect Pro Central (bij Beheer > Gebruikers en groepen > Gebruikersprofiel aanpassen).

121 115 Als u Acrobat Connect Pro 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 de de Installatie- en configuratiegids voor Adobe Acrobat Connect Pro voor meer informatie). 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 een Acrobat Connect Pro-account op een hostserver. Aanvraag-URL &custom-fields=boolean &filter-definition=value &sort-definition=value &session=breezesessioncookievalue 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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. U kunt filter-type samen met report-bulk-users gebruiken om het type gebruiker dat als resultaat wordt gegeven (user of guest) te filteren. Antwoordenstructuur <status code=allowedvalue /> <report-bulk-users> <row principal-id=integer type="string"> <login>string</login> <name>string</name> < >string</ > <manager>string</manager>.. any custom fields.. </row>... </report-bulk-users> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Element van het hoogste niveau voor het antwoord. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-bulk-users Container De hele lijst met gebruikers in de account. row Container Details van één gebruiker in de account.

122 116 Element Kenmerk Type Beschrijving principal-id Geheel getal De id van de gebruiker. type Reeks Het type gebruiker, user of guest. login Reeks De aanmeldings-id van de gebruiker, meestal een adres. name Reeks De volledige naam van de gebruiker, samengesteld uit de voornaam en de achternaam van de gebruiker. Reeks Het adres van de gebruiker. manager Reeks 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. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-bulk-users> <row principal-id=" " type="guest"> <name>john Owens</name> </row> <row principal-id=" " type="user"> <name>john Smith</name> </row>... </report-bulk-users> Zie ook report-bulk-objects, report-bulk-questions, report-bulk-slide-views, report-bulk-consolidatedtransactions report-course-status Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Geeft samenvattingsinformatie over een cursus als resultaat, zoals het aantal gebruikers die voor de cursus zijn geslaagd of gezakt, die de cursus hebben voltooid en het aantal momenteel ingeschreven personen. Voor deze aanvraag is de sco-id van een cursus vereist. Acrobat Connect Pro Central gebruikt deze aanroep om de status van een cursus weer te geven in het overzichtsrapport. U kunt dit rapport weergeven door Training > Gedeelde training > [naam van cursus] > Rapporten > Overzicht te kiezen.

123 117 Aanvraag-URL &sco-id=integer &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving sco-id Geheel getal J De unieke id van de cursus waarvan u de overzichtsinformatie wilt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-course-status total-course-completions=integer total-unique-course-completions=integer num-passed=integer num-failed=integer num-enrollees=integer /> <date-last-taken>datetime</date-last-taken> </report-course-status> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-course-status Container Overzichtsinformatie over een cursus. total-course-completions Geheel getal Het aantal malen dat gebruikers de cursus hebben voltooid, inclusief de voldoende scores, onvoldoende scores en meerdere pogingen van dezelfde gebruiker. total-unique-course-completions Geheel getal Het aantal malen dat verschillende gebruikers de cursus hebben voltooid, inclusief de voldoende en onvoldoende scores, maar niet meerdere pogingen van dezelfde gebruiker. num-completed Geheel getal Het aantal gebruikers dat de cursus heeft voltooid, voor cursussen die geen voldoende hebben. num-passed Geheel getal Het aantal gebruikers dat voor de cursus is geslaagd, voor cursussen die een voldoende score hebben.

124 118 Element Kenmerk Type Beschrijving num-failed Geheel getal Het aantal gebruikers dat voor de cursus is gezakt, voor cursussen die een voldoende score hebben. num-enrollees Geheel getal Het aantal gebruikers dat momenteel is ingeschreven voor de cursus. date-last-taken Datetime De laatste maal dat een willekeurige gebruiker heeft geprobeerd de cursus af te leggen, maar niet in de beoordelingsmodus op de server. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-course-status total-course-completions="1" total-unique-course-completions="1" num-completed="0" num-passed="1" num-failed="0" num-enrollees="4"> <date-last-taken> t13:55: :00</date-last-taken> </report-course-status> 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 studiepunten zijn toegekend, de score van de gebruiker, het unieke url-path naar de cursus, enzovoort. Aanvraag-URL &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

125 119 Antwoordenstructuur <status code=allowedvalue /> <report-curriculum-taker> <sco transcript-id=integer path-type=allowedvalue asset-id=integer sco-id=integer depth=integer folder-id=integer type=integer icon=allowedvalue lang=allowedvalue max-retries=integer source-sco-id=integer source-sco-type=allowedvalue status=allowedvalue score=integer certificate=integer max-score=integer attempts=integer> <access>allowedvalue</access> <credit-granted>boolean</credit-granted> <name>string</name> <url-path>string</url-path> <date-modified>datetime</date-modified> <override>boolean</override> </sco> </report-curriculum-taker> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-curriculum-taker 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 path-type voor toegestane waarden). asset-id Geheel getal De versie van de cursus die of het studieprogramma dat de gebruiker probeert te voltooien. De asset-id wordt steeds 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).

126 120 Element Kenmerk Type Beschrijving icon Toegestane waarde Het type pictogram waarmee de cursus of het studieprogramma wordt geïdentificeerd in Acrobat Connect Pro Central (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 drie maal kan volgen is max-retries 2. 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. 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 maximaal haalbare 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 van de gebruiker voor de cursus of het studieprogramma (zie access voor toegestane waarden). credit-granted Booleaanse waarde Een waarde die aangeeft of studiepunten zijn toegekend voor de cursus of het studieprogramma. name Reeks De naam van het leerobject of het studieprogramma. url-path Reeks 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 8601-notatie. override Booleaanse waarde Een waarde die aangeeft of de transcriptie van de SCO is aangepast. Voorbeeldaanvraag &user-id= &sco-id= Voorbeeldantwoord <status code="ok" /> <report-curriculum-taker>

127 121 <sco transcript-id=" " path-type="prereq-none" asset-id=" " sco-id=" " depth="0" folder-id=" " type="content" icon="producer" lang="en" max-retries="" source-sco-id="" source-sco-type="" status="user-failed" score="0" certificate="" max-score="0" attempts="5"> <access>access-open</access> <credit-granted>false</credit-granted> <name>test Quiz</name> <url-path>/quiz/</url-path> <date-created> t15:24: :00</date-created> <date-modified> t15:22: :00</date-modified> <date-taken> t15:24: :00</date-taken> <override>false</override> </sco> </report-curriculum-taker> report-meeting-attendance Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert een lijst met gebruikers die een Acrobat Connect Pro-vergadering hebben bijgewoond. 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 antwoord 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 &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue />

128 122 <report-meeting-attendance> <row transcript-id=integer sco-id=integer principal-id=integer answered-survey=boolean> <login>string</login> <session-name>string</session-name> <sco-name>string</sco-name> <date-created>datetime</date-created> <date-end>datetime</date-end> <participant-name>string</participant-name> </row>... </report-meeting-attendance> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-meeting-attendance 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 een opiniepeiling in de vergadering heeft beantwoord. Als de waarde 0 of false is, bevat de vergadering geen opiniepeiling of heeft de deelnemer de opiniepeiling niet beantwoord (het tegenovergestelde is van toepassing als de waarde 1 of true is). Deze waarde wordt bijgewerkt wanneer de opiniepeiling wordt gesloten. login Reeks De aanmeldingsnaam van de deelnemer aan de vergadering. session-name Reeks De naam van de gebruiker die de vergaderruimte heeft betreden, en zo een sessie heeft gemaakt. sco-name Reeks 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 Reeks De naam van de deelnemer aan de vergadering zoals deze bij de server is geregistreerd. Voorbeeldaanvraag &sco-id= Voorbeeldantwoord <status code="ok" />

129 123 <report-meeting-attendance> <row transcript-id=" " sco-id=" " principal-id=" " answered-survey="0"> <session-name>joy Smith</session-name> <sco-name>designing Online Courses</sco-name> <date-created> t14:35: :00</date-created> <date-end> t15:09: :00</date-end> <participant-name>joy Smith</participant-name> </row> </report-meeting-attendance> report-meeting-concurrent-users Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert het maximum aantal gelijktijdige gebruikers in Acrobat Connect Pro-vergaderingen gedurende de afgelopen 30 dagen, en het aantal keren waarop het maximum is bereikt. Het maximum is het hoogste aantal gebruikers in een vergadering op één moment, tijdens een vergadering, meerdere gelijktijdige vergaderingen of meerdere overlappende vergaderingen. 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 maximumaantal 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-meeting-concurrent-users max-users=integer max-participants-freq=integer />

130 124 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-meeting-concurrent-users Leeg, met kenmerken Informatie over het piekaantal gebruikers in vergaderingen die op hetzelfde moment plaatsvinden. max-users Geheel getal Het hoogste aantal 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. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-meeting-concurrent-users max-users="400" max-participants-freq="1" /> report-meeting-sessions Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt informatie over alle sessies van een Acrobat Connect Pro-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 wekelijkse vergadering heeft bijvoorbeeld 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 &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 waarover u sessie-informatie wilt. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt.

131 125 Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-meeting-sessions> <row sco-id=integer asset-id=integer version=integer num-participants=integer> <date-created>datetime</date-created> <date-end>datetime</date-end> </row>... </report-meeting-sessions> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-meeting-sessions Container De hele lijst met sessies van de vergadering. row Container Informatie over één sessie. sco-id Geheel getal De unieke id van de vergadering. asset-id Geheel getal De unieke id van de sessie. version Geheel getal Een volg-id voor de sessie, te beginnen met 1. 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. Voorbeeldaanvraag &sco-id= Voorbeeldantwoord <status code="ok" /> <report-meeting-sessions> <row sco-id=" " asset-id=" " version="1" num-participants="1"> <date-created> t11:46: :00</date-created> <date-end> t13:34: :00</date-end> </row> </report-meeting-sessions>

132 126 report-meeting-summary Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert overzichtsinformatie over een specifieke Acrobat Connect Pro-vergadering. De resultaten geven naast andere informatie over de vergadering aan hoeveel gebruikers waren uitgenodigd en hoeveel uitgenodigde deelnemers en gasten aanwezig waren. 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 report-meeting-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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-meeting-summary num-unique-meetings=integer peak-users=integer num-invitees=integer num-invitees-attended=integer ispublic=boolean num-guests-attended=integer /> Geretourneerde XML-elementen Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-meeting-summary 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 tijden plaatsvindt.

133 127 Element Kenmerk Type Beschrijving peak-users Geheel getal Het hoogste aantal gelijktijdige deelnemers in de vergaderruimte tijdens één vergaderinginstantie. num-invitees Geheel getal Het aantal uitgenodigde gebruikers. num-invitees-attended 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. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-meeting-summary num-unique-meetings="1" peak-users="1" num-invitees="1" num-invitees-attended="1" ispublic="1" num-guests-attended="0"> <most-recent-session> T15:11: :00 </most-recent-session> </report-meeting-summary> report-my-courses Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt informatie over iedere cursus waarvoor de huidige gebruiker is of was ingeschreven. De geretourneerde cursussen omvatten cursussen in het verleden, cursussen in de toekomst en cursussen die de gebruiker op dit moment volgt. De lijst met cursussen kan 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 &filter-definition=value &sort-definition=value &session=breezesessioncookievalue

134 128 Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <my-courses> <course sco-id=integer type="content" icon="course" permission-id=allowedvalue> <name>string</name> <description>string</description> <url>string</url> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <date-begin>datetime</date-begin> <url-path>string</url-path> <expired>boolean</expired> <completed>boolean</completed> </course>... </my-courses> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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. permission-id Toegestane waarde Het toegangsniveau van de gebruiker tot de cursus (zie permission-id voor waarden). name Reeks De naam van de cursus. url Reeks 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.

135 129 Element Kenmerk Type Beschrijving 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 Reeks 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 Voorbeeldantwoord <status code="ok" /> <my-courses> <course sco-id=" " type="content" icon="course" permission-id="view"> <name>test Course</name> <url>example.com/test/</url> <date-created> t10:21: :00</date-created> <date-modified> t10:22: :00</date-modified> <date-begin> t10:15: :00</date-begin> <url-path>/test/</url-path> <expired>false</expired> <completed>false</completed> </course> </my-courses> report-my-events Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Acrobat Connect Pro Server- of uw Acrobat Connect Pro-account op de hostserver, roept u sco-shortcuts aan om de sco-id van de map events op te vragen. Roep vervolgens sco contents aan met de sco-id om alle gebeurtenissen te vermelden. Aanvraag-URL &filter-definition=value &sort-definition=value &session=breezesessioncookievalue

136 130 Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <my-events> <event sco-id=integer type="event" icon="event" permission-id=allowedvalue> <name>string</name> <domain-name>string</domain-name> <url-path>string</url-path> <date-begin>datetime</date-begin> <date-end>datetime</date-end> <expired>boolean</expired> <duration>datetime/duration> </event>... </my-events> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 van de gebruiker voor de gebeurtenis (zie permissionid voor waarden). name Reeks De naam van de gebeurtenis. domain-name Reeks De domeinnaam van de Acrobat Connect Pro-server die na (of en vóór de unieke gebeurtenisnaam in de URL van de gebeurtenis staat. url-path Reeks De unieke gebeurtenisnaam, die na de domeinnaam in de URL van de gebeurtenis staat.

137 131 Element Kenmerk Type Beschrijving date-begin Datum De datum waarop de gebeurtenis begint, uitgedrukt in de ISO notatie. date-end Datum De datum waarop de gebeurtenis stopt, uitgedrukt in de ISO 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 het tijdgedeelte van een ISO 8601-datumnotatie. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <my-events> <event sco-id=" " type="event" icon="event" permission-id="host"> <name>meet the Famous Author</name> <domain-name>example.com</domain-name> <url-path>/author/</url-path> <date-begin> t18:00: :00</date-begin> <date-end> t20:00: :00</date-end> <expired>true</expired> <duration>02:00:00.000</duration> </event> </my-events> report-my-meetings Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt informatie over alle Acrobat Connect Pro-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. Aanvraag-URL &filter-definition=value &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt.

138 132 Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <my-meetings> <meeting sco-id=integer type="meeting" icon="meeting" permission-id=allowedvalue active-participants=integer> <name>string</name> <description>string</description> <domain-name>domain</domain-name> <url-path>url</url-path> <date-begin>date</date-begin> <date-end>date</date-end> <expired>boolean</expired> <duration>time</duration> </meeting>... </my-meetings> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 De unieke id van de vergadering. type Toegestane waarde Het type object dat is geretourneerd (voor deze aanroep altijd meeting). icon Toegestane waarde Het pictogram dat de vergadering in Acrobat Connect Pro Central op visuele wijze identificeert (voor deze aanroep altijd meeting). permission-id Toegestane waarde Het machtigingsniveau van de gebruiker tot de vergadering (zie permission-id voor waarden). active-participants Geheel getal Het aantal deelnemers dat de vergadering op dit moment heeft, inclusief gastheren en presentatoren. name Reeks De naam van de vergadering. domain-name Reeks Het domeinnaamgedeelte van de URL naar de vergaderruimte. url-path Reeks 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).

139 133 Element Kenmerk Type Beschrijving date-end Datetime De datum en tijd waarop de vergadering stopt (of is gestopt). 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 Voorbeeldantwoord <status code="ok" /> <my-meetings> <meeting sco-id=" " type="meeting" icon="meeting" permission-id="host" active-participants="0"> <name>how to Write a Novel</name> <domain-name>example.com</domain-name> <url-path>/novel/</url-path> <date-begin> t11:30: :00</date-begin> <date-end> t12:30: :00</date-end> <expired>true</expired> <duration>01:00:00.000</duration> </meeting> <meeting sco-id=" " type="meeting" icon="meeting" permission-id="host" active-participants="0"> <name>intro to Film</name> <domain-name>example.com</domain-name> <url-path>/film/</url-path> <date-begin> t14:00: :00</date-begin> <date-end> t20:00: :00</date-end> <expired>true</expired> <duration>06:00:00.000</duration> </meeting> </my-meetings> report-my-training Beschikbaarheid Connect Enterprise Web Services 6 Beschrijving 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 type=content en icon=course, terwijl studieprogramma's type=curriculum en icon=curriculum hebben. Aanvraag-URL &principal-id=integer

140 134 &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-my-training> <row sco-id=integer type=allowedvalue icon=allowedvalue max-retries=integer permission-id=allowedvalue transcript-id=integer attempts=integer> <name>string</name> <url>string</url> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <date-begin>datetime</date-begin> <url-path>string</url-path> <expired>boolean</expired> <completed>boolean</completed> </row>... </report-my-training> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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). icon Toegestane waarde Het type pictogram waarmee het object in Acrobat Connect Pro Central wordt geïdentificeerd (zie icon voor toegestane waarden). Als content het type is, wordt met de waarde icon de inhoud beschreven.

141 135 Element Kenmerk Type Beschrijving max-retries Geheel getal Het toegestane aantal herkansingen voor de cursus. permission-id Toegestane waarde De machtiging van de principal voor het object (zie permission-id voor toegestane waarden). transcript-id Geheel getal De id van de cursustranscriptie. attempts Geheel getal Het aantal malen dat de gebruiker heeft geprobeerd om de cursus te voltooien. name Reeks De naam van de cursus of het studieprogramma. description Reeks De beschrijving van de cursus of het studieprogramma. url Reeks Het deel van de RUL naar de cursus of het studieprogramma dat de domeinnaam en de unieke naam bevat, zonder of 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 Reeks Een niet-unieke id voor de cursus of het studieprogramma zoals deze in de gebruikersinterface wordt weergegeven, bijvoorbeeld ECON101. url-path Reeks 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 in het verleden ligt (true indien ja, false indien nee). completed Booleaanse waarde Een waarde die aangeeft of de gebruiker of de groep de cursus heeft voltooid. tr-status Reeks Of de gebruiker heeft geprobeerd de cursus af te leggen (attempted) of niet (not-attempted). Voorbeeldaanvraag &principal-id= Voorbeeldantwoord <status code="ok" /> <report-my-training> <row sco-id=" " type="content" icon="course" max-retries="" permission-id="view" transcript-id="" attempts="0"> <name>intro to Psychology</name> <url>example.com/psychology/</url> <date-created> t10:21: :00</date-created> <date-modified> t10:22: :00</date-modified> <date-begin> t10:15: :00</date-begin> <url-path>/psychology/</url-path> <expired>false</expired> <completed>true</completed> </row>

142 136 <row sco-id=" " type="curriculum" icon="curriculum" permission-id="view"> <name>a Day in the Life</name> <url>example.com/day/</url> <date-created> t14:47: :00</date-created> <date-modified> t14:47: :00</date-modified> <date-begin> t14:45: :00</date-begin> <url-path>/day/</url-path> <expired>false</expired> <completed>false</completed> <tr-status>not-attempted</tr-status> </row> </report-my-training> report-quiz-interactions Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 meerdere malen 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 ooit 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: &sco-id= &filter-like-name=joy%20smith U kunt ook alleen de antwoorden van een bepaalde gebruiker op een specifieke vraag opvragen: &sco-id= &filter-name=joy%20smith &filter-like-description=what is the capital of California Aanvraag-URL &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat.

143 137 Antwoordenstructuur <status code=allowedvalue /> <report-quiz-interactions> <row display-seq=integer transcript-id=integer interaction-id=integer sco-id=integer score=integer> <name>string</name> <sco-name>string</sco-name> <date-created>datetime</date-created> <description>string</description> <response>integer</response> </row>... </report-quiz-interactions> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-quiz-interactions 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. 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 Reeks 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 Reeks De quizvraag die de gebruiker heeft beantwoord. response Reeks Het antwoord dat de gebruiker heeft gegeven. Voorbeeldaanvraag &sco-id= &filter-name=joy Smith &filter-like-description=governor Voorbeeldaanvraag <status code="ok" /> <report-quiz-interactions> <row display-seq="2" transcript-id=" "

144 138 interaction-id=" " sco-id=" " score="10"> <name>joy Smith</name> <sco-name>california Quiz</sco-name> <date-created> t15:50: :00</date-created> <description> The governor of California is a former actor. </description> <response>true</response> </row> <row display-seq="2" transcript-id=" " interaction-id=" " sco-id=" " score="0"> <name>joy Smith</name> <sco-name>california Quiz</sco-name> <date-created> t17:32: :00</date-created> <description> The governor of California is a former actor. </description> <response>false</response> </row> <row display-seq="2" transcript-id=" " interaction-id=" " sco-id=" " score="10"> <name>joy Smith</name> <sco-name>california Quiz/sco-name> <date-created> t11:55: :00</date-created> <description> The governor of California is a former actor. </description> <response>true</response> </row> </report-quiz-interactions> report-quiz-question-answer-distribution Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 die vraag wordt een interactie genoemd. Als een gebruiker de vraag meerdere malen 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 om 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 &interaction-id=integer &sco-id=integer &filter-definition=value &sort-definition=value &session=breezesessioncookievalue

145 139 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 De unieke id van een presentatie of cursus die een quiz bevat. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-quiz-question-answer-distribution> <row display-seq=integer interaction-id=integer score=integer asset-id=integer num-selected=integer> <response>string</response> </row>... </report-quiz-question-answer-distribution> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-quiz-question-answer-distribution Container De lijst met vragen en antwoorden. row Container Informatie over één gebruiker, één vraag en één antwoord. display-seq Geheel getal Het volgnummer van de vraag in de quiz. interaction-id Geheel getal 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 gekregen.

146 140 Element Kenmerk Type Beschrijving 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/niet-waarquizvragen is dit het volgnummer van het geselecteerde antwoord. response Reeks Het antwoord dat de gebruiker op de vraag heeft gegeven. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-quiz-question-answer-distribution> <row display-seq="1" interaction-id=" " score="0" asset-id=" " num-selected="1"> <response>san francisco</response> </row> <row display-seq="1" interaction-id=" " score="10" asset-id=" " num-selected="2"> <response>sacramento</response> </row> <row display-seq="2" interaction-id=" " score="0" asset-id=" " num-selected="1"> <response>false</response> </row>... </report-quiz-question-answer-distribution>

147 Hoofdstuk 6 ADOBE ACROBAT CONNECT PRO report-quiz-question-distribution Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert informatie over het aantal juiste en onjuiste antwoorden op de vragen in een quiz. Deze aanroep kan u helpen te 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 &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-quiz-question-distribution> <row display-seq=integer interaction-id=integer num-correct=integer num-incorrect=integer total-responses=integer percentage-correct=integer score=integer> <name>string</name> <description>string</description> </row>... </report-quiz-question-distribution> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status).

148 142 Element Kenmerk Type Beschrijving report-quiz-question-distribution Container Informatie over alle vragen in een quiz. row Container Informatie over één vraag in de quiz. display-seq Geheel getal De volgreeks 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. percentage-correct Geheel getal Het percentage van het totale aantal correcte antwoorden. score Geheel getal De score die aan de quizvraag is toegewezen. name Reeks De naam van de quizvraag, gedefinieerd toen de vraag in Quiz Manager werd gemaakt. description Reeks De definitie van de quizvraag, gedefinieerd toen de vraag in Quiz Manager werd gemaakt. Voorbeeldaanvraag &sco-id= &filter-like-description=the capital of California Voorbeeldantwoord <status code="ok" /> <report-quiz-question-distribution> <row display-seq="1" interaction-id=" " num-correct="2" num-incorrect="1" total-responses="3" percentage-correct="66" score="10"> <name>the capital of California is<1></name> <description>the capital of California is<1></description> </row> </report-quiz-question-distribution> report-quiz-question-response Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 alle gebruikers op alle 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 interactie is een combinatie van één gebruiker en één vraag. Als een gebruiker dezelfde vraag meerdere malen beantwoordt, maken alle antwoorden deel uit van dezelfde interactie en hebben ze dezelfde interaction-id.

149 143 Aanvraag-URL &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. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-quiz-question-response> <row principal-id=integer interaction-id=string> <user-name>string</user-name> <response>string</response> <date-created>datetime</date-created> </row> </report-quiz-question-response> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-quiz-question-response 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. user-name Reeks De naam van de gebruiker zoals deze op de server is geregistreerd. response Reeks 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.

150 144 Voorbeeldaanvraag &sco-id= &filter-interaction-id= Voorbeeldantwoord <status code="ok" /> <report-quiz-question-response> <row principal-id=" " interaction-id=" "> <user-name>joy Smith</user-name> <response>sacramento</response> <date-created> t15:50: :00</date-created> </row> <row principal-id=" " interaction-id=" "> <user-name>joy Smith</user-name> <response>san francisco</response> <date-created> t17:32: :00</date-created> </row> <row principal-id=" " interaction-id=" "> <response>sacramento</response> <date-created> t11:55: :00</date-created> </row> </report-quiz-question-response> report-quiz-summary Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt een overzicht van gegevens over een quiz, inclusief het aantal keren dat de quiz is afgelegd, de gemiddelde, hoge en lage scores, en andere informatie. Aanvraag-URL &sco-id=integer &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving sco-id Geheel getal J De unieke id van een presentatie die een quiz bevat. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-quiz-summary>

151 145 <row num-questions=integer average-score=integer low-score=integer high-score=integer numtaken=integer numdistincttaken=integer maxpossiblescore=integer asset-id=integer /> </report-quiz-summary> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-quiz-summary Container Bevat informatie over de quiz. row Leeg, met kenmerken Overzichtsinformatie over de quiz. Kan meer dan één row-element 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 meerdere malen aflegt, wordt slechts één keer geteld. maxpossiblescore Geheel getal De hoogst mogelijke score voor de quiz. asset-id Geheel getal De id van de laatste versie van de SCO die naar de server is geüpload. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-quiz-summary> <row num-questions="2" average-score="0" low-score="0" high-score="0" numtaken="1" numdistincttaken="1" maxpossiblescore="0" asset-id=" " /> <row num-questions="2" average-score="13" low-score="0" high-score="20" numtaken="3" numdistincttaken="3" maxpossiblescore="20" asset-id=" " /> </report-quiz-summary>

152 146 report-quiz-takers Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Verschaft informatie over alle gebruikers die een quiz in een training hebben afgelegd. Gebruik een sco-id voor het identificeren van de quiz. Als u de omvang van het antwoord wilt beperken, gebruikt u een van de toegestane filters of geeft u een parameter type door om informatie te retourneren over slechts één type SCO (cursussen, presentaties of vergaderingen). Aanvraag-URL &sco-id=integer &principal-id=integer &type=allowedvalue &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. principal-id Geheel getal N De id van een principal van wie u de quizresultaten wilt. type Toegestane waarde N Het type inhoud waarvan u de resultaten wilt. Toegestane waarden zijn course, presentation en meeting. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-quiz-takers> <row transcript-id=integer sco-id=integer principal-id=integer status=allowedvalue score=integer asset-id=integer permission-id=allowedvalue attempts=integer time-taken=integer certificate=integer answered-survey=boolean version=integer> <name>string</name> <login>string</login> <date-created>datetime</date-created> <principal-name>string</principal-name> <override>boolean</override> </row> </report-quiz-takers>

153 147 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 user-failed. 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. permission-id Toegestane waarde Het toegangsniveau van de gebruiker tot de quiz (zie permission-id voor waarden). attempts Geheel getal Het aantal keren dat de gebruiker de quiz heeft afgelegd. time-taken Geheel getal De hoeveelheid tijd in milliseconden die de gebruiker aan de quiz heeft besteed. certificate Geheel getal De unieke id van een gebruikerstranscriptie. answeredsurvey Booleaanse waarde Geeft aan of de student een quiz heeft voltooid. Als deze waarde 0 of false is, heeft de training geen quiz of heeft de student de quiz niet voltooid. Als de waarde 1 of true is, heeft de student de quiz voltooid. version Geheel getal Het revisienummer van de quiz. name Reeks De naam van de quiz. login Reeks De aanmeldingsnaam van de gebruiker op de server. date-created Datetime De datum en tijd van de laatste poging van de gebruiker om de quiz af te leggen. principal-name Reeks 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 Voorbeeldantwoord <status code="ok" /> <report-quiz-takers> <row transcript-id=" " sco-id=" " principal-id=" " status="incomplete" score="0" max-score="20" asset-id=" " permission-id="" attempts="4" time-taken="12593" certificate="" answered-survey="1"

154 148 version="1"> <name>california State Quiz</name> <date-created> t11:14: :00</date-created> <principal-name>joy Smith</principal-name> <override>false</override> </row> </report-quiz-takers> report-quotas Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Retourneert informatie over de quota die van toepassing zijn op uw Acrobat Connect Pro-licentie of op uw Acrobat Connect Pro-account op de hostserver. Acrobat Connect Pro forceert de naleving van verschillende quota voor bijvoorbeeld het aantal gelijktijdige trainingdeelnemers, het aantal downloads, het aantal auteurs, enzovoort. Hoewel bepaalde quota door uw serverlicentie worden bepaald, kunt u de limiet van uw licentie overschrijden. In het antwoord van report-quotas is soft-limit het aantal dat door uw licentie wordt gedefinieerd. De soft-limit is gelijk aan de limit, tenzij u een Burst Pack aanschaft voor vergaderingen. In dat geval kunnen op overschotbasis meer deelnemers aan de vergadering deelnemen dan volgens de limiet is toegestaan. Aanvraag-URL &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-quotas> <quota acl-id=integer quota-id=string used=integer limit=allowedvalue soft-limit=integer> <date-begin>datetime</date-begin> <date-end>datetime</date-end> </quota> </report-quotas>

155 149 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 en eindigend op -quota. used Geheel getal Het aantal malen gebruik dat meetelt voor dit quotum. limit Geheel getal De limiet waarbij de server toegang niet toestaat. Dezelfde waarde als soft-limit, tenzij een Burst Pack is aangeschaft waarmee overschotten worden opgevangen. 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. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-quotas> <quota acl-id="624520" quota-id="download-quota" used="1" limit="unlimited" soft-limit=" "> <date-begin> t09:45: :00</date-begin> <date-end> t00:00: :00</date-end> </quota> <quota acl-id="624520" quota-id="bandwidth-quota" used="12802" limit="unlimited" soft-limit=" "> <date-begin> t17:00: :00</date-begin> <date-end> t17:00: :00</date-end> </quota>... </report-quotas> report-sco-slides Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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.

156 150 Aanvraag-URL &sco-id=integer &asset-id=integer &sort-definition=value &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving sco-id 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. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-sco-slides> <row slide=integer name=integer asset-id=integer views=integer> <date-created>datetime</date-created> </row>... </report-sco-slides> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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. date-created Datetime De datum en de tijd waarop de dia voor het laatst is bekeken. Voorbeeldaanvraag

157 151 Voorbeeldantwoord <status code="ok" /> <report-sco-slides> <row slide="1" name="1" views="4"> <date-created> t11:14: :00</date-created> </row> <row slide="2" name="2" views="4"> <date-created> t11:14: :00</date-created> </row> <row slide="3" name="3" views="3"> <date-created> t11:55: :00</date-created> </row> <row slide="4" name="4" views="3"> <date-created> t11:55: :00</date-created> </row> <row slide="5" name="5" views="3"> <date-created> t11:56: :00</date-created> </row> </report-sco-slides> Zie ook report-sco-views report-sco-views Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Geeft aan hoe vaak en hoe recent een SCO is bekeken. Aanvraag-URL &sco-id=integer &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving sco-id Geheel getal J De unieke id van een SCO waarvan u de weergaven wilt controleren. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <report-sco-views sco-id=integer type=allowedvalue is-folder=boolean views=integer>

158 152 <name>string</name> <last-viewed-date>string</last-viewed-date> </report-sco-views> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-sco-views 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. 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 gebruikers de SCO hebben bekeken. name Reeks De naam van de SCO. last-viewed-date Datetime De datum en de tijd waarop de SCO voor het laatst is bekeken. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <report-sco-views sco-id=" " type="content" is-folder="0" views="3"> <name>quiz on California</name> <last-viewed-date> t11:55: :00</last-viewed-date> </report-sco-views> report-user-trainings-taken Beschikbaarheid Connect Enterprise Web Services 6 Beschrijving 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 &principal-id=integer &session=breezesessioncookievalue

159 153 Parameters Naam Type Vereist Beschrijving principal-id Geheel getal J De id van een gebruiker van wie u een lijst met trainingen wilt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-user-trainings-taken> <row transcript-id=integer max-retries=integer sco-id=integer type=allowedvalue icon=allowedvalue status=allowedvalue certificate=integer score=integer permission-id=allowedvalue attempts=allowedvalue> <name>string</name> <description>string</description> <url-path>string</url-path> <date-taken>datetime</date-taken> <from-curriculum>boolean</from-curriculum> </row>... </report-user-trainings-taken> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). type Toegestane waarde Het type SCO. Toegestane waarden zijn user-content, content en my-content. report-user-trainings-taken Container Een lijst met alle trainingen die de gebruiker heeft geprobeerd af te leggen. row Container Informatie over een cursus die of een studieprogramma dat de gebruiker heeft afgelegd, ongeacht of de gebruiker ervoor is geslaagd. transcript-id Geheel getal 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 training-sco. type Toegestane waarde Het type training-sco (zie type voor toegestane waarden). icon Toegestane waarde Het type pictogram dat de cursus of het studieprogramma aanduidt in Connect Pro Central. Verschaft informatie over de cursus of het studieprogramma, in aanvulling op het type (zie icon voor toegestane waarden).

160 154 Element Kenmerk Type Beschrijving status Toegestane waarde De status van het werk van de gebruiker met de SCO. Toegestane waarden voor een cursus of presentatie zijn user-passed, 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. permission-id Toegestane waarde De machtiging die aan de gebruiker is toegewezen voor toegang tot de cursus of het studieprogramma (zie permission-id voor toegestane waarden). attempts Geheel getal Het aantal pogingen dat de gebruiker voor deze training heeft uitgevoerd. name Reeks De naam van de training-sco. description Reeks De beschrijving van de training-sco. url-path Reeks 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 training-sco plaatsvond (presentatie bekeken, quiz afgelegd, enzovoort). from-curriculum Booleaanse waarde Een waarde die aangeeft of deze cursus deel uitmaakte van een studieprogramma. Voorbeeldaanvraag &principal-id= &principal-id= Voorbeeldantwoord <status code="ok" /> <report-user-trainings-taken> <row transcript-id=" " max-retries="" sco-id=" " type="content" icon="course" status="user-passed" certificate=" " score="0" permission-id="" attempts="1"> <name>all About Web Communities</name> <description>test</description> <url-path>/p /</url-path> <date-taken> t15:06: :00</date-taken> <from-curriculum>false</from-curriculum> </row>... </report-user-trainings-taken>

161 155 report-user-training-transcripts Beschikbaarheid Connect Enterprise Web Services 6 Beschrijving Retourneert een lijst met transcripties voor trainingen die een gebruiker heeft gevolgd. Een transcriptie is de record van een score die de gebruiker heeft gekregen voor één poging om de training af te leggen. Een training kan een cursus, studieprogramma, vergadering of gebeurtenis zijn. 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren of sorteren op alle elementen of kenmerken die het bevat. Antwoordenstructuur <status code=allowedvalue /> <report-user-training-transcripts> <row transcript-id=integer sco-id=integer principal-id=integer status=allowedvalue score=integer max-score=integer certificate=integer type=allowedvalue icon=allowedvalue> <name>string</name> <url-path>string</url-path> <login>string</login> <date-taken>datetime</date-taken> <principal-name>string</principal-name> <sco-tag>string</sco-tag> </row>... </report-user-training-transcripts>

162 156 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). report-user-training-transcripts 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. transcript-id Geheel getal 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 De id van de gebruiker. status Toegestane waarde De status van het werk van de gebruiker met de SCO (zie status attribute 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. 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 of zij is geslaagd. type Toegestane waarde Het type SCO. Toegestane waarden zijn usercontent, content en my-content. icon Toegestane waarde De naam van het pictogram dat de cursus of het studieprogramma aanduidt in Acrobat Connect Pro Central. name Reeks De naam van de cursus of het studieprogramma. url-path Reeks De unieke identificatiecode van de cursus die of het studieprogramma dat in de URL achter de domeinnaam staat. login Reeks De aanmeldings-id van de gebruiker in Acrobat Connect Pro Server. date-taken Datetime De datum waarop interactie tussen de gebruiker en de cursus of het studieprogramma plaatsvond (presentatie bekeken, quiz afgelegd, enzovoort). principal-name Reeks De naam van de gebruiker die interactie met de SCO heeft. sco-tag Reeks Een beschrijvend label voor de SCO, in aanvulling op de naam (bijvoorbeeld een korte cursusnaam). Voorbeeldaanvraag &principal-id=

163 157 Voorbeeldantwoord <status code="ok" /> <report-user-training-transcripts> <row transcript-id=" " sco-id=" " principal-id=" " status="review" score="0" max-score="" certificate="" type="content" icon="course"> <name>test Course</name> <url-path>/test/</url-path> <date-taken> t15:23: :00</date-taken> <principal-name>joy Smith</principal-name> </row> <row transcript-id=" " sco-id=" " principal-id=" " status="review" score="0" max-score="" certificate="" type="content" icon="course"> <name>test Course</name> <url-path>/test/</url-path> <date-taken> t16:55: :00</date-taken> <principal-name>joy Smith</principal-name> </row> </report-user-training-transcripts> sco-contents Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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. Aanvraag-URL &sco-id=integer &filter-definition=value &sort-definition=value &session=value

164 158 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 opvragen door sco-shortcuts aan te roepen. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren op alle elementen of kenmerken, met de volgende uitzonderingen: U kunt niet filteren op duration. Als u filter-date-begin, filter-date-end of filter-date-modified gebruikt, geeft u een tijd op zonder een tijdzone, zoals bijvoorbeeld: filter-date-modified= t10:44:03 U kunt filter-gt of filter-lt gebruiken, met een datumveld en een volledige datum, inclusief de tijdzone. U kunt het antwoord sorteren op alle elementen of kenmerken. Antwoordenstructuur <status code=allowedvalue /> <scos> <sco sco-id=integer source-sco-id=integer folder-id=integer type=allowedvalue icon=allowedvalue display-seq=integer is-folder=boolean byte-count=integer ref-count=integer> <name>string</name> <url-path>string</url-path> <description>string</description> <date-begin>string</date-begin> <date-modified>datetime</date-modified> <date-end>string</date-end> <sco-tag>string</sco-tag> </sco> </scos> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). scos Container De lijst met objecten in de map. sco Container Eén object in de map. sco-id Geheel getal De unieke id van een object in de map. source-sco-id Geheel getal De unieke id van een inhoud-sco die in een cursus of studieprogramma wordt gebruikt. folder-id Geheel getal De id van een map, doorgegeven als sco-id in de aanvraag.

165 159 Element Kenmerk Type Beschrijving type Toegestane waarde Het type object (zie type voor waarden). SCO's die inhoud vertegenwoordigen, hebben het type content in plaats van een specifieker type, zoals presentatie. 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 Acrobat Connect Pro Central of uw toepassing het object weergeeft. is-folder Booleaanse waarde in de vorm van een getal Een waarde die aangeeft of het object een map is (1) of niet (0). byte-count Geheel getal De omvang van de inhoud. Voor mappen is deze waarde 0. ref-count Geheel getal Het aantal SCO's waarnaar deze SCO verwijst. name Reeks De naam van het object op de server. url-path Reeks De unieke id achter de domeinnaam in de URL naar de SCO. description Reeks 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 Reeks 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 Reeks Een korte beschrijving van de SCO. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <scos> <sco sco-id=" " source-sco-id=" " folder-id=" " type="content" icon="course" display-seq="0" is-folder="0"> <name>java 101</name> <url-path>/java101/</url-path> <date-begin> t17:15: :00</date-begin> <date-modified> t17:21: :00</date-modified> </sco> </scos> Zie ook sco-expanded-contents, sco-shortcuts

166 160 sco-delete Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 verwijzende SCO s niet meer werken, 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 inhoud-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 &sco-id=integer &session=value Parameters Naam Type Vereist Beschrijving sco-id Geheel getal J De unieke id van een SCO. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status).

167 161 Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> Zie ook sco-info, sco-move, sco-nav, sco-expanded-contents sco-expanded-contents Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Vermeldt alle SCO's in een map, inclusief de inhoud van submappen, studieprogramma's en alle typen insluitende SCO's. Opmerking: als u deze opdracht aanroept op een grote map, zoals de hoofdmap van een vergadering voor een grote account, wordt een groot aantal gegevens als resultaat gegeven. Als u geen filter gebruikt, wordt de lijst met SCO's geretourneerd in dezelfde volgorde als waarin deze in Acrobat Connect Pro Central wordt weergegeven. Als u een filter gebruikt of een sorteerbewerking uitvoert, wordt de lijst geretourneerd volgens het gebruikte filter of de gebruikte sorteerbewerking. Aanvraag-URL &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 map. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren op alle elementen of kenmerken, met de volgende uitzonderingen: U kunt niet filteren op duration. Als u filter-date-begin, filter-date-end of filter-date-modified gebruikt, geeft u een datum op in de ISO 8601-notatie, maar zonder een tijdzone, zoals bijvoorbeeld: filter-date-modified= t10:44:03 U kunt echter filter-gt-datefield of filter-lt-datefield gebruiken met een volledige datum én een tijdzone. Gebruik geen filters voor gedeeltelijke overeenkomsten die zijn samengesteld met filter-like (zoals filter-likename). Dit zou nadelige invloed kunnen hebben op de serverprestaties.

168 162 U kunt het antwoord sorteren op alle kenmerken of elementen, met uitzondering van date-begin, date-created, date-modified en url-path. Antwoordenstructuur <status code=allowedvalue /> <expanded-scos> <sco depth=integer sco-id=integer folder-id=integer type=allowedvalue icon=allowedvalue lang=allowedvalue source-sco-id=integer display-seq=integer source-sco-type=integer> <name>string</name> <url-path>string</url-path> <date-created>datetime</date-created> <date-modified>datetime</date-modified> </sco>... more sco elements... </expanded-scos> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 Het niveau 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 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 van dit 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). 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 Acrobat Connect Pro Central (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 dat geval moet de toepassing de weergavevolgorde definiëren. De standaardwaarde is 0. source-scotype Geheel getal Een geheel getal dat het type SCO aanduidt op basis waarvan deze SCO is gemaakt. Voorbeeldaanvraag

169 163 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=""> <name>shared Meetings</name> <url-path>/f624529/</url-path> <date-created> t09:45: :00</date-created> <date-modified> t10:19: :00</date-modified> </sco> <sco depth="1" sco-id=" " folder-id="624529" type="meeting" icon="meeting" lang="en" source-sco-id="-8888" display-seq="0" source-sco-type="3"> <name>monday Night Football</name> <url-path>/r /</url-path> <description>monday Night Football</description> <date-begin> t15:30: :00</date-begin> <date-end> t00:15: :00</date-end> <date-created> t15:50: :00</date-created> <date-modified> t00:34: :00</date-modified> </sco> </expanded-scos> sco-info Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt informatie over een SCO in Acrobat Connect Pro. 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 datum 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

170 164 Antwoordenstructuur <status code=allowedvalue /> <sco account-id=integer disabled=datetime display-seq=integer folder-id=integer icon=allowedvalue lang=allowedvalue max-retries=integer sco-id=integer source-sco-id=integer type=allowedvalue version=integer> <date-begin>datetime</date-begin> <date-created>datetime</date-created> <date-end>datetime</date-end> <date-modified>datetime</date-modified> <description>string</description> <name>string</name> <url-path>string</url-path> <passing-score>integer</passing-score> <duration>datetime</duration> <section-count>integer</section-count> </sco> <source-sco> <source-sco account-id=integer display-seq=integer folder-id=integer icon=allowedvalue lang=allowedvalue max-retries=integer sco-id=integer source-sco-id=integer type=allowedvalue version=integer> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <name>string</name> <url-path>string</url-path> </source-sco> </source-sco> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). sco 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. Als de SCO wel is uitgeschakeld, is dit de datum en tijd waarop de SCO is uitgeschakeld. display-seq Geheel getal De volgorde waarin Acrobat Connect Pro Central (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 display-seq-waarde hebben. In dat 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 De unieke id van de SCO.

171 165 Element Kenmerk Type Beschrijving 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, is dit 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, is dit de datum en tijd waarop de vergadering stopt. date-modified Datetime De datum en tijd waarop de SCO voor het laatst is gewijzigd. description Reeks De beschrijving van de SCO die is ingevoerd toen de SCO werd gemaakt. name Reeks De naam van de SCO. url-path Reeks 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 is 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 broninhoud verschaft aan de SCO waarin u bent geïnteresseerd. Heeft extra elementen en kenmerken, net als het element sco. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <sco account-id="624520" disabled="" display-seq="0" folder-id=" " icon="meeting" lang="en" max-retries="" sco-id=" " source-sco-id=" " type="meeting" version="0"> <date-begin> t11:15: :00</date-begin> <date-created> t11:27: :00</date-created> <date-end> t12:15: :00</date-end> <date-modified> t11:27: :00</date-modified> <name>technology and Law Review Meeting</name> <url-path>/tlawreview/</url-path> </sco> <source-sco> <source-sco account-id="624520" display-seq="0" folder-id=" " icon="meeting" lang="en" max-retries="" sco-id=" " source-sco-id="-8888" type="meeting" version="0"> <date-created> t00:49: :00</date-created>

172 166 <date-modified> t15:03: :00</date-modified> <name>default Meeting Template</name> <url-path>/defaultmeetingtemplate/</url-path> </source-sco> </source-sco> sco-move Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 mappen (zoals my-meetings, my courses, my-events, my-content 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 &folder-id=integer &sco-id=integer &session=breezesessioncookievalue 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag &folder-id=

173 167 Voorbeeldantwoord <status code="ok" /> Zie ook sco-nav sco-nav Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 sco-elementen, éé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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <sco-nav> <sco sco-id=integer type=allowedvalue icon=allowedvalue depth=integer> <name>string</name> </sco>... </sco-nav>

174 168 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 De unieke id van de SCO. type Toegestane waarde Het type van de 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 map van het hoogste niveau. name Reeks De naam van de SCO. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <sco-nav> <sco sco-id="624522" type="folder" icon="folder" depth="2"> <name>user Content</name> </sco> <sco sco-id=" " type="folder" icon="folder" depth="1"> <name>joy@acme.com</name> </sco> <sco sco-id=" " type="content" icon="producer" depth="0"> <name>test Quiz</name> </sco> </sco-nav> Zie ook sco-move sco-search Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Biedt een lijst met alle SCO's die inhoud bevatten die overeenkomt met de zoektekst.

175 169 De actie sco-search zoekt naar de inhoud van bepaalde SCO-typen voor de querytekenreeks. De typen SCO's die worden doorzocht, omvatten presentatiearchieven, vergaderarchieven en de presentatieonderdelen van een cursus of studieprogramma. Een presentatie die is opgenomen in een cursus, retourneert twee sets resultaten, een voor de feitelijke presentatie en een voor de cursus. De zoekopdracht omvat niet de SCO-naam of SCO-metagegevens die in de database zijn opgeslagen. De query is niet hoofdlettergevoelig en u kunt jokertekens toevoegen aan het einde van de querytekenreeks. De toegestane jokertekens zijn: Een asterisk (*) voor een willekeurig teken of willekeurige tekens. Een vraagteken (?) voor een willekeurig teken. U kunt bijvoorbeeld de querytekenreeksen quiz, qu* of qui? gebruiken. Het is echter niet mogelijk een jokerteken aan het begin of midden in een querytekenreeks te plaatsen. U kunt ook de functies and en or gebruiken om meerdere resultaten te retourneren. Zet een spatie tussen de functie en de zoektermen: or test Als u bijvoorbeeld naar quizortest zoekt, interpreteert de server dit als een letterlijke tekenreeks en worden alleen exacte resultaten weergegeven. Aanvraag-URL &query=querystring &filter-definition=value &sort-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 hoofdlettergevoelig en u kunt de jokertekens * en? toevoegen aan het einde van de reeks. filter-definition Filterdefinitie N Een filter waarmee de omvang van het antwoord wordt beperkt. sort-definition Sorteringsdefinitie N Een sortering die resultaten in een bepaalde volgorde rangschikt. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt het antwoord filteren op een element of kenmerk dat het bevat. Antwoordenstructuur <status code=allowedvalue /> <sco-search-info> <sco sco-id=integer folder-id=integer type=allowedvalue icon=allowedvalue byte-count=integer tree-type=integer> <name>string</name>

176 170 <url-path>string</url-path> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <hit>integer</hit> <hit-type>allowedvalue</hit-type> <thumbnail-path>string</thumbnail-path> </sco> </sco-search-info> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 De unieke id van de SCO. folder-id Geheel getal De id van de map waarin de SCO is opgeslagen. type icon Toegestane waarde Toegestane waarde Het type inhoud dat aan de SCO is toegewezen (zie type voor waarden). Het pictogram waarmee de SCO visueel in een gebruikersinterface wordt geïdentificeerd. byte-count Geheel getal De grootte van de SCO, uitgedrukt in bytes. tree-type Geheel getal Het type boomstructuur. name Reeks De bestandsnaam van de SCO. url-path Reeks 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. hit-url Reeks 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 Reeks Een relatieve URL naar een afbeelding van de SCO die de zoekterm bevat. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <sco-search-info> <sco sco-id=" " folder-id=" " type="content" icon="producer" byte-count="5985" tree-type="13"> <name>final Quiz</name>

177 171 <url-path>/p /</url-path> <date-created> t14:24: :00</date-created> <date-modified> t14:24: :00</date-modified> <hit>0</hit> <hit-type>metadata</hit-type> </sco> <sco sco-id=" " folder-id=" " type="content" icon="producer" byte-count="5985"> <name>final Quiz</name> <url-path>/p /</url-path> <date-created> t14:24: :00</date-created> <date-modified> t14:24: :00</date-modified> <hit>7</hit> <hit-type>slide</hit-type> <hit-url>slide=7</hit-url> </sco>... </sco-search-info> sco-search-by-field Beschikbaarheid Acrobat Connect Pro 7 Beschrijving Verschaft een lijst met alle SCO's die overeenkomen met de zoektekst in het opgegeven veld. U kunt met deze actie zoeken naar objecten in de database op basis van de naam, beschrijving of auteur van de SCO. U kunt ook zoeken naar alle drie velden. De actie sco-search-by-field zoekt naar de inhoud van bepaalde SCO-typen voor de querytekenreeks. Er wordt gezocht naar mappen, trainingscursussen, studieprogramma's, vergaderingen, inhoud en archieven. Als u naar uitdrukkingen met meerdere woorden wilt zoeken en er spaties tussen de woorden staan, zoekt u alleen naar het eerste woord en plaatst u een jokerteken achter dit woord. Als u bijvoorbeeld naar Sales Presentation wilt zoeken, typt u: query=sales* Opmerking: de opdracht sco-search-by-field biedt geen ondersteuning voor de functies and/or. Aanvraag-URL &query=searchterm &field=allowedvalue

178 172 Parameters Naam Type Vereist Beschrijving query Reeks J De term waarnaar u in het opgegeven veld wilt zoeken. De query is niet hoofdlettergevoelig. field Reeks N Het veld dat u wilt doorzoeken. U kunt vier waarden opgeven in dit veld: name, description, author of allfields: name zoekt alleen naar het naamveld van SCO's. description zoekt alleen naar het beschrijvingsveld van SCO's. author vindt overeenkomsten met het veld full name (niet met de velden first-name of last-name) van de principal die de SCO's heeft gemaakt. allfields doorzoekt de velden name, description en author. Als deze parameter niet wordt ingevuld, wordt het veld name doorzocht. Filters U kunt filters gebruiken voor alle velden die als resultaat kunnen worden gegeven. U kunt bijvoorbeeld &filter-gt-date-created= t08:00: gebruiken als u alleen resultaten wilt zien die zijn gemaakt na uur op 12 september Antwoordenstructuur <status code=allowedvalue /> <sco-search-info> <sco sco-id=integer tree-id=integer folder-id=integer type=allowedvalue status=allowedvalue sco-data-id=integer source-sco-id=integer host-id=integer authorcontact-id=integer learning-time=allowedvalue lang=allowedvalue seq-id=integer icon=allowedvalue display-seq=integer max-retries=integer version=integer accountid=integer tree-type=integer> <name>string</name> <url-path>string</url-path> <date-created>datetime</date-created> <date-modified>datetime</date-modified> <principal-name>string</principal-name> <folder-name>string</folder-name> </sco> </sco-search-info> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). sco-search-by-field-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 De unieke id van de SCO. folder-id Geheel getal De id van de map waarin de SCO is opgeslagen.

179 173 Element Kenmerk Type Beschrijving 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. name Reeks De bestandsnaam van de SCO. url-path Reeks 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 laatste datum waarop de SCO is gewijzigd. principal-name Reeks De auteur van de SCO. folder-name Reeks De naam van de map waarin de SCO is opgeslagen. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <sco-search-by-field-info> <sco sco-id=" " tree-id="" folder-id=" " type="meeting" status="" scodata-id="" source-sco-id=" " host-id="" author-contact-id="" learning-time="" lang="en" seq-id="" icon="virtual-classroom" display-seq="0" max-retries="" version="0" account-id=" " tree-type="4"> <name>virt1</name> <url-path>/r /</url-path> <date-created> t16:41: :00</date-created> <date-modified> t16:41: :00</date-modified> <principal-name>piet Pompies</principal-name> </sco> <sco sco-id=" " tree-id="" folder-id=" " type="folder" status="" scodata-id="" source-sco-id="" host-id="" author-contact-id="" learning-time="" lang="en" seqid="" icon="folder" display-seq="0" max-retries="" version="0" account-id=" "> <name>test1</name> <url-path>/f /</url-path> <date-created> t18:00: :00</date-created> <date-modified> t18:00: :00</date-modified> <principal-name>trainer two</principal-name> </sco> </sco-search-by-field-info> sco-shortcuts Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 bovenliggende mappen in de navigatiehiërarchie.

180 174 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 samen met de domain-name die wordt geretourneerd door sco-shortcuts. U kunt bijvoorbeeld deze twee tekenreeksen samenvoegen: (de domain-name die wordt geretourneerd door sco-shortcuts) /f / (het url-path dat wordt geretourneerd door sco-info, sco-contents of sco-expandedcontents) Het resultaat is deze URL: U kunt sco-contents ook aanroepen met de sco-id van een map die wordt geretourneerd door sco-shortcuts om de inhoud van de map te zien. Aanvraag-URL &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=code /> <sneltoetsen> <sco tree-id=integer sco-id=integer type=allowedvalue> <domain-name>string</domain-name> </sco>... </shortcuts> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). sneltoetsen Container Informatie over alle mappen die betrekking hebben op de huidige gebruiker. sco Container Informatie over een 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. domain-name Reeks De domeinnaam van de map.

181 175 De waarden die geretourneerd kunnen worden in het kenmerk type van het element sco (alleen voor deze aanroep: sco shortcuts) identificeren Acrobat Connect Pro-mappen. Elk maptype is toegewezen aan een map in Acrobat Connect Pro Central en vereist een bepaald machtigingsniveau voor toegang. Deze niveaus worden in de volgende tabel beschreven. Type waarde account-custom content cursussen events vergaderingen my-courses my-content my-events my-meetings my-meeting-templates seminars shared-meeting-templates user-content user-courses user-events user-meetings Beschrijving Aangepaste inhoud voor een account, zoals een aangepaste aanmeldingspagina, banner, enzovoort. De map Gedeelde inhoud. Vereist het privilege Beheerder of de machtiging Beheren. De map Gedeelde training. Vereist het privilege Beheerder of de machtiging Beheren. De map Gedeelde gebeurtenissen. Vereist het privilege Beheerder of de machtiging Beheren. De map Gedeelde vergaderingen. Vereist het privilege Beheerder of de machtiging Beheren. De map Mijn training. Individuele gebruikers hebben standaard de machtiging Beheren. De map Mijn inhoud. Individuele gebruikers hebben standaard de machtiging Beheren. De map Mijn gebeurtenissen. Individuele gebruikers hebben standaard de machtiging Beheren. De map Mijn vergaderingen. Individuele gebruikers hebben standaard de machtiging Beheren. De map Mijn sjablonen. Individuele gebruikers hebben standaard de machtiging Beheren. De map Gedeelde seminars. Vereist het privilege Beheerder of de machtiging Beheren. De map Gedeelde sjablonen. Ontleent de machtigingen aan Gedeelde vergaderingen. Bevat de inhoudsmappen van de gebruiker. Bevat de cursusmappen van de gebruiker. Bevat de gebeurtenismappen van de gebruiker. Bevat de vergaderingenmappen van de gebruiker. Voorbeeldaanvraag Voorbeeldantwoord <status code="ok" /> <sneltoetsen> <sco tree-id=" " sco-id=" " type="my-courses"> <domain-name> </sco> <sco tree-id=" " sco-id=" " type="my-events"> <domain-name> </sco>... </shortcuts> Zie ook sco-info, sco-expanded-contents

182 176 sco-update Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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 Acrobat Connect Pro Central. 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 er 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. Aanvraag-URL &author-info-1=string &author-info-2=string &author-info-3=string &date-begin=datetime &date-end=datetime &description=string & =string &first-name=string &folder-id=integer &icon=allowedvalue &lang=allowedvalue &first-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 Reeks 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 Reeks N Extra informatie over de auteur. Wordt alleen voor presentaties gebruikt. Kan worden gebruikt voor de professionele functie van de auteur of voor andere informatie. author-info-3 Reeks 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. description Reeks N Een beschrijving van de SCO die in de gebruikersinterface wordt weergegeven.

183 177 Naam Type Vereist Beschrijving Reeks N Het adres van de contactpersoon voor een presentatie (wordt alleen met presentatie-sco's gebruikt). first-name Reeks 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. icon Toegestane waarde N Het visuele symbool dat wordt gebruikt ter identificatie van een SCO in Acrobat Connect Pro Central en dat naast informatie over het type ook andere informatie over de SCO verschaft. last-name Reeks N De achternaam van de contactpersoon voor een presentatie (wordt alleen met presentaties gebruikt). name Reeks 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 Reeks 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. url-path Reeks 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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <sco folder-id=integer lang=allowedvalue type=allowedvalue sco-id=integer version=integer account-id=integer icon=integer> <url-path>string</url-path> <description>string</description> <name>string</name> </sco> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). sco Container Informatie over een nieuwe SCO die u zojuist hebt gemaakt, inclusief de sco-id. Wordt alleen geretourneerd als u een SCO maakt.

184 178 Element Kenmerk Type Beschrijving 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). 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 gemaakt. icon Geheel getal Het type pictogram waarmee een nieuwe SCO in Acrobat Connect Pro Central wordt geïdentificeerd (zie icon voor waarden). url-path Reeks Het deel van de SCO-URL dat na de domeinnaam komt en dat de SCO op unieke wijze identificeert. description Reeks Een tekstbeschrijving van de SCO. name Reeks De naam van de SCO. Voorbeeldaanvraag &description=test&name=more About Web Communities&type=content &lang=en Voorbeeldantwoord <status code="ok" /> <sco folder-id=" " account-id="624520" type="content" lang="en" icon="content" sco-id=" " version="0"> <url-path>/p /</url-path> <description>test</description> <name>more About Web Communities</name> </sco> Zie ook sco-upload sco-upload Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving 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:

185 179 <FORM action=" enctype="multipart/form-data" method="post"> <P> What files are you sending? <INPUT type="file" name="file"> <BR> <INPUT type="submit" value="send"> <INPUT type="reset"> </FORM> 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: <FORM action=" enctype="multipart/form-data" method="post"> <P> PPT files you are sending <INPUT type="file" name="file"><br> PPC files you are sending <INPUT type="file" name="file"><br> <INPUT type="submit" value="send"> <INPUT type="reset"> </FORM> 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. Aanvraag-URL &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 HTML-formulier 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 Reeks N Een korte beschrijving van de SCO die in Acrobat Connect Pro Central of in uw toepassing wordt weergegeven. title Reeks N De titel van de SCO. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> <files> <file> <path>string</path> </file> </files>

186 180 Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). files Container Informatie over alle geüploade bestanden. Gedeactiveerd en wordt mogelijk uit toekomstige versies verwijderd. file Container Informatie over één bestand. Gedeactiveerd en wordt mogelijk uit toekomstige versies verwijderd. path Reeks Het pad naar het nieuwe, geüploade bestand. Alleen voor intern gebruik door Adobe. Gedeactiveerd en wordt mogelijk uit toekomstige versies verwijderd. Voorbeeldaanvraag Deze aanvraag wordt gemaakt door een bestand te uploaden via een HTML-formulier: Voorbeeldantwoord <status code="ok" /> <files> <file> <path>624520/ /input/whatmakesagreatfilm.ppt</path> </file> </files> Zie ook sco-update user-accounts Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Verschaft een lijst met de accounts waartoe de gebruiker behoort. De actie user-accounts wordt alleen gebruikt wanneer een gebruiker tot meerdere accounts op de server behoort en dezelfde aanmeldings-id en hetzelfde wachtwoord gebruikt 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 &login=string &password=string &session=breezesessioncookievalue

187 181 Parameters Naam Type Vereist Beschrijving login Reeks J De aanmeldingsnaam van de gebruiker, dit kan bijvoorbeeld het adres van de gebruiker zijn. password Reeks J Het gebruikerswachtwoord. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Standaard wordt op account-name gesorteerd. Antwoordenstructuur <status code=allowedvalue /> <users> <user user-id=integer account-id=integer> <name>string</name> <date-expired>datetime</date-expired> </user>... </users> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). 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 Reeks De naam van de account waartoe de gebruiker behoort. date-expired Datetime De datum en tijd waarop de aanmelding van de gebruiker verloopt. Voorbeeldaanvraag &password=bigdog Voorbeeldantwoord <status code="ok" /> <users> <user user-id=" " account-id="624520"> <name>test Account</name> <date-expired> t16:00: :00</date-expired> </user> </users>

188 182 user-transcript-update Beschikbaarheid Breeze 5; Connect Enterprise Web Services 6 Beschrijving Hiermee vervangt u de score van een onderdeel in een studieprogramma. U kunt user-transcript-update bijvoorbeeld 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 &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 Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren. Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status).

189 183 Voorbeeldaanvraag &curriculum-id= &sco-id= &status=user-passed &principal-id= &score=100 Voorbeeldantwoord <status code="ok" /> Zie ook learning-path-info, learning-path-update user-update-pwd Beschikbaarheid Breeze 4 en Breeze 5; Connect Enterprise Web Services 6 Beschrijving Hiermee wijzigt u het wachtwoord van een gebruiker. Het wachtwoord kan in de volgende twee gevallen worden gewijzigd: door een bij de account aangemelde beheerder, met of zonder het oude wachtwoord van de gebruiker door een willekeurige Acrobat Connect Pro Server-gebruiker, met het principal-id-nummer, de aanmeldingsnaam en het oude wachtwoord van de gebruiker 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 het nieuwe wachtwoord van de gebruiker niet aan de regels voldoet, geeft Acrobat Connect Pro een foutmelding weer met de mededeling dat het nieuwe wachtwoord ongeldig is. Als u user-update-pwd aanroept, wordt het wachtwoord via HTTP of HTTPS en gehasht verzonden. Aanvraag-URL &user-id=integer &password-old=string &password=string &password-verify=string &session=breezesessioncookievalue Parameters Naam Type Vereist Beschrijving user-id Geheel getal J De id van de gebruiker. password-old Reeks J/N Het huidige gebruikerswachtwoord. Vereist voor standaardgebruikers, maar niet voor beheerders. password Reeks J Het nieuwe wachtwoord. password-verify Reeks J Een tweede exemplaar van het nieuwe wachtwoord, ter verificatie. session Reeks N De waarde van het BREEZESESSION-cookie. Gebruik deze parameter als u geen bibliotheek voor cookiebeheer op de client gebruikt. Filters U kunt resultaten niet filteren of sorteren.

190 184 Antwoordenstructuur <status code=allowedvalue /> Antwoordwaarden Element Kenmerk Type Beschrijving results Container Alle resultaten die de actie retourneert. status Leeg, met kenmerken De status van het antwoord. code Toegestane waarde Een code die de antwoordstatus aangeeft (zie status). Voorbeeldaanvraag Beheerders kunnen deze aanvraag gebruiken om het wachtwoord van een gebruiker te wijzigen zonder kennis van het oude wachtwoord: Voorbeeldantwoord Dit antwoord geeft aan dat de wijziging is gelukt: <status code="ok" />

191 185 Hoofdstuk 7: Filter- en sorteringsreferentie Dit hoofdstuk vormt een referentie voor filters en sorteringswaarden waarmee u het volume van de antwoorden van XML acties kunt reduceren in Adobe Acrobat Connect Pro Web Services. filter-definition Beschrijving Een filter is een speciaal type parameter waarmee u de omvang van het antwoord beperkt. Wanneer u filterdefinition 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. Gebruik hierbij de volgende syntaxis: filter-modifier-field=value In de volgende tabel ziet u de wijzigingstoetsen die u kunt toevoegen: Filter filter-field=value filter-like-field=value filter-out-field=value filter-rows=value filter-start=value filter-gt-datefield=value filter-lt-datefield=value filter-gte-datefield=value filter-lte-datefield=value filter-ismember=value Beschrijving Retourneert alle items waarvoor de gegevens in field precies overeenkomen met value. Retourneert alle items met de reeks value in field, ook als field geen exacte overeenkomst is. Filtert of sluit alle items met value in field uit. Beperkt de resultaten tot het aantal rijen dat is opgegeven in value. Start de resultaten bij het indexnummer dat is opgegeven in 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. Selecteert alle items met een datum vroeger dan value. Dit werkt alleen met datumvelden. De waarde moet een datum in de ISO 8601-notatie zijn. 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 date in de ISO 8601-notatie zijn. 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 8601-notatie gebruikt. Selecteert alle principals die leden zijn van een groep, die is opgegeven in een afzonderlijke parameter. Accepteert de Booleaanse waarden true of false. value is niet hoofdlettergevoelig. Zo komen de volgende twee filters bijvoorbeeld beide 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 acties. Controleer een specifieke actie in ''Actiereferentie'' op pagina 53 om te leren welke veldnamen u kunt gebruiken in filters. Filter voor exacte overeenkomsten filter-name=goals Review Zoekt items met Goals Review (met willekeurig hoofdlettergebruik) in de naam.

192 186 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. Filters om items mee uit te sluiten filter-out-name=status Zoekt naar items 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= &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= &filter-lt-date-begin= Geeft alle items als resultaat met een begindatum na 1 mei 2005 en vóór 31 mei 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. Gebruik hierbij de volgende 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). 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 Verschilt per aanroep. asc of desc Sorteert de resultaten op een veld, hetzij oplopend of aflopend, en geeft de resultaten door aan de volgende sorteerbewerking. sort2 Verschilt per aanroep. 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

193 187 De volgende tabel verschaft meer informatie over het gebruik van de sorteringswaarden asc en desc. Waarde asc desc Beschrijving 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. 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. 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

194 188 Hoofdstuk 8: Algemene referentie In dit referentiegedeelte worden XML-elementen en -kenmerken beschreven die door meerdere acties worden gebruikt in Adobe Acrobat Connect Pro Web Services. Er wordt naar de in dit hoofdstuk beschreven elementen verwezen vanuit de verzoek- en antwoordtabellen die acties 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 access-blocked access-hidden access-open access-optional access-pass Beschrijving De cursus of het studieprogramma is beperkt en gebruikers kunnen de cursus of het studieprogramma niet afleggen. 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 Acrobat Connect Pro Central (of de gebruikersinterface van een aangepaste toepassing, als u deze waarde gebruikt). De cursus of het studieprogramma is open en gebruikers kunnen de cursus of het studieprogramma afleggen. De cursus of het studieprogramma is optioneel. De gebruiker heeft de cursus of het studieprogramma al afgelegd en is ervoor geslaagd. feature-id Beschrijving Een kenmerk dat verwijst naar een functie die gebruikers kunnen gebruiken of naar gebeurtenissen die tijdens een vergadering kunnen plaatsvinden. Gebruik feature-id met de actie meeting-feature-update. Zie het Acrobat Connect Pro Handboek voor meer informatie over pods die u kunt in- en uitschakelen. Waarden Waarde fid-archive Beschrijving van functie wanneer waarde is ingeschakeld Hiermee kan een gastheer het opnemen van een vergadering beginnen of beëindigen. Wanneer deze instelling wordt uitgeschakeld, kan de gastheer de opname-instellingen niet besturen. Als u wilt dat Connect automatisch alle vergaderingen opneemt, dient u fid-archive uit te schakelen en fid-archive-force in te schakelen. fid-archive-force fid-archive-publish-link fid-chat-transcripts Hiermee stelt u in dat alle vergaderingen worden opgenomen zodra ze worden begonnen. Opgenomen vergaderingen worden weergegeven in Acrobat Connect Pro Central. Wanneer vergaderingen automatisch worden opgenomen (als fid-archive-force in ingeschakeld), kan de gastheer een koppeling tot stand brengen naar de opname in de vergadermap. Hiermee maakt u een transcriptiebestand (één per vergadersessie) van alle tekstberichten die zijn uitgewisseld in de pods Chat, Vragen en antwoorden en IM.

195 189 Waarde fid-meeting-app-sharing fid-meeting-auto-promote fid-meeting-breakout fid-meeting-chat fid-meeting-chat-clear fid-meeting-chat-presenter fid-meeting-chat-private fid-meeting-chat-public fid-meeting-desktop-sharing fid-meeting-dialout fid-meeting-disclaimer Beschrijving van functie wanneer waarde is ingeschakeld Hiermee kan de gastheer besturing aanvragen van het invoerapparaat (muis of toetsenbord) van een deelnemer als een deelnemer zijn of haar scherm, bureaublad of toepassing deelt. Stelt gastheren in staat de optie in te schakelen om deelnemers automatisch te bevorderen tot presentatoren. Hiermee kunnen gebruikers brainstormsessies maken. Hiermee wordt de pod Chat ingeschakeld. Hiermee wordt de historie in de pod Chat automatisch gewist wanneer een nieuwe sessie van een bestaande vergadering wordt gestart. Hiermee kunnen gebruikers alleen chatberichten verzenden naar de presentator. Hiermee kunnen gebruikers chatberichten verzenden naar bepaalde aanwezigen. Hiermee kunnen gebruikers chatberichten verzenden naar alle aanwezigen. Hiermee kunnen gebruikers hun scherm delen (hun volledige bureaublad of individuele toepassingen). Hiermee kunnen gebruikers de functies Uitbellen en Mij bellen gebruiken. Hiermee geeft u een disclaimer weer (bijvoorbeeld om uit te leggen dat de vergadering wordt opgenomen) wanneer een gebruiker de account opent of een vergadering in de account bijwoont. De gastheer of de aanwezigen moeten de disclaimer accepteren om door te kunnen gaan met de vergadering. Als een gebruiker de disclaimer niet accepteert, wordt de startpagina van Connect weer afgebeeld. Gebruik de actie meeting-disclaimer-update om de tekst van de disclaimer in te stellen. fid-meeting-enhanced-rights fid-meeting-file-share fid-meeting-flv fid-meeting-full-screenaffects-all fid-meeting-hold fid-meeting-host-cursors fid-meeting-im Hiermee kan een gastheer de toegang van aanwezigen tot bepaalde subfuncties wijzigen. Hiermee wordt de pod voor het delen van bestanden ingeschakeld. Hiermee kunnen gebruikers FLV- en MP3-bestanden gebruiken in de vergadering. Hiermee wordt Presentatorwijzigingen betreffen iedereen ingeschakeld in de volledige-schermmodus. Opmerking: met deze functie wordt de mogelijkheid van de gebruikers om de volledige-schermmodus te activeren niet in- of uitgeschakeld. Hiermee kunnen gastheren deelnemers in de wachtstand plaatsen. Hiermee kan een gastheer de weergave van zijn cursor wijzigen. Hiermee schakelt u de pod IM in. Deze functie maakt deel uit van de integratie van Acrobat Connect Pro met ondersteunde en in real-time uitgevoerde Microsoft-communicatieservers. Schakel deze functie uit wanneer u de pod Deelnemerlijst (fid-meeting-inviteepresence=true) wilt weergeven, maar de bijbehorende pod IM wilt verbergen. fid-meeting-inviteepresence fid-meeting-manage-link fid-meeting-note fid-meeting-notes-clear fid-meeting-pause-annotate fid-meeting-people-list fid-meeting-poll fid-meeting-pres-only fid-meeting-pr-mode Hiermee schakelt u de pod Deelnemerlijst en de daaraan gekoppelde pod IM in. Deze functie maakt deel uit van de integratie van Acrobat Connect Pro met ondersteunde en in real-time uitgevoerde Microsoftcommunicatieservers. Hiermee wordt de koppeling Ruimte beheren met webbeheer in het vergadermenu ingeschakeld. Hiermee wordt de pod Opmerking ingeschakeld. Hiermee wordt de historie in de pod Opmerking automatisch gewist wanneer een nieuwe sessie van een bestaande vergadering wordt gestart. Hiermee kunnen gebruikers het delen van hun scherm pauzeren en notities aanbrengen op een bedekkend whiteboard. Hiermee wordt de pod Deelnemerlijst ingeschakeld. Hiermee wordt de pod Opiniepeiling ingeschakeld. Hiermee wordt het gebruik van het Gebied met alleen de presentator ingeschakeld. Schakelt de voorbereidingsmodus in, zodat gastheren de schermindeling van de vergadering kunnen wijzigen zonder de schermindeling van andere gebruikers te beïnvloeden. Schakel deze modus uit als de schermindeling klaar is, zodat alle gebruikers de schermindeling kunnen zien.

196 190 Waarde fid-meeting-qa-clear fid-meeting-questions fid-meeting-room-bg fid-meetings-custom-pods fid-meeting-shared-library fid-meeting-shared-upload fid-meeting-show-talker fid-meeting-show-talker-area fid-meeting-video fid-meeting-voip fid-meeting-web-links fid-meeting-white-board fid-start-meeting-button fid-training-openenroll Beschrijving van functie wanneer waarde is ingeschakeld Hiermee wordt de historie in de pod Vragen en antwoorden automatisch gewist wanneer een nieuwe sessie van een bestaande vergadering wordt gestart. Hiermee wordt de pod Vragen en antwoorden ingeschakeld. Hiermee kan een gastheer de achtergrond van een vergaderruimte aanpassen. Achtergronden worden meestal ingesteld in de vergadersjabloon. Hiermee worden aangepaste pods ingeschakeld. Hiermee kunnen gebruikers vanuit de pod Delen documenten selecteren in de inhoudsbibliotheek. (Deze instelling heeft geen invloed op de pod Bestanden delen.) Hiermee kunnen gebruikers vanuit de pod Delen documenten uploaden naar de inhoudsbibliotheek. (Deze instelling heeft geen invloed op de pod Bestanden delen.) Hiermee kunnen gastheren het gebied Wie is aan het woord? in een vergadering in- of uitschakelen. Hiermee wordt het gebied Wie is aan het woord? ingeschakeld. Hiermee wordt de pod Camera ingeschakeld. Hiermee schakelt u stembesturing in de vergaderinterface van gebruikers in, zoals de mogelijkheid om audio uit te zenden met VoIP. Hiermee wordt de pod Webkoppelingen ingeschakeld. Hiermee schakelt u het gebruik van het whiteboard in in de pod Delen. Hiermee kan een gebruiker de vergadering weer starten als de gastheer deze heeft beëindigd. Hiermee schakelt u open inschrijving in, zodat gebruikers zichzelf zonder goedkeuring van de trainingsmanager kunnen inschrijven voor een cursus. Als u deze functie uitschakelt voor een account, kan een trainingsmanager de instellingen van een cursus in Acrobat Connect Pro Central niet wijzigen om gebruikers in te laten schrijven zonder goedkeuring. field Beschrijving Een element met informatie over een aangepast veld dat is gedefinieerd voor een object of principal. Kenmerken Kenmerk Type Beschrijving 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. Acrobat Connect Pro Central geeft de field-id niet weer, maar deze id wordt door verschillende acties 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 actie 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.

197 191 Kenmerk Type Beschrijving 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. 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 dat in Acrobat Connect Pro Central wordt gebruikt ter identificatie van een SCO. Waarden Waarde archive attachment authorware captivate course curriculum external-event flv html image lms-plugin logos meeting-template mp3 pdf pod presentation producer seminar session swf Beschrijving Een archief van een Adobe Acrobat Connect Pro-vergadering. Een stuk inhoud dat is geüpload als een bijlage. Een stuk multimedia-inhoud dat is gemaakt met Macromedia Authorware van Adobe. Een demo of film die is gemaakt met Adobe Captivate. Een trainingscursus. Een studieprogramma. Een externe training die aan een studieprogramma kan worden toegevoegd. Een mediabestand in de FLV-indeling. Een HTML-bestand. Een afbeelding. Een stuk inhoud uit een extern LMS. Een aangepast logo dat wordt gebruikt in een vergaderruimte of in Acrobat Connect Pro Central. Een aangepaste weergave voor een vergadering. Een MP3-bestand. Een Adobe PDF-bestand. Een visueel vak met beschikbare functies in een schermindeling voor een vergaderruimte. Een presentatie die is gemaakt met een eerdere versie van Adobe Breeze -software. Een presentatie die is gemaakt met Adobe Presenter. Een seminar dat is gemaakt met Adobe Acrobat Connect Pro Seminars. Een instantie van een herhaalde Acrobat Connect Pro-vergadering. Een SWF-bestand.

198 192 lang Beschrijving Een uit twee of drie letters bestaande code die een taal aangeeft volgens de ISO 639-specificaties. ISO beschrijft uit twee letters bestaande codes en ISO beschrijft uit drie letters bestaande codes. De taalcode beïnvloedt de weergave in een Acrobat Connect Pro-toepassing, zoals een vergaderruimte of een Acrobat Connect Pro Central-weergave. 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 Acrobat Connect Pro-object beschrijft. Waarden Waarde object-type-account object-type-action object-type-event object-type-hidden object-type-meeting object-type-principal object-type-readonly object-type-sco Betekenis Een account die principals en SCO's bevat. Een actie in de Web Services XML API. Een Acrobat Connect Pro-gebeurtenis. Een SCO die niet zichtbaar is in Acrobat Connect Pro Central (of in uw toepassing, als u deze waarde gebruikt). Een Acrobat Connect Pro-vergadering. Een gebruiker of groep. Een instelling die aangeeft dat Acrobat Connect Pro Central bepaalde gegevens weergeeft, maar dat een gebruiker de gegevens niet kan instellen in Acrobat Connect Pro Central. 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.

199 193 Waarden Waarde completion-none completion-required prereq-none prereq-required prereq-hidden prereq-suggested preass-blocked preass-none preass-hidden preass-optional Betekenis De huidige SCO is geen voltooiingsvereiste voor het studieprogramma. De huidige SCO is een voltooiingsvereiste. Het huidige leerobject kent geen voorwaarden. De huidige SCO beschikt over een voorwaarde waaraan moet worden voldaan. Het doelleerobject is vereist als een voorwaarde. Het huidige leerobject is verborgen totdat het doelleerobject is voltooid. De huidige SCO heeft een voorwaarde die wordt aanbevolen, maar die niet is vereist. 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. Er bestaan geen evaluatietests voor de huidige SCO. 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. 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 actie of het antwoord, kan de machtiging een machtiging zijn van een principal voor een SCO of een machtiging die is vereist om een actie uit te voeren. Waarden Machtiging view host mini-host remove publish manage denied Beschrijving 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. Alleen beschikbaar voor vergaderingen. De principal is de gastheer van een vergadering en kan de vergadering maken of fungeren als presentator, zelfs zonder view-machtiging voor de bovenliggende map van de vergadering. 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. 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. Beschikbaar voor andere SCO's dan vergaderingen. De principal kan de SCO publiceren of bijwerken. Tot de publishmachtigingen behoort view en deze machtiging staat 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. 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. Beschikbaar voor andere SCO's dan vergaderingen. De principal mag de SCO niet weergeven, openen of beheren.

200 194 Speciale machtigingen De server definieert een speciale principal, public-access, waarin de waarden van permission-id worden gecombineerd om speciale toegangsmachtigingen voor vergaderingen in te stellen: 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 beveiligd is en dat alleen geregistreerde gebruikers en geaccepteerde gasten de ruimte kunnen betreden. principal-id=public-access en permission-id=denied betekenen dat de vergadering privé is en dat alleen geregistreerde gebruikers en deelnemers de ruimte kunnen betreden. quota-id Beschrijving De parameter quota-id definieert een quotum in het systeem. Het type quotum dat u opgeeft, bepaalt de waarde van acl id die wordt gebruikt. Waarden Type quotum Quotumbeschrijving Overeenkomstige te gebruiken acl-id live-user-quota concurrent-user-per-meetingquota training-user Het aantal aanwezigen van vergaderingen in de gehele account. Het aantal gelijktijdige gebruikers in een vergadering. Het aantal gelijktijdige studenten voor een account. De account-id van de account. De tree-id van de structuur user-meetings of meetings. De account-id van de account. num-of-members-quota Het aantal auteurs of gastheren van vergadering. De principal-id for voor de groep Auteurs of Gastheren van vergadering (live-admins), afhankelijk van het quotum dat u opgeeft. status Beschrijving Een statuscode die door Acrobat Connect Pro wordt geretourneerd als antwoord op alle acties in de Web Services XML API. Antwoordenstructuur <status code=allowedvalue > of <status code=allowedvalue> <invalid field=string type=allowedvalue subcode=allowedvalue /> </status> Kenmerken code De status van het antwoord.

201 195 Waarde invalid no-access no-data ok too-much-data Beschrijving Geeft aan dat een aanroep om een bepaalde reden ongeldig is. Raadpleeg het element invalid voor nadere informatie. Geeft aan dat u niet over de machtiging beschikt om de actie aan te roepen. Het kenmerk subcode verschaft nadere informatie. Geeft aan dat er geen gegevens beschikbaar zijn (in antwoord op een actie 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. Geeft aan dat de actie is voltooid. Geeft aan dat de actie éé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 actie 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. subcode 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. Waarde account-expired denied no-login no-quota not-available not-secure pending-activation pending-license sco-expired sco-not-started Beschrijving De account van de klant is verlopen. Op basis van de opgegeven aanmeldingsgegevens beschikt u niet over de machtiging om de actie aan te roepen. De gebruiker is niet aangemeld. U kunt deze fout oplossen door u aan te melden (met gebruik van de actie login) voordat u de aanroep uitvoert. Zie login voor nadere informatie. De accountlimieten zijn bereikt of overschreden. De vereiste is bron is niet beschikbaar. U moet SSL gebruiken om deze actie aan te roepen. De account is nog niet geactiveerd. De gebruiksrechtovereenkomst van de account is nog niet afgesloten. De cursus of het bijhouden van inhoud is verlopen. 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 invalid Leeg, met kenmerken Informatie over waarom de aanroep ongeldig was. field Reeks De naam van de aanvraagparameter 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 (zie de volgende tabel voor waarden).

202 196 De volgende tabel bevat de toegestane waarden voor subcode wanneer de code invalid is. Waarde duplicate format illegal-operation missing no-such-item range Beschrijving De aanroep heeft geprobeerd een gedupliceerd item toe te voegen in een context waarin elk item uniek moet zijn. Een doorgegeven parameter heeft niet de goede indeling. De gewenste bewerking schendt de integriteitsregels (verplaatst een map bijvoorbeeld naar zichzelf). Een vereiste parameter ontbreekt. De aangevraagde gegevens bestaan niet. De waarde valt buiten het toegestane waardenbereik. Geretourneerd door Alle acties in de Acrobat Connect Pro Web Services XML API. Voorbeelden Dit is een geslaagd antwoord: <status code="ok" /> Dit is een ongeldig antwoord: <status code="invalid"> <invalid field="principal-id" type="id" subcode="missing" /> </status> status attribute Beschrijving Een kenmerk dat de vorderingen van een gebruiker in een cursus- of studieprogramma-sco beschrijft. Dit kenmerk wordt geretourneerd door acties 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 de status wordt geretourneerd in een row-element dat een cursus beschrijft. Waarde user-passed user-failed completed incomplete not-attempted. review Beschrijving De SCO heeft score-interacties waarvoor de gebruiker is geslaagd. De SCO heeft score-interacties. De gebruiker heeft deze beantwoord, maar is gezakt. De gebruiker heeft alle inhoud van de SCO weergegeven, maar de inhoud bevat geen score-interacties. De gebruiker heeft niet alle inhoud van de SCO weergegeven. De gebruiker is nog niet begonnen met het weergeven van alle inhoud van de SCO. De gebruiker is geslaagd voor de cursus, heeft deze voltooid of heeft alle beschikbare pogingen opgebruikt. Voorbeeld <status code="ok" /> <report-user-training-transcripts> <row transcript-id=" " sco-id=" " principal-id=" " status="review" score="0" max-score="" certificate="" type="content" icon="course"> <name>test Course</name>

203 197 <url-path>/test/</url-path> <date-taken> t15:23: :00</date-taken> <principal-name>joy Smith</principal-name> </row> </report-user-training-transcripts> </results 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 (GMT) Greenwich Mean Time: Dublin, Edinburgh, Lissabon, Londen 85 (GMT) Casablanca, Monrovia 90

204 198 Tijdzone-instelling Waarde (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 (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

205 199 Tijdzone-instelling Waarde (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 voor SCO's en voor principals. SCO-typen Een SCO kan inhoud zijn, een Adobe Acrobat Connect Pro-vergadering, een gebeurtenis, cursus, studieprogramma, map of boomstructuur of een willekeurig ander object in Acrobat Connect Pro. Alle Acrobat Connect Pro-objecten zijn SCO's. In het algemeen gesproken, kan een SCO een van de volgende waarden hebben voor type: Waarde content course curriculum event folder link meeting session tree Beschrijving 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, enzovoort. Een cursus, onderdeel van een studieprogramma. Een studieprogramma. Een gebeurtenis. Een map met inhoud op de vaste schijf van de server. 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. Een Acrobat Connect Pro-vergadering. Een instantie van een herhaalde Acrobat Connect Pro-vergadering. 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.

206 200 De inhoudsobjecten die door sommige acties worden geretourneerd (bijvoorbeeld report-bulk-objects) hebben de waarden voor type die worden vermeld in de volgende tabel: Waarde archive attachment authorware captivate course curriculum external-event flv image meeting presentation swf Beschrijving Een gearchiveerd exemplaar van een live uitgevoerde Acrobat Connect Pro-vergadering of -presentatie. Een stuk inhoud dat is geüpload als een bijlage. Een stuk multimedia-inhoud dat is gemaakt met Macromedia Authorware van Adobe. Een demo of film die is gemaakt met Adobe Captivate. Een cursus. Een studieprogramma, inclusief cursussen, presentaties en andere inhoud. Een externe training die aan een studieprogramma kan worden toegevoegd. Een mediabestand in de FLV-indeling. Een afbeelding, bijvoorbeeld in de GIF- of JPEG-indeling. Een Acrobat Connect Pro-vergadering. Een presentatie. Een SWF-bestand. Principal-typen De voor principals toegestane waarden voor type worden weergegeven in de volgende tabel: Waarde admins authors course-admins event-admins event-group everyone external-group external-user group guest learners live-admins seminar-admins user Beschrijving De geïntegreerde groep Beheerders voor Acrobat Connect Pro-serverbeheerders. De geïntegreerde groep Auteurs, voor auteurs. De geïntegreerde groep Trainingsmanagers, voor trainingsmanagers. De geïntegreerde groep Gebeurtenismanagers, voor iedereen die een Acrobat Connect Pro-vergadering kan maken. De groep gebruikers die is uitgenodigd voor een gebeurtenis. Alle Acrobat Connect Pro-gebruikers. Een groep die is geverifieerd via een extern netwerk. Een gebruiker die is geverifieerd via een extern netwerk. Een groep die een gebruiker of beheerder maakt. Een niet-geregistreerde gebruiker die een Acrobat Connect Pro-vergaderruimte betreedt. De geïntegreerde groep Studenten, voor gebruikers die cursussen afleggen. De geïntegreerde groep Gastheren van vergaderingen, voor gastheren van Acrobat Connect Pro-vergaderingen. De geïntegreerde groep Seminargastheren, voor gastheren van seminars. Een geregistreerde gebruiker op de server. Aangepaste veldtypen Wanneer type wordt gebruikt met een aangepast veld, kan het de volgende waarden hebben. Waarde required optional optional-no-self-reg Beschrijving Een verplicht aangepast veld voor de account. Een optioneel veld dat tijdens zelfregistratie wordt weergegeven. Een optioneel veld dat tijdens zelfregistratie wordt verborgen.

207 201 Hoofdstuk 9: 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-viewcontroller-architectuur en kan worden uitgevoerd op een willekeurige webtoepassingsserver met een J2EEservletcontainer. Aan de hand van de voorbeeldtoepassing wordt uitgelegd hoe de vergaderingsfuncties van Acrobat Connect Pro 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 Acrobat Connect Pro Web Services XML API te onthouden: De volgorde van API-aanroepen 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. Verschillende parameternamen voor dezelfde waarde 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. 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 Opmerking: raadpleeg de voorbeeldbestanden XMLApiAdapter.java, login.jsp en mymeetings.jsp. Een adapterklasse is bijzonder handig wanneer u een aangepaste toepassing ontwerpt om Acrobat Connect Pro 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 aanvragen 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 Acrobat Connect Pro. U gebruikt deze constructor als u al over de BREEZESESSION-cookiewaarde 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(); }

208 202 De tweede constructor accepteert de aanmeldings-id en het wachtwoord van een gebruiker en ook een BREEZESESSIONcookiewaarde: public XMLApiAdapter(String baseurl, String login, String password, String breezesession) throws XMLApiException { this(baseurl, breezesession); 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 Acrobat Connect Pro aangemelde gebruiker vertegenwoordigt. De huidige waarde van breezesession, die de BREEZESESSIONcookiewaarde 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 Acrobat Connect Pro. Een aanmeldingsmethode dient een verbinding met de server te openen, de actie login aan te roepen en het XML-antwoord op te halen. De methode moet ook de waarde van het BREEZESESSION-cookie lezen in de antwoordheader en deze waarde opslaan. Dit is de eenvoudigste vorm van de actie login: &password=jazz Wellicht dient u ook de parameters session, account-id of domain toe te voegen aan de actie login (zie ''Aanmelden vanuit een toepassing'' voor meerdere manieren om login aan te roepen). Een gelukte aanmelding geeft het volgende antwoord als resultaat, met de statuscode ok: <status code="ok" />

209 203 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: Deze methode voegt bovendien een naam voor de actie en een querytekenreeks toe die u eraan doorgeeft. 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 actie login aan, opent de verbinding met de server, leest het 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, "="); 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 Acrobat Connect Pro."); } catch (IOException ioe) { throw new XMLApiException(IO_ERROR, ioe); } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); }

210 204 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 actie en een querytekenreeks verschaft. De request-methode in het voorbeeld accepteert een actie en een querytekenreeks en stuurt de BREEZESESSIONcookiewaarde in de antwoordheader terug naar de server: 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(); InputStream resultstream = conn.getinputstream(); Document doc = new SAXBuilder(false).build(resultStream); return doc.getrootelement(); } } catch (IOException ioe) { throw new XMLApiException("A communication error occurred", ioe); } catch (JDOMException jde) { throw new XMLApiException("A parsing error occurred", jde); } XML-antwoorden parseren Opmerking: zie het voorbeeldbestand XMLApiAdapter.java. Wanneer u een XML-aanvraag naar Acrobat Connect Pro 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" /> <sneltoetsen> <sco tree-id=" " sco-id=" " type="my-courses"> <domain-name> </sco> <sco tree-id=" " sco-id=" " type="my-events"> <domain-name> </sco>... </shortcuts>

211 205 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: 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 actie 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(); } Gebruikersinformatie weergeven Opmerking: 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 naam.

212 206 U kunt eenvoudige gegevens over de gebruiker opvragen door common-info aan te roepen nadat de gebruiker zich heeft aangemeld: Het antwoord beschikt over een user-element met informatie die u kunt weergeven of in variabelen kunt opslaan voor later gebruik: <user user-id=" " type="user"> <name>joy Smith</name> <login>joy@acme.com</login> </user> Als u common-info aanroept voordat de gebruiker zich aanmeldt, heeft het antwoord geen user-element. 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)); user.setuserid(id.valueof(e)); return user; } } catch (JDOMException jde) { throw new XMLApiException(PARSE_ERROR, jde); }

213 207 De vergaderingen van een gebruiker vermelden Opmerking: 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 report-my-meetings alle vergaderingen van een gebruiker als resultaat: 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: 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=" " type="meeting" icon="meeting" permission-id="host" active-participants="0"> <name>september All Hands Meeting</name> <description>for all company employees</description> <domain-name>example.com</domain-name> <url-path>/sept15/</url-path> <date-begin> t09:00: :00</date-begin> <date-end> t18:00: :00</date-end> <expired>false</expired> <duration>09:00:00.000</duration> </meeting> 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);