BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE - Logiciel de conférence en ligne MACROMEDIA - Notice d'utilisation et mode d'emploi gratuit
Retrouvez gratuitement la notice de l'appareil BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE MACROMEDIA au format PDF.
| Intitulé | Description |
|---|---|
| Type de produit | Logiciel de présentation et de collaboration en ligne |
| Version | Breeze 5 |
| Utilisation principale | Création et diffusion de présentations interactives via le web |
| Services web XML | Intégration de services web XML pour l'interaction avec d'autres applications |
| Compatibilité | Compatible avec divers navigateurs web et systèmes d'exploitation |
| Installation | Installation via un package d'installation standard |
| Maintenance | Mises à jour régulières disponibles pour corriger les bugs et améliorer les fonctionnalités |
| Sécurité | Fonctionnalités de sécurité intégrées pour protéger les données et les présentations |
| Documentation | Documentation complète fournie pour l'utilisation et la configuration |
| Support technique | Assistance technique disponible via forums et support client |
| Exigences système | Exigences minimales en matière de matériel et de logiciel spécifiées dans la documentation |
FOIRE AUX QUESTIONS - BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE MACROMEDIA
Questions des utilisateurs sur BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE MACROMEDIA
0 question sur cet appareil. Repondez a celles que vous connaissez ou posez la votre.
Poser une nouvelle question sur cet appareil
Téléchargez la notice de votre Logiciel de conférence en ligne au format PDF gratuitement ! Retrouvez votre notice BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE - MACROMEDIA et reprennez votre appareil électronique en main. Sur cette page sont publiés tous les documents nécessaires à l'utilisation de votre appareil BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE de la marque MACROMEDIA.
MODE D'EMPLOI BREEZE 5-UTILISATION DES SERVICES WEB XML DE BREEZE MACROMEDIA
Utilisation des services Web XML de Breeze
Marques commerciales
Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Bright Tiger, Clustercats, ColdFusion, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, Fontographer, FreeHand, Generator, HomeSite, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Breeze, Macromedia Contribute, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, SoundEdit, Titemaker, UltraDev, Web Design 101, what the web can be et Xtra sont des marques commerciales ou des marques déposées de Macromedia, Inc. qui peuvent être déposées aux Etats-Unis et/ou dans d'autres juridictions ou pays. Les autres noms de produits, logos, graphiques, mises en page, titres, mots ou expressions mentionnés dans cette publication peuvent être des marques commerciales, des marques de service ou des noms de marque appartenant à Macromedia, Inc. ou à d'autres entités et peuvent être déposés dans certaines juridictions ou pays.
Autres marques mentionnées
Ce guide contient des liens vers des sites Web qui ne sont pas sous le contrôle de Macromedia, qui n'est donc aucunement responsable de leur contentu. L'accès à ces sites se fait sous votre seule responsabilité. Macromedia ne mentionne ces liens qu'à titre pratique et leur inclusion n'implique en aucun cas que Macromedia peut être tenu pour responsable du contentu de ces sites.
Copyright © 1997-2004 Macromedia, Inc. Tous droits réservés. Le présente manuel ne doit pas être copié, photocopié, reproduit, tranduit ou converti sous tout format électronique ou lisible par une machine, en tout ou partie, sans l'autorisation écrite préalable de Macromedia, Inc.
Remerciements
Gestion du projet : Stephanie Gowin
Gestion de la production : Patrice O'Neill
Conception et production des supports : Adam Barnett, Christopher Basmajian, Aaron Begley
Première édition : mars 2004
Macromedia, Inc.
600 Townsend St.
San Francisco, CA 94103
TABLE DES MATIERES
INTRODUCTION: Avant de commencer 7
Utilisateurs concernés 7
Guide des supports pedagogiques 7
Ressources supplémentaires 8
Conventions typographiques. 9
CHAPITRE 1:Vue d'ensemble de l'architecture. 11
Flux de données 12
Appel d'une action sur le serveur 13
A propos des paramètres 13
A propos des mandants, des entités SCO et des identifiants 14
A propos de la sécurité. 15
CHAPITRE 2: Tâches courantes 19
Scenario: Integration de Breeze à un service d'annuaire 19
Scenario: Integration de Breeze à un portail 23
Scenario:generation derapports. 25
CHAPITRE 3: Guide de reférence des actions. 27
accesskey-exec 27
accesskey-info 28
action-list 29
common-info 29
group-membership-update 30
login 30
logout 31
permissions-info 31
permissions-reset 32
permissions-update 32
principal-info 33
principal-list 34
principal-update 34
principals-delete 35
CHAPITRE 4: Réréences pour les résultats XML 61
A propos du code XML renvoyé 61
access-key (conteneur) 62
access-key (cle) 62
access-keys 63
account 63
action 64
actions. 64
answer-text 65
body 65
common 65
cookie 66
course 67
date. 67
date-begin 68
date-closed 68
date-created. 68
date-end 69
date-expired. 69
date-modified 69
date-taken 70
description 70
domain-name 71
duration 71
email 71
expired 72
first-name 72
hit 73
host. 73
invalid. 73
last-name. 74
Les services Web XML Macromedia Breeze permettent à un système externe (tel qu'une application Web) d'interagir avec un serveur Breeze.
Le present guide explique comment appeler des services Web XML (« actions ») sur le serveur Breeze à partir du système exter et comment interpréter les résultats XML renvoyés par Breeze. Il comporte également des sections de réference expliquant l'effect des différentes actions et indique les paramètres pouvant être associés à ces actions.
Remarque : Pour utiliser les services Web XML de Breeze, vous doivent disposer d'une clé d'accès valide. Pour plus d'informations, consultez la section A propos de la sécurité, page 15.
Les services Web mentionnés dans ce document sont sujets à modifications. Consultez la page de mises à jour (http://www.macromedia.com/go/breeze_xmlapi Updates_fr) pour prendre reconnaissance des dernières mises à jour et modifications.
Utilisateurs concernés
Le present document a ete concu pour les develloppeurs qui souhaitent integrer les services Web XML de Breeze dans leurs systèmes externes, tels que les applications Web.
Il implique des notions de base du code XML et de l'utilisation des requêtes HTTP permettant de communiquer entre une application et un serveur. Vous doivent également savoir comment écrire du code en langage serveur, tel que le langage CFML (Macromedia ColdFusion Markup Language).
Guide des supports pédagogiques
Macromedia Breeze dispose de plusieurs supports qui permettent de maîtriser rapidement ce produit. Outre le présente document, les manuels électroniques et les systèmes d'aide en ligne suivants sont disponibles :
- Guide d'installation de Breeze indique comment installer les modules de Breeze. Ce guide est disponible sous forme d'insert sur le DVD pour les utilisateurs professionnels, ainsi qu'au format PDE.
-
Utilisation de Breeze Manager déscrit comment utiliser les composants d'administration, de presentation et de formation de Breeze Live. Vous pouvez acceder à ce guide à partir de la page d'accueil de Breeze Manager et du lien Aide de l'application Web Breeze Manager.
-
Mode d'emploi de Breeze Live à l'intention desprésentateurs de réunions comprend des informations sur l'utilisation de l'application Web Breeze Live pour héberger des réunions en temps réel en ligne. La documentation inclut des procédures qui démontré àquel point il est facile d'ajouter des diapositives, des fichiers Flash SWF, des images, du son et des videos à votre presentation. Vous pouvez acceder à ce document à partir de la page d'accueil de l'application Breeze Manager et du menu Aide dans une salle de réunion Breeze Live (lorsque vous entrez en tant queprésentateur) en sélectionnant Réunion > Aide.
- Mode d'emploi de Breeze Live à l'intention des participants aux réunions comprend les informations qui s'appliquent aux utilisateurs participant à une réunion en temps réel en ligne. Breeze Live met à la disposition des participants différentes options qui facilitent la participation, ce qui inclut la possibilité d'envoyer des messages et des questions auxprésentateurs et aux autres participants, ainsi que la possibilité de participer en direct à l'aide des fonctions audio et video. Vous pouze acceder à ce document à partir de la page d'accueil de l'application Breeze Manager et du menu Aide dans une salle de réunion Breeze Live (lorsque vous entrez en tant que participant) en selectionnant Réunion > Aide.
- Utilisation du plug-in Breeze pour PowerPoint explique comment utiliser le plug-in qui permet aux utilisateurs de creer des presentations Breeze à partir de PowerPoint. Vous pouvez acceder à ce document à partir de la page d'accueil de Breeze Manager et du menu Breeze de PowerPoint enclinquant sur Breeze >Aide.
- Utilisation de l'Assistant de publication de Breeze comprend les procédures de publication sur un serveur Breeze des presentations Breeze créées dans PowerPoint. Vous pouvez acceder à ce document à partir de la page d'accueil de l'application Breeze Manager et du bouton Aide de l'Assistant de publication.
Remarque : L'intérêt de ces guides dépend des modules installés sur la plate-forme de presentation Breeze, du type d'utilisateur (tel que gestionnaire du contenu de la réunion, ingénieur informatique ou représentateur de cours) et des autorisations du compte Breeze de l'utilisateur.
Ressources supplémentaires
Voutrouverez ci-dessous les principales ressources disponibles sur le Web :
Remarque : Pour obtenir la liste des ressources de Breeze, consultez le manuel Guide des supports pédagogiques, page 7.
The Web Service Primer à xml.com (http://webservices.xml.com/pub/a/ws/2001/04/04/webservices/) constitue un excellent point de départ pour les services Web.
Working with XML and ColdFusion dans le manuel ColdFusion Developer's Handbook (http://www.macromedia.com/devnet/mx/coldfusion/articles/CF_handbk_ch6.html) comporte des informations supplémentaires sur les notions de base du code XML et la rédaction de code avec CFML.
Leveraging XML with ColdFusion (http://www.macromedia.com/devnet/mx/coldfusion/articles/cf_handbk_ch7.html) traite des services Web, de SOAP et des méthodes d'emploi des services Web avec le langage CFML.
La Specification XSL Transformations (XSLT) (http://www.w3.org/TR/xslt) introduit le code XSLT, que vous pouverez utiliser pour convertir les données.
Numeric representation of Dates and Time (http://www.iso.ch/iso/en/prods-services/popstds/datesandtime.html) fournit des informations sur le format de date et d'heure de la norme ISO 8601. De façon plus spécifique, la note W3C relative aux dates et aux heures (http://www.w3.org/TR/NOTE-datetime) fournit des informations sur le profil ISO 8601 retenu par Breeze.
Conventions typographiques
Ce manuel utilise les conventions typographiques suivantes :
- La police en italieque indique une valeur qui doit etre remplacemente (par exemple, dans le chemin d'un dossier).
- La police de code identifie le code. Elle met également en avant le nom des actions, des paramètres, des balises et des attributs.
- La police en gras désigne une citation ou un élément de menu.
CHAPITRE 1
Vue d'ensemble de l'architecture
Le cadre d'API de Macromedia Breeze convertit les interfaces en un ensemble de services Web XML. Ces services permettent à un système externe, tel qu'un portail, de communiquer avec le serveur Breeze en utilisant le protocole HTTP ou HTTPS pour appeler des actions sur le serveur et receivevoir les résultats formats en tant que code XML. Vous pouvez utiliser les services Web pour ajouter le service de gestion de Breeze et les fonctionnalités de création de rapportes sur votre système externe.
Remarque : Breeze ne prend pas encore en charge le protocole SOAP (Simple Object Access Protocol).
Le present chapitreporte sur les flux de données entre le serveur Breeze et les applications Web, et indique comment definir les parametes et les autorisations de sécurité.
Flux de données
Le diagramme suivant illustrer le flux de données dans une application Web qui interagit avec le serveur Breeze :
L'exemple suivant décrit ce qui peut de se produit lorsqu'un utilisateur se connecte au portail de formation d'un site intranet créé avec Macromedia ColdFusion MX et ayant recours aux services Web XML de Breeze :
1 Un utiliser connecté se sert d'un navigateur Web pour demander une page qui affiche la liste des cours auquel il est inscrit.
2 Le serveur Web trouve la page et la passe au serveur d'applications.
3 Le serveur d'applications analyse et exécute le code ColdFusion contenu dans la page.
4 Lors de l'execution du code, le serveur d'applications appelle une action sur le serveur Breeze de la société, afin d'obtenir la liste des cours. Cet appel d'action prend la forme d'une requête POST HTTP disposant d'informations d'identification de sécurité incluses dans la requête.
5 Le serveur Breeze exécut e l'action, en renvoyant les données XML résultatses au serveur d'applications.
6 Le code d'application analyse le code XML renvoyé et insère des données dans la page Web en fonction des besoin, puis passes la page finale au serveur Web.
7 Le serveur Web passé la page finale au navigateur, ce qui permet de l'afficher.
Appel d'une action sur le serveur
Pour appeler une action sur le serveur Breeze, passez les paramétres voulus au servlet de services Web à l'adresse http://nomServeur/api/xml.
Toutes les actions nécessitent au moins deux paramètres : le paramètre action spécifique le nom de l'action et le paramètre accesskey donne la clé d'action du compte. La plupart des actions disposent également d'autres paramètres. Pour plus d'informations sur les clés d'accès, consultez la section A propos de la sécurité, page 15. Pour plus de détails sur les paramètres supplémentaires correspondant à une action donnée, consultez la documentation de cette action dans le Chapitre 3, Guide de referencia des actions, page 27.
Utilisez l'une des méthodes suivantes pour transmettre les paramètres au serveur :
- Créez une chaîne de requête — une URL qui inclut les paramètres de la requête — et transmettez-la au serveur sous forme de requête HTTP, GET ou POST, dont le contenu est défini sur "application/x-ww-form-urls-encoded". (Dans la plupart des cas, il n'est pas nécessaire de définir le type de contenu de façon explicite lorsque vous appliquez cette méthode.) L'URL à utiliser pour la chaîne de requête prend la forme http://breeze.exemple.com/api/xml?action=nom_action&accesskey=clé_accès. Les autres paramètres de l'action sont ajoutés en tant que paramètres de requête en option et séparés par des signes &.
- Créée un objet XML contenant les paramétres sous forme de balises param contenues dans une balise params, puis envoie une requête HTTP POST au serveur, dont le type de contenu HTTP est défini sur "text/xml".
Pour consulter un exemple de code indiquant comment appeler une action, reportez-vous au Chapitre 2, Tâches courantes, page 19.
Remarque : L'exemple de code figurant dans ce document utilise l'approche avec paramétres de requête, pour plus de clarté et parce que l'utilisation du code CFML pour envoyer des objets XML contenant des paramétres est soumise à certaines limitations. Macromedia recommande d'utiliser la méthode POST si possible ; en raison de la façon dont le code HTTP implémente les méthodes GET et POST. POST permet de renforcer la sécurité lorsque vous passez des paramétres dans la chaîne de requête. Pour plus d'informations, consultez la section A propos de la sécurité, page 15.
A propos des paramètres
La plupart des actions permettent de spécifier un ou plusieurs paramètres.
Voupez generalement specifie les parametes sous forme de paire nom-valeur, mais le processus exact depend du langage utilise pour appeler l'action sur le serveur Breeze. Pour consulter un exemple de code en langage CFML (ColdFusion Markup Language), consultez le chapitre Chapitre 2, Taches courantes, page 19.
La documentation des actions affiche les paramètres requis. Les paramètres facultatifs sont signalés de façon explicite.
Certaines actions permettent de fournir plusieurs paramètres du même nom. Par exemple, l'action principales-delete prend un paramètre appelé principal-id. Vous pouvez spécifique plusieurs paires nom-valeur principal-id (portant toutes le nom principal-id) lorsque vous appelez l'action sur le serveur Breeze. L'exemple de code CFML suivant illustrtre comment supprimer deux utilisateurs spécifés à l'aide d'un appel d'action unique, en spécifique deux paramètres principal-id. (Cet exemple recourt aux variables baseurl, accesskey et loginCookie que vous avez définies pendant le processus de connexion. Pour plus de détails, consultez la section Scénario: Intégration de Breeze à un service d'annuaire, page 19.)
<cfset idOne=12345>
<cfset idTwo=23456>
<cfhttp url="/#baseurl#/api/xml?action=principals-delete&accesskey=/#accesskey#/&principal-id=/#idOne#/&principal-id=/#idTwo#" method="post">
<cfhttparam type="Cookie" name="JSESSIONID" value="/#loginCookie#" />
</cfhttp>
Certaines actions permettent de fournir des jours de paramètres multiples. Par exemple, l'action group-membership-update prend les paramètres group-id, principal-id, et is-member pour procéder à plusieurs mises à jour suite à un appel unique. Sécífiez chacun de ces paramètres pour le mandant et le groupe, puis spécifique-les (en conservant les mêmes noms de paramètre) pour un autre, etc.
A propos des mandants, des entités SCO et des identifiants
Breeze compte deux types d'identités de base : les mandants et les SCO (Shareable Content Objects).
Le terme mandant couvre toutes les entités qui disposent d'autorisations régissant leurs interactions avec les entités SCO. Vous trouvrez ci-dessous les principaux types de mandant :
user Unutilisateur specifique.
group Un groupe d'utilisateurs.
Il existe d'autres types de mandants, appelés « groupes primaires » : "administr", "authors", "live-admins" et "course-admins". Pour plus d'informations sur les groupes primaires, consultez la section Utilisation de Breeze Manager.
Vou puevez creer et modifier des utilisateurs et des groupes, mais pas des groupes primaires.
Une entité SCO est un document Breeze, tel qu'une réunion ou une presentation. Les dossiers sont également des SCO.
Breeze Inclut les deux types d'entité SCO suivants :
tree La racine d'une hierarchie de dossiers. La racine d'une arborescence est traitée en tant que hierarchie independante. Vous ne pouvez pas déterminer le dossier parent d'une arborescence à partir de cette arborescence.
folder Un dossier sur le disque dur du serveur qui renferme le contenu Breeze.
presentation Une presentation.
course Uncours.
meeting Une réunion.
fly Un fichier video Flash.
swf Un fichier SWF Flash.
image Un fichier d'images.
session Une session de réunion. Une session commence lorsqu'une personne pénétre dans une salle de réunion vide et se termine lorsque la dernière personne quitte la salle.
archive Une réunion archivée.
attachment Un fichier partagé utiliser le module de partage de fichiers au cours d'une réunion.
pod Un plug-in de réunion.
logos Une image (telle qu'un logo d'entreprise) qui peut etre attachée a du contenu, tel qu'une presentation.
Chaque mandant et entité SCO dispose d'un identifient numérique unique. Lorsque vous appelez une action qui utilise l'identifient d'une entité en tant que paramètre, le nom de paramètre indique le type d'entité auquel l'identifient appartient, mais cet identifient reste le même què que soit le nom de paramètre. Les noms de paramètres qui s'appliquent aux identifiants incluent acl-id, folder-id, group-id, parent-acl-id, principal-id, Sco-id et user-id.
Par exemple, pourmettreà jour unmot de passetutilisateur,appelezl'actionuser-update-pwd et donnez l'identifiantde l'utilisateur en tant que parametre user-id.Pour déterminer un nom d'utilisateur,appelezl'actionprincipal-info et donnez l'identifiantde l'utilisateur en tant que parametre principal-id.
Vous disposez de quelques autres types d'identifiants, tels que account-id, answer-id, permission-id et question-id. Dans la plupart des cas, un nom de paramètre qui se termine en -id indique que la valeur de ce paramètre est un identificant de mandant ou d'entite SCO.
A propos de la sécurité
Le modele de sécurité de Breeze garantit que tout code appelant une action donnée a ete autorise. Pratiquement tous les appeals d'action incluent deux types d'informations d'identification : une clé d'accès et un cookie qui representent un utiliseur connecté donné.
La clé d'accès ou « clé de connexion » est un code permettant de protégger le serveur contre toute utilisation non autorisée. Toute action (ce qui inclut login) nécessite une clé d'accès, que vous spécifiez en tant que paramètre appelé accesskey. Les clés d'accès tiennent compte des majuscules et des minuscules.
Seuls les utilisateurs connectés peuvent appeler la plupart des actions. Par conséquent, vous doivent appeler l'action login avant toute autre action. (Les exceptions, les actions qui ne nécessitent pas de connexion préalable, sont accesskey-exec, action-list, common-info, login et user-accounts.)
Lors de la connexion, le serveur Breeze renvoie des résultats en code XML pour indiquer si la connexion a réussi. Les en-têtes HTTP de ces résultats incluent un cookie appelé JSESSIONID. Lorsque vous receivez les résultats d'un appel login, vous doivent enregistrer la valeur de ce cookie de façon à pouvoir l'utiliser par la suite. Vous doivent ensuite inclure la valeur de ce cookie dans toutes les requêtes transmises ultérieurement avec cet identifient. Pour obtenir des exemples, consultez le Chapitre 2, Tâches courantes, page 19.
Pour appeler une action avec succès, par conséquent, vous doivent fournir une clé d'accès et le cookie correspondant à l'utilisateur connecté qui dispose d'autorisations pour appeler cette action. Si vous ne fournissez pas ces deux informations d'identification (par exemple, si vous fournissez le cookie d'un utiliser qui ne dispose pas des bonnes autorisations), l'action échoue.
Votre application permet de connecter plusieurs utilisateurs et d'appeler des actions quel que soit l'utilisateur. Par exemple, lorsqu'un utiliser ordinaire exécute votre application, il peut être nécessaire d'utiliser les informations d'identification de cet utiliser tout en conservant une connexion administrateur pour effectuer les tâches nécessitant ce niveau d'autorisation.
Pour plus de détails sur les codes d'etat pouvant être renvoyés par le serveur, consultez la section relative à la balise status.
Clés d'accès pour les clients dont le compte est hébergé sur un système Macromedia Breeze (ASP)
Par défaut, votre compte n'est pas activé pour les services Web XML. Vous doivent contacter le service de support technique de Macromedia pour obtenir une clé d'accès XML valide à utiliser en konjction avec les actions.
Pour contacter le centre de support technique, consultez la page de support de Breeze (http://www.macromedia.com/support/breeze/) et demandez la génération d'une clé d'accès XML pour votre compte.
Clés d'accès pour les clients dont le compte est hébergé sur un système Macromedia Breeze Enterprise (sous licence)
Le serveur ne dispose pas d'une clé d'accès XML en standard. Vous devez ajouter cette clé avant d'utiliser les services Web XML.
Pour ajouter une clé d'accès :
1 Recherche le fichier custom.ini dans le sous-repertoire breeze du repertoire d'installation.
2 Ajoutez un paramètre à la fin du fichier en tapant le code suivant sur une nouvelle ligne : XML_API_KEY=
3 Juste après le signe égal, sur la même ligne, tapez une clé d'accès. Cette clé doit composer 16 caractères et doit composer des chiffres et des lettres. Les clés d'accès tiennent compte des majuscules et des minuscules.
4 Arretez le serveur Breeze, puis redemarrez-le.
A propos des autorisations
Les autorisations régissant les interactions entre un mandant et une entité SCO.
L'association d'autorisations à un mandant en fonction d'une entité SCO donnée est appelée ACL. Tout ACL comprend trois éléments d'information : l'identifiant d'un SCO (généralement appelé identifiant d'ACL dans ce contexte), l'identifiant d'un mandant et un un mot clé spécifique les autorisations (généralement désigné comme identifiant d'autorisation).
Breeze dispose de deux types d'autorisation : les autorisations associées à des SCO spécifique et les autorisations qui s'appliquent à l'ensemble des utilisateurs qui appartiennent à des groupes spéciaux, appelés groupes primaires. Les autorisations relatives aux groupes primaires sont prioritaires par rapport aux autorisations définies sur une entité SCO.
Pour identifier les autorisations d'un utiliser connecté sur un élément donné, appezez l'action permissions-info. Pour modifier les autorisations d'un mandant, appezez l'action principal-update.
Si un mandant ne dispose pas d'autorisations spécifiques sur une entité SCO donnée, les autorisations de ce mandant sur le parent du SCO s'appliquent.
You pouvez spécifier les autorisations suivantes sur un SCO :
view Le mandant peut afficher l'entité SCO, mais ne peut pas la modifier. Dans le cadre d'un cours, l'autorisation view permet au mandant de s'inscrite. Dans le cadre d'une réunion, view permet au mandant de participer. Dans le cadre d'un dossier, view permet au mandant d'afficher le contenu.
publish Le mandant peut publier l'entité SCO sur le serveur et laMETRE à jour. Cette autorisation inclut l'autorisation view. Elle permet également au mandant d'afficher des rapportes en relation avec le SCO. Pour un dossier, publish ne permet pas au mandant de creer de nouveaux dossiers dans le dossier ou de définir des autorisations pour ce dernier. Vous ne pouvez pas appliquer cette autorisation à des réunions ou des cours.
manage Le mandant peut afficher, supprimer, déplacer et modifier l'entité SCO. Cette autorisation permet également au mandant de définir des autorisations pour l'entité SCO. Lorsqu'il s'agit d'un dossier, l'autorisation manage permet au mandant d'afficher des rapports sur les fichiers contenus dans le dossier et de créé de nouveaux dossiers. Vous ne pouvez pas associé cette autorisation à des réunions ou des cours.
denied Le mandant ne peut pas afficher, acceder à ou gérer l'entité SCO. Vous ne pouvez pas associier cette autorisation à des réunions ou des cours.
presenter (Réunions uniquement) Le mandant peut creer ouprésenter une réunion. Cette autorisation permet au mandant de creer ouprésenter la réunion, même si le mandant ne dispose pas d'une autorisation view pour le dossier parent de la réunion.
Dans la mesure où un groupe constitue un mandant, vous pouze définir les autorisations citées ci-dessus sur une entité SCO pour un groupe non primaire ou un utilisateur donné. Si un groupe dispose d'une autorisation spécifique, tous les membres en hérêt. Utilisez l'action group-membership-update pour ajouter un membre à un groupe. Utilisez l'action permissions-update pour définir les autorisations d'un groupe en fonction d'une entité SCO donnée.
Le seul moyen d'obtenir certains types d'autorisation est d'appartenir à un groupe primaire, comme indiqué ci-dessous :
Le groupe primaire des autres permet à ses membres de creer ou modifier une presentation dans tout le système, quelles que soient les autorisations ACL.
Le groupe primaire des administrateurs permet de gerer des utilisateurs et des groupes.
Le groupe primaire des administrateurs de réunion permet de creer et deprésenter des réunions dans tout le système, quelles que soient les autorisations ACL.
Le groupe primaire des gestionnaires de cours permet de creer et de modifier des réunions dans tout le système, quelles que soient les autorisations ACL.
Pour acceder à l'ensemble du système, vous doivent être membre des quatre groupes primaires.
A propos des autorisations d'accès public
Il existe un identifient special de mandant qui n'a pas de valeur numérique : "public-access". Cet identifient définit les paramètres globaux d'accès, en ligne ou hors connexion. Vous pouvez attribuer les autorisations suivantes à une entité SCO pour le mandant public-access :
denied Personne ne peut afficher, acceder a ou gerer l'entite SCO.
view Tout le monde peut afficher l'entité SCO, même hors connexion.
view-only (Présentation uniquement) Tout le monde peut afficher la presentation, même hors connexion. Cependant, les autorisations définies sur le dossier parent de la presentation ne s'appliquent pas à cette dernière. Par exemple, même si un utilisateur dispose d'une autorisation manage sur le dossier parent, l'utilisateur ne peut pas supprimer les presentations dont l'autorisation est view-only. (Les autorisations normales s'appliquent toujours à la presentation. Si l'utilisateur dispose d'une autorisation manage sur la presentation, il peut la supprimer.)
view-hidden (Réunions uniquement) Tout le monde peut participer à la réunion, même hors connexion. Cependant, les autorisations définies sur le dossier parent de la réunion ne s'appliquent pas à cette dernière.
N'attribuuez pas les autorisations manage, presenter ou publish au mandant public-access. N'attribuuez pas les autorisations view-only ou view-hidden à des mandants ordinaires.
A propos de la sécurité et du lancement du contenu
Lorsque vous lancez une entité SCO, vous doivent fournir une authenteification. Pour ce faire, utilisez l'une des approches suivantes :
- Lorsque vous ouvrez l'URL du contentu, ajoutez un paramètre de requête appelé session dont la valeur doit être égale à celle du cookie de connexion, comme indiqué dans l'exemple suivant :
http://breeze.example.com/p12345678/?session=breez3238uf298
Cette approche risque de remettre en cause la sécurité, dans la mesure ou toute personne disposant de l'URL spécifique peut se composer en tant qu'utilisateur connecté. Par conséquent, utilisez le cookie d'un utilisateur ordinaire et non pas celui d'un administrateur.
En outre, si un utilisateur transmet l'URL à quelqu'un d'autre (dans un messagelectronique, par exemple), il donne accès à son compte, ce qui représenté également un risque d'atteinte à la sécurité.
- Vous pouvez définir un cookie JSESSIONID sur le navigateur d'un utilisateur, en appliquant la valeur du cookie de connexion.
Cependant, cette approche ne peut fonctionner que si votre application fonctionne sur un serveur utilisant le même nom de Domaine que le serveur Breeze.
En outre, si vous serveur d'applications fonctionne dans un environnement de servlet J2EE (tel que ColdFusion ou Java), le serveur d'application doit également utiliser un cookie appelé JSESSIONID, ce qui risque de provoquer un conflit entre Breeze et le serveur d'applications.
- Vous pouvez vous contenter d'ouvrir l'URL et de demander à l'utilisateur de se connecter de nouveau.
Cette approche est plus sure, mais moins pratique du point de vue des utilisateurs.
CHAPITRE 2
Tâches courantes
Ce chapitre décrit des scénarios typiques d'intégration de Macromedia Breeze à des applications ou systèmes externes. Ces scénarios illustrent la mise en œuvre de diverses tâches courantes. Pour effecturer ces tâches, l'utiliseur appelle une ou plusieurs actions sur le serveur Breeze, puis les balises XML renvoyées par le serveur sont analysées. Dans certains cas, les informations renvoyées sont utilisées comme paramètres pour l'action suivante.
Ce chapitre compte des exemples de code montrant la mise en œuvre de certaines tâches à l'aide du langage CFML (ColdFusion Markup Language) de Macromedia.
Remarque: Certaines descriptions ne sont pas accompaniesées d'exemples de code. La syntaxe d'applé d'une action est similaire pour toutes les actions. Il est donc possible d'utiliser les exemples de code fournis comme modèles pour accomplir d'autres tâches.
Chaque appel d'une action sur le serveur Breeze doit composer une clé d'accès et des informations d'identification permettant de connaître l'auteur authentifié de l'action. Pour plus d'informations sur le modele de sécurité de Breeze, en particulier sur les clés d'accès, consultez la section A propos de la sécurité, page 15.
Pour une description détaillée de chaque action et de chaque balise XML, voir Chapitre 3, Guide de réference des actions, page 27 et Chapitre 4, Références pour les résultats XML, page 61.
ScENARIO : Intégration de Breeze à un service d'annuaire
Supposons que votre organisation utilise un référentiel central pour toutes les informations sur les utilisateurs, par exemple LDAP (Lightweight Directory Access Protocol). Breeze permet d'importer ou synchroniser ces informations à partir de ce service d'annuaire.
La procédure ci-dessous déscrit les étapes que doit suivre votre application pour effectuer cette tâche. Cette procédure part du principe que si les informations transmises par le service d'annuaire ne correspondent pas aux informations fournies par le serveur Breeze, ce sont celles qui proviennent du service d'annuaire qui sont correctes et actuelles.
Pour synchroniser Breeze avec le service d'annuaire :
1 Connectez-vous en appelant l'action login sur le serveur Breeze, en indiquant l'identifant de connexion et le mot de passer d'un administrateur de comptes. Dans les en-têtes HTTP renvoyés, recherche la valeur du cookie JSESSIONID. Ce paramètre est nécessaire pour appeler les actions suivantes.
Remarque : Il peut etre utile de creer un utilisateur doté de privilèges d'administration, spécifquement chargé des synchronisations. Dans ce cas, il est conseilé d'exclure cet utilisateur de la liste des utilisateurs à synchroniser.
L'exemple de code suivant ouvre une session utiliser et récapère la valeur du cookie :
<cfset login="pierre@example.com"> <cfset password="abcdefg"> <cfset accesskey="0123456789101112"> <cfset baseurl="http://breeze.example.com/" > <cfset params="accesskey=#accesskey#&action=login&login=#login#&password=#password#" <cfhttp url="#baseurl#api/xml?#params#" method="get"> <cfset loginHeaders="#cfhttp.ResponseHeader#" /> <cfloop collection="#loginHeaders#" item="httpHeader" > <cfif httpHeader eq "Set-Cookie"> <cfset value= loginHeaders[httpHeader] /> <cfset cookieHeader="#value[1]" /> <cfloop list "#cookieHeader#" index="c" delimiters=";"/> <cfset cookieName= Left(c, Find('=', c)-1) /> <cfif cookieName eq "JSESSIONID" > <cfset fullCookie= mid(c, len cookieName)+2, len(c)-len cookieName)+1) /> <cfset loginCookie= Left(fullCookie, Find '.', fullCookie)-1) /> </cfif> </cfloop> </cfif> </cfloop>
2 Pour vérifier que l'action login s'est terminée correctement, analysez le code XML renvoyé et examinez la valeur de l'attribut code de la balise status. Si le code d'était n'est pas "ok", déterminez l'origine de l'erreur et prenez les mesures appropriées.
<cfset xml=XmlParse(cfhttp.FileContent)>
<cfset resultsElement=XmlSearch(xm1, "/status [@code='ok']")>
<cfif ArrayLen(resultsElement) ne 1>
<!-- Pas de code d'etat "ok". Vérifier les autres codes d'etat pour traiter les erreurs. --->
</cfif>
3 Appelez l'action principal-list pour demander au serveur Breeze une liste des utilisateurs de Breeze. Le serveur renvoie la liste complète de tous les mandants, y compris ceux qui ne sont pas des utilisateurs. (Pour plus d'informations sur les mandants, consultez A propos des mandants, des entités SCO et des identifiants, page 14.
Le code ci-dessous appelle l'action principal-list. Notez que la valeur de cookie reçue à l'étape précédente est passée en paramètre HTTP.
<cfhttp url="/#baseurl#/api/xml?action=principal-list&accesskey=#" method="post">
<cfhtpparam type="Cookie" name="JSESSIONID" value="#loginCookie#" />
</cfhttp>
Remarque: Cette requête HTTP utilise la méthode "post" et non pas "get", car "post" représentée la seule méthode permettant de spécifiqueur paramètre HTTP en CFML. Toutefois, l'URL et les paramétres de la requête restent les mêmes que pour "get".
4 Pour vérifier que l'action s'est terminée correctement, analysez le code XML renvoyé et vérifie que la valeur de l'attribut code de la balise status est "ok". Il est conseillé de vérifier la balise status du code XML renvoyé après chaque action.
5 Si le code d'etat est "ok", recherche la liste des mandants qui a ete renvoyee, afin de trouver tous les mandants dont I'attribut type est user. L'exemple de code ci-dessous place la liste de tous les utilisateurs de Breeze dans le tableau allUsers.
6 Récupérez la liste de tous les utilisateurs figurant dans le service d'annuaire. La procédure exacte dépend du service d'annuaire utilisé.
7 Comparez les valeurs contenues dans la balise login des utilisateurs de Breeze aux adresses e-mail du service d'annuaire, en utilisant l'algorithmme de comparaison de listes de votrechioix. Determininez les utilisateurs qui figurent dans le service d'annuaire mais pas dans Breeze ; ces nouveaux utilisateurs doivent etre ajoutes a Breeze. Determininez ensuite les utilisateurs qui figurent dans Breeze , mais pas dans le service d'annuaire ; ces utilisateurs doivent etre supprimés de Breeze. Enfin, determininez les utilisateurs qui apparaissent a la fois dans Breeze et dans le service d'annuaire, mais sous des noms differents ; les noms de ces utilisateurs doivent etre changés dans Breeze.
8 Ajoutez dans Breeze tous les utilisateurs apparaissant dans le service d'annuaire mais pas dans Breeze, en procédant comme suit :
a Extrayez du service d'annuaire le prénom, le nom et l'identifant de connexion de chaque utilisateur.
Dans Breeze, l'identifant de connexion de l'utilisateur est généralement son adresse électronique.
b Appelez l'action principal-update en définissant le paramètre type comme user.
Ne spécifie pas de paramètre principal-id. L'absence de ce paramètre indique que vous n'actualisez pas un utilisateur existant, mais que vous ajoutez un nouvel utilisateur.
c Dans le code XML renvoyé, vérifie que le code d'etat est "ok".
L'exemple de code ci-dessous montre comment ajouter un utilisateur à Breeze. Il fait appel à des variables définies antérieurement, par exemple baseur1. Pour préserver la simplicité et la clarté de cet exemple, ce code spécifique les informations sur l'utilisateur dans les premières lignes, au lieu de les extraire d'un service d'annuaire.
</!--- Vérifier que le code d'etat est ok'. -->
9 Supprimez de Breeze chaque utiliser qui apparait dans Breeze mais pas dans le service d'annuaire. Pour ce faire, appelez l'action principals-delete en indiquant l'ID de cet utiliser. Dans le code XML renvoyé, vérifie que le code d'etat est "ok".
L'exemple de code ci-dessous montre comment supprimer un utilisateur ..
< ! - - - Vérifier la presence du code d'etat "ok".--->
10 Extrayez l'ID de chaque utiliser dont les informations dans Breeze doivent être actualisées :
a Examinez les données renvoyees par l'action principal-list dans les étapes 2 à 4, et recherche l'ID associé à l'identifant de connexion de l'utilisateur.
b Appelez l'action principal-info pour extraire les anciennes valeurs de prénom et de nom de l'utilisateur.
c Modifiez ces valeurs de façon appropriée pour qu'elles soient identiques à celles contenues dans le service d'annuaire.
d Appelez l'action principal-update.
e Dans le code XML renvoyé, vérifie que le code d'etat est "ok".
L'exemple de code ci-dessous ne comporte pas l'appoint de principal-update ni la vérification du code d'etat, puisque ces procédures ont été décrites ci-dessus.
<cfset principal=XmlSearch xmlPrincipalList,
"/principal[login='#login#']")>
<cfset principalId= principal[1].XmlAttributes["principal-id"]>
<cfhttp url="#baseurl#api/xml?
action=principal-info&accesskey=#accesskey#&principal-id=#principalId#"
"method="post"
<cfhtpparam type="Cookie" name="JSESSIONID" value="#loginCookie#"
</cfhttp>
...
<!-- Ajouter ici le code de vérification de la présence du code d'etat "ok".-->
<cfset xml=XmlParse(cfhttp.FileContent)
<cfset element=XmlSearch(xml, "results/contact/first-name")>
<cfset xmlns=firstElement[1].XmlText>
<cfset lastElement=XmlSearch(xml, "results/contact/last-name")>
<cfset lastName=lastElement[1].XmlText>
...
<!-- Ajouter ici le code attribuant de nouvelles valeurs de prénom et de nom, appeler principal-update, et vérifier la présence du code d'etat "ok".-->
ScENARIO : Intégration de Breeze à un portail
Supposons que vous administrrez une application portail, par exemple le portail de l'intranet de votre entreprise. Vous pouvez intégrer Breeze à ce portail pour permettre aux utilisateurs de voir et modifier les informations relatives à Breeze dans le contexte du portail. Cela permettra par exemple aux utilisateurs de voir les prochains réunions Breeze et de consulter la liste des cours auxquels ils sont inscrits.
Les procédures décrites dans cette section montrent commentaccomplir diverses tâches liées à l'intégration de Breeze à une application de portail.
Pour vous connecter sous une identité spécifique :
1 Utilisez un formulaire Web pour extraire l'identifant de connexion et le mot de passage de cet utiliser.
2 Appelez l'action login sur le serveur Breeze en utilisant l'identifiant de connexion et le mot de passée ainsi reçus.
3 Dans le code XML renvoyé, vérifie que le code d'etat est "ok".
Pour déterminer l'ID d'un utiliser à partir de son identifient de connexion et son mot de passer :
1 Connectez-vous avec son identifient.
2 Appelez l'action common-info.
3 Dans le code XML renvoyé, recherche la valeur de l'attribut user-id de la balise user. Cette valeur est l'ID de cet utiliser.
Pour vérifier qu'un mot de passer saisi est correct :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 Si le code d'etat renvoyé est "ok", le mot de passage est correct.
Cette procédure est la seule méthode permettant de vérifier un mot de passer ; pour des raisons de sécurité, Breeze ne permet pas de demander au serveur le mot de passer d'un utilisateur.
Pour obtenir la liste de tous les cours auxquels l'utilisateur s'est inscrit :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 Appelez l'action report-my-courses.
3 Analysez le code XML renvoyé et affichez les résultats. Pour plus d'informations sur le code XML renvoyé par le serveur, consultez la section my-courses.
Pour obtenir la liste de toutes les réunions auxquelles l'utilisateur doit participer :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 Appelez l'action report-my-meetings.
3 Analysez le code XML renvoyé et affichez les résultats. Pour plus d'informations sur le code XML renvoyé par le serveur, consultez la section my-meetings.
Pour afficher le dossier de contenu de cet utilisateur :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 Appelez l'action Sco-shortcuts.
Cette action permet d'obtenir l'emplacement du dossier racine du compte actuel, ainsi que l'emplacement des autres dossiers (réunions auxquelles doit participer cet utilisateur, etc.)
Le code ci-dessous utilise les mêmes variables baseurl, accesskey et loginCookie que le code d'ouverture de session indiqué dans la section Scénario : Intégration de Breeze à un service d'annuaire, page 19.
3 Dans les balises sco renvoyées, recherche l'attribut type approprié pour déterminer l'ID du dossier my-content.
<cfset response= cfhttp.FileContent>
<cfset xml= XmlParse(response)>
<cfset contentScoElement= XmlSearch(xml, "/sco [@type='my-content']")>
<cfset contentSco= contentScoElement[1].XmlAttributes["sco-id"]}
4 Si vous souhaitez fournir des liens (sous forme d'adresses URL absolues) vers les éléments de contenu, déterminez le nom du domaine du dossier.
5 Appelez l'action Sco-contents en lui transmettant l'ID SCO du dossier.
Cette action renvoie la liste du contenu du dossier indiqué.
6 Analysez le code XML renvoyé et affichez les informations appropriées.
| SCO ID | Type | Type |
|---|---|---|
| #item.XmlAttributes["sco-id"]# | #item.name.XmlText# | #item.XmlAttributes["type"]# |
7 Pourmettre à la disposition des utilisateurs des liens pointant directement sur des éléments de contenu,appelez l'action sco-info pour chaque element,et déterminezson adresse URL complète en insérant le contenu de la balise url-path renvoyée après le nom de Domaine que vous avez obtenu précédemment. Vous obtenez ainsi une adresse URL complète,par exemple http://breeze.exemple.com/p12345678/.
Pour plus d'informations sur l'activation d'un lien vers du contenu, consultez A propos de la sécurité et du lancement du contenu, page 18.
Pour creer une nouvelle réunion :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 (Facultatif) Vous pouvez permettre a l'utilisateur de besoin, dans une interface Web, le dossier dans lequel la nouvelle reunion doit etre createe. Si vous ne specifiez pas de dossier particulier, la reunion est creeee dans le dossier my-meetings (Mes reunions). Pour déterminer I'ID de ce dossier de reunion par defaut, appelez l'action sco-shortcuts.
3 Appelez l'action sc0-update en lui transmettant l'ID du dossier pour le parametre folder-id. Ne spécifie pas de parametre pour sc0-id.
4 Assurez-vous du bon résultat de l'action en vérifier le contenu de la balise status renvoyée.
Pour rechercher du contenu :
1 Utilisez un-formulaire Web pour extraire la chaine que l'utilisateur doit rechercher.
2 Connectez-vous avec l'identifant de cet utilisateur.
3 Appelez l'action sco-search, en lui passant la chaine spécifiée comme valeur du paramètre query.
4 Dans le code XML renvoyé, recherche les informations sur le SCO qui contiennent cette chaine; et affiche les informations utiles.
ScENARIO : génération de rapportes
Supposons que vous souhaitez que votre application puisse partager les détails de tous les cours auxquels un utilisateur est inscrit, ou identifier les utilisateurs inscrits à une réunion donnée. Les services Web XML de Breeze compte un grand nombre de rapportes affichant des données sur l'utilisation de Breeze.
Les données des rapportes sont renvoyées dans des formulaires XML. Vous pouvez utiliser directement les résultats, par exemple dans le cadre d'une application Web, ou convertir les données dans d'autres formats tels que des fichiers CSV (comma-separated-values).
Pour générer le rapport de formation d'un utilisateur sous forme de fichier CSV :
1 Connectez-vous avec l'identifant de cet utilisateur.
2 Déterminé l'ID d'un cours. Dans la plupart des cas, la démarche consiste à désenter une liste de cours (obtenue en appelant l'action sco-contents, qui renvoie également les ID des cours) dans l'interface de l'application, et à permettre à l'utilisateur d'en seLECTIONner un.
3 Appelez l'action report-course-takers.
Cette action renvoie une série de balises row dont chacune fournit des informations sur un utiliseur inscrit au cours.
4 Convertissez les données renvoyées en XML dans un fichier texte, en utilisant des virgules comme séparateurs de champs, et enregistrez ce fichier en CSV. L'approche la plus courante consiste à afficher le fichier CSV resultant dans le navigateur de l'utilisateur, ce qui permet à celui-ci d'enregistrer ces données sur son disque dur local.
Pour transformer le fichier en données séparées par des virgules, vous pouvez utiliser soit un langage interprétré sur le serveur comme CFML, soit un langage de conversion comme XSLT. Pour toutes informations sur XSLT, reportez-vous à la rubrique Ressources supplémentaires, page 8.
CHAPITRE 3
Guide de réference des actions
Ce chapitre est le guide de reférence de toutes les actions exposées dans l'API XML de Macromedia Breeze. Il indique les paramètres pouvant être passés à chaque action. Dans ce chapitre, les actions apparaissent en ordre alphétique.
Pour toutes informations sur les balises, données et codes d'etat XML renvoyés par le serveur Breeze, consultez le Chapitre 4, Récipes pour les résultatsats XML, page 61. Le Chapitre 2, Tâches courantes, page 19, présente des exemple de diverses tâches courantes faisant appel à des actions.
Tout appel d'une action doit composer des informations d'identification permettant de connaître l'auteur authentifié de l'action. Pour plus d'informations, consultez la section A propos de la sécurité, page 15.
Chaque action renvoie une balise résultats contenant une ou plusieurs autres balises, dont une balise d'etat (status). La section « Éléments renvoyés » de la documentation de chaque action n'indique que les autres éléments renvoyés ; les éléments résultats et status sont implicitement renvoyés.
Pour plus d'informations sur le passage de paramètres, consultez la section A propos des paramètres, page 13. Pour plus d'informations sur les mandants et les SCO, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14.
accesskey-exec
Description
Exécutedes fonctions spéciales associées à des clés d'accès spécifique.
Actuellement, la seule fonction spéciale prise en charge est celle qui permet aux utilisateurs de s'auto-inscrire à des réunions et à des cours. La documentation relative à cette action n'aborde donc que la fonction d'auto-inscription.
Pour appeler cette action, vous doivent disposer à la fois de la clé d'accès normale du compte et d'une clé d'accès spéciale associée à une réunion ou à un cours. Il est possible d'indiquer la clé d'accès spéciale à une personne qui n'est pas utilisatrice de Breeze. Cette personne peut ensuite, via une interface spécifique, s'inscrite à la réunion ou au cours, ce qui créé alors un nouvel utilisateur Breeze.
Pour obtenir la clé d'accès spécifique, appezelez l'action accesskey-info.
La différence entre accesskey-exec et principal-update pour creer un nouvel utiliser reside dans le fait qu'il est possible d'appeler accesskey-exec sans avoir ouvert une session et sans'être administrateur.
Paramètres
accesskey Clé d'accès du compte.
access-key Clé d'accès spéciale qui permet à l'utilisateur de s'inscrite de lui-même.
first-name Nouveau prénom de l'utilisateur.
has-children Ce paramètre doit toujours être mis à 0 pour l'inscription d'un nouvel utiliseur.
first-name Nouveau prénom de l'utilisateur.
login Nouvel identifant de connexion de l'utilisateur (qui est fréquement l'adresse de messagerie de cet utiliser).
password Nouveau mot de passer de l'utilisateur.
type Ce paramètre doit toujours être "user" pour l'inscription d'un nouvel utilisateur.
Éléments renvoyés
Aucun.
Exemple derésultat
<results>
<status code="ok" />
</results>
accesskey-info
Description
Permet d'obtenir une clé d'accès spécifique, si cette clé est associée au SCO spécifique.
Pour plus d'informations, consultez l'action accesskey-exec.
Pour connaître le groupe auquel l'utilisateur sera automatiquement ajoute lorsqu'il s'inscirra à l'aide de la clé d'accès spécifique, appezelez l'action principal-info avec la valeur renvoyée par accesskey-info pour parent-acl-id.
Paramètres
accesskey Clé d'accès du compte.
acl-id Identifiant d'un SCO.
Éléments renvoyés
access -keys
Exemple derésultat
<results>
<status code="ok" />
<access-key>
<access-key acl-id="622847" action="action-self-reg-meeting" parent-acl-id="503265">
<access-key>3hzvnifcfmphn3id</access-key>
<date-created>2004-03-05T10:28:14.750-08:00</date-created>
</access-key>
</access-key>
</results>
action-list
Description
Renvoie la liste de toutes les actions que vous pouvez appeler.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
actions
Exemple de résultat
<results>
<status code="ok" />
<actions>
<action>accesskey-exec</action>
<action>accesskey-info</action>
<action>action-list</action>
...
[la liste des autres actions figure ici]
...
<action>user-accounts</action>
<action>user-update-pwd</action>
</actions>
</results>
common-info
Description
Renvoie des informations de base sur l'utilisateur actuel et le serveur.
Si vous appelez common-info sans vous être identifié au préalable, ces mêmes informations sont renvoyées à l'exception de la balise user. De plus, la valeur de compte-id peut être différente.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
common
Exemple de résultat
<results>
<status code="ok" />
<common locale="en">
<cookie>breezm5qtgnye46zpckbf.MARIANNE</cookie>
<date>2004-02-12T15:53:19.797-07:00</date>
<host>http://admin.breeze.exemple.com</host>
<url>/api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info</url>
<version>breeze_402_r116</version>
<account account-id="222914" />
<user user-id="503562">
<login>gerweck@example.com</login>
</user>
</common>
</results>
</results>
group-membership-update
Description
Permet d'ajouter un ou plusieurs mandants (principals) à un groupe, ou de supprimer des mandants d'un groupe.
Pour actualiser plusieurs mandants et groupes, transmettez autant de groupes de trois paramètres group-id, principal-id et is-member que nécessaire. Pour plus d'informations, reportez-vous à la rubrique A propos des paramètres, page 13.
Paramètres
accesskey Clé d'accès du compte.
group-id Identifiant du groupe dont vous souhaitez actualiser l'appartenance.
principal-id Identifant du mandant dont vous souhaitez actualiser le statut d'appartenance.
is-member Indique si lemandant est membre du groupe.
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
login
Description
Connecte un utilisateur (ouverture de session) avec l'identifant de celui-ci.
Remarque : Àprous l'ouverture de session, vous devez dire et conserver le contenu du cookie JSESSIONID, qui figure dans les en-têtes HTTP du code XML résultat. Vous devez ensuite inclure la valeur de ce cookie dans toutes les requêtes transmises ultérieurement avec cet identificant. Pour plus d'informations, reportez-vous à la section A propos de la sécurité, page 15.
Paramètres
accesskey Clé d'accès du compte.
account-id Identifiant du compte associé à cet utilisateur. Ce paramètre est facultatif. Si vous organise ne dispose que d'un seul compte, ne spécifie pas le paramètre account-id.
login Identifant de connexion de l'utilisateur (qui est frequently l'adresse de messagerie de cet utiliser).
password Mot de passer de l'utilisateur.
Remarque : Si le paramètre login ou password est absent ou incorrect, le serveur Breeze renvoie le code d'etat "no-data".
Éléments renvoyés
Aucun.
Exemple derésultat
<results>
<status code="ok" />
</results>
logout
Description
Déconnecte un utilisateur (ferme la session), en invalidant le cookie reçu par l'application à l'ouverture de cette session.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
permissions-info
Description
Renvoie des informations sur les mandants et les autorisations dont ils disposent pour le SCO indiqué.
Pour plus d'informations sur les autorisations, consultez la section A propos des autorisations, page 16.
Paramètres
accesskey Clé d'accès du compte.
acl-id Identifiant d'un SCO spécifique.
Éléments renvoyés
permissions
Exemple de résultat
<results> <status code="ok" /> <permissions> <principal principal-id="181248" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Englesberg, Anne</name> <login>englesberg@example.com</login> </principal> <principal principal-id="181249" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Mauduit, Susanne</name> <login>mauduit@example.com</login> </principal> </permissions> </results>
permissions-reset
Description
Réinitialise les autorisations de tous les mandants pour le SCO indiqué. Les autorisations sur le parent de ce SCO s'appliquent alors à tous les mandants.
Pour plus d'informations sur les autorisations, consultez la section A propos des autorisations, page 16.
Paramètres
accesskey Clé d'accès du compte.
acl-id Identifiant d'un SCO.
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
permissions-update
Description
Actualise les autorisations d'un ou plusieurs mandants pour un ou plusieurs SCO.
Pour plus d'informations sur les mandants, consultez A propos des mandants, des entités SCO et des identifiants, page 14.
Pour plus d'informations sur les autorisations, consultez la section A propos des autorisations, page 16.
Pour actualiser les autorisations de plusieurs mandants, transmettez autant de groupes de trois paramètres acl-id, permission-id et principal-id que nécessaire. Pour plus d'informations, reportez-vous à la rubrique A propos des paramètres, page 13.
Paramètres
accesskey Clé d'accès du compte.
acl-id Identifiant d'un SCO.
permission-id Identifient d'une autorisation.
principal-id Identifiant d'unmandant (utilisateur ou groupe).
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
principal-info
Description
Renvoie des informations sur le mandant spécifique ; en particulier, fournit des informations sur un utilisateur défini.
Pour plus d'informations sur les mandants, consultez A propos des mandants, des entités SCO et des identifiants, page 14.
Paramètres
accesskey Clé d'accès du compte.
principal-id Identifiant d'unmandant spécifique.
Éléments renvoyés
principal
Exemple de résultat
<results>
<status code="ok" />
<principal account-id="222914" has-children="true" is-primary="true">
<principal-id="222926" type="course-admins">
<description>Groupe Gestionnaires de cours</description>
<login>Gestionnaires de cours</login>
<name>Gestionnaires de cours</name>
</principal>
</results>
Voir aussi
principal-list,principal-update
principal-list
Description
Renvoie la liste complète des utilisateurs et des groupes, y compris les groupes primaires.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
principal-list
Exemple de résultat
<results>
<status code="ok" />
<principal-list>
<principal principal-id="222917" type="administrs" has-children="true" is-primary="true" is-hidden="0">
<name>Administrateurs des comptes</name>
<login>Administrateurs des comptes</login>
<description>Groupe Administrateurs des comptes</description>
</principal>
<principal principal-id="503123" type="user" has-children="false" is-primary="false" is-hidden="0">
<name>Marchi, fabio</name>
<login>marchi@example.com</login>
<email>marchi@example.com</email>
</principal>
</principal-list>
</results>
principal-update
Description
Actualise les informations relatives à un mandant pour le compte actuel, ou créé un nouveau mandant. Pour plus d'informations sur les mandants, consultez A propos des mandants, des entités SCO et des identifiants, page 14.
Dans la plupart des cas, il est nécessaire d'obtenir la version originale des informations sur le mandant (à l'aide de l'action principal-info) avant d'appeler l'action principal-update.
Pour creer un nouveau mandant, appelez l'action principal-update sans spécifier le parametre principal-id. Si vous creez un nouveau mandant, le code XML renvoye contient les informations sur celui-ci, y compris son identifiant.
Paramètres
accesskey Clé d'accès du compte.
description Description du nouveau groupe. Utilisé uniquement lors de la création d'un nouveau groupe.
first-name Nouveau prénom à affecter à l'utilisateur. Utilisé uniquement lors de la création ou de l'actualisation d'un utiliser.
has-children Indique si le mandant possede des enfants. Si le mandant est un groupe, ce parametre doit etre mis a 1. Si le mandant est un utiliseur, ce parametre doit etre mis a 0.
last-name Nouveau nom à affecter à l'utilisateur. Utilisé uniquement lors de la création ou de l'actualisation d'un utiliser.
login Nouvel identifant de connexion du mandant (qui est frequentlyment l'adresse de messagerie associée à ce mandant).
name Nom du nouveau groupe. Utilisé uniquement lors de la création d'un nouveau groupe.
password Nouveau mot de passer de l'utilisateur. Utilisé uniquement lors de la création d'un nouvel utiliser.
principal-id Identifiant du mandant dont vous modifiez les données. Si vous ne précisez pas ce paramètre, l'action principal-update create un nouveau mandant.
type Type du nouveau mandant. Utilisé uniquement lors de la création d'un nouveau mandant. Pour plus d'informations sur les types disponibles, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14.
Éléments renvoyés
En cas d'actualisation d'un mandant existant, aucun.
En cas de création d'un nouveau mandant, renvoie principal (dans le même format que les éléments renvoyés pour principal-info).
Exemple derésultat
Exemples de résultats renvoyés lors de la création d'un nouveau mandant :
<results>
<status code="ok" />
<principal type="user" principal-id="2500848" has-children="0" account-id="181224">
<login>jacques@example.com</login>
<name>dupont, jacques</name>
</principal>
</results>
Voir aussi
principal-info, principal-update, principals-delete
principals-delete
Description
Supprime un ou plusieurs mandants.
Pour supprimer plusieurs mandants, transmettez plusieurs paramètres principal-id. Pour plus de détails, consultez la section A propos des paramètres, page 13.
Paramètres
accesskey Clé d'accès du compte.
principal-id Identifiant d'unmandant 出 supprimer.
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
Renvoie la liste des utilisateurs qui sont actuellement presentateurs de réunions.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifient d'une réunion; si ce paramètre est spécifique, le rapport renvoie des informations sur cette réunion uniquement. Ce paramètre est facultatif.
Éléments renvoyés
Renvoie la liste des réunions en cours.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
Indique la bande passante totale utilisé par le compte actif depuis sa création, en octets.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
report-bandwidth
Exemple de résultat
report-course-takers
Description
Renvoie la liste des utilisateurs inscrits au cours spécifique.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un cours.
Éléments renvoyés
report-quiz-takers
Exemple de résultat
<results> <status code="ok" /> <report-quiz-takers> <row transcript-id="" Sco-id="" principal-id="506299" status="score=" percentage-score="" time-taken="" certificate=""> <login> benedict@example.com</login> <principal-name>Benedict, Francis</principal-name> </row>
<row transcript-id="sco-id=" principal-id="508197" status="score=" percentage-score="time-taken=" certificate=">
<login>chiang@example.com</login>
<principal-name>Chiang, Louis</principal-name>
</row>
<row transcript-id="sco-id=" principal-id="550016" status="score=" percentage-score="time-taken=" certificate=">
<login>cantrell@example.com</login>
<principal-name>Cantrell, Thomas</principal-name>
</row>
</report-quiz-takers>
</results>
report-disk-usage
Description
Renvoie des informations sur l'espace disque utilisé par le contenu Breeze du compte actif, en octets. Tout le contenu et les archives sont inclus.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
report-disk-usage
Exemple de résultat
<results>
<status code="ok" />
<report-disk-usage total="849327881" />
</results>
report-meeting-attendance
Description
Renvoie la liste des utilisateurs ayant assisté à la réunion spécifique. Si la réunion n'a pas encore commencé, le tableau des données renvoyées ne contient pas de lignes.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
report-meeting-attendance
Exemple de résultat
<results>
<status code="ok" />
<report-meeting-attendance>
<row transcript-id="462409" Sco-id="505267" principal-id="181255" answered-survey="0">
<login>martin@example.com</login>
<spo-name>Ma réunion</spo-name>
<date-created>2004-01-29T00:59:15.490-08:00</date-created>
</root>
</footer>
</results>
<date-closed>2004-01-29T00:59:41.470-08:00</date-closed>
<participant-name>Martin, Patrick</participant-name>
</row>
</report-meeting-attendance>
</results>
Indique le nombre maximal d'utilisateurs pouvant participer simultanément à la réunion spécifique. Ce nombre maximal est déterminé par la licence du compte.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
Renvoie des informations sur une réunion, dont le nombre de participants et les dates et heures de début et de fin.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
report-meeting-session
Exemple de résultat
report-meeting-sessions
Description
Renvoie des informations sur toutes les sessions d'une réunion. Une nouvelle session débute chaque fois qu'une personne entre dans une salle de réunion vide. La session se termine lorsque le dernier participant quitte la réunion. Une nouvelle session débute si une personne entre à nouveau dans la salle de réunion désormais vide.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
report-meeting-sessions
Exemple derésultat
<results>
<status code="ok" />
<report-meeting-sessions>
<row sco-id="622852" num-participants="1" num-guests="0" num-polls="0">
<name>Ma réunion</name>
<date-begin>2004-03-05T10:33:09.030-08:00</date-begin>
<date-end>2004-03-05T10:54:09.030-08:00</date-end>
</row>
<row sco-id="622852" num-participants="1" num-guests="0" num-polls="0">
<name>Ma réunion</name>
<date-begin>2004-03-05T11:00:09.030-08:00</date-begin>
</row>
</report-meeting-sessions>
</results>
report-meeting-session-slots
Description
Renvoie des informations sur le nombre de participants à une réunion pour chaque période de 10 minutes.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
report-meeting-session-slots
Exemple de résultat
<results> <status code="ok" /> <report-meeting-session-slots> <row num-attendees="0"> <time-slot-begin>2004-02-14T06:30:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T06:40:00.000-08:00</time-slot-end> </row>
<row num-attendees="0">
<time-slot-begin>2004-02-14T06:40:00.000-08:00</time-slot-begin>
<time-slot-end>2004-02-14T06:50:00.000-08:00</time-slot-end>
</row>
<row num-attendees="0">
<time-slot-begin>2004-02-14T06:50:00.000-08:00</time-slot-begin>
<time-slot-end>2004-02-14T07:00:00.000-08:00</time-slot-end>
</row>
</report-meeting-session-slots>
</results>
report-meeting-summary
Description
Indique le nombre d'utilisateurs invites à la réunion spécifique et le nombre d'invités et d'hôtes qui y ont réellement assisté.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une réunion.
Éléments renvoyés
report-meeting-summary
Exemple de résultat
<results>
<status code="ok" />
<report-meeting-summary num-invitees="10" num-invitees-attended="5" num-guests-attended="1" />
</results>
report-my-courses
Description
Renvoie des informations sur chaque cours auquel l'utilisateur actuel est inscrit.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
my-courses
Exemple de résultat
<results>
<status code="ok" />
<my-courses>
<course sco-id="555038" status="active" type="course">
<name>Mon nom</name>
<url>admin.breeze.exemplc.com/p38547860</url>
<date-created>2004-02-09T14:40:38.497-08:00</date-created>
<date-modified>2004-02-09T14:40:44.623-08:00</date-modified>
<date-begin>2004-02-09T14:30:00.000-08:00</date-begin>
<date-end>2004-02-09T14:30:00.000-08:00</date-end>
<url-path>/p38547860</url-path> <expired>true</expired> </course> <course sco-id="565003" status="active" type="course"> <name>quiz 100</name> <url>admin.breeze.exemplc.com/p81997938</url> <date-created>2004-02-16T21:04:48.750-08:00</date-created> <date-modified>2004-02-16T21:33:17.560-08:00</date-modified> <date-begin>2004-02-16T21:00:00.000-08:00</date-begin> <url-path>/p81997938</url-path> <expired>false</expired> </course> </my-courses> </results>
report-my-meetings
Description
Renvoie des informations sur chaque réunion à laquelle l'utilisateur actuel est invité à participer.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
my-meetings
Exemple de résultat
<results>
<status code="ok" />
<my-meeting>
<meeting SCO-id="181487" type="meeting" status="active" permission-id="view" active-participants="0">
<name>morris shared</name>
<domain-name>admin.breeze.exemple.com</domain-name>
<url-path>/r99718924</url-path>
<date-begin>2003-07-14T23:00:00.000-07:00</date-begin>
<date-end>2003-07-15T09:00:00.000-07:00</date-end>
<expired>true</expired>
</meeting>
<meeting SCO-id="505659" type="meeting" status="active" permission-id="presenter" active-participants="0">
<nouveau chef de service</name>
<domain-name>admin.breeze.exemple.com</domain-name>
<url-path>/p50473388</url-path>
<date-begin>2004-01-29T05:30:00.000-08:00</date-begin>
<date-end>2004-01-29T05:30:00.000-08:00</date-end>
<expired>true</expired>
</meeting>
</my-meeting>
</results>
report-quiz-answer-distribution
Description
Indique le nombre d'utilisateurs qui ont choisi une reponse particulière à une question spécifique du questionnaire.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-answer-distribution
Exemple derésultat
<results>
<status code="ok" />
<report-quiz-answer-distribution>
<row question-number="1" question-id="257" a1="0" a2="0" a3="5" a4="3" total="8">
<body What is 2+2? </body>
</row>
<row question-number="2" question-id="258" a1="8" a2="0" a3="0" a4="0" total="8">
<body Quelle est la distance de la Terre au Soleil ? </body>
</row>
<row question-number="3" question-id="259" a1="8" a2="0" a3="0" a4="0" total="8">
<body Quel est le standard international qui définit ECMAScript ? </body>
</row>
</report-quiz-answer-distribution>
</results>
report-quiz-definition-answers
Description
Renvoie des informations sur chacune des réponses autorisées (à la fois correctes et incorrectes) pour le questionnaire spécifique.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
Renvoie des informations sur chaque question d'un questionnaire.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
Renvoie des informations sur toutes les interactions des utilisateurs avec le questionnaire spécifique. Une interaction est le besoin effectué par un utilisateur dans le questionnaire. Ce rapport produit donc des informations sur toutes les réponses que chaque utilisateur a choisi pour chaque question du questionnaire.
Dans les résultats renvoyés par cette action, l'attribut score indique la note reçue par le participant à cette question.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-interactions
Exemple de résultat
<results> <status code="ok" /> <report-quiz-interactions> <row transcript-id="459350" question-id="257" Sco-id="217706" score="20"> <date-created>2004-01-13T02:00:46.163-08:00</date-created> <question>Combien font 2+2?</question> </row> <row transcript-id="459350" question-id="258" sco-id="217706" score="0"> <date-created>2004-01-13T02:00:46.163-08:00</date-created> <question>Quelle est la distance de la Terre au Soleil ?</question> </row> <row transcript-id="459350" question-id="259" sco-id="217706" score="20"> <date-created>2004-01-13T02:00:46.163-08:00</date-created> <question>Quel est le standard international qui définit ECMAScript ?</ question> </row> <row transcript-id="893541" question-id="259" sco-id="217706" score="20">
<date-created>2004-01-13T02:00:46.163-08:00</date-created>
<question>Quel est le standard international qui définit ECMAScript ?
question>
</row>
</report-quiz-interactions>
</results>
report-quiz-question-answer-distribution
Description
Indique le nombre d'utilisateurs qui ont choisi une reponse particulière à une question spécifique du questionnaire.
Utilisez les actions report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l'identifant d'une question (cet identifient sera passé comme paramètre à l'action question-id).
Remarque : Les identifiants des questions ne correspondant pas nécessairement aux numérose affectés aux questions dans un questionnaire.
Paramètres
accesskey Clé d'accès du compte.
question-id Identifiant d'une question spécifique du questionnaire.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-question-answer-distribution
Exemple derésultat
<results> <status code="ok" /> <report-quiz-question-answer-distribution> <row question-id="259" answer-id="1" correct="0" total-responses="1" percentage-responed="10"> <question-text>Quel est le standard international qui définit ECMAScript ?</question-text> <answer-text>ISO-9000</answer-text> </row> <row question-id="259" answer-id="2" correct="0" total-responses="3" percentage-responed="30"> <question-text>Quel est le standard international qui définit ECMAScript ?</question-text> <answer-text>RFC 821</answer-text> </row> <row question-id="259" answer-id="3" correct="0" total-responses="2" percentage-responed="20"> <question-text>Quel est le standard international qui définit ECMAScript ?</question-text> <answer-text>ECMA-976</answer-text> </row> <row question-id="259" answer-id="4" correct="1" total-responses="4" percentage-responed="40"> <question-text>Quel est le standard international qui définit ECMAScript ?</question-text> <answer-text>ECMA-262</answer-text> </row>
</report-quiz-question-answer-distribution>
</results>
report-quiz-question-distribution
Description
Indique le nombre d'utilisateurs ayant repondu correctement à chaque question du questionnaire spécifique.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-question-distribution
Exemple derésultat
<results> <status code="ok" /> <report-quiz-question-distribution> <row question-id="257" question-number="1" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> </body>Combien font 2+2?</body> </row> <row question-id="258" question-number="2" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> </body>Quelle est la distance de la Terre au Soleil ?</body> </row> <row question-id="259" question-number="3" num-correct="4" num-incorrect="6" percentage-correct="40" score="20"> </body>Quel est le standard international qui definit ECMAScript ?</ body> </row> </report-quiz-question-distribution> </results>
report-quiz-question-response
Description
Renvoie la liste de toutes les réponses choisis par des utilisateurs à une question particulière.
Utilisez les actions report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l'identifant d'une question (cet identifient sera passé comme paramètre à l'action question-id).
Remarque : Les identifiants des questions ne correspondant pas nécessairement aux numéroes affectés aux questions dans un questionnaire.
Paramètres
accesskey Clé d'accès du compte.
question-id Identifiant d'une question spécifique du questionnaire.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-question-response
Exemple de résultat
<results> <status code="ok" /> <report-quiz-question-response> <row principal-id="506299" question-id="257" answer-id="2"> <body>Combien font 2+2 ?</body> <answer-text>5</answer-text> </row> <row principal-id="557527" question-id="257" answer-id="2"> <body>Combien font 2+2 ?</body> <answer-text>5</answer-text> </row> <row principal-id="181255" question-id="257" answer-id="3"> <body>Combien font 2+2 ?</body> <answer-text>4</answer-text> </row> </report-quiz-question-response> </results>
report-quiz-question-totals
Description
Indique le nombre total d'utiliseurs qui ont repondu à la question spécifiée et le nombre d'utilisateurs qui y ont repondu correctement.
Utilisez les actions report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l'identifant d'une question (cet identifient sera passé comme paramètre à l'action question-id).
Remarque : Les identifiants des questions ne correspondant pas nécessairement aux numéroes affectés aux questions dans un questionnaire.
Paramètres
accesskey Clé d'accès du compte.
question-id Identifiant d'une question spécifique du questionnaire.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-question-totals
Exemple derésultat
<results> <status code="ok" /> <report-quiz-question-totals question-id="260" total-responses="8" num-correct-answers="5" /> </results>
report-quiz-summary
Description
Renvoie des informations sur les résultats d'un questionnaire.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifient d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-results, report-quiz-summary
Exemple de résultat
<results> <status code="ok" /> <report-quiz-results average-score="95" low-score="90" high-score="100" numtaken="8" numdistincttaken="1" /> <report-quiz-summary sco-id="217706" numquestions="5" maxpossiblescore="100" passingscore="50" /> </results>
report-quiz-takers
Description
Renvoie des informations sur toutes les personnes ayant repondu à un questionnaire particulier.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation contenant un questionnaire.
Éléments renvoyés
report-quiz-takers
Exemple de résultat
<results>
<status code="ok" />
<report-quiz-takers>
<row transcript-id="586821" Sco-id="586760" principal-id="506385"
status="not-attempted" score="0" percentage-score="0" time-taken=""
certificate="">
<name>Test de maths</name>
<login>benedict@example.com</login>
<date-taken>2004-02-27T10:53:05.013-08:00</date-taken>
<principal-name>Benedict, Francis</principal-name>
</row>
<row transcript-id="586837" Sco-id="586760" principal-id="557527"
status="user-failed" score="10" percentage-score="25"
time-taken="51796" certificate="">
<name>Test de maths</name>
<login>benedict2@example.com</login>
<date-taken>2004-02-27T10:58:36.373-08:00</date-taken>
<principal-name>Benedict, Georges</principal-name>
</row>
</results>
<row transcript-id="587485" sco-id="586760" principal-id="181255" status="user-passed" score="30" percentage-score="75" time-taken="37856" certificate="587485"> <name>Test de maths</name> <login>martin@example.com</login> <date-taken>2004-02-27T14:30:02.107-08:00</date-taken> <principal-name>Martin, Patrick</principal-name> </row> </report-quiz-takers> </results>
report-sco-slides
Description
Indique le nombre de fois que chaque diapositive d'une presentation a ete visionnnee, et la date du dernier affichage.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation.
Éléments renvoyés
report-sco-slides
Exemple de résultat
Indique le nombre de fois que la presentation spécifiée a été visionnée, et la date du dernier affichage.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'une presentation.
Éléments renvoyés
report-sco-views
Exemple de résultat
<results>
<status code="ok" />
<report-sco-views>
<row sco-id="217706" type="presentation" is folder="0" views="24">
<name>Test 1</name>
<last-viewed-date>2004-01-13T17:11:47.923-08:00</last-viewed-date>
</row>
</report-sco-views>
</results>
Indique le plus grand nombre d'utilisateurs ayant utilisé le système en même temps.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
Provoque la compilation du SCO spécifique par le serveur Breeze. Un SCO est invisible tant qu'il n'a pas ete compile. Appelez cette action après avoir transfere un SCO a l'aide de I'action scoupload.
Si vous transférez une nouvelle version d'un SCO existant, vous devez le recompiler en appelant l'action SCO-build. Tant que ce ne sera pas fait, les utilisateurs continuont à voir l'ancienne version de ce SCO.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un SCO à compiler.
Éléments renvoyés
Aucun.
Exemple de résultat
Voir aussi
sco-upload
sco-contents
Description
Renvoie la liste des SCO du dossier spécifique.
Dans la mesure où les dossiers sont eux-memes des SCO,la liste renvoyee comprehend les dossiers contenus dans le dossier spécifique, mais cette liste ne comprend pas le contenu de ces sous-dossiers.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un dossier.
Éléments renvoyés
SCOS
Exemple de résultat
<results>
<status code="ok" />
<sco>
<sco-sco-id="505677" status="no-content" type="folder" is folder="1">
<name>tests réunion PPT</name>
<date-modified>2004-01-29T06:22:49.157-08:00</date-modified>
</sco>
<sco-sco-id="193496" status="active" type="meeting" is folder="0">
<name>Mon nom</name>
<date-begin>2003-08-27T00:00:00.000-07:00</date-begin>
<date-end>2003-08-27T01:00:00.000-07:00</date-end>
<date-modified>2003-08-26T23:33:20.300-07:00</date-modified>
<duration>1900-01-02T/+:00:00.000+00:00</duration>
</sco>
<sco-sco-id="505323" status="active" type="meeting" is folder="0">
<name>Mon nom 2</name>
<date-begin>2004-01-29T01:30:00.000-08:00</date-begin>
<date-end>2004-01-29T01:30:00.000-08:00</date-end>
<date-modified>2004-01-29T01:35:26.433-08:00</date-modified>
<duration>1900-01-02T/*:00:00.000+00:00</duration>
</sco>
</scos>
</results>
sco-delete
Description
Supprime un ou plusieurs SCO.
Pour supprimer plusieurs SCO, transmettez plusieurs paramètres sc0-id. Pour plus d'informations, consultez la section A propos des paramètres, page 13.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un SCO.
Éléments renvoyés
Aucun.
Exemple derésultat
<results>
<status code="ok" />
</results>
sco-info
Description
Renvoie des informations sur un SCO. Pour toutes informations sur les SCO, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un SCO.
Éléments renvoyés
Les balises renvoyées dépendent du type de SCO de l'élement indiqué.
Voici les principales balises susceptibles d'être renvoyées :
Les exemples de résultat suivants concernent un SCO de type Réunion :
<results> <status code="ok" /> <sco author-contact-id="123200" folder-id="181412" host-id="" learning-time="0" sco-data-id="95654" sco-id="201894" source-sco-id="" status="active" tree-id="181227" type="swf"> <date-created>2004-01-26T20:47:05.653-07:00</date-created> <date-modified>2004-01-27T22:21:14.557-07:00</date-modified> <name>Ma réunion</name> <url-path>/p53917999</url-path>
</sco> <sco-author> <email>martin@example.com</email> <first-name>Paul</first-name> <last-name>Martin</last-name> </sco-author> <sco-data byte-count="3993" height="252" length=-1" Sco-data-id="95654" slide-count=-1" version="1" width="380"> <date-created>2004-01-26T20:47:05.653-07:00</date-created> <date-modified>2004-01-26T20:47:05.653-07:00</date-modified> <physical-path>222914/503227</physical-path> </sco-data> <source-sco /> </results>
sco-move
Description
Déplace un SCO d'un dossier à un autre.
Paramètres
accesskey Clé d'accès du compte.
folder-id Identifiant du dossier de destination.
sco-id Identifiant du SCO à déplacer.
Éléments renvoyés
status
Exemple derésultat
<results>
<status code="ok" />
</results>
sco-nav
Description
Décrit la hierarchie de dossiers contenant le SCO spécifique.
Dans les résultats renvoyés, l'attribut depth de la balise sc0 indique le nombre de niveaux qui séparent le dossier du SCO spécifique dans la hierarchie. En d'autres termes, un attribut depth égal à 0 indique le SCO lui-même, un attribut depth égal à 1 indique le dossier qui contient le SCO, etc.
Paramètres
accesskey Clé d'accès du compte.
sco-id Identifiant d'un SCO.
Éléments renvoyés
sco-nav
Exemple de résultat
<results> <status code="ok" /> <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>Réunions utiliserasseurs</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>martin@example.com</name> </sco> <sco sco-id="503545" tree-id="181230" type="meeting" depth="0"> <name>cré avec 402</name> </sco> </sco-nav> </results>
sco-search
Description
Renvoie la liste de tous les SCO correspondant au texte de recherche.
Le titre et le résumé de chaque type de SCO sont analysés. Le contenu des presentations et des autres SCO contenant du texte est également analysé.
Paramètres
accesskey Clé d'accès du compte.
query Chaine a recherche.
Éléments renvoyés
sco-search-info
Exemple derésultat
<results>
<status code="ok" />
<sco-search-info>
<sco sco-id="202014" folder-id="202008" type="presentation" slide-count="4" length="20000">
<name>Questionnaire 1</name>
<url-path>/p92628681</url-path>
<date-created>2003-11-26T22:52:28.973-08:00</date-created>
<date-modified>2003-11-26T22:52:37.867-08:00</date-modified>
<first-name>Michel</first-name>
<last-name>Durand</last-name>
<hit>1</hit>
<hit>4</hit>
</sco>
<sco sco-id="202015" folder-id="202008" type="presentation" slide-count="7" length="35000">
<name>Autres questionnaires incomplets</name>
<url-path>/p49954414</url-path>
<date-created>2003-11-26T23:02:52.870-08:00</date-created>
<date-modified>2003-11-26T23:03:23.313-08:00</date-modified>
<first-name>Michel</first-name>
<last-name>Durand</last-name>
<hit>1</hit>
<hit>4</hit>
</sco-sco-id="202015" folder-id="202008" type="presentation"
<sco sco-id="202015" folder-id="202008" type="presentation"
slide-count="7" length="35000">
<name>Autres questionnaires incomplets</name>
<url-path>/p49954414</url-path>
<date-created>2003-11-26T23:02:52.870-08:00</date-created>
<date-modified>2003-11-26T23:02:33.313-08:00</date-modified>
<first-name>Michel</first-name>
<last-name>Durand</last-name>
<hit>1</hit>
<hit>4</hit>
</sco-sco-id="202015" folder-id="202008" type="presentation"
<sco sco-id="202015" folder-id="202007" type="presentation"
slide-count="7" length="35007">
<name>Autres questionnaires incomplets</name>
<url-path>/p49954414</url-path>
<date-created>2003-11-26T23:02:52.870-08:00</date-created>
<date-modified>2003-11-26T23:03:23.313-08：00</date-modified>
<first-name>Michel</first-name>
<last-name>Durand</last-name>
<hit>1</hit>
<hit>4</hit>
hit>5</hit> <hit>7</hit> </sco> </sco-search-info> </results>
sco-shortcuts
Description
Renvoie les identifiants d'un ensemble de dossiers dont le contenu concerne l'utilisateur actuel : le dossier dans lequel sont enregistrées les réunions de l'utilisateur, le dossier dans lequel il place son contenu, etc.
Pour déterminer l'adresse URL d'un SCO, concaténez le nom de Domaine renvoyé par cette action avec l'adresse URL renvoyée par l'action Sco-info dans la balise url-path.
Paramètres
accesskey Clé d'accès du compte.
Éléments renvoyés
shortcuts
Exemple derésultat
<results> <status code="ok" /> <shortcuts> <sco tree-id="181230" SCO-id="181576" type="my-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181227" SCO-id="181412" type="my-content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181225" SCO-id="181225" type="content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181226" SCO-id="181226" type="courses"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181227" SCO-id="181227" type="user-content"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181228" SCO-id="181228" type="meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> <sco tree-id="181230" SCO-id="181230" type="user-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> </shortcuts> </results>
Voir aussi
sco-info
sco-update
Description
Si cette action est appelée avec une valeur pour le paramètre sc0-id, elle modifie le type du SCO.
Si cette action est appelée avec une valeur pour le paramètre folder-id, elle cree un nouveau SCO. Si vous creeez un nouveau SCO, le code XML renvoye contient les informations sur celui-ci, y compris son identifiant.
Un seul des deux paramètres suivants doit être indiqué : folder-id ou sco-id.
Après avoir appelé cette action, vous devez aeppler l'action permissions-update pour attribuer les autorisations. Pour plus d'informations sur les autorisations, consultez la section A propos de la sécurité, page 15.
Paramètres
accesskey Clé d'accès du compte.
date-begin Date et heures de début prévues. (Utilisé uniquement pour les réunions et les cours.)
Date-end Date et heures de fin prévues. (Utilisé uniquement pour les réunions et les cours.)
description Description du SCO, à l'intention des utilisateurs.
email Adresse e-mail de la personne à contacter pour ce SCO. (Utilisé uniquement pour les presentations.)
first-name Prénom de la personne à contacter pour ce SCO. (Utilisé uniquement pour les représentations.)
folder-id Identifient du dossier dans lequel le serveur creera le nouveau SCO. Ce paramètre est facultatif et ne peut pas etre spécifie avec sco-id.
last-name Nom de la personne à contacter pour ce SCO. (Utilisé uniquement pour les représentations.)
name Nom du SCO.
sco-id Identifient d'un SCO à actualiser. Ce paramètre est facultatif et ne peut pas être spécifique avec folder-id.
sco-tag Libellé d'un SCO. Ce paramètre peut conténir des données arbitraires. Par exemple, pour un cours sur les notions de base de l'économie, vous pouvez indiquer « Notions de base » comme valeur du paramètre sc0-tag. (Utilisé uniquement pour les cours.)
source-sco-id Identifiant du contenu du SCO. (Utilise uniquement pour les cours.)
type Type du nouveau SCO. Pour plus d'informations sur les types, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14.
Éléments renvoyés
En cas d'actualisation d'un SCO existant, aucun.
En cas de creation d'un SCO, sco.
Exemple de résultat
Exemples de résultats renvoyés lors de la création d'un nouveau SCO :
<results>
<status code="ok" />
<sco folder-id="181412" type="folder" Sco-id="2501961" status="active">
author-contact-id="2501962" tree-id="181227" sco-data-id="2501963">
<url-path>/p54135747</url-path>
<name>Contact SC0</name>
</sco>
</results>
sco-upload
Description
Transfere un fichier sur le serveur Breeze.
Les paramètres de cette action doivent être transmis sous la forme MIME multipartie (multipart/form-data media type). Pour creer ces paramètres, le plus simple consiste à utiliser un contrôle de formulaire du type "file" dans un formulaire de page Web.
Après avoir transféré un fichier, appelez l'action Sco-build pour le compiler.
Paramètres
accesskey Clé d'accès du compte.
file Fichier à transférer. Ce paramètre doit contenir les vraies données du fichier, pas simplement son nom de fichier ou son chemin d'accès.
sco-id Identifient du nouveau SCO. Le type de ce SCO doit avoir eté défini auparavant, par exemple à l'aide de l'action sco-update.
summary Bref résumé des informations générales sur le SCO. Ce résumé, qui apparait dans les listes de contenu, est renvoyé par l'action sco-info. Ce paramètre est facultatif.
title Titre du nouveau SCO.
Éléments renvoyés
Aucun.
Exemple derésultat
Voir aussi
sco-build
user-accounts
Description
Renvoie la liste des comptes auxquels appartient l'utilisateur spécifique.
Dans un système Breeze d'entreprise (non hébergé), il n'existe en général qu'un seul compte, auquel cas il est peu probable que vous ayez besoin d'utiliser cette action.
Paramètres
accesskey Clé d'accès du compte.
login Identifant de connexion de l'utilisateur (qui est frequently l'adresse de messagerie de cet utiliser).
password Mot de passer de l'utilisateur.
Éléments renvoyés
users
Exemple de résultat
<results>
<status code="ok" />
<users>
<user user-id="211729" account-id="211655">
<name>martine@example.com</name>
<date-expired>2004-01-24T00:59:59.000-07:00</date-expired>
</user>
<user user-id="212988" account-id="212928">
<name>julien@example.com</name>
<date-expired>2004-01-24T00:59:59.000-07:00</date-expired>
</user>
<user user-id="214251" account-id="214191">
<name>fabrice@example.com</name>
<date-expired>2004-01-24T00:59:59.000-07:00</date-expired>
</user>
</users>
</results>
user-update-pwd
Description
Modifie le mot de passer d'un utiliser.
Paramètres
accesskey Clé d'accès du compte.
password Nouveau mot de passer.
password-old Mot de passer actuel de l'utilisateur.
password-verify Second exemplaire du nouveau mot de passer pour vérification.
user-id Identifiant de l'utilisateur.
Éléments renvoyés
Aucun.
Exemple de résultat
<results>
<status code="ok" />
</results>
CHAPITRE 4
Références pour les résultats XML
Leprésent chapitre décrit les balises XML, les données et les codes d'etat renvoyés par le serveur Macromedia Breeze en response à une action. Pour plus de détails sur les actions pouvant être appelées sur le serveur, consultez la section Chapitre 3, Guide de référence des actions, page 27.
A propos du code XML renvoyé
Lorsque you appelez une action sur le serveur Breeze, ce dernier renvoie un bloc de code XML.
La balise parente du code XML est toujours une balise résultats. La balise résultats contient une balise status, qui indique si l'action s'est terminée avec succès. Dans la plupart des cas, si l'action s'est terminée avec succès, la balise résultats contient également d'autres balises qui regroupent les données renvoyées par l'action.
Par exemple, une action common- info peut renvoyer les résultats suivants :
<resulttats>
<status code="ok" />
<common locale="fr">
<cookie> breezezm5qtgnye46zpckbf.MARIANNE</cookie>
<date>2004-02-12T15:53:19.797-07:00</date>
<host>http://admin.breeze.exemple.com</host>
<url>/api/xml?accesskey=yyyyyyyyyyyyyyyy&action=common-info</url>
<version> breeze_402_r116</version>
<account account-id="222914" />
<user user-id="503562">
<login>dupont@example.com</login>
</user>
</common>
</results>
Le present chapitre presente les balises par ordre alphabetique ; chaque balise dispose de sa propre section.
Pour plus de détails sur les valeurs possibles de la balise « status», voir la section status.
Pour plus de détails sur les balises renvoyées pour une action données, consultez la documentation correspondant à cette action dans le Chapitre 3, Guide de référence des actions, page 27.
En l'absence de données pour une balise devant normalement être renvoyée en réponse à une action, cette balise n'est pas renvoyée. Dans l'exemple précédent, si l'application d'appeil n'a pas spécifique d'utilisateur connecté, les résultats renvoyés ne contiennent pas de balise user.
Lorsque votre application Web reçoit le code XML renvoyé, elle l'analyse pour identifier les valeurs renvoyées. Pour consulter des exemples, reportez-vous au Chapitre 2, Tâches courantes, page 19.
access-key (conteneur)
Il existe deux balises access-key qui sont décrites dans des sections différentes.
Description
Contient des informations sur une clé d'accès spéciale fournie par une entité SCO.
Attributes
acl-id L'identifant de l'entité SCO associée à la clé d'accès.
action Indique le type d'auto-inscription devant ettre applique par l'utilisateur. Les valeurs possibles sont "action-self-reg-meeting" et "action-self-reg-course".
Balises continues
Il existe deux balises access-key qui sont décrites dans des sections différentes.
Description
Contient une clé d'accès spéciale à utiliser pour l'auto-inscription.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
accesskey-info
Example
Voir aussi
Balise conteneur ; contient une ou plusieurs clés d'accès.
Attributes
Aucun.
Balises continues
access-key (conteneur)
Renvoyees par
accesskey-info
Example
<access-key> <access-key acl-id="619605" action="1" parent-acl-id="619605"> <access-key>vb7gmg6ohtz4y7k6</access-key> <date-created>2004-03-05T00:30:38.483-08:00</date-created> </access-key> </access-key>
account
Description
Contient l'identifant du compte.
Attributes
account-id L'identifant du compte.
Balises continues
Aucune. (Balise vide.)
Renvoyees par
common-info
Example
action
Description
Contient le nom d'une action.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
action-list
Example
actions
Description
Balise conteneur ; contient une liste d'actions.
Attributes
Aucun.
Balises contenues
action
Renvoyées par
action-list
Example
<actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action> .. [la liste des autres actions figure ici] .. <action>user-accounts</action> <action>user-update-pwd</action> </actions>
answer-text
Description
Cette balise est incluse dans les résultats renvoyés par une action de type report, contient le texte d'une réponse à un questionnaire.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-quiz-answer-distribution, report-quiz-question-response
Example
body
Description
Contient le texte de l'objet renvoyé, tel que le texte d'une réponse dans un rapport incluant un questionnaire.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-quiz-answer-distribution, report-quiz-definition-answers, report-quiz-definition-questions, report-quiz-question-distribution, report-quiz-question-response
Example
Combien font 2+2 ?
common
Description
Balise conteneur ; contient des balises qui fournissant des informations sur le serveur et l'utilisateur connecté.
Si vous appelez common-info avant d'étalir une connexion, les mêmes informations sont renvoyées, sauf pour la balise user.
Attributes
locale Indique la zone géographique de l'utilisateur connecté.
Balises continues
Contient la valeur du cookie de session du servlet Java, appelé JSESSIONID.
Il s'agit du cookie accompagnant tout appel d'action pour identifier l'utilisateur d'origine. Si vous appelez common-info avant de vous connecter, le serveur renvoie un nouveau cookie.
Vouavesbeinsodece cookielorsque,parexample,vouscriezune nouvellefenetre de navigateur ou lancez un SCO.Selon l'implémentation du systeme externe,ilpeutetreplus pratique d'acqérirlecookiea partirdu serveurà l'aidedecommon-info que delaisser cette couche de code déterminer le cookiea envoyer lorsd'un appeld'action.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
common-info
Example
course
Description
Contient des informations sur un cours.
Attributes
sco-id L'identifant du cours.
status Indique si le cours est actif. Les valeurs possibles sont "no-content", qui indiquent que le cours vient d'être créé et ne compteaucun contenu, et"active".
type Indique que cette entité SCO est un cours. La valeur est toujours "course".
Balises continues
date-begin, date-created, date-end, date-modified, expired, name, url, url-path
Renvoyees par
report-my-courses
Example
<course sco-id="555038" status="active" type="course">
<name>Mon nom</name>
<url>admin.breeze.example.com/p38547860</url>
<date-created>2004-02-09T14:40:38.497-08:00</date-created>
<date-modified>2004-02-09T14:40:44.623-08:00</date-modified>
<date-begin>2004-02-09T14:30:00.000-08:00</date-begin>
<date-end>2004-02-09T14:30:00.000-08:00</date-end>
<url-path>/p38547860</url-path>
<expired>true</expired>
</course>
date
Description
Renvoie la date et l'heure du serveur au format ISO 8601.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyées par
common-info
Example
date-begin
Description
Contient la date et l'heure prévues de lancement de l'entité SCO, au format de date ISO 8601.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
Indique l'heure à laquelle l'utilisateur a fermé la fenêtre de la réunion, ce qui confirme qu'il a quitté la réunion.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-attendance
Example
date-created
Description
Contient la date et l'heure de création d'une entité SCO, au format de date ISO 8601.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
Contient la date et l'heure prévues de fin prévue de l'entité SCO, au format de date ISO 8601.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-session, report-my-courses, report-my-meetings, sco-contents
Example
date-expired
Description
Contient la date d'expiration prévue de l'entité SCO, au format de date ISO 8601.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
user-accounts
Example
date-modified
Description
Indique la dernière date de modification de quelques choses, au format de date ISO 8601.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
Indique la date à laquelle un utiliser a répondu à un questionnaire.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-quiz-takers
Example
<date-taken>2004-01-13T01:33:49.460-08:00</date-taken>
description
Description
Contient la description d'une entité principale.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
principal-info,principal-list
Example
<description>Groupe d'administrateurs de compte</description>
domain-name
Description
Contient le nom de Domaine de l'emplacement de l'entité SCO avec tous ses qualificatifs.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-my-meetings, sco-shortcuts
Example
duration
Description
La durée d'une entité SCO.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
sco-contents
Example
Description
Contient l'adresse e-mail d'un utilisateur.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
Indique si une entité SCO a expiré.
Une entité SCO expire lorsque sa date de fin est atteinte et que cette entité n'est plus disponible.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-my-courses, report-my-meetings
Example
first-name
Description
Contient le prénom d'un utilisateur.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
Indique qu'une diapositive donnée contient les termes recherchés.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
sco-search
Example
hit>5
host
Description
Contient l'URL de l'hote du serveur Breeze.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
common-info
Example
invalid
Description
Explique pourquoit l'appeil à une action n'est pas valide.
Cet élément s'affiche uniquement dans une balise status et uniquement lorsque l'attribut code de cette balise est défini sur "invalid".
Le serveur renvoie uniquement une balise invalid pour une requête donnée, même s'il manque plusieurs paramétres. Pour résoudre les erreurs liées aux paramétres manquants, ajoutez les paramétres requis à l'action. Pour déterminer les paramétres requis, consultez le document de reférence de l'action concernée dans le Chapitre 3, Guide de référence des actions, page 27.
Attributes
field Le nom du paramètre non valide.
subcode La raison pour laquelle le paramètre n'était pas valide. Vous trouvez ci-dessous les valeurs possibles de cet attribut :
duplicat L'appea tente d'ajouter un element dupliquedans un contexte imposant des elements uniques.
format Le format de l'un des paramètres passés n'est pas correct.
illegal-operation L'opération requise ne respecte pas les règles d'intégrité (par exemple, le déplacement d'un dossier sur lui-même est une operation non valide).
missing Un paramètre requisite est manquant.
no-such-item Les informations requises n'existent pas.
range La valeur est en dehors de la plage authorisée.
type Le type de paramètre, tel que "id", "long" ou "string".
Balises continues
Aucune. (Balise vide.)
Renvoyees par
Toute action non valide.
Example
last-name
Description
Contient le nom d'un utiliser.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
Indique la date et l'heure du dernier affichage de l'identité SCO.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-sco-views
Example
last-viewed
Description
Indique la date et l'heure du dernier affichage de l'entité SCO.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-sco-slides
Example
login
Description
Indique le nom de connexion de l'utilisateur, qui correspond généralement à son adresse électronique.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
common-info, permissions-info, principal-info, principal-list, report-course-takers, report-meeting-attendance, report-quiz-takers
Example
meeting
Description
Contient des informations sur une réunion.
Attributes
active-participants Le nombre actuel de participants.
permission-id Les autorisations de l'utilisateur dans le cadre de la réunion. Pour plus d'informations, consultez la section A propos de la sécurité, page 15.
sco-id L'identifant de la réunion.
status Indique l'etat de la réunion. Les valeurs possibles sont "no-content", qui indique que la réunion vient d'être créée, mais n'a pas encore reçu de contenu ou "in-progress", qui désigne une réunion en cours et "active".
type Indique que cette entité SCO est une réunion. La valeur est toujours "meeting".
Balises continues
date-begin, date-end, domain-name, expired, name, url-path
Renvoyees par
report-my-meetings
Example
<meeting sco-id="181487" type="meeting" status="active" permission-id="view" length="36000000" active-participants="0"> <name>morris shared</name> <domain-name>admin.breeze.example.com</domain-name> <url-path>/r99718924</url-path> <date-begin>2003-07-14T23:00:00.000-07:00</date-begin> <date-end>2003-07-15T09:00:00.000-07:00</date-end> <expired>true</expired> </meeting>
my-courses
Description
Balise contèneur ; contient des informations sur un ou plusieurs cours.
Attributes
Aucun.
Balises continues
course
Renvoyees par
report-my-courses
Example
<my-courses> <course sco-id="555038" status="active" type="course"> <name>Mon nom</name> <url>admin.breeze.exemplc.com/p38547860.</url> <date-created>2004-02-09T14:40:38.497-08:00</date-created> <date-modified>2004-02-09T14:40:44.623-08:00</date-modified> <date-begin>2004-02-09T14:30:00.000-08:00</date-begin> <date-end>2004-02-09T14:30:00.000-08:00</date-end> <url-path>/p38547860.</url-path> <expired>true</expired> </course> </my-courses>
my-meetings
Description
Balise conteneur ; contient des informations sur une ou plusieurs réunions.
Attributes
Aucun.
Balises continues
meeting
Renvoyees par
report-my-meetings
Example
<my-meetings>
<meeting sco-id="181487" type="meeting" status="active" permission-id="view"
length="36000000" active-participants="0">
<name>morris shared</name>
<domain-name>admin.breeze.exemple.com</domain-name>
<url-path>/r99718924</url-path>
<date-begin>2003-07-14T23:00:00.000-07:00</date-begin>
<date-end>2003-07-15T09:00:00.000-07:00</date-end>
<expired=true</expired>
</meeting>
</my-meetings>
name
Description
Contient un nom. Par exemple, selon le contexte, la balise peut contenir le nom d'une personne, le nom d'un groupe, le nom d'une entité SCO, une adresse électronique ou tout autreXE de nom.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
<name>Contrôle de mathématiques</name>
participant-name
Description
Contient le nom d'un participant à une réunion.
Le nom est presenté sous la forme correspondant aux paramètres régionaux.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-attendance
Example
<participant-name>Durand，Pat</participant-name>
permissions
Description
Balise conteneur ; contient des informations sur une ou plusieurs entités principales et les autorisations correspondantes.
(Pour plus d'informations sur les entités principales, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14. Pour plus d'informations sur les autorisations, consultez la section A propos de la sécurité, page 15.
Attributes
Aucun.
Balises continues
principal
Renvoyees par
permissions-info
Example
<autorisations>
<principal principal-id="181248" is-primary="false" type="user">
has-children="false" permission-id="view">
<name>Englesberg, Ari</name>
<login>englesberg@example.com</login>
</principal>
</permissions>
physical-path
Description
Contient le chemin de l'entité SCO sur le serveur.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
sco-info
Example
principal
Description
Contient des informations sur une entité principale.
(Pour plus d'informations sur les entités principales, consultez la section A propos des mandants, des entités SCO et des identifiants, page 14.
Attributes
account-id L'identifant du compte dont le mandant est membre. Cet attribut est renvoyé uniquement par l'action principal-info.
has-children Indique si le mandant possede des enfants. Les groupes peuvent avoir des enfants, mais pas les utilisateurs. Par consequent, cet attribut indique si le mandant est un groupe.
is-primary Indique si le mandant est un groupe primaire. Pour plus de détails, voir l'attribut type.
permission-id Les autorisations du mandant dans le cadre de l'entité SCO spécifique. Cet attribut est renvoyé uniquement par l'action permissions-info.
principal-id L'identifant du mandant.
type Le type du mandant. Les valeurs possibles incluent "user", "group" et différents types de groupes primaires: "administr", "authors", "live-admins" et "course-admins". Vous pouvezisser et modifier des utilisateurs et des groupes, mais pas des groupes primaires.
Balises continues
Remarque: Les balises continues ne sont renvoyees que sous certaines conditions.
Renvoyees par
Balise conteneur ; contient un ou plusieurs mandants.
Attributes
Aucun.
Balises continues
principal
Renvoyees par
principal-list
Example
<principal-list> <principal principal-id="222917" type="admins" has-children="true" is-primary="true" is-hidden="0"> <name>Administrateurs de compte</name> <login>Administrateurs de compte</login> <description>Groupe d'administrateurs de compte</description> </principal> </principal-list>
principal-name
Description
Contient le nom d'un mandant.
Le nom est presenté sous la forme correspondant aux paramètres régionaux.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-course-takers, report-quiz-takers
Example
question-text
Description
Contient l'une des questions d'un questionnaire.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-quiz-question-answer-distribution
Example
question
Description
Contient l'une des questions d'un questionnaire.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
report-quiz-interactions
Example
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte la reponse à une question.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-definition-answers
Example
<quiz-definition-answers> <row answer-id="1" question-id="257" correct="0"> <body>1</body> </row> <row answer-id="2" question-id="257" correct="1"> <body>2</body> </row> <row answer-id="1" question-id="258" correct="1"> <body>1</body> </row> <row answer-id="2" question-id="258" correct="0"> <body>2</body> </row> </quiz-definition-answers>
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte la réponse à une question.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-definition-questions
Example
<quiz-definition-questions>
<row question-number="1" question-id="257" score="20" chapter-id="1">
<body>Combien font 2+2 ?</body>
<date-modified>2004-01-13T17:09:40.230-08:00</date-modified>
</row>
<row question-number="2" question-id="258" score="20" chapter-id="1">
<body>Quelle est la distance de la terre au soleil ?
<date-modified>2004-01-13T17:09:40.230-08:00</date-modified>
</row>
</quiz-definition-questions>
Balise conteneur ; contient la liste des utilisateurs qui sont en train deprésenter des réunions.
Attributes
Aucun.
Balises continues
SCO
Renvoyees par
Balise conteneur ; contient la liste des réunions en cours.
Attributes
Aucun.
Balises contenues
SCO
Renvoyees par
Indique la bande passante totale utilisé par le compte actif depuis sa création, en octets.
Attributes
total Le montant total de la bande passante, en octets.
Balises contenues
Aucune. (Balise vide.)
Renvoyees par
report-bandwidth
Example
report-disk-usage
Description
Indique l'espace disque occupe par le contenu Breeze, en octets. Tout le contenu et les archives sont inclus.
Attributes
total La quantité totale d'espace disque utilisé, en octets.
Balises continues
Aucun. (Balise vide.)
Renvoyees par
report-disk-usage
Example
report-meeting-attendance
Description
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte des informations sur l'un des utilisateurs qui a participé à une réunion.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-meeting-attendance
Example
<report-meeting-attendance> <row transcript-id="462409" sco-id="505267" principal-id="181255" answered-survey="0"> <login>durand@exemple.com</login> <sco-name>Ma réunion</sco-name> <date-created>2004-01-29T00:59:15.490-08:00</date-created> <date-closed>2004-01-29T00:59:41.470-08:00</date-closed> <participant-name>Durand, Pat</participant-name> </row> </report-meeting-attendance>
Indique le nombre maximum d'utilisateurs qui peuvent participer simultanément à la réunion spécifique.
Attributes
max-participants-freq Le nombre de fois où le nombre maximum d'utilisateurs a ete atteint au cours du mois.
max-users Le nombre maximum d'utiliseurs.
Balises continues
Aucune. (Balise vide.)
Renvoyees par
Contient des informations sur une réunion.
Attributes
num-guests Le nombre de participants qui se sont connectés en tant qu'observateurs et non pas en tant que participants inscrits.
num-participants Le nombre total de participants à la réunion.
sco-id L'identifant de la réunion.
session-sco-id Un identificant unique de session.
Balises contenues
Balise conteneur ; contient des informations sur l'ensemble des « sessions » d'une réunion. Pour plus d'informations, consultez l'action report-meeting-sessions.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-meeting-sessions
Example
<report-meeting-sessions>
<row sco-id="622852" num-participants="1" num-guests="0" num-polls="0">
<name>Ma réunion</name>
<date-begin>2004-03-05T10:33:09.030-08:00</date-begin>
</row>
</report-meeting-sessions>
report-meeting-session-slots
Description
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte des informations sur une session donnée. Pour plus d'informations, consultez l'action report-meeting-session-slots.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-meeting-session-slots
Example
<report-meeting-session-slots> <row num-attendees="0"> <time-slot-begin>2004-02-14T06:30:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T06:40:00.000-08:00</time-slot-end> </row> <row num-attendees="0"> <time-slot-begin>2004-02-14T06:40:00.000-08:00</time-slot-begin> <time-slot-end>2004-02-14T06:50:00.000-08:00</time-slot-end> </row> </report-meeting-session-slots>
report-meeting-summary
Description
Indique le nombre d'utilisateurs invites à la réunion spécifique et le nombre d'invités et d'hôtes qui y ont réellement assisté.
Attributes
num-guests-attended Le nombre de participants qui se sont connectés en tant qu'observateurs et non pas en tant que participants inscrits.
num-invitees Le nombre d'utilisateurs qui ont eté invités.
num-invitees-attended Le nombre d'utilisateurs invitees qui ont participé.
Balises continues
Aucun. (Balise vide.)
Renvoyees par
report-meeting-summary
Example
report-quiz-answer-distribution
Description
Balise conteneur ; contient une ou plusieurs balises row qui indiquent le nombre d'utilisateurs ayant choisi de répondre à la question spécifique.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-answer-distribution
Example
<report-quiz-answer-distribution>
<row question-number="1" question-id="257" a1="0" a2="0" a3="5" a4="3"
total="8">
<body>Combien font 2+2 </body>
</row>
<row question-number="2" question-id="258" a1="8" a2="0" a3="0" a4="0"
total="8">
<body>Quelle est la distance de la terre au soleil </body>
</row>
<row question-number="3" question-id="259" a1="8" a2="0" a3="0" a4="0"
total="8">
</report-quiz-answer-distribution>
<body>Quellenorme internationaledéfinitle langageECMAScript></body></row></report-quiz-answer-distribution>
report-quiz-interactions
Description
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte des informations sur l'interaction entre un utiliser et le questionnaire spécifique. Pour plus d'informations sur les interactions, voir l'action report-quiz-interactions.
Attributes
Aucun.
Balises contenues
row
Renvoyées par
report-quiz-interactions
Example
<report-quiz-interactions>
<row transcript-id="459350" question-id="257" Sco-id="217706" score="20">
<date-created>2004-01-13T02:00:46.163-08:00</date-created>
<question>Combien font 2+2 ?</question>
</row>
<row transcript-id="459350" question-id="258" Sco-id="217706" score="0">
<date-created>2004-01-13T02:00:46.163-08:00</date-created>
<question>Quelle est la distance de la terre au soleil ?
</question>
</row>
<row transcript-id="459350" question-id="259" Sco-id="217706" score="20">
<date-created>2004-01-13T02:00:46.163-08:00</date-created>
<question>Quelle norme internationale définit le langage ECMAScript ?
<question>
</row>
</report-quiz-interactions>
</report-quiz-interactions>
report-quiz-question-answer-distribution
Description
Balise conteneur ; contient une ou plusieurs balises row qui indiquent le nombre d'utilisateurs ayant choisi telle reponse à la question spécifiée.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-question-answer-distribution
Example
<report-quiz-question-answer-distribution>
<row question-id="259" answer-id="1" correct="0" total-responses="1" percentage-responed="10">
<question-text>Quelle norme internationale définit le langage ECMAScript <?question-text>
<answer-text>ISO-9000</answer-text>
</row>
<row question-id="259" answer-id="2" correct="0" total-responses="3" percentage-responed="30">
<question-text>Quelle norme internationale définit le langage ECMAScript <?question-text>
<answer-text>RFC 821</answer-text>
</row>
<row question-id="259" answer-id="3" correct="0" total-responses="2" percentage-responed="20">
<question-text>Quelle norme internationale définit le langage ECMAScript <?question-text>
<answer-text>ECMA-976</answer-text>
</row>
<row question-id="259" answer-id="4" correct="1" total-responses="4" percentage-responed="40">
<question-text>Quelle norme internationale définit le langage ECMAScript <?question-text>
<answer-text>ECMA-262</answer-text>
</row>
</report-quiz-question-answer-distribution>
report-quiz-question-distribution
Description
Balise conteneur ; contient une ou plusieurs balises row qui indiquent le nombre d'utilisateurs ayant repondu correctement à la question spécifiée.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-question-distribution
Example
<report-quiz-question-distribution> <row question-id="257" question-number="1" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> </body>Combien font 2+2 ?</body> </row> <row question-id="258" question-number="2" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> </body>Quelle est la distance de la terre au soleil ?</body> </row> <row question-id="259" question-number="3" num-correct="4" num-incorrect="6" percentage-correct="40" score="20">
<body>Quellenorme internationaledéfinitle langageECMAScript></body></row></report-quiz-question-distribution>
report-quiz-question-response
Description
Balise conteneur ; contient une ou plusieurs balises row qui décrivent la réponse apportée à la question spécifique.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-quiz-question-response
Example
<report-quiz-question-response> <row principal-id="506299" question-id="257" answer-id="2"> <body>Combien font 2+2 ?</body> <answer-text>5</answer-text> </row> <row principal-id="557527" question-id="257" answer-id="2"> <body>Combien font 2+2 ?</body> <answer-text>5</answer-text> </row> <row principal-id="181255" question-id="257" answer-id="3"> <body>Combien font 2+2 ?</body> <answer-text>4</answer-text> </row> </report-quiz-question-response>
report-quiz-question-totals
Description
Indique le nombre total d'utiliseurs qui ont repondu à la question spécifiée et le nombre d'utilisateurs qui y ont repondu correctement.
Attributes
num-correct-answers Le nombre d'utiliseurs qui ont repondu correctement à la question.
question-id L'identifant de la question.
total-responses Le nombre total d'utilisateurs qui ont repondu à la question.
Balises continues
Aucune. (Balise vide.)
Renvoyees par
report-quiz-question-totals
Example
Contient des informations sur le nombre d'utilisateurs qui ont participé au questionnaire et la plage de résultats correspondante.
Attributes
average-score La moyenne des résultats des utilisateurs qui ont répondu au questionnaire.
high-score Le résultat le plus élevé.
low-score Le résultat le plus faible.
numdistincttaken Le nombre d'individus qui ont répondu au questionnaire.
numtaken Le nombre d'utilisations du questionnaire.
Balises continues
Aucun. (Balise vide.)
Renvoyees par
report-quiz-summary
Example
Contient des informations sur un questionnaire.
Attributes
maxpossiblescore Le meilleur résultat possible.
numquestions Le nombre de questions du questionnaire.
passingscore Résultat minimum considéré comme acceptable. Défini par le creator du questionnaire.
sco-id L'identifant du questionnaire.
Balises continues
Aucun. (Balise vide.)
Renvoyees par
report-quiz-summary
Example
<report-quiz-summary sco-id="217706" numquestions="5" maxpossiblescore="100" passingscore="0"/>
report-quiz-takers
Description
Balise conteneur ; contient une ou plusieurs balises row, chacune de ces balises comporte des informations sur l'un des utilisateurs qui a participé au cours ou à la réunion spécifiée.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-course-takers, report-quiz-takers
Example
<report-quiz-takers> <row transcript-id="586821" sco-id="586760" principal-id="506385" status="not-attempted" score="0" percentage-score="0" time-taken=" certificate="" > <name>Contrôle de mathématiques</name> <login>benedicte@example.com</login> <date-taken>2004-02-27T10:53:05.013-08:00</date-taken> <principal-name>Benedicte, Fred</principal-name> </row> <row transcript-id="586837" sco-id="586760" principal-id="557527" status="user-failed" score="10" percentage-score="25" time-taken="51796" certificate="" > <name>Contrôle de mathématiques</name> <login)benedicte2@example.com</login> <date-taken>2004-02-27T10:58:36.373-08:00</date-taken> <principal-name>Benedicte, Georges</principal-name> </row> </report-quiz-takers>
report-sco-slides
Description
Balise conteneur ; contient une ou plusieurs balises row qui indiquent la fréquence d'affichage de l'une des diapositives de la presentation, ainsi que la date et l'heure de la dernière consultation.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-sco-slides
Example
Balise conteneur ; contient une ou plusieurs balises row qui indiquent la fréquence d'affichage de la presentation spécifiée, ainsi que la date et l'heure de la dernière consultation.
Attributes
Aucun.
Balises continues
row
Renvoyees par
report-sco-views
Example
Indique le plus grand nombre d'utiliseurs ayant utilisé le système en même temps.
Attributes
account-id L'identifant du compte courant.
limit Le nombre maximum d'utilisateurs pouvant acceder au système en même temps, conformément aux specifications de la licence de votre compte.
max-num-sessions Le plus grand nombre de sessions ayant eté ouvertes simultanémert.
Balises continues
name
Renvoyees par
Balise conteneur ; tous les résultats renvoyés par une action sont contenus dans une balise results.
Attributes
Aucun.
Balises continues
Tout type.
Renvoyees par
Toutes les actions.
Example
< résultats>
<status code="ok" />
</results>
row
Description
Contient un enregistrement unique d'informations dans un rapport.
Pour obtenir des exemples d'attributs acceptables et de balises contenues, consultez les exemples de résultats fournis dans la documentation pour l'action que vous appelez.
Attributes
Les attributs de la balise row varient considérablement en fonction de l'action représentée par cette balise.
Balises contenues
Les balises contenues dans la balise row varient considérablement en fonction de l'action représentée par cette balise.
Renvoyees par
report-course-takers, report-meeting-attendance, report-meeting-sessions, report-meeting-session-slots, report-quiz-answer-distribution, report-quiz-definition-answers, report-quiz-definition-questions, report-quiz-interactions, report-quiz-question-answer-distribution, report-quiz-question-distribution, report-quiz-question-response, report-quiz-takers, report-sco-slides, report-sco-views
Example
<row sco-id="622852" num-participants="1" num-guests="0" num-polls="0"> <name>Ma réunion</name> <date-begin>2004-03-05T10:33:09.030-08:00</date-begin> </row>
SCO
Description
Contient des informations sur une entité SCO, ce qui correspond à un document Breeze unique.
Pour obtenir des exemples d'attributs acceptables et de balises contenues, consultez les exemples de résultats fournis dans la documentation.
Attributes
Les attributs de la balise s co varient considérablement en fonction de l'action représentée par cette balise.
Balises continues
Les balises contenues dans la balise s co varient considérablement en fonction de l'action représentée par cette balise.
Renvoyees par
Fournit des informations sur l'auteur d'une entité SCO.
Attributes
Aucun.
Balises continues
Contient des informations sur le fichier de données sous-jacent (tel que le fichier contenant une presentation) utilisé dans une entité SCO.
Attributes
byte-count La taille du fichier de l'entité SCO, en octets.
height La hauteur de l'entité SCO, en pixels.
length La durée d'une presentation, en millisecondes.
sco-data-id L'identifant du fichier de données de l'entité SCO.
slide-count Le nombre de diapositives dans l'entité SCO. Une valeur de -1 indique que le décompte de diapositives ne s'applique pas; par exemple, si l'entité SCO est une réunion et non pas une presentation, le nombre de diapositives s'affiche sous la forme -1.
version Le numero de version de l'entité SCO.
width La largeur de l'entité SCO, en pixels.
Balises continues
Le nom d'une entité SCO donnée, sous une forme compréhensible par l'utilisateur, tel que le nom d'une réunion.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-attendance
Example
sco-nav
Description
Contient des informations sur la hierarchie de dossiers renferment l'entité SCO spécifique.
Attributes
Aucun.
Balises continues
SCO
Renvoyees par
sco-nav
Example
<sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>Ma réunion</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>durand@example.com</name> </sco> </sco-nav>
sco-search-info
Description
Balise conteneur ; contient une ou plusieurs balises sco, chacune de ces balises comporte des informations sur une entité SCO correspondant au texte de recherche spécifique.
Attributes
Aucun.
Balises continues
SCO
Renvoyees par
sco-search
Example
<sco-search-info> <sco sco-id="202014" folder-id="202008" type="presentation" slide-count="4" length="20000"> <name>Questionnaire 1</name> <url-path>/p92628681</url-path> <date-created>2003-11-26T22:52:28.973-08:00</date-created> <date-modified>2003-11-26T22:52:37.867-08:00</date-modified> <first-name>Paul</first-name> <last-name>Martin</last-name> <hit>1</hit> <hit>4</hit> </sco> </sco-search-info>
SCOS
Description
Balise conteneur ; contient une ou plusieurs balises sco, chacune de ces balises comporte des informations sur une entité SCO à l'intérieur du dossier spécifique.
Attributes
Aucun.
Balises continues
SCO
Renvoyees par
sco-contents
Example
<scos> <sco sco-id="505677" status="no-content" type="folder" is folder="1"> <name>Mes tests de réunion PPT</name> <date-modified>2004-01-29T06:22:49.157-08:00</date-modified> </sco> <sco sco-id="193496" status="active" type="meeting" is folder="0"> <name>Mon nom</name> <date-begin>2003-08-27T00:00:00.000-07:00</date-begin> <date-end>2003-08-27T01:00:00.000-07:00</date-end> <date-modified>2003-08-26T23:33:20.300-07:00</date-modified> <duration>1900-01-02T/+:00:00.000+00:00</duration> </sco> </scos>
shortcuts
Description
Balise conteneur ; contient une ou plusieurs balises sco, chacune de ces balises contient des informations sur un dossier dont le contenu se rapporte à l'utilisateur connecté. Pour plus d'informations, consultez l'action sco-shortcuts.
Attributes
Aucun.
Balises continues
SCO
Renvoyees par
sco-shortcuts
Example
<racourcis> <sco tree-id="181230" Sco-id="181576" type="my-meetings"> <domain-name>http://admin.breeze.exemple.com</domain-name> </sco> <sco tree-id="181227" sco-id="181412" type="my-content"> <domain-name>http://admin.breeze.exemple.com</domain-name> </sco> ... [Autres balises sco ici.] ... <sco tree-id="181230" sco-id="181230" type="user-meetings"> <domain-name>http://admin.breeze.exemple.com</domain-name> </sco> </shortcuts>
source-sco
Description
Balise conteneur ; contient des informations sur le SCO qui se rapportent au contenu d'un cours.
Attributes
Aucun.
Balises contenues
source-sco
Renvoyees par
sco-info
Example
<source-sco> <source-sco author-contact-id="586761" folder-id="506334" host-id="" learning-time="" sco-data-id="586762" sco-id="586760" source-sco-id="" status="active" tree-id="181225" type="presentation"> <date-created>2004-02-27T10:31:06.717-08:00</date-created> <date-modified>2004-02-27T10:52:58.217-08:00</date-modified> <description>Présentation de test simple</description> <name>Contrôle de mathématiques</name> <url-path>/p60802018</url-path> </source-sco> </source-sco>
status
Description
Lorsque Breeze renvoie des données XML, il inclut une balise status. Cette section regroupe des informations sur tous les codes et les sous-codes d'etat que Breeze peut renvoyer.
Attributes
code L'etat de l'action. Vous trouverez ci-dessous les valeurs possibles de cet attribut :
invalid Indique qu'un appel n'est pas valide, sans plus de précisions. Si l'attribut code est défini sur "invalid", la balise status contient une balise invalid qui comporte plus de détails sur l'origine du problème.
no-access Indique que vous ne disposez pas des autorisations nécessaires pour exécuter l'action. Ce problème peut survenir sous différentes situations ; la valeur de l'attribut subcode fournit plus de détails. Pour plus de détails sur les valeurs possibles de l'attribut subcode, consultez la section suivante. Si vous fournissez une clé d'accès non valide, aucune valeur n'est renvoyée par subcode.
no-data Indique qu'aucune donnée n'est disponible (en response à une action devant normalement renvoyer des données). Indique généralement qu'aucun élément ne dispose de l'identifient spécifique. Pour résoudre cette erreur, modifier l'identifant spécifique de façon à ce qu'il correspondé à un élément existant.
ok Indique que l'action s'est terminée avec succès.
too-much-data Indique que l'action aurait d'renvoyer un résultat unique, mais a renvoyé des résultats multiples. Par exemple, si plusieurs utilisateurs portent le même nom et utilisent le même mot de passer, et si vous appezez l'action login qui utilise ce nom et ce mot de passer en tant que paramètres, le système ne peut pas déterminer votre identité lors de la connexion et renvoie l'erreur "too-much-data".
subcode Parfois utilise pour donner plus de détails sur l'etat de l'action. Par exemple, les valeurs subcode permettent de détecter les situations où code est définir sur no-access. Vous trouvez ci-dessous les valeurs possibles de cet attribut :
account-expired Le compte du client a expire.
denied Vos informations de sécurité ne permettent pas d'executer l'action.
no-login Vous ne vous étés pas connecté. Pour résoudre cette erreur, connectez-vous (avec l'action login) avant d'appeler l'action. Pour plus d'informations, consultez l'action login.
no-quota Les limites du compte ont ete atteintes ou depassees.
not-available Laressourc specifie n'est pas disponible.
not-secure Vousevezutiliser SSL pour appeler cette action.
pending-activation Le compte n'a pas encore ete activé.
pending-license Le contrat de licence du compte n'a pas encore ete accepte.
sco-expired Le cours ou le contenu de suivi a expiry.
sco-not-started La réunion ou le cours n'a pas encore commencé.
Balises continues
invalid
Renvoyees par
Toutes les actions.
Example
time-slot-begin
Description
Contient la date et l'heure de début d'une réunion.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-session-slots
Example
time-slot-end
Description
Contient la date et l'heure de fin d'une réunion.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
report-meeting-session-slots
Example
url
Description
ContientuneURL.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyees par
common-info, report-my-courses
Example
url-path
Description
Contient le chemin de l'entité SCO spécifique sur le serveur Breeze.
Attributes
Aucun.
Balises contenues
Aucune. (Contenu uniquement.)
Renvoyees par
Contient des informations sur un'utilisateur.
Attributes
user-id Identifiant de l'utilisateur.
Balises continues
login
Renvoyées par
common-info
Example
<user user-id="503562">
<login>dupont@example.com</login>
</user>
user (user-accounts)
Description
Contient des informations sur un'utilisteur.
Attributes
user-id Identifiant de l'utilisateur.
account-id L'identifiant d'un compte.
Balises contenues
date-expired, name
Renvoyees par
user-accounts
Example
<user user-id="211729" account-id="211655">
<name>jacques@example.com</name>
<date-expired>2004-01-24T00:59:59.000-07:00</date-expired>
</user>
users
Description
Balise contèneur ; contient une ou plusieurs balises user, chacune de ces balises comporte des informations sur un utilisateur et un compte.
Attributes
Aucun.
Balises continues
user (user-accounts)
Renvoyées par
user-accounts
Example
<users> <user user-id="211729" account-id="211655"> <name>jacques@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="212988" account-id="212928"> <name>lapierre@example.com</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> </users>
version
Description
Contient le numero de version de Breeze.
Attributes
Aucun.
Balises continues
Aucune. (Contenu uniquement.)
Renvoyées par
common-info
Example
<version> breeze_402_r116</version>
A
acces public, autorisations 18
accès, clés 15
accès, clés spéciales 27, 28
acl-id, paramétres 15
actionaccesskey-exec 27
actionaccesskey-info 28
mises à jour des informations 7
noms 64
permissions-info 31
permissions-reset 32
permissions-update 32
principal-info 22,33
terminées avec succès 20
user-accounts 59
user-update-pwd 59
Voiraussi services Web
actions, balise 64
actualisation
appartenance au groupe 30
authorisations 32
informationsutilisateur22
mandants 34
mots de passer 59
SCO 57
admins, groupe primaire 14
adresses électroniques comme nom de connexion 75
affichage
diapositives 50
prsentations 50
affichage en tableau des informations renvoyees 24
ajout d'utilisateurs à Breeze 21
ajout demandantsaun groupe 30
analyse du code XML renvoyé 20
answer-text, balise 65
archiver, réunion 15
attributes,recherche 21
authors, groupe primaire 14
bande passante, rapport 37
body, balise 65
Breeze
affichage de contenu spécifique 23
documentation 7
intégration à un portail 23
interaction avec le serveur 12
liste de toutes les actions 29
numéro de version 105
utilisateurs,actualisation 22
utilisateurs,ajout21，27
utilisateurs, suppression 22
C
cas courants d'utilisation 19
CFML
exemples de code 13
utilisation du code XML 8
chaines de requête, creation 13
chemin d'accès à du contenu 24
clés d'accès
Breeze Enterprise 16
clients hébergés 16
obtention 28
comptes hébergés, clés d'accès pour 16
configuration des clés d'accès 16
specifique, affiche 23
conventions typographiques 9
cookie, balise 66
cookies Voir JSESSIONID, cookies
cours
lancement 18
liste 23, 25, 41
participants inscrits 37
vued'ensemble 14
Voir aussi SCO
course, balise 67
course-admins, groupe primaire 14
creation chaines de requete 13
mandants 34
réunions 25
SCO 57
utilisateurs 21
utilisateurs administratifs 20
CSV (données séparées par des virgules) 25
D
date, balise 67
date-begin, balise 68
date-closed, balise 68
demande de la liste des utilisateurs de Breeze 20
denied, autorisation 17
dépannage 101
déplacement de SCO 54
description des mandants 33
description, balise 70
diapositives
nombrediapositives97
nombredvisionnages50
documentation et mises à jour 7
domain-name, balise 71
dossiers
authorisations 17
communs 56
contenu 52
hiéarchies 54
liste des contenus 24
my-content (Mon content) 24
relatif s à l'utilisateur actuel 56
vued'ensemble 14
VoiraussiSCO
dossiers parents 54
duration, balise 71
E
elements XML renvoyes 27, 61
email, balise 71
erreur, recherche d' 20
espace disqueutilisé38
exemples de code
analyse du code XML renvoyé 20
presentation 19
utilisation de CFML 13
exemples de tâches courantes 19
expired, balise 72
extraction de l'URL 56
F
first-name, balise 72
Flash, fichiers 14
flux de données 12
flux de travail 12
folder-id, parametes 15
formatCSV25
G
génération de rapports 25
gras, convention 9
group-id, paramétres 15
groups
authorisations 17
members,actualisation 30
primaires 14
rejoints lors de l'auto-inscription 28
vued'ensemble 14
Voiraussimandants,utilisateurs
groups primaires
authorisations 16
definition 14
H
heures et dates 9
hiéarchies de dossiers 54
hit, balise 73
host, balise 73
HTTP
parametes 20
requêtes GET et POST 13
1
ID
utilisateurs, extraction 23
identifiant
account 63
authorisations 16
identifiants de connexion, obtention 33
identé, verification 30
images, fichier 15
informations
affichage 24
sur lesmandants 33
sur les SCO 53
sur les serveurs, obtaining 29
informationsd'identification,securite15,30
informations de dernier minute 7
inscription d'un utiliser 27
insertion d'un nouvel utiliseur Breeze 21
intégration de Breeze à un portail 23
interaction avec le serveur Breeze 12
interactions avec les questionnaires 45
interfaces, conversion 11
invalid, balise 73
invités, nombre 41
ISO 8601, format de date 9
conflits des noms de cookie 18
cookie, balise 66
exampie de code 19
invalidation 31
sécurities 15
vued'ensemble 15
L
lancement du content 18
last-name, balise 74
licence, clés d'accès 16
liens hypertexte, creation 24
limits des comptes 39
liste
actions 29
comptes 59
contenu des dossiers 24, 52
cours 23, 41
mandants 34
presentateurs 36
questions 44
réunions 23, 36
stagiaires 37
live-admins, groupe primaire 14
login, action 15
login, balise 75
logos 15
M
manage, autorisation 17
mandants
ajouta un groupe 30
authorisations 16, 31, 32
creation 34
informations,obtenir 33
liste 34
public-access 18
vued'ensemble 14
Voir aussi utilisateurs, groupes
manuels 7
meeting, balise 76
mises à jour de la documentation 7
mises à jour récentes de la documentation 7
modification
appartenance au groupe 30
authorisations 32
mandants 34
modules 15
mots de passer
modification 59
verification 23
my-content (Mon contenu), dossier 24
my-courses, balise 76
my-meetings, balise 77
N
name, balise 78
noms d'actions 64
noms de Domaine, extraction 24
notes des questionnaires 45
notions de base des services Web 8
nouveautés 7
P
paramètres
en option 13
ID 15
paramètres en option 13
parametes requis 13
parent-acl-id, paramètres 15
participant-name, balise 78
participants à un cours 37
participation
aux réunions 38
maximum 39
participation maximale à une réunion 39
periodes de session de réunion 40
permissions, balise 79
planning de réunions 39, 42
portails, intégration de Breeze 23
POST, requêtes (HTTP) 13, 20
prérezquis 7
préSENTateurs
de réunions 36
presentsions des services Web 8
presentations
nombrediapositives97
nombredvisionnages50
recherche 25
vued'ensemble 14
Voir aussenco
presenter
authorisations 17
principal, balise 80
principal-id, paramètres 15
liste des réponses 47
nombredutilisateursayantrépondu48
note, definition 45
questions 44
réponses correctes aux questions 47
réponses correctes et incorrectes 43
réponses,distribution 43,46
réponses, texte 65
résumé des résultats 49
utilisateurs ayant repondu 49
VoiraussiSCO
questions
text dans des SCO 55
recherche d'erreurs 20
recompilation de SCO 51
réinitialisation des autorisations 32
réponses au questionnaire
correctes et incorrectes 43
distribution 43, 46
interactions 45
liste 47
réponses correctes 47
texte 65
requêtes GET et POST (HTTP) 13, 20
ressources
bande passante, rapport 37
rapport sur l'espace disque utilisé 38
ressources (documentation), supplémentaires 8
ressources en ligne 8
résultats
actions 61
des questionnaires 49
results, balise 61, 95
résumé des résultats d'un questionnaire 49
retrait
mandants d'un groupe 30
utilisateurs 22
réunions
actives 36
archivée 15
authorisations 17
creation 25
invités, nombre 41
lancement 18
liste 23, 36
planifiées 39, 42
presentateurs 36
sessions 40
vides 40
vued'ensemble 14
Voir aussi SCO
réunions actives
liste 36
presentateurs 36
réunions, participation
liste des utilisateurs 38
maximum 39
nombredeparticipants 39
participants par période de 10 minutes 40
résumé 41
row, balise 25, 96
s
scenarios courants 19
SCO
actualisation 57
autorisations du parent 17
authorisations,actualisation 32
autorisations, affichage des informations 31
autorisations, vue d'ensemble 16
compilation 51, 58
courament utilisés 56
creation 57
déplacement 54
dossiers parents 54
extraction de l'URL 56
hiérchies de dossiers 54
liste des SCO d'un dossier 52
obtention d'informations 53
recherche 25, 55
réinitialisation des autorisations 32
suppression 53
transfert 58
vued'ensemble 14
Voir aussi cours, dossiers, réunions,présentations, questionnaires
sco, balise 96
sco-id, paramétres 15
sco-name, balise 98
sco-nav, balise 98
sécurities, vue d'ensemble 15
serveurs, informations 29
services d'annulaire, synchronisation 19
services Web
mises à jour 7
primer 8
vued'ensemble de l'architecture 11
Voiraussi actions
session, paramètre de requête 18
sessions de réunions 39, 40
shortcuts, balise 100
SOAP (Simple Object Access Protocol) 11
source-sco, balise 101
sous-dossiers,iste 52
specification de paramètres multiples
actualisation de l'appartenance à un groupe 30
actualisation des autorisations 33
mandants, suppression 35
SCO, suppression 53
vued'ensemble 13
stagaires,iste 37
supports pedagogiques 7
suppression
mandants 35
mandants de Breeze 35
SCO 53
utilisateurs 22
synchronisation avec des services d'annuaire 19
systèmes d'aide 7
T
tableaux, affchage 24
taches courantes 19
texte,recherche dans desSCO 55
time-slot-begin, balise 102
time-slot-end, balise 103
transfert de SCO 51, 58
typographie, conventions 9
U
url, balise 103
URL, extraction 24
url-path, balise 103
user, balise 104
user-id, parametes 15
users
vued'ensemble 14
Voir aussi mandants, groupes
users, balise 105
utilisateur administratif 20
utilisateurs
actualisation des informations 22
administratifs 20
ajout 21
authorisations 31
ayant repondu à un questionnaire 49
connexion 23, 30
déconnexion 31
dossiers 56
groups, changement d'appartenance 30
ID, extraction 23
informations,obtenir 29,33
inscription à des cours 23, 41
inscription dans Breeze 27
inscrits à des cours 37
liste 20
liste des comptes 59
mots de passer, modification 59
participation à une réunion, nombre maximal 39
réunions planifiées 23, 42
réunions, participation 38
simultanés maximum 51
suppression 22
V
verification de l'identité 30
version, balise 105
view, autorisation 17
view-hidden, autorisation 18
view-only, autorisation 18
vued'ensemble del'architecture 11
X
XML, résultats
analyse 20
vued'ensemble 61
XML,utilisationavecCFML8
XML_API_KEY, configuration 16
XSLT (XSL Transformations) 8, 25