Guide d’intégration de Breeze Marques de commerce 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev et WebHelp sont des marques déposées ou des marques de commerce de Macromedia, Inc. aux Etats-Unis ou dans d’autres pays y compris au niveau international. Les autres noms de produits, logos, concepts, titres, mots ou phrases mentionnés peuvent être des marques commerciales, des marques de service ou des appellations commerciales de Macromedia, Inc. ou d’autres entités dans certains pays y compris au niveau international. Informations au sujet des parties tierces Ce guide contient des liens vers des sites Web tiers qui ne sont pas contrôlés par Macromedia et Macromedia ne peut en aucun cas être tenu responsable de leur contenu. Si vous accédez à un site Web tiers mentionné dans ce guide, vous le faites à vos propres risques. Macromedia fournit des liens dans un but de commodité uniquement et l’inclusion du lien n’implique pas que Macromedia est responsable ou accepte de l’être vis-à-vis du contenu de ces sites tiers. Copyright © 1997-2005 Macromedia, Inc. Tous droits réservés. Le présent manuel ne doit pas être copié, photocopié, reproduit, traduit ou converti sous tout format électronique ou lisible par une machine, en tout ou partie, sans l’autorisation écrite préalable de Macromedia, Inc. Nonobstant les dispositions précédentes, le propriétaire ou l’utilisateur autorisé d’une copie valide du logiciel avec lequel ce manuel a été livré est autorisé à imprimer une seule copie de ce manuel à partir de la version électronique de ce dernier, ce propriétaire ou utilisateur autorisé ayant comme unique objectif d’apprendre à utiliser ce logiciel, sous réserve qu’aucune section de ce manuel ne soit imprimée, reproduite, distribuée, revendue ou transmise pour tout autre motif, y compris, mais sans s’y limiter, des motifs commerciaux, tels que vendre des copies de cette documentation ou proposer des services d’assistance facturés. Remerciements Directeur : Erick Vera Gestion du projet : Stephanie Gowin Rédaction : Jody Bleyle Rédactrice en chef : Rosana Francescato Edition : Linda Adler, Geta Carson, Evelyn Eldrige, Mary Ferguson, Lisa Stanziano, Jessie Wood Gestion de la production et de l’édition : Patrice O’Neill Conception et production : Adam Barnett, John Francis Première édition : Mai 2005 Macromedia, Inc. 601 Townsend St. San Francisco, CA 94103 TABLE DES MATIÈRES INTRODUCTION : Avant de commencer ................................ 9 Utilisateurs concernés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Nouvelles fonctionnalités des API XML de Breeze. . . . . . . . . . . . . . . . . . . . . . . . . . 9 Fonctionnalités modifiées des API XML de Breeze . . . . . . . . . . . . . . . . . . . . . . . . 10 Guide des supports pédagogiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Autres ressources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Conventions typographiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 CHAPITRE 1 : Utilisation des API XML de Breeze . . . . . . . . . . . . . . . . . . . . . . . . 13 Flux de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Appel d’une API sur le serveur. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Présentation des paramètres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Présentation des mandants, des SCO et des identifiants. . . . . . . . . . . . . . . . . . . . . Sécurité . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPITRE 2 : Utilisation de filtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Présentation des filtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Présentation des filtres de tri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exemples de filtres spéciaux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Liste des filtres gérés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test du code dans un navigateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pour en savoir plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPITRE 3 : Tâches courantes 14 15 16 17 18 21 23 23 24 25 26 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Appel de la première API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Connexion à Breeze. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Création d’un utilisateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ajout d’un utilisateur dans un groupe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Affichage des réunions, des cours et des événements d’un utilisateur . . . . . . . . . . . Création d’une réunion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Création d’une réunion à partir d’un modèle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Création et gestion de cursus de formation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Intégration de Breeze à un service d’annuaire. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Intégration de Breeze à un portail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Génération de rapports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 29 31 31 31 32 32 33 33 37 40 3 CHAPITRE 4 : Informations de référence sur les API XML. . . . . . . . . . . . . . . . . . 41 Exemple d’entrée API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Liste d’API par fonction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 API classées par ordre alphabétique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Informations de référence sur les API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 accesskey-exec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 accesskey-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 acl-field-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 acl-field-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 acl-field-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 acl-preference-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 action-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 common-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 custom-field-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 custom-fields-delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 group-membership-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 learning-path-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 learning-path-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 permissions-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 permissions-reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 permissions-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 principal-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 principal-list-by-field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 principal-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 principals-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 report-account-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 report-active-meeting-presenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 report-bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 report-bulk-consolidated-transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 report-bulk-content-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 report-bulk-course-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 report-bulk-meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 report-bulk-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 report-bulk-objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 report-bulk-questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 report-bulk-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 report-bulk-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 report-course-takers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 report-disk-usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 report-meeting-attendance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 4 Table des matières report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-my-events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-expanded-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sco-upload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . user-accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . user-transcript-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . user-update-pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHAPITRE 5 : Informations de référence sur les résultats XML . 102 102 103 104 105 106 107 108 109 110 112 113 114 115 117 118 119 120 121 122 123 124 125 126 126 128 129 129 132 132 133 135 136 140 141 142 143 . . . . . . . . . . . . 145 Code XML renvoyé . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exemple de balise XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Balises XML classées par ordre alphabétique . . . . . . . . . . . . . . . . . . . . . . . . . . . . access-key (conteneur) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . access-key (clé) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . access-key-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . access-keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . acl-field-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table des matières 145 146 146 153 153 154 155 155 156 156 5 acl-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 answer-correct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 answer-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 course . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 custom-fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 date-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 date-closed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 date-created . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 date-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 date-expired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 date-last-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 date-modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 date-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 date-time-attempted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 domain-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 expanded-scos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 expired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 hit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 last-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 last-viewed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 last-viewed-date. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 learning-path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 learning-paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 most-recent-session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 my-events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 my-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 participant-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 6 Table des matières permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . physical-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . presentation-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . principal-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . question-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quiz-definition-answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quiz-definition-questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quota. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-account-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-active-meeting-presenters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-active-meetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-consolidated-transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-content-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-content-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-course-quiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-course-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-meeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-slide-views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-bulk-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-course-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-disk-usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-attendance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-question-answer-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-question-distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-question-totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quiz-takers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table des matières 179 180 180 181 184 184 185 186 186 187 187 187 188 188 189 190 190 191 192 192 193 193 194 195 195 196 197 198 198 199 200 201 201 202 202 203 203 204 205 205 206 207 208 208 209 210 210 211 212 212 7 report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 report-training-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 sco. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 sco-author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 sco-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 sco-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 sco-search-info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 scos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 source-sco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 time-slot-begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 time-slot-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 time-taken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 url-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 user (common-info) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 user (user-accounts). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 user-agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 user-first-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 user-last-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 user-login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 user-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 view-date-time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 INDEX 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Table des matières INTRODUCTION Avant de commencer Les services Web XML Macromedia Breeze permettent à un système externe (tel qu’une application Web) d’interagir avec un serveur Breeze. Le présent guide explique comment appeler des services Web XML (également appelés API ou actions) sur le serveur Breeze à partir du système externe et comment interpréter les résultats XML renvoyés par Breeze. Il comporte également des sections de référence expliquant le rôle de chaque interface de programmation d’application (API), ainsi que celui des paramètres correspondants. Utilisateurs concernés Le présent guide s’adresse aux développeurs qui souhaitent intégrer 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 pour communiquer entre une application et un serveur. Vous devez également savoir comment programmer en langage serveur, tel que CFML (Macromedia ColdFusion Markup Language). Nouvelles fonctionnalités des API XML de Breeze vous permettent d’ajouter et de mettre à jour des champs personnalisés, ainsi que d’en extraire des informations : acl-field-info, acl-field-list, acl-field-update. Les API de champs personnalisés vous permettent d’extraire des données du serveur Breeze : report-bulk-consolidated-transactions, report-bulk-objects, report-bulkquestions, report-bulk-slide-views, report-bulk-users, report-bandwidth et reportmy-events. De nouvelles API de génération de rapports Les API de type report-quiz mises à jour incluent de nouveaux types de données d’interaction : report-quiz-interactions, report-quiz-question-answer-distribution, report-quiz-question-distribution, report-quiz-question-response. Les API associées aux mandants mises à jour comportent des informations sur les champs personnalisés. Les API SCO mises à jour gèrent de nouveaux types de SCO (Shareable Content Object) et de contenus. 9 répertorient tous les SCO d’un compte. Utilisez l’API sco-expandedassociée à des filtres pour localiser des SCO déterminés. Les nouvelles API SCO contents Les API de type curriculum vous permettent de collecter des informations sur les curriculums et de mettre à jour ces derniers : learning-path-info, learning-path-update. Fonctionnalités modifiées des API XML de Breeze Certaines API prises en charge dans Breeze 4 ne sont plus gérées par Breeze 5.1. Pour plus d’informations sur les API de substitution, consultez le cas échéant les sections correspondantes du Chapitre 4, Informations de référence sur les API XML, page 41. Les API suivantes ne sont plus prises en charge dans Breeze 5.1 : • • • • • • • • • • • • • • • • • • • • 10 accesskey-exec accesskey-info report-account-meeting-attendance report-bandwidth report-bulk-content-quiz report-bulk-content-quiz-results report-bulk-content-slide-views report-bulk-course-quiz report-bulk-course-results report-bulk-meeting report-bulk-meeting-attendance report-course-takers report-disk-usage report-meeting-session report-meeting-session-slots report-principal-list report-quiz-answer-distribution report-quiz-definition-answers report-quiz-definition-questions report-quiz-question-totals Introduction : Avant de commencer Guide des supports pédagogiques Breeze dispose de plusieurs supports qui permettent de maîtriser rapidement ce produit. Outre le présent guide, les manuels électroniques et les systèmes d’aide en ligne suivants sont disponibles : • Le Guide d’installation et de configuration de Breeze indique comment installer les applications Breeze. Ce manuel est disponible sous forme d’insert sur le DVD pour les utilisateurs professionnels, ainsi qu’au format PDF. • Le Mode d’emploi de Breeze Manager décrit comment utiliser les composants d’administration, de présentation et de formation de Breeze Meeting. Vous pouvez accéder au guide Mode d’emploi de Breeze Manager à partir de la page d’accueil de Breeze Manager et du lien Aide de l’application Web Breeze Manager. • Mode d’emploi de Breeze Meeting à l’intention des participants/présentateurs de réunions décrit l’utilisation de l’application Web Breeze pour héberger des réunions en ligne et en temps réel. Cette documentation inclut des procédures qui démontrent à quel point il est facile d’ajouter des diapositives, des fichiers Macromedia Flash SWF, des images, du son et des vidéos à vos présentations. • Il comprend aussi des informations utiles 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. Les participants peuvent par exemple s’envoyer des messages et des questions entre eux ainsi qu’aux présentateurs. Ils peuvent également participer en direct grâce aux fonctions audio et vidéo. Vous pouvez accéder à cette documentation à partir de la page d’accueil de l’application Breeze Manager, ainsi que du menu Aide dans une salle de réunion Breeze Meeting en sélectionnant Aide > Aide de Breeze Meeting. • Le Mode d’emploi de Macromedia Breeze Presenter décrit le plug-in permettant de créer des présentations Breeze à partir de PowerPoint. Vous pouvez accéder au Mode d’emploi de Macromedia Breeze Presenter à partir de la page d’accueil de Breeze Manager et du menu Breeze intégré à Microsoft PowerPoint en sélectionnant Breeze > Aide. Remarque : L’intérêt de ces guides dépend des applications installées sur la plate-forme de présentation Breeze, du type d’utilisateur (gestionnaire du contenu de la réunion, ingénieur informatique ou présentateur de cours) et des autorisations associées au compte Breeze de l’utilisateur. Guide des supports pédagogiques 11 Autres ressources Vous trouverez ci-dessous une liste de ressources disponibles sur le Web : Le Centre des développeurs Breeze, à l’adresse macromedia.com (www.macromedia.com/fr/ devnet/breeze/), contient des exemples de code, ainsi que des articles relatifs à l’intégration de Breeze. The Web Services Primer, à l’adresse 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 (www.macromedia.com/devnet/mx/coldfusion/articles/cf_handbk_ch6.html, en anglais uniquement) comporte des informations sur les notions de base du code XML et la rédaction de code avec CFML. (www.macromedia.com/devnet/mx/coldfusion/articles/ cf_handbk_ch7.html, en anglais uniquement) traite des services Web, du protocole SOAP (Simple Object Access Protocol) et des méthodes d’appel des services Web via CFML. « Leveraging XML with ColdFusion » (www.w3.org/TR/xslt) présente le code XSLT, que vous pouvez utiliser pour convertir les données en d’autres formats. La spécification XSL Transformations (XSLT) Numeric representation of Dates and Time (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. Plus spécifique, la note W3C relative à la date et à l’heure (www.w3.org/TR/NOTEdatetime) est consacrée au profil ISO 8601 retenu par Breeze. Conventions typographiques Ce manuel utilise les conventions typographiques suivantes : • Une police en italique indique une valeur qui doit être remplacée (par exemple, dans le chemin d’un dossier). • La police de code identifie le code. Elle met également en évidence le nom des API, des paramètres, des balises et des attributs. • Une police en gras désigne une citation ou un élément de menu. 12 Introduction : Avant de commencer CHAPITRE 1 Utilisation des API XML de Breeze Le modèle d’interface de programmation d’application (API) XML 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 API sur le serveur et recevoir les résultats formatés en tant que code XML. Vous pouvez utiliser les services Web pour ajouter le service de gestion et les fonctionnalités de création de rapports de Breeze sur votre système externe. Pour appeler les API XML de Breeze, vous pouvez utiliser tout langage capable de gérer XML via HTTP. Remarque : Breeze ne prend pas encore en charge le protocole SOAP (Simple Object Access Protocol). Le présent chapitre porte sur les flux de données entre le serveur Breeze et les applications Web, et indique comment définir les paramètres et les autorisations de sécurité. 13 Flux de données Le diagramme suivant illustre le flux de données dans une application Web qui interagit avec le serveur Breeze : Navigateur Web Etape 1 : Le navigateur Web demande une page. Requête Réponse Etape 7 : Le serveur Web envoie la page finale au navigateur ayant émis la requête. Serveur Web Etape 2 : Le serveur Web trouve la page et la passe au serveur d’applications. <HTML> <code> </HTML> Etape 6 : Le serveur d’applications insère des données dans la page, puis la passe au serveur Web. Etape 3 : Le serveur d’applications exécute du code. Etape 4 : Le serveur d’applications appelle l’API sur le serveur Breeze. <HTML> <p>Hi</p> </HTML> Serveur d'applications Action Données XML Etape 5 : Le serveur Breeze renvoie des données XML au serveur d’applications. Serveur Breeze L’exemple suivant décrit ce qui risque de se produire lorsqu’un utilisateur se connecte au portail de formation d’un site intranet créé avec Macromedia ColdFusion MX qui a recours aux services Web XML de Breeze : 1. Un utilisateur connecté se sert d’un navigateur Web pour demander une page qui affiche la liste des cours auxquels 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. 14 Chapitre 1 : Utilisation des API XML de Breeze 4. Lors de l’exécution du code, le serveur d’applications appelle une API sur le serveur Breeze de la société, afin d’obtenir la liste des cours. L’appel à l’API prend la forme d’une requête HTTP POST. 5. Le serveur Breeze exécute l’API et renvoie les données XML résultantes au serveur d’applications. 6. Le code du serveur d’applications analyse le code XML renvoyé, insère des données dans la page Web en fonction des besoins, puis passe la page finale au serveur Web. 7. Le serveur Web passe la page finale au navigateur, qui l’affiche. Appel d’une API sur le serveur Pour appeler une API sur le serveur Breeze, passez les paramètres appropriés au servlet de services Web à l’adresse http://nom_serveur/api/xml. Pour appeler les API XML de Breeze, vous pouvez utiliser tout langage capable de gérer XML via HTTP. Toutes les API requièrent le paramètre action, qui indique leur nom. Vous ajoutez le paramètre à l’URL du servlet de services Web, suivi d’une chaîne de requête, comme suit : action http://server_name/api/xml?action=action_name La plupart des API gèrent également d’autres paramètres. Pour plus d’informations sur les paramètres supplémentaires pris en charge par une API donnée, consultez la section correspondant à celle-ci dans le Chapitre 4, Informations de référence sur les API XML, page 41. 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 transmettezla au serveur sous forme de requête HTTP GET ou POST, le type de contenu HTTP étant réglé sur application/x-www-form-urlencoded. 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.example.com/ api/xml?action=nom_action. Les paramètres de l’API sont ajoutés en option et séparés par des symboles &. • Créez un objet XML contenant les paramètres sous forme de balises param imbriquées dans une balise params, puis envoyez une requête HTTP POST au serveur, le type de contenu HTTP étant réglé sur text/xml ou application/xml. Le code suivant appelle l’API login par le biais d’une requête HTTP GET : http://admin.breezecentral.com/api/ xml?action=login&[email protected]&password=foobar Le code ci-dessous est équivalent au code précédent, mais utilise POST plutôt que GET : <params> <param name="action">login</param> <param name="login">[email protected]</param> <param name="password">foobar</param> </params> Pour consulter un exemple de code indiquant comment appeler une API, reportez-vous au Chapitre 3, Tâches courantes, page 27. Appel d’une API sur le serveur 15 Remarque : Les exemples de code figurant dans le présent manuel utilisent des paramètres de requête, par souci de clarté et parce que l’utilisation du code CFML (Macromedia ColdFusion Markup Language) pour envoyer des objets XML contenant des paramètres est soumise à certaines limitations. Macromedia recommande d’utiliser si possible la méthode POST. En raison de la façon dont le code HTTP met en oeuvre les méthodes GET et POST, l’utilisation de POST permet parfois 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 Sécurité, page 18. Connexion à Breeze au préalable Seuls les utilisateurs connectés peuvent appeler la plupart des API. Par conséquent, vous devez appeler l’API login avant d’appeler la plupart des autres API. (Vous pouvez appeler les API suivantes sans vous connecter : 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é BREEZESESSION. Lorsque vous recevez les résultats d’un appel login, enregistrez la valeur de ce cookie. Vous devez inclure la valeur du cookie BREEZESESSION dans toutes les requêtes transmises ultérieurement avec cet identifiant. Dans le cas contraire, l’API échoue. Pour obtenir des exemples, consultez la section Connexion à Breeze, page 29. Votre application permet de connecter plusieurs utilisateurs et autorise chacun d’eux à appeler des API. Par exemple, lorsqu’un utilisateur ordinaire exécute votre application, il peut s’avérer utile d’utiliser les informations d’identification de cet utilisateur pour appeler des API, tout en conservant une connexion administrateur pour effectuer les tâches nécessitant ce niveau d’autorisation. Pour plus d’informations sur la sécurité dans Breeze, consultez la section Sécurité, page 18. Présentation des paramètres La plupart des API permettent de spécifier un ou plusieurs paramètres supplémentaires. (L’utilisation du paramètre action est obligatoire.) Pour plus d’informations, consultez la section Appel d’une API sur le serveur, page 15. Vous spécifiez généralement les paramètres sous forme de paire nom-valeur, mais le processus exact dépend du langage utilisé pour appeler l’API sur le serveur Breeze. Pour consulter un exemple de code en langage CFML (ColdFusion Markup Language), reportez-vous au chapitre Chapitre 3, Tâches courantes, page 27. Dans le chapitre consacré aux API, tous les paramètres recensés sont obligatoires. Les paramètres facultatifs sont signalés de façon explicite. Certaines API vous permettent de spécifier plusieurs paramètres du même nom. Par exemple, l’API principals-delete gère le paramètre principal-id. Vous pouvez spécifier plusieurs paires nom-valeur principal-id (portant toutes le nom principal-id) lorsque vous appelez l’API sur le serveur Breeze. 16 Chapitre 1 : Utilisation des API XML de Breeze L’exemple de code CFML suivant illustre la suppression de deux utilisateurs donnés par le biais d’un appel API unique en spécifiant deux paramètres principal-id. Cet exemple requiert l’utilisation des variables baseurl et loginCookie, que vous définissez lors du processus de connexion. Pour plus d’informations, consultez la section Intégration de Breeze à un service d’annuaire, page 33. <cfset idOne=12345> <cfset idTwo=23456> <cfhttp url="#baseurl#api/xml?action=principals-delete&principalid=#idOne#&principal-id=#idTwo#" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> Certaines API gèrent l’utilisation de jeux de paramètres multiples. Exemple : L’API groupmembership-update accepte les paramètres group-id, principal-id, et is-member. Pour effectuer des mises à jour multiples par le biais d’un appel unique, vous pouvez spécifier chacun de ces paramètres pour le mandant et le groupe, puis les spécifier à nouveau sous la même forme pour un autre élément, et ainsi de suite. Présentation des mandants, des SCO et des identifiants Breeze comporte deux types d’entités de base : les mandants et les SCO (Shareable Content Objects). Le terme mandant couvre toute entité qui dispose d’autorisations régissant ses interactions avec les SCO. Les types de mandants les plus courants correspondent à Utilisateur (un utilisateur spécifique) et Groupe (un groupe d’utilisateurs). Il existe d’autres types de mandants, appelés groupes prédéfinis : Administrateurs, Auteurs, Gestionnaires de formation, Gestionnaires d’événements, Responsables de réunion et Hôtes de séminaires. Vous pouvez créer des utilisateurs et des groupes et modifier leurs autorisations. Il est possible d’ajouter des utilisateurs et des groupes aux groupes prédéfinis, mais non de modifier les autorisations de ces derniers. Pour plus d’informations sur les groupes prédéfinis, consultez le manuel Mode d’emploi de Breeze Manager. Présentation des mandants, des SCO et des identifiants 17 Un SCO est un document Breeze, tel une réunion ou un événement. Un dossier est également un SCO. Breeze comprend les types de SCO suivants : SCO Description content Fichier ou ensemble de fichiers accessible en lecture seule transféré sur le serveur Breeze. Exemple : un fichier FLV, un fichier SWF, une image, un module ou un fichier HTML. curriculum Curriculum Breeze event Evénement Breeze folder Un dossier stocké sur le disque dur du serveur qui renferme un contenu Breeze. link Une référence à un autre SCO, utilisée par un curriculum pour accéder à d’autres SCO. Lorsqu’un contenu est ajouté à un curriculum, un lien est établi entre ce dernier et le contenu. meeting Réunion Breeze. tree La racine d’une arborescence de dossiers. La racine d’une arborescence est traitée en tant que hiérarchie indépendante. Vous ne pouvez pas déterminer le dossier parent d’une arborescence à partir de cette arborescence. Chaque mandant et SCO disposent d’un identifiant numérique unique. Lorsque vous appelez une API qui utilise l’identifiant d’une entité en tant que paramètre, le nom du paramètre indique le type d’entité auquel correspond l’identifiant, mais cet identifiant reste le même quel que soit le nom du paramètre. Les noms de paramètres associés aux identifiants incluent acl-id, folderid, group-id, parent-acl-id, principal-id, sco-id et user-id. Ainsi, pour mettre à jour un mot de passe utilisateur, appelez l’API user-update-pwd et indiquez l’identifiant de l’utilisateur sous la forme du paramètre user-id. Pour déterminer un nom d’utilisateur, appelez l’API principal-info et indiquez l’identifiant de l’utilisateur sous la forme du paramètre principal-id. Quelques autres types d’identifiants, tels account-id, answer-id, permission-id et question-id, ne sont pas associés à un mandant ou à un SCO. Dans la plupart des cas, un nom de paramètre qui se termine en -id indique que la valeur correspondante est un identifiant de mandant ou de SCO. Sécurité Le modèle de sécurité de Breeze garantit que tout code appelant une API donnée est habilité à le faire. Quasiment tout appel API doit comprendre un cookie représentant un utilisateur connecté spécifique. Pour plus d’informations, consultez la section Connexion à Breeze au préalable, page 16. Pour plus d’informations sur les codes d’état susceptibles d’être renvoyés par le serveur, consultez la section relative à la balise status. 18 Chapitre 1 : Utilisation des API XML de Breeze Présentation des autorisations Les autorisations régissent les interactions entre un mandant spécifique et un SCO. L’affectation d’autorisations à un mandant spécifique sur un SCO donné porte le nom de liste de contrôle des accès (ACL). Une ACL est capable de gérer les affectations d’autorisations entre l’objet et un mandant, mais n’en contient parfois pas. Toute ACL comprend trois informations : l’identifiant d’un SCO, d’un mandant ou d’un compte (généralement appelé identifiant d’ACL dans ce contexte), puis l’identifiant d’un mandant et un mot clé spécifiant les autorisations (généralement désigné comme identifiant d’autorisation). Breeze gère deux types d’autorisation : les autorisations associées à des SCO spécifiques et les autorisations qui s’appliquent à tous les utilisateurs appartenant à des groupes spéciaux, appelés groupes prédéfinis. Les autorisations relatives aux groupes prédéfinis priment sur les autorisations définies sur un SCO. Pour identifier les autorisations d’un utilisateur connecté sur un élément donné, appelez l’API Pour modifier les autorisations d’un mandant, appelez l’API principalupdate. permissions-info. Si un mandant ne dispose pas d’autorisations spécifiques sur un SCO donné, les autorisations de ce mandant sur le parent du SCO sont appliquées. Vous pouvez spécifier les autorisations suivantes sur un SCO : Autorisation Description Denied Le mandant ne peut ni afficher, ni gérer le SCO. Il lui est également impossible d’y accéder. Vous ne pouvez pas associer cette autorisation à des réunions ou des cours. Host (Réservée aux réunions) Cette autorisation se réfère à l’hôte d’une réunion. Elle permet au mandant de créer ou de présenter la réunion, même s’il ne dispose pas d’une autorisation View sur le dossier parent de la réunion. L’autorisation Presenter a été remplacée par Host. Le concept de présentateur dans Breeze 4 correspond à hôte dans Breeze 5.1. Manage Le mandant peut afficher, supprimer, déplacer et modifier le SCO. Cette autorisation permet également au mandant de définir des autorisations sur le SCO. Lorsqu’il s’agit d’un dossier, l’autorisation Manage permet au mandant d’afficher des rapports sur les fichiers que contient le dossier et de créer de nouveaux dossiers. Vous ne pouvez pas associer cette autorisation à des réunions ou des cours. Publish Le mandant peut publier le SCO sur le serveur et le mettre à jour. Cette autorisation inclut l’autorisation View. Elle permet également au mandant d’afficher des rapports relatifs au SCO. Pour un dossier, l’autorisation Publish ne permet pas au mandant de créer de nouveaux dossiers dans le dossier ou de définir des autorisations sur ce dernier. Vous ne pouvez pas associer cette autorisation à des réunions ou des cours. View Le mandant peut afficher le SCO, mais ne peut pas la modifier. Dans le cadre d’un cours, l’autorisation View permet au mandant de s’inscrire. Dans le cadre d’une réunion, elle permet au mandant de participer. Dans le cadre d’un dossier, elle permet au mandant d’afficher le contenu du dossier. Sécurité 19 Dans la mesure où un groupe est un mandant, vous pouvez affecter les autorisations citées cidessus sur un SCO à un groupe personnalisé comme à un utilisateur donné. Si un groupe dispose d’une autorisation spécifique, tous ses membres en héritent. Utilisez l’API group-membershipupdate pour ajouter un membre à un groupe. Utilisez l’API permissions-update pour définir les autorisations d’un groupe sur un SCO donné. Pour plus d’informations sur les groupes et les autorisations, consultez le chapitre 19, consacré aux utilisateurs et aux groupes, du manuel Mode d’emploi de Breeze Manager. Présentation de la sécurité et du lancement de contenu Lorsque vous lancez un SCO, vous devez vous authentifier. Pour ce faire, procédez comme suit, au choix : • Lorsque vous ouvrez l’URL du contenu, ajoutez le paramètre de requête session, dont la valeur doit être égale à celle du cookie de connexion BREEZESESSION, ainsi que l’illustre l’exemple ci-dessous : http://breeze.example.com/p12345678/?session=breez3238uf298 Dans la mesure où toute personne disposant de l’URL spécifiée peut se comporter comme un utilisateur connecté, cette approche présente des risques potentiels du point de vue de la sécurité. Par conséquent, utilisez le cookie d’un utilisateur ordinaire, plutôt que celui d’un administrateur. Par ailleurs, si des utilisateurs transmettent l’URL à un collègue (par le biais d’une opération copier-coller dans un message électronique, par exemple), ils donnent accès à leur compte, soit un risque d’atteinte à la sécurité. • Vous pouvez définir un cookie BREEZESESSION sur le navigateur d’un utilisateur en appliquant la valeur du cookie de connexion. Cependant, cette approche ne fonctionne que si votre application tourne sur un serveur utilisant le même nom de domaine que le serveur Breeze. Par ailleurs, si votre serveur d’applications réside dans un environnement de servlet J2EE (tel que Macromedia ColdFusion ou Java), il risque d’utiliser également le cookie BREEZESESSION, d’où un conflit potentiel 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 sûre, mais moins pratique du point de vue des utilisateurs. 20 Chapitre 1 : Utilisation des API XML de Breeze CHAPITRE 2 Utilisation de filtres Les données et informations stockées dans le référentiel de contenu Macromedia Breeze de votre société risquent de se multiplier au fil du temps. Si tel est le cas, il est parfois préférable de ne pas répertorier chaque élément du référentiel à l’intention de tous les utilisateurs. Vous pourriez par exemple recenser les cours les plus récents et la présentation consacrée aux résultats financiers du dernier trimestre sur votre intranet d’entreprise. Il est impératif de trier et d’organiser votre référentiel dont le volume va croissant pour assurer aux utilisateurs des délais de recherche d’informations réduits. Dans les services Web XML de Macromedia Breeze, l’utilisation de filtres vous permet de définir des critères de recherche de données à partir de Breeze. Utilisez un ou plusieurs filtres associés à une API XML déterminée pour garantir que les données consultées par les utilisateurs répondent exactement à leurs besoins. Présentation des filtres Vous pouvez associer un filtre à la plupart, mais non à la totalité, des champs dans le code XML. Vous pouvez également inclure ou inclure des valeurs de champ. Vous pouvez aussi trier les résultats et filtrer les données renvoyées pour réduire le nombre de résultats (les 25 premières lignes correspondantes, par exemple). Les filtres sont combinés aux appels d’action pour modifier ou classer les données renvoyées par le serveur Breeze. Ils vous aident à sélectionner des données, à en exclure, voire à trier les données à afficher. Vous pouvez par exemple demander l’affichage de tous vos cours ou utiliser un filtre pour ne sélectionner que les cours qui incluent le terme « Java ». Vous pouvez également répertorier tous les utilisateurs ou ne sélectionner que les utilisateurs dont le nom de famille correspond à Dupont et les trier par nom de connexion. Pour utiliser un filtre, ajoutez-le à un appel d’action en le précédant du symbole &, comme suit : report-my-course&filter-like-name=Java Pour combiner plusieurs filtres, séparez chacun d’eux à l’aide du symbole &, comme suit : report-my-course&filter-like-name=Java&sort-date-begin=desc 21 Comme vous pouvez le constater, les filtres comprennent un type (filter ou sort) et un modificateur facultatif (tel like), le nom du champ (tel name), le cas échéant, et enfin la valeur du nom du champ (tel Java). Le format du filtre est le suivant : Type-Modifier-FieldName=Value Il existe deux types de filtre : un filtre de base, qui débute par le terme filter, et un filtre de tri, qui débute par le terme sort. Vous pouvez combiner ces deux types de filtre pour obtenir le résultat escompté. Pour plus d’informations sur les filtres, consultez la section Présentation des filtres de tri, page 23. Exemples de filtre L’exemple ci-dessous est simple et permet d’illustrer le fonctionnement général des filtres. L’API de service Web report-my-courses renvoie la liste des cours auxquels vous vous êtes inscrits. Associée à un filtre portant sur le nom des cours, tel report-my-courses&filter-likename=Java, cette même API extrait les cours dont le titre contient le texte indiqué, soit dans ce cas Java. Si vous ajoutez un filtre de tri tel que report-my-course&filter-likename=Java&sort-date-begin=desc, Breeze trie vos cours Java et affiche en tête de liste le cours que vous avez commencé. Ces exemples illustrent l’utilisation de deux types de filtre : de base et de tri. Le filtre de base associe le modificateur like au champ name et spécifie la valeur Java. Si vous n’indiquez pas le modificateur like, Breeze renvoie les cours dont le titre correspond exactement à Java, plutôt que ceux dont le titre inclut Java. L’utilisation du filtre de tri sans modificateur sur le champ datebegin avec la valeur desc spécifie un ordre de tri décroissant. Le tableau ci-dessous indique quelques autres exemples qui vous permettront d’assimiler les principes de base des filtres. Filtre Description filter-name=Analyse des objectifs Renvoie les éléments hébergés sur le serveur dont le nom correspond à « Analyse des objectifs ». Sont inclus les réunions, les cours ou tout élément associé à un champ name. filter-like-name=Objectifs Renvoie tous les éléments dont le nom comporte le terme « Objectifs », tel « Analyse des objectifs » ou « Objectifs trimestriels ». filter-out-name=Etat Exclut tous les éléments dont le champ name contient le terme « Etat ». filter-like-name=Objectifs &filter-out- Renvoie tous les éléments dont le nom contient le status=active terme « Objectifs » qui ne sont plus actifs. Vous pouvez utiliser ce filtre pour extraire d’anciennes présentations consacrées aux « objectifs » de trimestres antérieurs. 22 filter-gt-date-begin=2004-05-01&sortname=asc Renvoie tous les éléments dont la date de début est antérieure au 1er mai 2004, triés par nom par ordre croissant. filter-gt-date-begin=2004-0501&filter-lt-date-begin=2004-05-31 Renvoie tous les éléments débutés en mai 2004. Chapitre 2 : Utilisation de filtres Présentation des formats de date Dans Breeze, les dates correspondent à un type spécial de valeur de champ conforme à la norme ISO 8601. Ainsi, le 28 mai 2004 est exprimé sous la forme 2004-05-28, 16:23 le 28 mai 2004 est exprimé sous la forme 2004-05-28T16:23:00.000. A partir de l’année, vous pouvez utiliser toute section de date requise pour filtrer les résultats. L’utilisation de la valeur 2004 renvoie tous les éléments correspondant à cette année, ce qui ne constitue probablement pas un usage judicieux des filtres. En spécifiant l’année et le mois, vous pouvez extraire tout élément associé à un mois spécifique. Libre à vous d’ajouter d’autres sections de la date pour sélectionner les données hébergées sur le serveur les plus précises. Présentation des filtres de tri Les filtres de type sort vous permettent de trier les données par ordre croissant ou décroissant. Ainsi, le filtre ci-dessous tri le champ name par ordre croissant : sort-name=asc Le code suivant trie le champ name par ordre décroissant : sort-name=desc Vous pouvez également effectuer des tris primaires et secondaires. Par exemple, si vous appelez l’action principal-list pour répertorier les mandants, vous pouvez effectuer un tri primaire sur le champ type, puis un tri secondaire sur le champ name. Tous les mandants d’un type déterminé sont ainsi regroupés et triés par nom dans chaque groupe. Pour ce faire, vous spécifiez les paramètres suivants : sort1-type=asc&sort2-name=desc Exemples de filtres spéciaux Les exemples de filtrage de données ci-dessous varient selon l’action. Pour plus d’informations sur les options de tri et de filtrage associées à des actions spécifiques, consultez les sections correspondantes dans le Chapitre 4, Informations de référence sur les API XML, page 41. Filtrage de données basé sur un champ type Vous pouvez exclure une combinaison de types d’entrées ou n’afficher que celle-ci. Ainsi, le filtre suivant n’affiche que les types folder (dossier) et meeting (réunion) : filter-type=folder&filter-type=meeting L’exemple suivant affiche tous les types de données, à l’exception de folder meeting (réunion) : (dossier) et filter-out-type=folder&filter-out-type=meeting Si le champ type gère la valeur null, vous pouvez exclure les entrées contenant des valeurs null et non null. L’exemple suivant n’affiche que les types null : filter-type=null L’exemple suivant n’affiche que les types non null : filter-out-type=null Exemples de filtres spéciaux 23 Filtrage de données basé sur la date d’un enregistrement L’exemple suivant affiche tous les enregistrements dont la date de modification est comprise entre le 1er juillet et le 10 juillet : filter-lt-date-modified=2004-07-10T10:00:00.000-07:00&filter-gt-datemodified=2004-07-1T10:00:00.000-07:00 Filtrage d’un nombre spécifique d’entrées à partir d’une entrée déterminée La technique suivante vous permet de créer une pagination lorsque le volume de données excède une page. L’exemple ci-dessous affiche 25 enregistrements à partir du 100e enregistrement : filter-rows=25&filter-start=100 Filtrage basé sur l’appartenance à des groupes standard Pour effectuer un filtrage basé sur l’appartenance à des groupes standard, filtrez par champ type, comme suit : action=principal-list&filter-type=admins N’utilisez pas le champ name pour baser le filtrage sur l’appartenance à des groupes standard, car les noms de groupe risquent d’être modifiés et ne sont donc pas fiables. L’exemple suivant illustre une technique incorrecte de filtrage basé sur l’appartenance à des groupes : action=principal-list&filter-name=Account Administrators Liste des filtres gérés Les filtres comprennent un type (filter ou sort), un modificateur facultatif, le nom du champ, le cas échéant, puis la valeur du champ, ainsi que l’illustre l’exemple ci-dessous : Type-Modifier-FieldName=Value Le tableau ci-dessous répertorie tous les types de filtres et modificateurs gérés par Breeze. 24 Type Modificateur Description filter (aucun) Le champ doit correspondre exactement à la valeur indiquée. filter like Le champ doit impérativement contenir une valeur. filter out Le champ ne doit pas contenir la valeur spécifiée. filter rows Limite les résultats renvoyés au nombre de lignes indiqué par la valeur. Les noms de champ ne sont pas utilisés. filter start Limite les résultats renvoyés au nombre de lignes indiqué par la valeur. Les noms de champ ne sont pas utilisés. filter gt Sélectionne tous les éléments supérieurs à la valeur indiquée. Cette syntaxe est réservée aux dates. filter lt Sélectionne tous les éléments supérieurs à la valeur indiquée. Cette syntaxe est réservée aux dates. Chapitre 2 : Utilisation de filtres Type Modificateur Description filter gte Sélectionne tous les éléments supérieurs ou égaux à la valeur indiquée. Cette syntaxe est réservée aux dates. filter lte Sélectionne tous les éléments inférieurs ou égaux à la valeur indiquée. Cette syntaxe est réservée aux dates. sort (aucun) Trie les résultats. La valeur doit correspondre à asc ou desc. Test du code dans un navigateur Vous pouvez entrer une URL test dans le champ d’adresse d’une fenêtre de navigateur et observer la réponse XML du serveur. Nous vous recommandons de vous familiariser avec les filtres dans un navigateur avant de rédiger du code. Les subtiles différences entre les filtres déterminent le type de filtre à utiliser avec certains appels d’API. L’utilisation du navigateur vous permet d’essayer rapidement diverses combinaisons et de vous rendre ainsi compte des syntaxes qui fonctionnent et de celles qui ne fonctionnent pas. Appliquée hors du navigateur, cette technique nécessite de compiler le code, de charger le résultat sur votre serveur d’applications et de le déboguer pour vérifier si un filtre mène au résultat escompté. L’utilisation d’un navigateur est en revanche beaucoup plus rapide et donne lieu à un résultat immédiat. Vous pouvez ainsi utiliser l’URL et le filtre ci-dessous pour afficher tous les cours dont le titre contient le terme filter (filtre) et la description inclut le terme date. Cet exemple d’URL fait appel au serveur breezedev.mycompany.com. Connectez-vous d’abord au serveur, puis tapez l’URL ci-dessous en substituant votre serveur à breezedev.mycompany.com : http://breezedev.mycompany.com/api/xml?action=report-my-courses&filter-likename=filter&filter-like-description=date Le résultat renvoyé dans le navigateur devrait être similaire au code ci-dessous : <?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <my-courses> <course sco-id="2649026" status="active" type="course"> <name>Understanding Filters Part 2</name> <description>Second course in the series, covering important topics such as date and range filtering.</description> <url>admin.ibreeze.macromedia.com/p40583853/</url> <date-created>2004-05-26T17:51:40.840-07:00</date-created> <date-modified>2004-05-26T17:51:47.750-07:00</date-modified> <date-begin>2004-05-24T14:00:00.000-07:00</date-begin> <url-path>/p40583853/</url-path> <expired>false</expired> </course> </my-courses> </results> Test du code dans un navigateur 25 Si vos filtres sont trop stricts et qu’aucun cours ne répond aux critères définis, la sortie est similaire au code ci-dessous : <?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <my-meetings /> </results> Enfin, en essayant divers filtres et API dans le navigateur, vous risquez d’obtenir une réponse inattendue. Ainsi, si vous associez à un filtre un nom de champ incorrect, qui correspond à un autre élément de la base de données, vous pourriez recevoir une réponse XML débutant comme suit : <?xml version="1.0" encoding="utf-8" ?> <results> <status code="internal-error"> Pour que votre code puisse être utilisé dans un environnement de production, assurez-vous qu’il prend en charge les erreurs et situations inattendues. Vérifiez la présence de codes d’état inattendus et, si vous en rencontrez, avertissez le service informatique de votre entreprise. Pour en savoir plus Le Centre de développement Macromedia Breeze contient un article intitulé « Working with Filters » (Utilisation des filtres) qui décrit la procédure de construction d’un exemple d’application qui utilise des filtres pour rechercher et trier une liste de cours. Cet article vous apprend à utiliser des filtres avec les services Web de Breeze par le biais d’un exemple simple, qui extrait la liste des cours auxquels s’est inscrit un utilisateur, puis permet à ce dernier d’effectuer des recherches et de trier la liste. Il vous explique en outre l’impact des filtres sur l’optimisation des données extraites en vue d’une utilisation dans d’autres systèmes d’entreprise. 26 Chapitre 2 : Utilisation de filtres CHAPITRE 3 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 effectuer ces tâches, vous appelez une ou plusieurs API sur le serveur Breeze, puis vous analysez les balises XML renvoyées par le serveur. Dans certains cas, vous utilisez les informations renvoyées comme paramètres pour l’API suivante. Ce chapitre comporte des exemples de code montrant la mise en œuvre de certaines tâches à l’aide du langage Macromedia CFML (ColdFusion Markup Language). Remarque : Certaines descriptions de tâche ne sont pas accompagnées d’exemples de code. La syntaxe d’appel d’une API est similaire pour toutes les API. Il est donc possible d’utiliser les exemples de code fournis comme modèles pour accomplir d’autres tâches. Pour obtenir une description détaillée de chaque API et balise XML, consultez le Chapitre 4, Informations de référence sur les API XML, page 41 et le Chapitre 5, Informations de référence sur les résultats XML, page 145. Ce chapitre passe en revue les tâches suivantes : Appel de la première API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Connexion à Breeze . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Création d’un utilisateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Ajout d’un utilisateur dans un groupe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Création d’une réunion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Création d’une réunion à partir d’un modèle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Affichage des réunions, des cours et des événements d’un utilisateur . . . . . . . . . . . . . . . . . . . . 31 Création et gestion de cursus de formation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Intégration de Breeze à un service d’annuaire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Intégration de Breeze à un portail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Génération de rapports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 27 Appel de la première API Vous pouvez entrer une URL test dans le champ d’adresse d’une fenêtre de navigateur et observer dans cette dernière la réponse XML du serveur. Le code XML renvoyé est identique au code XML résultant de l’appel de l’API dans une application. Il est recommandé de se familiariser avec les appels d’API dans le navigateur avant de rédiger du code dans une application. Pour appeler la plupart des API, vous devez être connecté à Breeze. (Les API action-list, common-info, login et user-accounts ne nécessitent pas de connexion préalable .) Il est recommandé d’appeler en premier lieu l’API action-list, car elle ne requiert pas de connexion préalable et renvoie une liste d’API que vous pouvez appeler. Pour appeler une API, vous devez connaître les éléments suivants : • Le domaine de votre compte Breeze. Exemple : breeze.votreentreprise.com. • Le nom de l’API que vous voulez appeler. Pour obtenir la liste complète des API, consultez le chapitre Informations de référence sur les API XML, page 41. Pour appeler une API Breeze dans un navigateur : 1. Ouvrez une fenêtre de navigateur. 2. Tapez l’adresse du serveur Breeze dans la barre d’adresse du navigateur. Ajoutez le paramètre action dans une chaîne de requête : http://breeze.example.com/api/xml?action=action_name 3. Appuyez sur Entrée (Windows) ou Retour (Macintosh). L’API renvoie le code XML résultant dans la fenêtre du navigateur. Ainsi, un appel de l’API action-list renvoie le code XML suivant : <results> <status code="ok"/> <actions> <action>accesskey-info</action> <action>account-contact-update</action> <action>acl-field-info</action> <action>acl-field-list</action> <action>acl-field-update</action> <action>acl-preference-update</action> <action>action-list</action> ... list of actions continues... </actions> </results> Vous pouvez également tester les filtres dans le navigateur. Pour plus d’informations, consultez la section Test du code dans un navigateur, page 25. 28 Chapitre 3 : Tâches courantes Connexion à Breeze La plupart des API nécessitent une connexion préalable. Par conséquent, vous devez appeler l’API login avant la plupart des autres API. (Seules les API action-list, common-info, login et user-accounts font exception à la règle.) Lorsque vous appelez l’API login, si le résultat XML comprend le code d’état ok, l’en-tête de réponse inclut le cookie BREEZESESSION. Capturez le cookie et enregistrez les résultats dans une variable, telle loginCookie. Passez ensuite la variable loginCookie sous forme de paramètre session dans les appels d’API suivants. Pour vous connecter à Breeze : 1. Créez une page ColdFusion au contenu suivant : <cfif IsDefined("FORM.username")> <cfset baseurl = "http://breezeserveraddress"> <cfhttp url="#baseurl#/api/ xml?action=login&login=#FORM.username#&password=#FORM.password#" method="GET"/> <!-- placer la réponse dans une variable, puis dans un objet XML --> <cfset response = CFHTTP.FileContent/> <cfset xml = XMLParse(response)> <!-- extraire l’identifiant de BREEZESESSION de l’en-tête--> <cfset loginHeader = CFHTTP.header> <cfset loginCookie = ListLast(ListFirst(loginHeader, ";"), "=")> <cfif xml.XmlRoot.status.XMLAttributes['code'] EQ "OK"> <!-- Connexion réussie. --> <cfhttp url="#baseurl#/api/xml?action=report-mymeetings&session=#loginCookie#" method="GET"/> <cfset meetings = CFHTTP.FileContent/> <cfset meetings_xml = XMLParse(meetings)/> <cfdump var="#meetings_xml#"> <cfelse> <!-- Echec de connexion. --> Login Failed. </cfif> <cfelse> <form action="#CGI.Script_Name#" method="POST"> Username: <input type="text" name="username" size="25"><br> Password: <input type="password" name="password" size="25"><br> <input type="submit" name="submit" value="Submit"><br> </form> </cfif> 2. Enregistrez la page sous le nom login.cfm dans le répertoire ColdFusion wwwroot. 3. Affichez login.cfm dans un navigateur (utilisez une URL localhost). Connexion à Breeze 29 Examen du code Le tableau ci-dessous décrit le code mis en évidence et sa fonction. Code Description <cfif IsDefined("FORM.username")> Vérifie si la variable username est définie. Si tel est le cas, le bloc de code suivant s’exécute. Dans le cas contraire, l’utilisateur entre un nom d’utilisateur (et un mot de passe) dans le formulaire qui s’affiche. <cfset baseurl = "http:// breezeserveraddress"> <cfhttp url="#baseurl#/api/ xml?action=login&login=#FORM.username#& password=#FORM.password#" method="GET"/ > Si la variable username est définie, ce code règle la variable baseurl sur le nom du serveur Breeze. Il utilise la variable baseurl dans la balise <cfhttp> pour appeler l’API login sur le serveur Breeze. L’API login nécessite deux paramètres, login et password, qu’un utilisateur tape dans un formulaire. <cfset response = CFHTTP.FileContent/> <cfset xml = XMLParse(response)> Place les données renvoyées par l’appel <cfhttp> dans la variable response. La seconde ligne convertit les données de chaîne placées dans la variable response en un document XML et les mémorise dans la variable xml. <cfset loginHeader = CFHTTP.header> <cfset loginCookie = ListLast(ListFirst(loginHeader, ";"), "=")> Place les données extraites de l’en-tête renvoyées par l’appel <cfhttp> dans la variable loginHeader. La deuxième ligne analyse l’en-tête pour extraire la valeur du cookie BREEZESESSION et la mémorise dans la variable loginCookie. <cfif Vérifie si l’attribut du code d’état que contient la xml.XmlRoot.status.XMLAttributes[’code’ réponse XML correspond à ok. ] EQ "OK"> <!-- Connexion réussie. --> 30 <cfhttp url="#baseurl#/api/ xml?action=report-mymeetings&session=#loginCookie#" method="GET"/> <cfset meetings = CFHTTP.FileContent/ > <cfset meetings_xml = XMLParse(meetings)/> <cfdump var="#meetings_xml#"> Si le code d’état correspond à ok, l’appel de l’API login a réussi et l’utilisateur est connecté. Vous pouvez maintenant passer la variable loginCookie en tant que paramètre session pour vous conduire comme un utilisateur connecté et appeler toute API. Ce code appelle l’API report-my-meetings, place la réponse dans la variable meetings et convertit la variable meetings en objet document XML. <cfelse> <!-- Echec de connexion. --> Login Failed. </cfif> Si l’attribut du code d’état figurant dans la réponse XML de l’API login ne correspondait pas à ok, imprimez Login Failed. <cfelse> <form action="#CGI.Script_Name#" method="POST"> Username: <input type="text" name="username" size="25"><br> Password: <input type="password" name="password" size="25"><br> <input type="submit" name="submit" value="Submit"><br> </form> </cfif> Si FORM.username n’est pas défini, vous devez taper un nom d’utilisateur et un mot de passe dans le formulaire qui s’affiche. Chapitre 3 : Tâches courantes Création d’un utilisateur Pour créer un utilisateur, appelez l’API principal-update en spécifiant les paramètres suivants : first-name, last-name, login, password, has-children et type (user ou group). Le code suivant crée un utilisateur associé au compte Breeze hébergé sur breezeserveraddress : http://breezeserveraddress/api/xml?action=principal-update&firstname=Will&last-name=Tip&[email protected]&password=66Mustang&haschildren=0&type=user Ajout d’un utilisateur dans un groupe Pour ajouter un utilisateur à un groupe, appelez l’API group-membership-update. Pour ajouter un utilisateur à un groupe par le biais de l’API XML, procédez comme suit : 1. Le cas échéant, créez l’utilisateur. Exemple : http://breezeserveraddress/api/xml?action=principal-update&firstname=Will&last-name=Tip&[email protected]&password=66Mustang&haschildren=0&type=user 2. Dans le code XML renvoyé, recherchez ce nouvel utilisateur ou un utilisateur en cours et prenez la valeur de principal-id. 3. Appelez group-membership-update et passez la valeur principal-id de l’utilisateur à ajouter au groupe, comme suit : http://breezeserveraddress/api/xml?action=group-membership-update&groupid=1222&principal-id=1822&is-member=true Prenez note des éléments suivants : ■ ■ ■ Passez la valeur principal-id de l’utilisateur à ajouter à ce groupe. Extrayez la valeur group-id du groupe auquel doit appartenir l’utilisateur et passez-la en tant que paramètre group-id. Utilisez le paramètre is-member pour ajouter ou supprimer un utilisateur : true ajoute l’utilisateur, false le supprime. Affichage des réunions, des cours et des événements d’un utilisateur Pour afficher les réunions et les cours d’un utilisateur, appelez les API report-my-meetings, report-my-courses et report-my-events. Vous pouvez trier et filtrer le code XML renvoyé pour limiter les résultats. Ainsi, le code suivant répertorie les réunions d’un utilisateur par ordre croissant en fonction de leur date de début : http://breezeserveraddress/api/xml?action=report-my-meetings&sort-datebegin=asc&session=#loginCookie# Remarque : Pour obtenir des informations plus détaillées sur le paramètre session, reportez-vous à la section Connexion à Breeze. Affichage des réunions, des cours et des événements d’un utilisateur 31 Création d’une réunion Pour créer une réunion, vous devez disposer des autorisations appropriées. Lorsque vous utilisez l’API XML, il est nécessaire de créer un compte d’administrateur doté de privilèges Administrateur de compte pour effectuer les tâches administratives associées à un compte Breeze. Pour créer une réunion, appelez l’API sco-update lorsque vous êtes connecté au compte d’administrateur. Le code suivant permet de créer une réunion : http://breezeserveraddress/api/xml?action=sco-update&folder-id=15&datebegin=2005-01-01T01:00:00.000-05:00&date-end=2005-01-02T01:00:00.00005:00&description=2005-D003&name=Test%20Meeting&type=meeting Création d’une réunion à partir d’un modèle Les modèles sont tout simplement des réunions stockées dans un dossier. Ainsi, pour répertorier les modèles disponibles, appelez l’API sco-shortcuts et prenez la valeur sco-id du dossier requis dans le code XML renvoyé. Le code suivant appelle l’API : http://breezeserveraddress/api/xml?action=sco-shortcuts Le code suivant est un exemple de code XML renvoyé : <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="181230" sco-id="181577" type="my-meeting-templates"> <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> </shortcuts> </results> Après avoir localisé le raccourci de type my-meeting-templates, appelez l’API sco-contents et passez la valeur my-meeting-templates en tant que paramètre sco-id. Le code XML renvoyé par l’appel à l’API suivante répertorie tous les modèles disponibles : http://breezeserveraddress/api/xml?action=sco-contents&sco-id=181577 Pour définir le modèle lorsque vous créez un SCO (réunion), appelez sco-update pour créer le SCO et ajoutez le paramètre suivant : source-sco-id=sco id of your template Remarque : Cette technique ne fonctionne que lorsque vous créez la réunion. Ultérieurement, la valeur de source-sco-id n’a plus d’importance, car Breeze ne définit pas le modèle. 32 Chapitre 3 : Tâches courantes Création et gestion de cursus de formation Pour créer et gérer des cursus de formation, utilisez les API suivantes : learning-path-info, learning-path-update et user-transcript-update. Appelez learning-path-info pour découvrir les restrictions qui s’appliquent à un objet d’étude qui crée le cursus de formation (objets d’étude à terminer, le cas échéant, avant de passer à l’objet d’étude suivant, par exemple). Appelez learning-path-update pour modifier le cursus de formation en changeant les conditions ou l’évaluation initiale requises pour un objet d’étude spécifique. 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, tel LDAP (Lightweight Directory Access Protocol). Breeze permet d’importer ou de synchroniser ces informations à partir de ce service d’annuaire. La procédure ci-dessous décrit 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, les informations provenant du service d’annuaire sont correctes et actuelles. Pour synchroniser Breeze avec le service d’annuaire : 1. Connectez-vous en appelant l’API login sur le serveur Breeze et spécifiez le nom de connexion et le mot de passe d’un administrateur de compte. Dans les en-têtes HTTP renvoyés, recherchez la valeur du cookie BREEZESESSION. Ce paramètre est nécessaire pour appeler les API suivantes. Remarque : Il peut être utile de créer un utilisateur doté de privilèges d’administration, spécifiquement chargé des synchronisations. Dans ce cas, il est conseillé d’exclure cet utilisateur de la liste des utilisateurs à synchroniser. L’exemple de code suivant ouvre une session utilisateur et récupère la valeur du cookie : <cfset login="[email protected]"> <cfset password="abcdefg"> <cfset baseurl="http://breeze.example.com/"> <cfset params="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 "BREEZESESSION"> <cfset fullCookie= mid(c, len(cookieName)+2, len(c)-len(cookieName)+1) /> <cfset loginCookie= Left(fullCookie, Find('.', fullCookie)-1) /> </cfif> </cfloop> </cfif> </cfloop> Intégration de Breeze à un service d’annuaire 33 2. Pour vérifier que l’API 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’état ne correspond pas à ok, déterminez l’origine de l’erreur et prenez les mesures appropriées, comme suit : <cfset xml= XmlParse(cfhttp.FileContent)> <cfset resultsElement= XmlSearch(xml, "//status[@code='ok']")> <cfif ArrayLen(resultsElement) neq 1> <!--- Pas de code d’état "ok". Vérifier les autres codes d’état pour traiter les erreurs. ---> </cfif> 3. Demandez au serveur Breeze la liste des utilisateurs de Breeze en appelant l’API principallist. 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 la section Présentation des mandants, des SCO et des identifiants, page 17.) Le code ci-dessous appelle l’API principal-list. Notez que la valeur du cookie reçue à l’étape précédente est passée en paramètre HTTP. <cfhttp url="#baseurl#api/xml?action=principal-list" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> Remarque : Cette requête HTTP utilise la méthode POST plutôt que GET, car seul POST permet de spécifier un paramètre HTTP en CFML. Toutefois, l’URL et les paramètres de la requête sont les mêmes que pour GET. 4. Pour vérifier que l’API s’est terminée correctement, analysez le code XML renvoyé et vérifiez que la valeur de l’attribut code de la balise status est réglée sur ok. Pour éviter les résultats inattendus, il est conseillé de vérifier la balise status du code XML renvoyé après chaque API 5. Si le code d’état correspond à ok, recherchez dans la liste des mandants renvoyée tous les mandants dont l’attribut type correspond à user. L’exemple ci-dessous place la liste de tous les utilisateurs de Breeze dans le tableau allUsers. <cfset xmlPrincipalList= XmlParse(cfhttp.FileContent)> <cfset allUsers = XmlSearch(xmlPrincipalList, "//principal [@type='user']")> 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 extraites des balises login associées aux utilisateurs de Breeze aux adresses e-mail du service d’annuaire, en utilisant l’algorithme de comparaison de listes de votre choix. a Déterminez les utilisateurs qui figurent dans le service d’annuaire mais pas dans Breeze ; ces nouveaux utilisateurs doivent être ajoutés à Breeze. b Déterminez ensuite les utilisateurs qui figurent dans Breeze, mais pas dans le service d’annuaire ; ces utilisateurs doivent être supprimés de Breeze. c Déterminez les utilisateurs qui apparaissent à la fois dans Breeze et dans le service d’annuaire, mais sous des noms différents ; leurs noms doivent être modifiés dans Breeze. 34 Chapitre 3 : Tâches courantes 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 le nom de connexion de chaque utilisateur. Dans Breeze, le nom de connexion de l’utilisateur correspond généralement à son adresse électronique. b Appelez l’API principal-update en réglant le paramètre type sur user. Ne spécifiez pas de paramètre principal-id. L’absence de principal-id indique en effet que vous n’actualisez pas un utilisateur existant, mais que vous ajoutez un nouvel utilisateur. c Dans le code XML renvoyé, vérifiez que le code d’état correspond à ok. L’exemple de code ci-dessous montre comment ajouter un utilisateur à Breeze. Il fait appel à des variables définies antérieurement, telle baseurl. Pour préserver la simplicité et la clarté de l’exemple, ce code spécifie les informations sur l’utilisateur dans les premières lignes, au lieu de les extraire d’un service d’annuaire. <cfset newlogin= "[email protected]"> <cfset newpass= "abcdefg"> <cfset newfirst= "Jake"> <cfset newlast= "Doe"> <cfhttp url="#baseurl#api/xml? action=principal-update&first-name=#newfirst# &last-name=#newlast#&has-children=0&login=#newlogin# &type=user" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> <!--- Vérifier la présence du code d’état ok. ---> <cfset xml= XmlParse(cfhttp.FileContent)> <cfset resultsElement= XmlSearch(xml, "//status[@code='ok']")> <cfif ArrayLen(resultsElement) neq 1> <!--- Pas de code d’état "ok". Vérifier les autres codes d’état pour traiter les erreurs. ---> </cfif> 9. Supprimez chaque utilisateur répertorié dans Breeze, mais non dans le service d’annuaire de Breeze en appelant l’API principals-delete et en spécifiant l’identifiant de l’utilisateur. 10. Pour chaque utilisateur supprimé, vérifiez que le code d’état correspond à ok dans le code XML renvoyé. L’exemple de code ci-dessous indique comment supprimer un utilisateur spécifique : <cfset userID= "503123"> <cfhttp url="#baseurl#api/xml? action=principals-delete&principal-id=#userID#" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> <!--- Vérifier la présence du code d’état "ok". ---> <cfset xml= XmlParse(cfhttp.FileContent)> <cfset resultsElement= XmlSearch(xml, "//status[@code='ok']")> <cfif ArrayLen(resultsElement) ne 1> <!--- Pas de code d’état "ok". Vérifier les autres codes d’état pour traiter les erreurs. ---> </cfif> Intégration de Breeze à un service d’annuaire 35 11. Extrayez l’identifiant de chaque utilisateur dont les informations mémorisées dans Breeze doivent être actualisées, comme suit : a Examinez les données renvoyées par l’API principal-list dans le cadre des étapes 2 à 4 et recherchez l’identifiant associé au nom de connexion de l’utilisateur. b Appelez l’API principal-info pour extraire les anciennes valeurs de prénom et de nom de l’utilisateur. c Effectuez les modifications requises pour que ces valeurs soient identiques à celles que contient le service d’annuaire. d Appelez l’API principal-update. e Dans le code XML renvoyé, vérifiez que le code d’état correspond à ok. L’exemple de code ci-dessous ne comporte pas de code permettant d’appeler principalou de vérifier le code d’état, puisque ces procédures ont été décrites ci-dessus : update <cfset principal= XmlSearch(xmlPrincipalList, "//principal[login='#login#']")> <cfset principalId= principal[1].XmlAttributes["principal-id"]> <cfhttp url="#baseurl#api/xml? action=principal-info&principal-id=#principalId# " method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> ... <!--- Ajouter ici le code de vérification de la présence du code d’état "ok". ---> ... <cfset xml= XmlParse(cfhttp.FileContent)> <cfset firstElement= XmlSearch(xml, "results/contact/first-name")> <cfset firstName= 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’état "ok". ---> 36 Chapitre 3 : Tâches courantes Intégration de Breeze à un portail Supposons que vous administriez une application portail, tel le portail de l’intranet de votre entreprise. Vous pouvez intégrer Breeze à ce portail pour permettre aux utilisateurs d’afficher et de modifier les informations relatives à Breeze dans le contexte du portail. Cela permettra par exemple aux utilisateurs de voir les prochaines réunions Breeze et de consulter la liste des cours auxquels ils sont inscrits. Les procédures décrites dans cette section indiquent comment accomplir 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 le nom de connexion et le mot de passe de cet utilisateur. 2. Appelez l’API login sur le serveur Breeze en utilisant le nom de connexion et le mot de passe spécifiés. 3. Dans le code XML renvoyé, vérifiez que le code d’état correspond à ok. Si le code d’état correspond à ok, l’en-tête de réponse comprend le cookie BREEZESESSION. Vous devez le capturer pour l’utiliser dans les appels d’API suivants. Pour déterminer l’identifiant d’un utilisateur à partir de son nom de connexion et de son mot de passe : 1. Connectez-vous en utilisant les informations d’identification de cet utilisateur. 2. Appelez l’API common-info. 3. Dans le code XML renvoyé, recherchez la valeur de l’attribut user-id de la balise user. Cette valeur correspond à l’identifiant de cet utilisateur. Pour vérifier qu’un mot de passe saisi est correct : 1. Connectez-vous en utilisant les informations d’identification de cet utilisateur. 2. Si le code d’état renvoyé correspond à ok, le mot de passe est correct. Cette procédure constitue l’unique méthode de vérification d’un mot de passe ; pour des raisons de sécurité, Breeze ne permet pas de demander au serveur le mot de passe d’un utilisateur. Pour obtenir la liste de tous les cours auxquels l’utilisateur s’est inscrit : 1. Connectez-vous en utilisant les informations d’identification de cet utilisateur. 2. Appelez l’API 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, page 176. Remarque : Cette requête doit comporter le cookie BREEZESESSION. Pour plus d’informations, consultez la section Connexion à Breeze, page 29. Intégration de Breeze à un portail 37 Pour obtenir la liste de toutes les réunions auxquelles l’utilisateur doit participer : 1. Connectez-vous en utilisant les informations d’identification de cet utilisateur. 2. Appelez l’API 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, page 177. Pour afficher ce que renferme le dossier de contenu de l’utilisateur : 1. Connectez-vous en utilisant les informations d’identification de cet utilisateur. 2. Appelez l’API sco-shortcuts. Cette API indique 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 et loginCookie que le code d’ouverture de session indiqué à la section Intégration de Breeze à un service d’annuaire, page 33 : <cfhttp url="#baseurl#api/xml?action=sco-shortcuts" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> 3. Déterminez l’identifiant du dossier My Content en recherchant l’attribut type approprié dans les balises sco renvoyées : <cfset <cfset <cfset <cfset response= cfhttp.FileContent > xml= XmlParse(response)> contentScoElement= XmlSearch(xml, "//sco[@type='my-content']")> 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 : <cfset domainElement= XmlSearch(xml, "//sco[@tree-id='#myTreeId#']/domain-name")> <cfset domainName= domainElement[1].XmlText> 5. Appelez l’API sco-contents en lui transmettant l’identifiant SCO du dossier. L’API suivante renvoie la liste du contenu du dossier indiqué : <cfhttp url="#baseurl#api/xml? action=sco-contents&sco-id=#contentSco#" method="post"> <cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#"> </cfhttp> 6. Analysez le code XML renvoyé et affichez les informations appropriées : <cfset response= cfhttp.FileContent > <cfset contentXml= XmlParse(response)> <cfset contents= XmlSearch(contentXml, "//sco")> <cfset contentCount= ArrayLen(contents)> <cfoutput> <table> 38 Chapitre 3 : Tâches courantes <tr> <th>SCO ID</th> <th>Name</th> <th>Type</th> </tr> <cfloop index="i" from="1" to="#contentCount#"> <cfset item=contents[#i#]> <tr> <td>#item.XmlAttributes["sco-id"]#</td> <td>#item.name.XmlText#</td> <td>#item.XmlAttributes["type"]#</td> </tr> </cfloop> </table> </cfoutput> 7. Pour mettre à la disposition des utilisateurs des liens pointant directement vers des éléments de contenu, appelez l’API sco-info pour chaque élément et déterminez son adresse URL complète en insérant le contenu de la baliseurl-path renvoyée après le nom de domaine que vous avez obtenu précédemment. Vous obtenez ainsi une adresse URL complète, telle http://breeze.exemple.com/p12345678/. Pour plus d’informations sur l’activation d’un lien vers du contenu, consultez la section Présentation de la sécurité et du lancement de contenu, page 20. Pour créer une nouvelle réunion : 1. Connectez-vous en utilisant les informations d’identification de l’utilisateur. 2. (Facultatif) Vous pouvez permettre à l’utilisateur de choisir, dans une interface Web, l’identifiant du dossier dans lequel la nouvelle réunion doit être créée. Si vous ne spécifiez pas de dossier particulier, la réunion est créée dans le dossier my-meetings (Mes réunions). Pour déterminer l’identifiant de ce dossier de réunions par défaut, appelez l’API sco-shortcuts. 3. Appelez l’API sco-update en utilisant l’identifiant du dossier dans le paramètre folder-id. Ne spécifiez pas de paramètre sco-id. 4. Assurez-vous que l’API s’exécute normalement en vérifiant le contenu de la balise status renvoyée. Pour rechercher du contenu : 1. Utilisez un formulaire Web pour extraire la chaîne que l’utilisateur doit rechercher. 2. Connectez-vous en utilisant les informations d’identification de l’utilisateur. 3. Appelez l’API sco-search en utilisant la chaîne spécifiée comme valeur du paramètre query. 4. Dans le code XML renvoyé, recherchez les informations sur les SCO qui contiennent cette chaîne. Affichez les informations pertinentes. Intégration de Breeze à un portail 39 Génération de rapports Supposons que vous souhaitiez que votre application présente des informations sur tous les cours auxquels un utilisateur est inscrit, ou identifie les utilisateurs inscrits à une réunion donnée. Les services Web XML de Breeze comportent un grand nombre de rapports, qui contiennent des données sur l’utilisation de Breeze. Les données des rapports sont renvoyées dans des formulaires XML. Vous pouvez utiliser directement les résultats dans votre système (par le biais d’une application Web, par exemple) ou convertir les données dans d’autres formats, tels les fichiers CSV (Comma Separated Values). Pour générer le rapport de formation d’un utilisateur sous forme de fichier CSV : 1. Connectez-vous en tant qu’administrateur. 2. Appelez l’API sco-contents pour déterminer l’identifiant d’un cours. 3. Appelez l’API report-quiz-takers. Cette API renvoie une série de balises row, dont chacune fournit des informations sur un utilisateur inscrit au cours. 4. Analysez le code XML et enregistrez les données au format texte dans un fichier CSV, en séparant les champs par des virgules. La technique la plus courante consiste à afficher le fichier CSV résultant 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 CSV, vous pouvez utiliser soit un langage interprété sur le serveur comme CFML, soit un langage de conversion comme XSLT (XSL Transformations). Pour plus d’informations sur XSLT, consultez la section Autres ressources, page 12. 40 Chapitre 3 : Tâches courantes CHAPITRE 4 Informations de référence sur les API XML Ce chapitre contient des informations de référence sur toutes les interfaces de programmation d’application (API) exposées dans l’API XML de Macromedia Breeze. Il indique également les paramètres pouvant être passés avec chaque API. Les API sont classées par ordre alphabétique. Chaque API renvoie une balise results contenant une ou plusieurs autres balises, dont une balise status. La section « Eléments renvoyés » de la documentation relative à chaque API n’indique que les autres éléments renvoyés, le renvoi de results et status étant implicite. Pour toutes informations sur les balises, données et codes d’état XML renvoyés par le serveur Breeze, consultez le Chapitre 5, Informations de référence sur les résultats XML, page 145. Le Chapitre 3, Tâches courantes, page 27 présente des exemples d’exécution de diverses tâches courantes. Pour plus d’informations sur la définition de paramètres, consultez la section Présentation des paramètres, page 16. Pour plus d’informations sur les mandants et les SCO (Shareable Content Objects), consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Exemple d’entrée API L’exemple d’entrée ci-dessous illustre les conventions utilisées pour toutes les API XML. Les entrées sont classées par ordre alphabétique. Titre de l’entrée Elément qui identifie le nom de l’API. Disponibilité Sauf avis contraire, cette section indique les versions de Breeze qui gèrent l’API. Sauf avis contraire, une API est prise en charge par la version spécifiée et toute version ultérieure. Description Cette section décrit l’utilisation de l’API. 41 Paramètres Cette section décrit tout paramètre inclus dans la syntaxe. A moins qu’ils ne soient libellés « facultatif », tous les paramètres sont obligatoires. Filtres Cette section décrit les champs utilisés pour filtrer et trier les données XML renvoyées. Eléments renvoyés Cette section identifie les éléments XML renvoyés, le cas échéant, par l’API. Exemple de résultats Cette section comporte un exemple de code qui illustre l’utilisation de l’API. Voir aussi Cette section identifie les API liées à l’API étudiée. Liste d’API par fonction Les tableaux suivants regroupent les API XML selon leur fonction. Gestion du contenu et des réunions Les services Web de Breeze vous permettent de créer et de gérer les ressources et réunions (SCO) de Breeze à partir de toute application, tel un portail externe, qui utilise des services Web. Vous pouvez ainsi transférer un contenu d’une application de portail externe vers Breeze. Vous pouvez également créer des réunions ou des sessions de collaboration à partir d’une application de portail. Le tableau ci-dessous répertorie les API de gestion du contenu et des réunions prises en charge par Breeze 5.1. 42 API Description sco-build Provoque la compilation du SCO spécifié par le serveur Breeze lorsque vous créez des présentations par le biais de l’API XML. sco-contents Renvoie la liste des SCO du dossier spécifié. sco-delete Supprime un ou plusieurs SCO. sco-expanded-contents Répertorie tous les SCO d’un dossier. sco-info Renvoie des informations sur un SCO. sco-move Déplace un SCO d’un dossier à un autre. sco-nav Décrit l’arborescence de dossiers contenant le SCO spécifié. sco-search Renvoie la liste de tous les SCO correspondant au texte de recherche. Chapitre 4 : Informations de référence sur les API XML API Description sco-shortcuts Renvoie les identifiants d’un ensemble de dossiers dont le contenu concerne l’utilisateur connecté, à savoir le dossier dans lequel sont enregistrées les réunions de l’utilisateur, le dossier dans lequel il place son contenu, etc. sco-update Crée ou actualise des présentations, des cours et des réunions. sco-upload Transfère un fichier vers le serveur Breeze lorsque vous créez une présentation par le biais de l’API XML. (Pour plus d’informations, consultez sco-update et sco-build.) Gestion des curriculum et des cursus de formation Les services Web de Breeze vous permettent de créer et de gérer des cursus de formation associés à un curriculum et à un utilisateur. Le tableau ci-dessous répertorie les API de curriculum prises en charge par Breeze 5.1 : API Description learning-path-info Renvoie la liste des cursus de formation associés à un objet d’étude appartenant à un curriculum. learning-path-update Actualise le cursus de formation pour un objet d’étude unique dans un curriculum. user-transcript-update Réinitialise le relevé de notes d’un utilisateur pour un objet d’étude ou le marque comme étant terminé. Champs personnalisés Vous pouvez ajouter des champs personnalisés aux objets Breeze. Le tableau ci-dessous répertorie les API de champs personnalisés prises en charge par Breeze 5.1 : API Description acl-field-info Renvoie les valeurs et identifiants de champs associés à une ACL. acl-field-list Renvoie la liste des valeurs et identifiants des ACL associées au compte de connexion pour l’identifiant de champ spécifié. acl-field-update Actualise la valeur du champ spécifié pour l’ACL indiquée. acl-preference-update Actualise les paramètres de fuseau horaire et de langue dans le profil de l’utilisateur. custom-fields-delete Supprime le champ personnalisé associé au compte spécifié. Liste d’API par fonction 43 API générales Le tableau ci-dessous répertorie les API générales prises en charge par Breeze 5.1 : API Description action-list Renvoie la liste des API de services Web de Breeze. common-info Renvoie des informations de base sur l’utilisateur et le serveur actuels. login Connecte un utilisateur. logout Déconnecte un utilisateur en invalidant le cookie reçu par l’application à l’ouverture de session. Autorisations Le tableau ci-dessous répertorie les API d’autorisations prises en charge par Breeze 5.1 : API Description permissions-info Renvoie des informations sur les mandants et les autorisations dont ils disposent sur le SCO indiqué. permissions-reset Réinitialise les autorisations de tous les mandants sur le SCO indiqué. Les autorisations sur le parent de ce SCO s’appliquent alors à tous les mandants. permissions-update Actualise les autorisations d’un ou de plusieurs mandants sur un ou plusieurs SCO. Rapports Vous pouvez utiliser les fonctionnalités détaillées de création de rapports des services Web de Breeze dans des systèmes externes tels que des solutions de gestion des performances des employés. Les API de services Web de Breeze suivantes vous permettent d’intégrer le référentiel de rapports de Breeze à des systèmes externes pour générer des rapports en temps réel à partir d’une infrastructure de création de rapports unique. Le tableau ci-dessous répertorie les API de rapports prises en charge par Breeze 5.1 : 44 API Description report-active-meeting-presenters Renvoie la liste des utilisateurs qui sont actuellement présentateurs de réunions. report-active-meetings Renvoie la liste des réunions en cours. report-bulk-consolidatedtransactions Renvoie des informations sur toutes les transactions associées à un compte. Une transaction correspond à une occurrence de mandant participant à un SCO. Chapitre 4 : Informations de référence sur les API XML API Description report-bulk-objects Renvoie des informations sur chaque objet hébergé sur le serveur Breeze. Parmi les types d’objets figurent archive, pièce jointe, Authorware, Captivate, cours, curriculum, événement externe, FLV, image, réunion, présentation et SWF. report-bulk-questions Renvoie des informations sur chaque question de questionnaire dans un compte déterminé. report-bulk-slide-views Renvoie des informations sur chaque occurrence d’un mandant qui affiche une diapositive dans un compte. report-bulk-users Renvoie des informations sur tous les utilisateurs associés à un compte. report-course-status Renvoie l’état des cours pour un mandant ou un SCO, en fonction des paramètres passés. report-meeting-attendance Renvoie la liste des utilisateurs ayant assisté à la réunion spécifiée. report-meeting-concurrent-users Indique le nombre maximal d’utilisateurs pouvant participer simultanément à la réunion spécifiée. report-meeting-sessions Renvoie des informations sur toutes les sessions d’une réunion. report-meeting-summary Indique le nombre d’utilisateurs invités à la réunion spécifiée et le nombre d’invités et d’hôtes qui y ont assisté. report-my-courses Renvoie des informations sur chaque cours auquel l’utilisateur connecté est inscrit. report-my-events Renvoie des informations sur chaque événement auquel l’utilisateur connecté a prévu de participer. report-my-meetings Renvoie des informations sur chaque réunion à laquelle l’utilisateur connecté a prévu de participer. report-quiz-interactions Renvoie des informations sur toutes les interactions des utilisateurs avec le questionnaire spécifié. report-quiz-question-answerdistribution Indique le nombre d’utilisateurs qui ont sélectionné une réponse spécifique à toutes les questions d’un questionnaire associé au SCO spécifié. report-quiz-question-distribution Indique le nombre d’utilisateurs ayant répondu correctement à chaque question du questionnaire spécifié. report-quiz-question-response Renvoie la liste de toutes les réponses à une question de questionnaire particulière choisies par les utilisateurs. report-quiz-question-totals Indique le nombre total d’utilisateurs qui ont répondu à la question de questionnaire spécifiée et le nombre d’utilisateurs qui y ont répondu correctement. report-quiz-summary Renvoie des informations sur les résultats d’un questionnaire. Liste d’API par fonction 45 API Description report-quiz-takers Renvoie des informations sur toutes les personnes ayant répondu à un questionnaire particulier. report-quotas Renvoie des informations sur les quotas de compte. report-sco-slides Indique le nombre de fois que chaque diapositive d’une présentation a été visionnée, ainsi que la date du dernier affichage. report-sco-views Indique le nombre de fois que la présentation spécifiée a été visionnée, ainsi que la date du dernier affichage. Gestion des utilisateurs Breeze propose un ensemble complet de services Web destinés à développer des processus de synchronisation entre votre service d’annuaire et Breeze. Ces services Web vous permettent en outre d’intégrer des profils utilisateur, un contenu Breeze personnalisé et des données de rapports à des systèmes externes tels que des applications de portail, CRM et ERP. Le tableau ci-dessous répertorie les API de gestion des utilisateurs prises en charge par Breeze 5.1 : 46 API Description group-membership-update Ajoute un ou plusieurs mandants à un groupe ou supprime un ou plusieurs mandants d’un groupe. principal-info Fournit des informations sur le mandant spécifié (utilisateur ou groupe). principal-list Renvoie la liste complète des utilisateurs et des groupes, y compris les groupes primaires. principal-list-by-field Vous permet de répertorier les mandants associés à une valeur de champ déterminée. principal-update Actualise les informations relatives à un mandant du compte actuel ou crée un nouveau mandant. principals-delete Supprime un ou plusieurs mandants. user-accounts Renvoie la liste des comptes auxquels appartient l’utilisateur spécifié. user-update-pwd Modifie le mot de passe d’un utilisateur. Chapitre 4 : Informations de référence sur les API XML API classées par ordre alphabétique La liste ci-dessous répertorie toutes les API passées en revue dans ce chapitre de référence. La colonne Description identifie les API non prises en charge par Breeze 5.1. API Description accesskey-exec Exécute des fonctions spéciales associées à des clés d’accès spécifiques. Cette API n’est pas prise en charge par Breeze 5.1. accesskey-info Permet d’obtenir une clé d’accès spéciale, si cette clé est associée au SCO spécifié. Cette API n’est pas prise en charge par Breeze 5.1. acl-field-info Renvoie les valeurs et identifiants de champs associés à une ACL. acl-field-list Renvoie la liste des valeurs et identifiants des ACL associées au compte de connexion pour l’identifiant de champ spécifié. acl-field-update Actualise la valeur du champ spécifié pour l’ACL indiquée. acl-preference-update Actualise les paramètres de fuseau horaire et de langue dans le profil de l’utilisateur. action-list Renvoie la liste des API de services Web de Breeze. common-info Renvoie des informations de base sur l’utilisateur et le serveur actuels. custom-field-update Actualise le champ personnalisé associé au compte spécifié. Le cas échéant, crée un champ personnalisé. Cette API n’est pas prise en charge par Breeze 5.1. custom-fields Répertorie les champs personnalisés d’un compte et les détails correspondants. Cette API n’est pas prise en charge par Breeze 5.1. custom-fields-delete Supprime le champ personnalisé associé au compte spécifié. group-membership-update Ajoute un ou plusieurs mandants à un groupe ou supprime un ou plusieurs mandants d’un groupe. learning-path-info Renvoie la liste des cursus de formation associés à un objet d’étude appartenant à un curriculum. learning-path-update Actualise le cursus de formation pour un objet d’étude unique dans un curriculum. login Connecte un utilisateur. logout Déconnecte un utilisateur en invalidant le cookie reçu par l’application à l’ouverture de session. permissions-info Renvoie des informations sur les mandants et les autorisations dont ils disposent sur le SCO indiqué. API classées par ordre alphabétique 47 API Description permissions-reset Réinitialise les autorisations de tous les mandants sur le SCO indiqué. Les autorisations sur le parent de ce SCO s’appliquent alors à tous les mandants. permissions-update Actualise les autorisations d’un ou de plusieurs mandants sur un ou plusieurs SCO. principal-info Fournit des informations sur le mandant spécifié (utilisateur ou groupe). principal-list Renvoie la liste complète des utilisateurs et des groupes, y compris les groupes primaires. principal-list-by-field Vous permet de répertorier les mandants associés à une valeur de champ déterminée. principal-update Actualise les informations relatives à un mandant du compte actuel ou crée un nouveau mandant. principals-delete Supprime un ou plusieurs mandants. report-account-meeting-attendance Renvoie le journal de participation aux réunions associé au compte. Cette API n’est pas prise en charge par Breeze 5.1. 48 report-active-meeting-presenters Renvoie la liste des utilisateurs qui sont actuellement présentateurs de réunions. report-active-meetings Renvoie la liste des réunions en cours. report-bandwidth Indique la bande passante totale utilisée par le compte actif depuis sa création, en octets. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-consolidatedtransactions Renvoie des informations sur toutes les transactions associées à un compte. Une transaction correspond à une occurrence de mandant participant à un SCO. report-bulk-content-quiz Renvoie des informations sur tous les questionnaires du contenu, y compris la liste des questionnaires et les questions et réponses correspondantes. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-content-quiz-results Renvoie les résultats d’un questionnaire du contenu, y compris des informations sur chaque utilisateur et chaque question. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-content-slide-views Renvoie des données sur l’affichage des diapositives pour le contenu. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-course-quiz Renvoie des informations sur tous les questionnaires du cours, y compris la liste des questionnaires et les questions et réponses correspondantes. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-course-results Renvoie les résultats d’un questionnaire du cours, y compris des informations sur chaque utilisateur et chaque question. Cette API n’est pas prise en charge par Breeze 5.1. Chapitre 4 : Informations de référence sur les API XML API Description report-bulk-meeting Renvoie des informations sur toutes les réunions. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-meeting-attendance Renvoie des données sur la participation aux réunions. Cette API n’est pas prise en charge par Breeze 5.1. report-bulk-objects Renvoie des informations sur chaque objet hébergé sur le serveur Breeze. Parmi les types d’objets figurent archive, pièce jointe, Authorware, Captivate, cours, curriculum, événement externe, FLV, image, réunion, présentation et SWF. report-bulk-questions Renvoie des informations sur chaque question de questionnaire dans un compte déterminé. report-bulk-slide-views Renvoie des informations sur chaque occurrence d’un mandant qui affiche une diapositive dans un compte. report-bulk-users Renvoie des informations sur tous les utilisateurs associés à un compte. report-course-status Renvoie l’état des cours pour un mandant ou un SCO, en fonction des paramètres passés. report-course-takers Renvoie la liste des utilisateurs inscrits au cours spécifié. Cette API n’est pas prise en charge par Breeze 5.1. report-disk-usage Renvoie des informations sur l’espace disque utilisé par le contenu Breeze du compte actif, en octets. Cette API n’est pas prise en charge par Breeze 5.1. report-meeting-attendance Renvoie la liste des utilisateurs ayant assisté à la réunion spécifiée. report-meeting-concurrent-users Indique le nombre maximal d’utilisateurs pouvant participer simultanément à la réunion spécifiée. report-meeting-session Fournit des informations sur une session de réunion déterminée, tels son nom, ses horaires de début et de fin, ainsi que le nombre de participants et d’hôtes qui y ont assisté. Cette API n’est pas prise en charge par Breeze 5.1. report-meeting-sessions Renvoie des informations sur toutes les sessions d’une réunion. report-meeting-session-slots Renvoie des informations sur le nombre de participants à la session de réunion spécifiée pour chaque période de 10 minutes. Cette API n’est pas prise en charge par Breeze 5.1. report-meeting-summary Indique le nombre d’utilisateurs invités à la réunion spécifiée et le nombre d’invités et d’hôtes qui y ont assisté. report-my-courses Renvoie des informations sur chaque cours auquel l’utilisateur connecté est inscrit. API classées par ordre alphabétique 49 API Description report-my-events Renvoie des informations sur chaque événement auquel l’utilisateur connecté a prévu de participer. report-my-meetings Renvoie des informations sur chaque réunion à laquelle l’utilisateur connecté a prévu de participer. report-principal-list Renvoie la liste de tous les mandants du compte. Cette API n’est pas prise en charge par Breeze 5.1. report-quiz-answer-distribution Indique le nombre d’utilisateurs qui ont sélectionné une réponse spécifique à toutes les questions d’un questionnaire associé au SCO spécifié. Cette API n’est pas prise en charge par Breeze 5.1. report-quiz-definition-answers Renvoie des informations sur chacune des réponses autorisées (à la fois correctes et incorrectes) du questionnaire spécifié. Cette API n’est pas prise en charge par Breeze 5.1. report-quiz-definition-questions Renvoie des informations sur chaque question d’un questionnaire. Cette API n’est pas prise en charge par Breeze 5.1. report-quiz-interactions Renvoie des informations sur toutes les interactions des utilisateurs avec le questionnaire spécifié. report-quiz-question-answerdistribution Indique le nombre d’utilisateurs qui ont sélectionné une réponse spécifique à toutes les questions d’un questionnaire associé au SCO spécifié. report-quiz-question-distribution Indique le nombre d’utilisateurs ayant répondu correctement à chaque question du questionnaire spécifié. 50 report-quiz-question-response Renvoie la liste de toutes les réponses à une question de questionnaire particulière choisies par les utilisateurs. report-quiz-question-totals Indique le nombre total d’utilisateurs qui ont répondu à la question spécifiée du questionnaire et le nombre d’utilisateurs qui y ont répondu correctement. report-quiz-summary Renvoie des informations sur les résultats d’un questionnaire. report-quiz-takers Renvoie des informations sur toutes les personnes ayant répondu à un questionnaire particulier. report-quotas Renvoie des informations sur les quotas de compte. report-sco-slides Indique le nombre de fois que chaque diapositive d’une présentation a été visionnée, ainsi que la date du dernier affichage. report-sco-views Indique le nombre de fois que la présentation spécifiée a été visionnée, ainsi que la date du dernier affichage. report-survey-question-response Renvoie la liste des utilisateurs qui ont répondu à la question spécifiée, ainsi que leur réponse. Cette API n’est pas prise en charge par Breeze 5.1. Chapitre 4 : Informations de référence sur les API XML API Description sco-build Provoque la compilation du SCO spécifié par le serveur Breeze lorsque vous créez des présentations par le biais de l’API XML. sco-contents Renvoie la liste des SCO du dossier spécifié. sco-delete Supprime un ou plusieurs SCO. sco-expanded-contents Répertorie tous les SCO d’un compte. Utilisez des filtres avec cette API pour identifier certains SCO. sco-info Renvoie des informations sur un SCO. sco-move Déplace un SCO d’un dossier à un autre. sco-nav Décrit l’arborescence de dossiers contenant le SCO spécifié. sco-search Renvoie la liste de tous les SCO correspondant au texte de recherche. sco-shortcuts Renvoie les identifiants d’un ensemble de dossiers dont le contenu concerne l’utilisateur connecté, à savoir le dossier dans lequel sont enregistrées les réunions de l’utilisateur, le dossier dans lequel il place son contenu, etc. sco-update Crée ou actualise des présentations, des cours et des réunions. sco-upload Transfère un fichier vers le serveur Breeze lorsque vous créez une présentation par le biais de l’API XML. (Pour plus d’informations, consultez sco-update et sco-build.) user-accounts Renvoie la liste des comptes auxquels appartient l’utilisateur spécifié. user-transcript-update Réinitialise le relevé de notes d’un utilisateur pour un objet d’étude ou le marque comme étant terminé. user-update-pwd Modifie le mot de passe d’un utilisateur. API classées par ordre alphabétique 51 Informations de référence sur les API Cette section répertorie les API XML de Breeze par ordre alphabétique. accesskey-exec Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Remarque : Aucune API actualisée n’est disponible, car la fonctionnalité d’auto-inscription n’existe plus dans Breeze 5.1. Description Exécute des fonctions spéciales associées à des clés d’accès spécifiques. Cette API vous permet d’effectuer les tâches suivantes : • Permettre aux utilisateurs d’utiliser la fonctionnalité d’auto-inscription aux réunions et aux cours. • Créer un nouvel utilisateur. Pour appeler l’API accesskey-exec, vous devez créer 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’utilise pas Breeze. Cette personne peut ensuite, via une interface spécifique, s’inscrire à la réunion ou au cours, créant ainsi un nouveau compte d’utilisateur Breeze. Pour obtenir la clé d’accès spéciale, appelez accesskey-info. Cette API ajoute automatiquement l’utilisateur qui s’est lui-même inscrit au groupe d’inscription automatique associé au cours ou à la réunion, s’il existe. La différence entre accesskey-exec et principal-update pour créer un nouvel utilisateur réside dans le fait qu’il est possible d’appeler accesskey-exec sans avoir ouvert une session et sans être administrateur. En outre, vous pouvez associer des champs personnalisés aux nouveaux utilisateurs lorsque vous appelez accesskey-exec. Pour ce faire, passez les champs personnalisés à accesskey-exec en tant que paramètres supplémentaires sous forme de paires nom-valeur, ainsi que l’illustre l’exemple suivant : field-id=xx&value=xxx&customfield-id=xx&value=xxx Vous pouvez déterminer les paramètres field-id à partir des données renvoyées par l’API custom-fields. Paramètres access-key Clé d’accès spéciale qui permet à l’utilisateur de s’inscrire lui-même. first-name Prénom du nouvel utilisateur. has-children Ce paramètre doit toujours être mis à 0 pour l’inscription d’un nouvel utilisateur. last-name Nom du nouvel utilisateur. Nom de connexion du nouvel utilisateur, qui correspond généralement à son adresse électronique. login 52 Chapitre 4 : Informations de référence sur les API XML Mot de passe du nouvel utilisateur. password Ce paramètre doit systématiquement correspondre à user pour l’inscription d’un nouvel utilisateur. type Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> accesskey-info Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Remarque : La fonctionnalité accesskey n’existant plus dans Breeze 5.1, aucune API actualisée n’est disponible. Description Permet d’obtenir une clé d’accès spéciale, si cette clé est associée au SCO spécifié. Pour plus d’informations, consultez l’API accesskey-exec. Pour identifier le groupe auquel appartiendra automatiquement l’utilisateur qui s’inscrit luimême à l’aide de la clé d’accès spéciale, vérifiez l’élément XML access-key-group. Si le groupe existe, cet élément est inclus dans le code XML renvoyé. S’il n’existe pas, aucun autre élément access-key-group supplémentaire ne figure dans le code. Paramètres acl-id Identifiant d’un SCO. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés access-keys, access-key-group accesskey-info 53 Exemple de résultats L’exemple de code XML ci-dessous est renvoyé lorsqu’un groupe n’existe pas et ne comprend par conséquent pas d’élément access-key-group : <results> <status code="ok" /> <access-keys> <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-keys> </results> L’exemple de résultats ci-dessous est renvoyé lorsqu’un groupe existe et comprend de ce fait un élément accesskey-group : <results> <status code="ok" /> <access-key-group account-id="7" has-children="true" is-primary="false" principal-id="630" type="group"> <login>COURSE-test1-self-reg-group</login> <name>COURSE-test1-self-reg-group</name> </access-key-group> <access-keys> <access-key acl-id="126" action="action-self-reg-course" parent-aclid="630"> <access-key>2cw6np2kx2dtdop2</access-key> <date-created>2004-07-07T12:27:04.590-07:00</date-created> </access-key> </access-keys> </results> acl-field-info Disponibilité Breeze 5.1. Description Renvoie les éléments field-ids et les valeurs d’une ACL. Pour l’appeler, vous devez disposer de l’autorisation d’affichage sur l’ACL. Vous pouvez appeler principal-list pour déterminer les valeurs account-id ou principal-ids. Une ACL est un objet Breeze sécurisable, tel un mandant, un SCO ou un compte. Pour plus d’informations, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Paramètres acl-id Identifiant de l’ACL dont vous voulez renvoyer des informations sur les champs. Ce paramètre peut correspondre à sco-id, account-id ou principal-id. 54 Chapitre 4 : Informations de référence sur les API XML Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés acl-fields Exemple de résultats L’exemple de résultats ci-dessous est renvoyé lorsque le paramètre acl-id correspond à une valeur account-id. Certains champs de l’ACL de comptes répertorient le contact principal associé au compte, soit dans ce cas Mike Brown. D’autres champs identifient l’entreprise associée au compte. Les champs sont spécifiés lors de la création des comptes et sont mémorisés dans un champ ACL. <results> <status code="ok"/> <acl-fields> <field acl-id="38181499" field-id="email"> <value>[email protected]</value> </field> <field acl-id="38181499" field-id="first-name"> <value>Daryl</value> </field> <field acl-id="38181499" field-id="last-name"> <value>Black</value> </field> <field acl-id="38181499" field-id="account-company"> <value>Macromedia</value> </field> <field acl-id="38181499" field-id="telephony-adaptor"> <value> com.macromedia.breeze_ext.premiere.gateway.PTekGateway </value> </field> <field acl-id="38181499" field-id="pricing-model-training"> <value>concurrent-learner</value> </field> <field acl-id="38181499" field-id="pricing-model-meeting"> <value>concurrent-attendee</value> </field> </acl-fields> </results> Voir aussi acl-field-list, acl-field-update acl-field-info 55 acl-field-list Disponibilité Breeze 5.1. Description Renvoie la liste des acl-ids et des valeurs dans le compte de connexion pour le field-id indiqué. Ainsi, pour répertorier les prénoms de tous les utilisateurs d’un compte, appelez cette API en spécifiant field-id=first-name. Pour appeler cette API, vous devez disposer de l’autorisation Administrateur sur le compte de connexion. Appelez acl-field-info pour déterminer les différents champs gérés par une ACL. Une ACL est un objet Breeze sécurisable, tel un mandant, un SCO ou un compte. Pour plus d’informations, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Paramètres field-id Identifiant du champ vous voulez renvoyer les valeurs. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés acl-field-list Exemple de résultats <results> <status code="ok"/> <acl-field-list> <acl acl-id="38122317"> <value>Stephanie</value> </acl> <acl acl-id="38130237"> <value>Daryl</value> </acl> <acl acl-id="38140560"> <value>Mary</value> </acl> </acl-field-list> </results> Voir aussi acl-field-info, acl-field-update 56 Chapitre 4 : Informations de référence sur les API XML acl-field-update Disponibilité Breeze 5.1. Description Actualise la valeur du champ spécifié pour l’ACL indiquée. Pour appeler cette API, vous devez disposer de l’autorisation de modification sur l’ACL. Une ACL est un objet Breeze sécurisable, tel un mandant, un SCO ou un compte. Pour plus d’informations, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Paramètres acl-id Identifiant de l’ACL que vous voulez modifier. Cet identifiant peut correspondre à ou account-id. principal-id, sco-id field-id valeur Identifiant du champ que vous voulez modifier. Valeur que vous voulez définir pour le champ spécifié par le paramètre field-id. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats L’appel ci-dessous actualise le prénom de l’utilisateur dont l’identifiant ACL correspond à 38140560 (appelez acl-field-list pour déterminer cette valeur) : http://server_name/api/xml?action=acl-field-update&acl-id=38140560&fieldid=first-name&value=Mary%20Sue Les résultats sont les suivants : <results> <status code="ok"/> </results> Appelez à nouveau acl-field-list pour afficher le prénom actualisé : http://server_name/api/xml?action=acl-field-list&field-id=first-name acl-field-update 57 Les résultats sont les suivants : <results> <status code="ok"/> <acl-field-list> <acl acl-id="38122317"> <value>Stephanie</value> </acl> <acl acl-id="38130237"> <value>Mike</value> </acl> <acl acl-id="38140560"> <value>Mary Sue</value> </acl> </acl-field-list> </results> Voir aussi acl-field-list, acl-field-info acl-preference-update Disponibilité Breeze 4. Description Actualise les paramètres de fuseau horaire et de langue dans le profil de l’utilisateur. Paramètres Identifiant de l’utilisateur dont vous voulez modifier les préférences. acl-id lang Paramètre de langue. Breeze gère actuellement les cinq langues suivantes : Langue Paramètre Anglais en Français fr Allemand de Japonais ja Coréen ko time-zone-id Paramètre du fuseau horaire. Breeze gère actuellement les 75 fuseaux horaires suivants : 58 Fuseau horaire Paramètre (GMT-12:00) Ligne de changement de date internationale (ouest) 0 (GMT-11:00) Midway, Samoa 1 (GMT-10:00) Hawaï 2 Chapitre 4 : Informations de référence sur les API XML Fuseau horaire Paramètre (GMT-09:00) Alaska 3 (GMT-08:00) Pacifique (USA et Canada), Tijuana 4 (GMT-07:00) Montagnes rocheuses (USA et Canada) 10 (GMT-07:00) Chihuahua, La Paz, Mazatlan 13 (GMT-07:00) Arizona 15 (GMT-06:00) Centre (USA et Canada) 20 (GMT-06:00) Saskatchewan 25 (GMT-06:00) Guadalajara, Mexico, Monterrey 30 (GMT-06:00) Amérique centrale 33 (GMT-05:00) Est (USA et Canada) 35 (GMT-05:00) Indiana (Est) 40 (GMT-05:00) Bogota, Lima, Quito 45 (GMT-04:00) Atlantique (Canada) 50 (GMT-04:00) Caracas, La Paz 55 (GMT-04:00) Santiago 56 (GMT-03:30) Terre-Neuve 60 (GMT-03:00) Brasilia 65 (GMT-03:00) Buenos Aires, Georgetown 70 (GMT-03:00) Groenland 73 (GMT-02:00) Centre-Atlantique 75 (GMT-01:00) Açores 80 (GMT-01:00) Iles du Cap-Vert 83 (GMT) Heure de Greenwich : Dublin, Edimbourg, Lisbonne, Londres 85 (GMT) Casablanca, Monrovia 90 (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague 95 (GMT+01:00) Sarajevo, Skopje, Varsovie, Zagreb 100 (GMT+01:00) Bruxelles, Copenhague, Madrid, Paris 105 (GMT+01:00) Amsterdam, Berlin, Berne, Rome, Stockholm, Vienne 110 (GMT+01:00) Afrique centrale -Ouest 113 (GMT+02:00) Bucarest 115 (GMT+02:00) Le Caire 120 (GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius 125 (GMT+02:00) Athènes, Istanbul, Minsk 130 acl-preference-update 59 60 Fuseau horaire Paramètre (GMT+02:00) Jérusalem 135 (GMT+02:00) Harare, Pretoria 140 (GMT+03:00) Moscou, St-Petersbourg, Volgograd 145 (GMT+03:00) Koweït, Riyad 150 (GMT+03:00) Nairobi 155 (GMT+03:00) Bagdad 158 (GMT+03:30) Téhéran 160 (GMT+04:00) Abu Dhabi, Muscat 165 (GMT+04:00) Baku, Tbilissi, Erevan 170 (GMT+04:30) Kabul 175 (GMT+05:00) Ekaterinbourg 180 (GMT+05:00) Islamabad, Karachi, Tachkent 185 (GMT+05:30) Chiennai, Calcutta, Mumbai, New Delhi 190 (GMT+05:45) Katmandou 193 (GMT+06:00) Astana, Dhaka 195 (GMT+06:00) Sri Jayawardenepura 200 (GMT+06:00) Almaty, Novossibirsk 201 (GMT+06:30) Rangoon 203 (GMT+07:00) Bangkok, Hanoi, Djakarta 205 (GMT+07:00) Krasnoïarsk 207 (GMT+08:00) Pékin, Chongqoing, Hong Kong, Urumqi 210 (GMT+08:00) Kuala Lumpur, Singapour 215 (GMT+08:00) Taipei 220 (GMT+08:00) Perth 225 (GMT+08:00) Irkoutsk, Oulan-Bator 227 (GMT+09:00) Séoul 230 (GMT+09:00) Osaka, Sapporo, Tokyo 235 (GMT+09:00) Iakutsk 240 (GMT+09:30) Darwin 245 (GMT+09:30) Adélaïde 250 (GMT+10:00) Canberra, Melbourne, Sydney 255 (GMT+10:00) Brisbane 260 (GMT+10:00) Hobart 265 Chapitre 4 : Informations de référence sur les API XML Fuseau horaire Paramètre (GMT+10:00) Vladivostok 270 (GMT+10:00) Guam, Port Moresby 275 (GMT+11:00) Magadan, Îles Salomon, Nouvelle Calédonie 280 (GMT+12:00) Iles Fidji, Kamchatka, Iles Marshall 285 (GMT+12:00) Auckland, Wellington 290 (GMT+13:00) Nuku’alofa 300 Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> action-list Disponibilité Breeze 4. Description Renvoie la liste des API (également appelées actions) des services Web de Breeze. Attention : Certaines API figurant dans cette liste ne sont pas documentées et certaines des API documentées sont absentes de la liste. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés actions Exemple de résultats <results> <status code="ok" /> <actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action> ... action-list 61 [other actions listed here] ... <action>user-accounts</action> <action>user-update-pwd</action> </actions> </results> common-info Disponibilité Breeze 4. Description Renvoie des informations de base sur l’utilisateur et le serveur actuels. Si vous appelez common-info sans vous être connecté au préalable, les mêmes informations sont renvoyées, à l’exception de la balise user. De plus, la valeur de account-id risque d’être différente. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés common Exemple de résultats <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.example.com</host> <url>/api/xml?action=common-info</url> <version>breeze_402_r116</version> <account account-id="222914" /> <user user-id="503562"> <name>Greg Erweck</name> <login>[email protected]</login> </user> <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> </common> </results> 62 Chapitre 4 : Informations de référence sur les API XML custom-field-update Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par l’API acl-field-update. Description Actualise le champ personnalisé associé au compte spécifié. Le cas échéant, crée un champ personnalisé. Paramètres field-id Identifiant du champ à actualiser, que vous pouvez obtenir en appelant l’API Ce paramètre ne doit être spécifié que lorsque vous actualisez un champ custom-fields. existant. name Nom du champ personnalisé, compris entre 1 et 60 caractères. Commentaire sur le champ personnalisé, compris entre 0 et 60 caractères. Ce paramètre est facultatif. comments type Type du champ personnalisé. Les types gérés sont les suivants : Valeur Description required Champ personnalisé de compte obligatoire optional Facultatif, affiché lors de l’auto-inscription optional-no-self-reg Facultatif, masqué lors de l’auto-inscription custom-seq Numéro du champ personnalisé. Ne spécifiez ce paramètre que si vous créez un champ personnalisé. Sa valeur doit être supérieure d’une unité à la valeur maximale actuelle de custom-seq. Eléments renvoyés Si vous actualisez un champ personnalisé existant : Aucun élément n’est renvoyé. Si vous créez un champ personnalisé : field. Exemple de résultats Si vous créez un champ personnalisé : <results> <status code="ok" /> <field field-id="1562" account-id="7" custom-seq="4" type="optional"> <comments>none</comments> <name>Manager</name> </field> </results> custom-field-update 63 Si vous actualisez un champ personnalisé existant : <results> <status code="ok" /> </results> custom-fields Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par l’API acl-field-list. Description Répertorie les champs personnalisés d’un compte et les détails correspondants. Paramètres Aucun. Filtres Basez le filtrage sur field-id uniquement. Vous pouvez également utiliser le modificateur filter-out pour le paramètre type. Il est impossible de trier les résultats. Par défaut, le tri est basé sur field-id, par ordre croissant. Eléments renvoyés custom-fields, field Exemple de résultats <results> <status code="ok" /> <custom-fields> <field field-id="1329" custom-seq="1" account-id="7" type="optional"> <name>Department</name> <comments>this is optional</comments> </field> <field field-id="1330" custom-seq="2" account-id="7" type="required"> <name>SSN</name> </field> </custom-fields> </results> 64 Chapitre 4 : Informations de référence sur les API XML custom-fields-delete Disponibilité Breeze 4. Description Supprime le champ personnalisé associé au compte spécifié. Paramètres field-id Identifiant du champ à supprimer, que vous pouvez obtenir en appelant l’API custom-fields. Eléments renvoyés Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi acl-field-info, acl-field-list, acl-field-update group-membership-update Disponibilité Breeze 4. Description Ajoute un ou plusieurs mandants à un groupe ou supprime un ou plusieurs mandants d’un groupe. Pour actualiser plusieurs mandants et groupes, spécifiez plusieurs groupes de trois paramètres group-id, principal-id et is-member. Pour plus d’informations, consultez la section Présentation des paramètres, page 16. Paramètres group-id Identifiant du groupe dont vous souhaitez actualiser l’appartenance. principal-id is-member Identifiant du mandant dont vous souhaitez actualiser l’appartenance. Indique si le mandant est ajouté (true) au groupe ou supprimé (false) de ce dernier. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. group-membership-update 65 Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> learning-path-info Disponibilité Breeze 5.1. Description Renvoie la liste des cursus de formation associés à un objet d’étude appartenant à un curriculum. Un objet d’étude correspond à tout SCO ajouté à un curriculum. Un cursus de formation est déterminé par des règles qui indiquent si un étudiant peut accéder ou non à l’objet d’étude suivant. Vous pouvez par exemple créer un cursus de formation en définissant des conditions préalables, des conditions d’accomplissement ou des conditions de préévaluation. Remarque : Appeler l’API learning-path-info décrit la relation entre les SCO au sein d’un curriculum, mais ne répertorie pas le contenu complet de ce dernier. Pour afficher le contenu d’un curriculum, appelez sco-expanded-contents. Paramètres curriculum-id sco-id Identifiant du curriculum auquel appartient l’objet d’étude. Identifiant de l’objet d’étude. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri current-sco-id Filtrage et tri curriculum-id Filtrage et tri name Filtrage et tri path-type Filtrage et tri permission-id Filtrage et tri target-sco-id Filtrage et tri Le champ target-sco-id contient l’identifiant de l’objet d’étude qui limite les accès à l’objet d’étude actuel. Ainsi, si un objet d’étude est associé à des conditions préalables, le SCO correspondant est target-sco-id. 66 Chapitre 4 : Informations de référence sur les API XML Le champ path-type gère les valeurs suivantes : • • • • • • • • • • completion-none completion-required preass-blocked preass-hidden preass-none prereq-hidden prereq-none preass-optional prereq-required prereq-suggested Eléments renvoyés learning-paths Exemple de résultats Pour comprendre les résultats XML, examinez le contenu suivant de la première balise learningpath. Le SCO actuel (5400246) requiert que le SCO cible (5400247) soit terminé. Le nom du SCO cible correspond à New Hire Safety. <results> <status code="ok"/> <learning-paths> <learning-path curriculum-id="5400246" current-sco-id="5400246" sco-id="5400247" path-type="completion-required"> <name>New Hire Safety</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" sco-id="5400248" path-type="completion-required"> <name>Beginning Electronics</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" sco-id="5400413" path-type="completion-required"> <name>Electronics 2</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400246" sco-id="5400414" path-type="completion-required"> <name>Electronics 3</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400249" sco-id="5400248" path-type="prereq-suggested"> <name>Beginning Electronics</name> </learning-path> <learning-path curriculum-id="5400246" current-sco-id="5400413" sco-id="5400248" path-type="prereq-required"> <name>Beginning Electronics</name> </learning-path> target- target- target- target- target- target- learning-path-info 67 <learning-path curriculum-id="5400246" current-sco-id="5400414" targetsco-id="5400413" path-type="prereq-required"> <name>Electronics 2</name> </learning-path> </learning-paths> </results> Voir aussi learning-path-update learning-path-update Disponibilité Breeze 5.1. Description Actualise le cursus de formation pour un objet d’étude unique dans un curriculum. Un objet d’étude correspond à tout SCO ajouté à un curriculum. Paramètres curriculum-id Identifiant du curriculum auquel appartient l’objet d’étude. current-sco-id Identifiant de l’objet d’étude. target-sco-id Identifiant de l’objet d’étude qui limite les accès à l’objet d’étude actuel. Ainsi, si un objet d’étude est associé à des conditions préalables, le SCO correspondant est target-sco-id. target-sco-id Identifiant de l’objet d’étude qui limite les accès à l’objet d’étude actuel. Ainsi, si un objet d’étude est associé à des conditions préalables, le SCO correspondant est target-sco-id. Envisagez le cas de figure suivant : Un étudiant doit réussir le cours « Introduction à la programmation » pour pouvoir s’inscrire au cours « Programmation avancée ». Dans cet exemple, « Introduction à la programmation » est représenté par l’attribut current-sco-id, l’attribut path-type correspond à prereq-req et target-sco-id à « Programmation avancée ». path-type • • • • • • • • • • 68 Le champ path-type gère les valeurs suivantes : completion-none completion-required preass-blocked preass-hidden preass-none prereq-hidden prereq-none preass-optional prereq-required prereq-suggested Chapitre 4 : Informations de référence sur les API XML Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok"/> </results> Voir aussi learning-path-info login Disponibilité Breeze 4. Description Connecte un utilisateur au serveur Breeze. Après l’ouverture de session, vous devez lire et conserver le contenu du cookie BREEZESESSION, qui figure dans les en-têtes HTTP du code XML résultant. Vous devez ensuite inclure la valeur de ce cookie dans toutes les requêtes transmises ultérieurement avec cet identifiant. L’exemple de code Java ci-dessous analyse les en-têtes HTTP pour y mémoriser le cookie, puis indique comment le passer pour toutes les requêtes suivantes : login="[email protected]" password="abcdefg" baseurl="http://breeze.example.com/" URL loginUrl=new URL(baseUrl + "api/xml?action=login&login=" + login + "&password=" + password); URLConnection conn=loginUrl.openConnection(); conn.connect(); InputStream resultStream=conn.getInputStream(); Document doc=new SAXBuilder(false).build(resultStream); String cookieString=(String) (conn.getHeaderField("Set-Cookie")); StringTokenizer st=new StringTokenizer(cookieString, "="); if (st.countTokens() > 1 && st.nextToken().equals("BREEZESESSION")) { String cookieNext=st.nextToken(); int semiIndex=cookieNext.indexOf(';'); cookie=cookieNext.substring(0, semiIndex); } login 69 if (cookie == null){ throw new RuntimeException("Couldn’t find the Breeze cookie."); } Pour passer le cookie BREEZESESSION pour toutes les requêtes suivantes, utilisez le code ci-dessous : URLConnection conn=url.openConnection(); conn.setRequestProperty("Cookie", "BREEZESESSION=" + cookie); conn.connect(); L’exemple précédent définit manuellement les variables password (mot de passe) et username (nom d’utilisateur). Dans une vraie application, vous créeriez probablement un formulaire dans lequel seraient tapés le mot de passe et le nom d’utilisateur, puis vous passeriez les variables au code. Pour obtenir un exemple ColdFusion, consultez la section Connexion à Breeze, page 29. Paramètres Identifiant du compte associé à cet utilisateur. Ce paramètre est facultatif. Si votre organisation ne dispose que d’un seul compte, ne spécifiez pas le paramètre account-id. account-id Nom de connexion de l’utilisateur, qui correspond généralement à son adresse électronique. login password Mot de passe de l’utilisateur. Remarque : Si le paramètre login ou password est absent ou incorrect, le serveur Breeze renvoie le code d’état no-data. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi logout 70 Chapitre 4 : Informations de référence sur les API XML logout Disponibilité Breeze 4. Description Déconnecte un utilisateur en invalidant le cookie reçu par l’application à l’ouverture de cette session. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi login permissions-info Disponibilité Breeze 4. Description Renvoie des informations sur les mandants et les autorisations dont ils disposent sur le SCO indiqué. Vous pouvez également passer le paramètre facultatif principal-id pour extraire des informations sur les autorisations dont dispose un mandant déterminé. Pour déterminer l’identifiant à utiliser en tant que paramètre principal-id, appelez l’API principal-list (le cas échéant, utilisez un filtre pour limiter les données renvoyées). Pour plus d’informations sur les autorisations, consultez la section Présentation des autorisations, page 19. Pour plus d’informations sur les filtres, consultez le Chapitre 2, Utilisation de filtres, page 21. Paramètres acl-id Identifiant d’un SCO spécifique. principal-id Identifiant d’un mandant spécifique. Ce paramètre est facultatif. permissions-info 71 Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri description Filtrage et tri has-children Filtrage et tri is-primary Filtrage et tri login Filtrage et tri name Filtrage et tri permission-id Filtrage et tri type Filtrage et tri Remarque : Les champs logged-in-access et public-access sont systématiquement renvoyés, quels que soient les filtres utilisés. Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés permissions Exemple de résultats Les données XML ci-dessous sont renvoyées lorsque le paramètre principal-id n’est pas passé et contient des informations sur tous les mandants : <results> <status code="ok" /> <permissions> <principal principal-id="181248" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Englesberg, Ari</name> <login>[email protected]</login> </principal> <principal principal-id="181249" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Milligan, Susan</name> <login>[email protected]</login> </principal> </permissions> </results> Les données XML ci-dessous sont renvoyées lorsque le paramètre principal-id est passé : <results> <status code="ok" /> <permission acl-id="27" permission-id="manage" principal-id="8" /> </results> Si le mandant ne dispose pas d’autorisations sur le SCO, le code d’état no-data est renvoyé. 72 Chapitre 4 : Informations de référence sur les API XML Voir aussi permissions-reset, permissions-update permissions-reset Disponibilité Breeze 4. Description Réinitialise les autorisations de tous les mandants sur 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 Présentation des autorisations, page 19. Paramètres acl-id Identifiant d’un SCO. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi permissions-info, permissions-update permissions-update Disponibilité Breeze 4. Description Actualise les autorisations d’un ou de plusieurs mandants sur un ou plusieurs SCO. Pour plus d’informations sur les mandants, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Pour plus d’informations sur les autorisations, consultez la section Présentation des autorisations, page 19. Pour actualiser les autorisations de plusieurs mandants, transmettez plusieurs groupes de trois paramètres acl-id, permission-id et principal-id. Pour plus d’informations, consultez la section Présentation des paramètres, page 16. permissions-update 73 Paramètres acl-id Identifiant d’un SCO. permission-id principal-id Identifiant d’une autorisation. Identifiant d’un mandant (utilisateur ou groupe). Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi permissions-info, permissions-reset principal-info Disponibilité Breeze 4. Description Fournit des informations sur le mandant spécifié (utilisateur ou groupe). Pour déterminer l’identifiant à utiliser en tant que paramètre principal-id, appelez l’API principal-list (le cas échéant, utilisez un filtre pour limiter les données renvoyées). Pour plus d’informations sur les mandants, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Paramètres principal-id Identifiant d’un mandant spécifique. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés principal 74 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <principal account-id="222914" has-children="true" is-primary="true" principal-id="222926" type="course-admins"> <description>Course managers group</description> <login>Course Managers</login> <name>Course Managers</name> </principal> </results> Les données XML ci-dessous sont renvoyées si l’attribut type de l’élément principal correspond à group : <results> <status code="ok" /> <principal account-id="7" has-children="true" is-primary="false" principal-id="122" type="group"> <login>test-1</login> <name>test-1</name> </principal> </results> Si l’attribut type de l’élément principal correspond à user, d’autres données relatives aux coordonnées de l’utilisateur, à son profil et à ses champs personnalisés sont renvoyées, ainsi que l’illustrent les données XML ci-dessous : <results> <status code="ok" /> <contact contact-id="654"> <email>[email protected]</email> <first-name>test4</first-name> <last-name>laxmi</last-name> </contact> <preferences acl-id="653" lang="en" time-zone-id="4" /> <principal account-id="7" has-children="false" is-primary="false" principal-id="653" type="user"> <login>[email protected]</login> <name>test4 laxmi</name> </principal> <principal-custom-field-values> <field field-id="652" custom-seq="1" account-id="7" type="optional" principal-id="653"> <name>Phone number</name> <value>408-1111-111</value> </field> </principal-custom-field-values> </results> Voir aussi principal-list, principal-list-by-field, principal-update, principals-delete. principal-info 75 principal-list Disponibilité Breeze 4. Description Renvoie la liste complète des utilisateurs et des groupes, y compris les groupes primaires. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri contact-id Filtrage et tri description Filtrage et tri has-children Filtrage et tri is-hidden Filtrage et tri is-primary Filtrage et tri login Filtrage et tri name Filtrage et tri principal-list Filtrage et tri type Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés principal-list 76 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <principal-list> <principal principal-id="8" contact-id="3" type="user" haschildren="false" is-primary="false" is-hidden="0"> <name>Enterprise Administrator</name> <login>[email protected]</login> <email>[email protected]</email> </principal> <principal principal-id="18" contact-id="" type="authors" haschildren="true" is-primary="true" is-hidden="0"> <name>Account Authors</name> <login>Account Authors</login> <description>Account authors group</description> </principal> </principal-list> </results> Voir aussi principal-info, principal-update, principal-list-by-field, principals-delete. principal-list-by-field Disponibilité Breeze 5.1. Description Vous permet de répertorier les mandants associés à une valeur de champ déterminée. Paramètres value Valeur du champ sur lequel vous voulez baser la recherche. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri account-id Filtrage et tri principal-id Filtrage et tri type Filtrage et tri has-children Filtrage et tri is-primary Filtrage et tri name Filtrage et tri login Filtrage et tri description Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. principal-list-by-field 77 Eléments renvoyés principal-list Exemple de résultats <results> <status code="ok" /> <principal-list> <principal account-id="7" principal-id="10018" type="user" haschildren="false" is-primary="false" is-hidden="false"> <name>John Doe</name> <login>[email protected]</login> <description>Example User</description> </principal> </principal-list> </results> Voir aussi principal-info, principal-list, principal-update, principals-delete principal-update Disponibilité Breeze 4. Description Actualise les informations relatives à un mandant du compte actuel ou crée un nouveau mandant. Pour plus d’informations sur les mandants, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Dans la plupart des cas, il est nécessaire d’obtenir la version originale des informations sur le mandant (à l’aide de l’API principal-info) avant d’appeler l’API principal-update. Pour créer un nouveau mandant, appelez l’API principal-update sans spécifier le paramètre Si vous créez un mandant, le code XML renvoyé contient les informations sur le nouveau mandant, y compris son identifiant. principal-id. Dans Breeze 4, l’API principal-update vous autorisait à actualiser les champs personnalisés. Dans Breeze 5.1, vous devez appeler acl-field-update pour les actualiser. Paramètres Description du nouveau groupe. Utilisé uniquement lors de la création d’un nouveau groupe. description first-name Nouveau prénom à affecter à l’utilisateur. Utilisé uniquement lors de la création ou de l’actualisation d’un utilisateur. Indique si le mandant possède des enfants. Si le mandant est un groupe, ce paramètre doit être mis à 1. Si le mandant est un utilisateur, ce paramètre doit être mis à 0. has-children Nouveau nom à affecter à l’utilisateur. Utilisé uniquement lors de la création ou de l’actualisation d’un utilisateur. last-name 78 Chapitre 4 : Informations de référence sur les API XML Nouveau nom de connexion du mandant, qui correspond généralement à son adresse électronique. Utilisé uniquement lors de la création ou de l’actualisation d’un utilisateur. login name Nom du nouveau groupe. Utilisé uniquement lors de la création d’un nouveau groupe. Mot de passe du nouvel utilisateur. Utilisé uniquement lors de la création d’un nouvel utilisateur. password Identifiant du mandant dont vous modifiez les données. Si vous ne précisez pas ce paramètre, l’API principal-update crée un nouveau mandant. principal-id 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 Présentation des mandants, des SCO et des identifiants, page 17. type Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Si vous actualisez un mandant existant, aucun élément n’est renvoyé. Si vous créez un mandant, principal est renvoyé (dans le même format que les éléments renvoyés pour principal-info). Exemple de résultats 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" accountid="181224"> <login>[email protected]</login> <name>doe, jake</name> </principal> </results> Voir aussi principal-info, principals-delete, principal-list, principal-list-by-field principals-delete Description Supprime un ou plusieurs mandants. Pour supprimer plusieurs mandants, transmettez plusieurs paramètres principal-id. Pour plus d’informations, consultez la section Présentation des paramètres, page 16. Paramètres principal-id Identifiant d’un mandant à supprimer. principals-delete 79 Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi principal-info, principal-list, principal-list-by-field, principal-update report-account-meeting-attendance Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Pour savoir quels mandants ont assisté à quelles réunions, utilisez l’API report-meetingattendance ou report-bulk-consolidated-transactions. Description Renvoie le journal de participation aux réunions associé au compte. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-closed Filtrage et tri date-created Filtrage et tri login Filtrage et tri participant-name Tri principal-id Filtrage et tri sco-name Tri tr.sco_id Filtrage et tri transcript-id Filtrage et tri Eléments renvoyés report-account-meeting-attendance 80 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <report-account-meeting-attendance> <row account-id="7" transcript-id="670" sco-id="623" principal-id="8" contact-id="3"> <login>[email protected]</login> <session-name>Enterprise Administrator</session-name> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T13:00:28.920-07:00</date-created> <date-closed>2004-07-09T13:02:55.810-07:00</date-closed> <participant-name>Enterprise Administrator</participant-name> </row> <row account-id="7" transcript-id="685" sco-id="623" principal-id="8" contact-id="3"> <login>[email protected]</login> <session-name>Enterprise Administrator</sessionname> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T14:33:06.577-07:00</datecreated> <date-closed>2004-07-09T14:33:43.547-07:00</dateclosed> <participant-name>Enterprise Administrator</participantname> </row> </report-account-meeting-attendance> </results> report-active-meeting-presenters Disponibilité Breeze 4. Description Renvoie la liste des utilisateurs qui sont actuellement présentateurs de réunions. Paramètres sco-id Identifiant d’une réunion ; si ce paramètre est spécifié, le rapport renvoie des informations sur cette réunion uniquement. Ce paramètre est facultatif. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-active-meeting-presenters report-active-meeting-presenters 81 Exemple de résultats <results> <status code="ok" /> <report-active-meeting-presenters> <sco sco-id="190298"> <name>Jack Monson</name> <date-created>2004-02-17T17:06:23.920-08:00</date-created> </sco> <sco sco-id="566058"> <name>Hans Gay</name> <date-created>2004-02-17T16:50:00.327-08:00</date-created> </sco> </report-active-meeting-presenters> </results> report-active-meetings Disponibilité Breeze 4. Description Renvoie la liste des réunions en cours. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-active-meetings Exemple de résultats <results> <status code="ok"/> <report-active-meetings> <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path> <date-created>2005-02-28T16:09:28.510-08:00</date-created> </sco> <sco sco-id="38345152" active-participants="1" length-minutes="1"> <name>Status Meeting</name> <url-path>/status/</url-path> <date-created>2005-02-28T16:10:21.353-08:00</date-created> </sco> </report-active-meetings> </results> 82 Chapitre 4 : Informations de référence sur les API XML report-bandwidth Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Description Indique la bande passante totale utilisée par le compte actif depuis sa création, en octets. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-bandwidth Exemple de résultats <results> <status code="ok" /> <report-bandwidth total="71000000" /> </results> report-bulk-consolidated-transactions Disponibilité Breeze 5.1. Description Renvoie des informations sur toutes les transactions associées à un compte. Une transaction correspond à une occurrence de mandant participant à un SCO. Envisagez les cas de figure suivants : • Si un mandant assiste deux fois à une réunion, deux transactions correspondantes sont générées : une par réunion à laquelle il a assisté. • Si cinq personnes assistent à une réunion, cinq transactions sont générées pour le SCO réunion : une par utilisateur. • Si un mandant participe trois fois à deux cours et ne réussit ces derniers qu’à la troisième tentative, six transactions sont générées pour le mandant : une par tentative et par cours. Paramètres Aucun. report-bulk-consolidated-transactions 83 Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-created Filtrage et tri login Filtrage et tri name Filtrage et tri principal-id Filtrage et tri score Filtrage et tri status Filtrage et tri transaction-id Filtrage et tri url Filtrage et tri user-name Filtrage et tri Eléments renvoyés report-bulk-consolidated-transactions Exemple de résultats <results> <status code="ok" /> <report-bulk-consolidated-transactions> <row transaction-id="3777813" principal-id="2564976" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>[email protected]</login> <user-name>Ben Harm</user-name> <status>completed</status> <date-created>2005-01-29T14:02:04.733-08:00</date-created> </row> <row transaction-id="4832819" principal-id="181271" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>[email protected]</login> <user-name>Gung Ho</user-name> <status>completed</status> <date-created>2005-01-04T10:10:09.077-08:00</date-created> </row> </report-bulk-consolidated-transactions> </results> Voir aussi report-bulk-objects, report-bulk-questions, report-bulk-slide-views, report-bulk-users 84 Chapitre 4 : Informations de référence sur les API XML report-bulk-content-quiz Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par les API suivantes : report-bulk-questions et report-quiz-interactions. Description Renvoie des informations sur tous les questionnaires, y compris la liste des questionnaires et les questions et réponses correspondantes. Les informations renvoyées sont similaires à celles du rapport à télécharger « Informations sur les questionnaires du contenu », mais sont au format XML plutôt que CSV. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-bulk-content-quiz Exemple de résultats <results> <status code="ok" /> - <report-bulk-content-quiz> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="1"> <presentation-name>test-quiz</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson ?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answertext> <answer-correct>YES</answer-correct> </row> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="2"> <presentation-name>test-quiz</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson ?</question-text> <answer-text>A basketball player with the New Jersey Nets</answer-text> <answer-correct>NO</answer-correct> </row> </report-bulk-content-quiz> </results> report-bulk-content-quiz 85 report-bulk-content-quiz-results Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par les API suivantes : report-quiz-interactions, report-quiz-question-distribution, report-quiz-question-response, report-quiz-summary, report-quiz-takers. Description Renvoie les résultats d’un questionnaire du contenu, y compris des informations sur chaque utilisateur et chaque question. Les informations renvoyées sont similaires à celles du rapport à télécharger « Réponses et résultats des questionnaires du contenu », mais l’API report-bulkquiz-results renvoie des données XML plutôt que des données CSV. Attention : Le formatage de la balise XML time-taken était incorrect, mais le problème a été résolu par le programme de mise à jour de Breeze 4.1. Si le format du contenu d’une balise XML time-taken est incorrect, téléchargez le programme de mise à jour du site Licensed Support Center. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-time-attempted Filtrage uniquement presentation-attempt-id Filtrage uniquement presentation-id Filtrage uniquement question-number Filtrage et tri quiz-id Filtrage uniquement user-id Filtrage et tri user-login Filtrage uniquement user-response Filtrage uniquement Eléments renvoyés report-bulk-content-quiz-results 86 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <report-bulk-content-quiz-results> <row user-id="8" presentation-attempt-id="725" presentation-id="720" quiz-id="1" question-number="1" user-response="1"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:51:35.047-07:00</date-timeattempted> <time-taken>00:00:28.017</time-taken> </row> <row user-id="8" presentation-attempt-id="726" presentation-id="720" quiz-id="1" question-number="2" user-response="3"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:52:23.780-07:00</date-timeattempted> <time-taken>00:00:45.046</time-taken> </row> </report-bulk-content-quiz-results> </results> report-bulk-content-slide-views Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par l’API report-bulk-slide-views. Description Renvoie des données sur l’affichage des diapositives pour le contenu. Les informations renvoyées sont similaires à celles du rapport à télécharger « Affichage des diapositives », mais sont au format XML plutôt que CSV. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri presentation-id Tri presentation-name Tri slide-number Filtrage et tri user-first-name Tri user-last-name Tri user-login Tri view-date-time Tri report-bulk-content-slide-views 87 Eléments renvoyés report-bulk-slide-views Exemple de résultats <results> <status code="ok" /> <report-bulk-slide-views> <row session-id="10000022" viewing-session="32" presentation-id="27" slide-number="1"> <user-login>[email protected]</user-login> <user-first-name>Enterprise</user-first-name> <user-last-name>Administrator</user-last-name> <presentation-name>test-slide</presentation-name> <view-date-time>2004-06-30T11:46:10.280-07:00</view-date-time> </row> <row session-id="10000022" viewing-session="32" presentation-id="27" slide-number="2"> <user-login>[email protected]</user-login> <user-first-name>Enterprise</user-first-name> <user-last-name>Administrator</user-last-name> <presentation-name>test-slide</presentation-name> <view-date-time>2004-06-30T11:46:12.500-07:00</view-date-time> </row> </report-bulk-slide-views> </results> report-bulk-course-quiz Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Description Renvoie des informations sur tous les questionnaires du cours, y compris la liste des questionnaires et les questions et réponses correspondantes. Les informations renvoyées sont similaires à celles du rapport « Informations sur les questionnaires des cours », mais sont au format XML plutôt que CSV. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-bulk-course-quiz 88 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <report-bulk-course-quiz> <row course-id="727" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="1"> <presentation-name>quiz-course-ln</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson ?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answertext> <answer-correct>YES</answer-correct> </row> <row course-id="727" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="2"> <presentation-name>quiz-course-ln</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson ?</question-text> <answer-text>A basketball player with the New Jersey Nets</answer-text> <answer-correct>NO</answer-correct> </row> </report-bulk-course-quiz> </results> report-bulk-course-results Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par l’API report-quiz-interactions. Description Renvoie les résultats d’un questionnaire du cours, y compris des informations sur chaque utilisateur et chaque question. Les informations renvoyées sont similaires à celles du rapport « Réponses et résultats des questionnaires du cours », mais sont au format XML plutôt que CSV. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri course-attempt-id Tri course-id Tri date-time-attempted Tri quiz-id Tri question-number Filtrage et tri report-bulk-course-results 89 Champ Filtrage/tri time-taken Tri user-id Filtrage et tri user-login Tri user-response Tri Eléments renvoyés report-bulk-course-quiz-results Exemple de résultats <results> <status code="ok" /> <report-bulk-course-quiz-results> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="1" user-response="2"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-timeattempted> <time-taken>00:00:14.017</time-taken> </row> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="2" user-response="1"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-timeattempted> <time-taken>00:00:34.017</time-taken> </row> </report-bulk-course-quiz-results> </results> Attention : Le formatage de la balise XML time-taken était incorrect, mais le problème a été résolu par le programme de mise à jour de Breeze 4.1. Si le format du contenu d’une balise XML time-taken est incorrect, téléchargez le programme de mise à jour du site Licensed Support Center. report-bulk-meeting Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par le filtre et l’APi report-bulk-objects pour le champ type, ainsi que l’illustre l’exemple suivant : http://breezeserver/api/xml?action=report-bulk-objects&filter-liketype=meeting Description Renvoie des informations sur toutes les réunions. Les informations renvoyées sont similaires à celles du rapport consacré aux informations sur les réunions, mais sont au format XML plutôt que CSV. 90 Chapitre 4 : Informations de référence sur les API XML Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-bulk-meeting Exemple de résultats <results> <status code="ok" /> <report-bulk-meeting> <row meeting-id="623" invited-participants="3"> <meeting-name>test-mtg-1</meeting-name> <meeting-scheduled-date-time>2004-07-07T10:00:00.000-07:00</meetingscheduled-date-time> </row> <row meeting-id="679" invited-participants="2"> <meeting-name>test-mtg-2</meeting-name> <meeting-scheduled-date-time>2004-07-09T14:00:00.000-07:00</meetingscheduled-date-time> </row> </report-bulk-meeting> </results> report-bulk-meeting-attendance Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Description Renvoie des données sur la participation aux réunions. Les informations renvoyées sont similaires à celles du rapport « Participation aux réunions », mais sont au format XML plutôt que CSV. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri attendee Tri attendee-exit Tri attendee-join Tri meeting-attendee Tri report-bulk-meeting-attendance 91 Champ Filtrage/tri meeting-id Tri meeting-name Tri Eléments renvoyés report-bulk-meeting-attendance Exemple de résultats <results> <status code="ok" /> <report-bulk-meeting-attendance> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T13:00:28.920-07:00</attendee-join> <attendee-exit>2004-07-09T13:02:55.810-07:00</attendee-exit> </row> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T14:33:06.577-07:00</attendee-join> <attendee-exit>2004-07-09T14:33:43.547-07:00</attendee-exit> </row> </report-bulk-meeting-attendance> </results> report-bulk-objects Disponibilité Breeze 5.1. Description Renvoie des informations sur chaque objet hébergé sur le serveur Breeze. Parmi les types d’objets figurent archive, pièce jointe, Authorware, Captivate, cours, curriculum, événement externe, FLV, image, réunion, présentation et SWF. Utilisez des filtres pour limiter les données XML renvoyées. Ainsi, pour renvoyer la liste des réunions associées à un compte, filtrez les données en fonction du champ type, ainsi que l’illustre l’exemple suivant : http://breezeserver/api/xml?action=report-bulk-objects&filter-liketype=meeting Paramètres Aucun. 92 Chapitre 4 : Informations de référence sur les API XML Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-modified Filtrage et tri name Filtrage et tri type Filtrage et tri url Filtrage et tri Attention : Breeze 5.1 ne gère pas le filtrage du champ type en fonction d’une valeur déterminée. Vous devez utiliser à cet effet le modificateur like. Par exemple, dans le code ci-dessous, la première ligne déclenche une exception, mais la deuxième ligne s’exécute correctement : http://breezeserver/api/xml?action=report-bulk-objects&filter-type=meeting http://breezeserver/api/xml?action=report-bulk-objects&filter-liketype=meeting Eléments renvoyés report-bulk-objects Exemple de résultats <results> <status code="ok" /> <report-bulk-objects> <row> <url>/pf232654/</url> <type>presentation</type> <name>232654</name> <date-created>2003-07-14T14:54:16.757-07:00</date-created> <date-end>2003-07-14T14:54:16.757-07:00</date-end> <date-modified>2003-10-30T12:14:52.740-08:00</date-modified> </row> <row> <url>/p30542007/</url> <type>presentation</type> <name>181438 Bullet Animation Test.ppt</name> <date-created>2003-07-14T14:54:16.757-07:00</date-created> <date-end>2003-07-14T14:54:16.757-07:00</date-end> <date-modified>2003-07-14T14:52:32.327-07:00</date-modified> </row> </report-bulk-objects> </results> Voir aussi report-bulk-consolidated-transactions, report-bulk-questions, report-bulk-slideviews, report-bulk-users report-bulk-objects 93 report-bulk-questions Disponibilité Breeze 5.1. Description Renvoie des informations sur chaque question de questionnaire dans un compte déterminé. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-created Filtrage et tri principal-id Filtrage et tri question Filtrage et tri response Filtrage et tri score Filtrage et tri transaction-id Filtrage et tri Eléments renvoyés report-bulk-questions Exemple de résultats <results> <status code="ok"/> <report-bulk-questions> <row transaction-id="38484112" score="10" principal-id="38181502"> <question>Is a capacitor active?</question> <response>false</response> <date-created>2005-03-24T16:36:36.100-08:00</date-created> </row> <row transaction-id="5335430" score="10" principal-id="4975764"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{green,red,Bob’s}</response> <date-created>2005-03-24T15:16:39.030-08:00</date-created> </row> <row transaction-id="5335151" score="0" principal-id="4954032"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{j,k,Bob’s}</response> <date-created>2005-03-24T11:52:14.280-08:00</date-created> </row> <row transaction-id="5335144" score="10" principal-id="4954032"> 94 Chapitre 4 : Informations de référence sur les API XML <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{red,green,Bob’s}</response> <date-created>2005-03-24T11:46:53.950-08:00</date-created> </row> </report-bulk-questions> </results> Voir aussi report-bulk-objects, report-bulk-consolidated-transactions, report-bulk-slideviews, report-bulk-users report-bulk-slide-views Disponibilité Breeze 5.1. Description Renvoie des informations sur chaque occurrence d’un mandant qui affiche une diapositive dans un compte. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-created Filtrage et tri page Filtrage et tri principal-id Filtrage et tri transaction-id Filtrage et tri Eléments renvoyés report-bulk-slide-views Exemple de résultats <results> <status code="ok"/> <report-bulk-slide-views> <row transaction-id="38484112" principal-id="38181502"> <page>0</page> <date-created>2005-03-24T16:36:41.820-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>4</page> <date-created>2005-03-24T16:37:53.070-08:00</date-created> </row> report-bulk-slide-views 95 <row transaction-id="38484112" principal-id="38181502"> <page>5</page> <date-created>2005-03-24T16:38:09.070-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>1</page> <date-created>2005-03-24T16:36:47.663-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>2</page> <date-created>2005-03-24T16:37:04.303-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>3</page> <date-created>2005-03-24T16:37:15.710-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>6</page> <date-created>2005-03-24T16:38:29.833-08:00</date-created> </row> </report-bulk-slide-views> </results> Voir aussi report-bulk-objects, report-bulk-questions, report-bulk-consolidatedtransactions, report-bulk-users report-bulk-users Disponibilité Breeze 5.1. Description Renvoie des informations sur tous les utilisateurs associés à un compte. N’oubliez pas d’utiliser des filtres pour limiter vos résultats. Exemple : Le code ci-dessous renvoie tous les utilisateurs dont le nom contient les lettres « Jo », triés par ordre croissant : http://admin.ibreeze.macromedia.com/api/xml?action=report-bulk-users&sortname=asc&filter-like-name=Jo Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. 96 Champ Filtrage/tri email Filtrage et tri login Filtrage et tri Chapitre 4 : Informations de référence sur les API XML Champ Filtrage/tri manager Filtrage et tri name Filtrage et tri principal-id Filtrage et tri type Filtrage et tri Attention : Breeze 5.1 ne gère pas le filtrage du champ type en fonction d’une valeur déterminée. Vous devez utiliser à cet effet le modificateur like. Par exemple, dans le code ci-dessous, la première ligne déclenche une exception, mais la deuxième ligne s’exécute correctement : http://breezeserver/api/xml?action=report-bulk-objects&filtertype=presentation http://breezeserver/api/xml?action=report-bulk-objects&filter-liketype=presentation Eléments renvoyés report-bulk-users Exemple de résultats <results> <status code="ok" /> <report-bulk-users> <row principal-id="181231"> <login>[email protected]</login> <name>Nathan Son</name> <email>[email protected]</email> <manager>[email protected]</manager> <type>user</type> </row> <row principal-id="182532"> <login>[email protected]</login> <name>laxmi vish</name> <email>[email protected]</email> <type>user</type> </row> <row principal-id="3914851"> <login>[email protected]</login> <name>Apple Cobbler</name> <email>[email protected]</email> <manager>[email protected]</manager> <type>user</type> </row> </report-bulk-users> </results> Voir aussi report-bulk-objects, report-bulk-questions, report-bulk-slide-views, report-bulk-consolidated-transactions report-bulk-users 97 report-course-status Disponibilité Breeze 4. Description Renvoie l’état des cours pour un mandant ou un SCO, en fonction des paramètres passés. Paramètres principal-id sco-id Identifiant du mandant pour lequel l’état du cours a été demandé. Identifiant du SCO pour lequel l’état du cours a été demandé. Remarque : Vous ne devez passer qu’un des paramètres principal-id ou sco-id, selon le type d’information requis. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-course-status Exemple de résultats Si vous passez le paramètre sco-id, le code XML suivant risque d’être renvoyé : <results> <status code="ok" /> <report-course-status total-course-completions="2" total-unique-coursecompletions="1" num-passed="1" num-failed="1" num-enrollees="3"> <date-last-taken>2004-07-13T10:55:28.763-07:00</date-last-taken> </report-course-status> </results> Si vous passez le paramètre principal-id, le code XML suivant risque d’être renvoyé : <results> <status code="ok" /> <report-course-status total-course-completions="4" total-unique-coursecompletions="4" num-passed="3" num-failed="1"> <date-last-taken>2004-07-27T12:53:42.297-07:00</date-last-taken> </report-course-status> </results> 98 Chapitre 4 : Informations de référence sur les API XML report-course-takers Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par report-quiz-takers. Description Renvoie la liste des utilisateurs inscrits au cours spécifié. Paramètres sco-id Identifiant d’un cours. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri answered-survey Tri date-taken Filtrage et tri certificate Tri login Tri percentage-score Filtrage et tri principal-name Tri sco-id Filtrage et tri status Filtrage et tri transcript-id Filtrage et tri time-taken Tri Tri Vous pouvez baser le tri des données sur tout champ personnalisé associé au compte. Il est en revanche impossible de filtrer en fonction d’un champ personnalisé. Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-takers report-course-takers 99 Exemple de résultats <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="13106" sco-id="13105" principal-id="10021" status="user-passed" score="2" certificate="13106" attempts="1"> <login>[email protected]</login> <date-taken>2005-03-02T16:00:33.170-08:00</date-taken> <principal-name>Bart Cassaly</principal-name> </row> <row transcript-id="13110" sco-id="13105" principal-id="11211" status="user-failed" score="0" certificate="13110" attempts="1"> <login>[email protected]</login> <date-taken>2005-03-02T16:03:36.750-08:00</date-taken> <principal-name>George Best</principal-name> </row> <row transcript-id="14102" sco-id="13105" principal-id="12029" status="user-passed" score="2" certificate="14102" attempts="4"> <login>[email protected]</login> <date-taken>2005-03-04T16:37:31.077-08:00</date-taken> <principal-name>Finbarr Cassidy</principal-name> </row> </report-quiz-takers> </results> report-disk-usage Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. 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 Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-disk-usage Exemple de résultats <results> <status code="ok" /> <report-disk-usage total="849327881" /> </results> 100 Chapitre 4 : Informations de référence sur les API XML report-meeting-attendance Disponibilité Breeze 4. Description Renvoie la liste des utilisateurs ayant assisté à la réunion spécifiée. Si la réunion n’a pas encore commencé, le tableau des données renvoyées ne contient pas de lignes. Les données n’incluent pas les utilisateurs qui ont été invités à la réunion, mais n’y ont pas participé. Paramètres sco-id Identifiant d’une réunion. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri answered-survey Filtrage et tri date-created Filtrage et tri date-end Filtrage et tri login Filtrage et tri participant-name Filtrage et tri principal-id Filtrage et tri sco-id Filtrage et tri sco-name Filtrage et tri session-name Filtrage et tri transcript-id Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-meeting-attendance report-meeting-attendance 101 Exemple de résultats <results> <status code="ok" /> <report-meeting-attendance> <row transcript-id="18308" sco-id="18302" principal-id="10021" answeredsurvey="0"> <login>[email protected]</login> <session-name>Bart Cassaly</session-name> <sco-name>8th Meeting</sco-name> <date-created>2005-03-15T10:11:00.700-08:00</date-created> <date-end>2005-03-15T10:13:12.810-08:00</date-end> <participant-name>Bart Cassaly</participant-name> </row> </report-meeting-attendance> </results> report-meeting-concurrent-users Disponibilité Breeze 4. Description Indique le nombre maximal d’utilisateurs pouvant participer simultanément à la réunion spécifiée. Ce nombre maximal est déterminé par la licence du compte. Paramètres sco-id Identifiant d’une réunion. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-meeting-concurrent-users Exemple de résultats <results> <status code="ok" /> <report-meeting-concurrent-users max-users="426" max-participants-freq="1" /> </results> report-meeting-session Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Breeze 5.1 vous permet d’appeler le filtre et l’API report-meeting-sessions sur le champ asset-id pour renvoyer des données relatives à une session de réunion spécifique. 102 Chapitre 4 : Informations de référence sur les API XML Description Fournit des informations sur une session de réunion déterminée, tels son nom, ses horaires de début et de fin, ainsi que le nombre de participants et d’hôtes qui y ont assisté. 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 sco-id Identifiant d’une réunion. Cette valeur doit correspondre à la valeur sco-id associée à une session de réunion déterminée. Pour obtenir la liste des sessions et des sco-ids correspondants, appelez l’API report-meeting-sessions. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-meeting-session Exemple de résultats <results> <status code="ok" /> <report-meeting-session session-sco-id="671" sco-id="623" numparticipants="1" num-guests="0"> <name>test-mtg-1 - 1</name> <date-begin>2004-07-09T13:00:32.153-07:00</date-begin> <date-end>2004-07-09T13:08:57.483-07:00</date-end> </report-meeting-session> </results> Voir aussi report-meeting-sessions report-meeting-sessions Disponibilité Breeze 4. 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 sco-id Identifiant d’une réunion. report-meeting-sessions 103 Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri asset-id Filtrage et tri date-created Filtrage et tri date-end Filtrage et tri num-participants Tri sco-id Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-meeting-sessions Exemple de résultats <results> <status code="ok" /> <report-meeting-sessions> <row sco-id="18302" asset-id="18304" num-participants="1"> <date-created>2005-03-15T09:30:28.233-08:00</date-created> <date-end>2005-03-15T09:45:36.903-08:00</date-end> </row> <row sco-id="18302" asset-id="18309" num-participants="1"> <date-created>2005-03-15T10:11:00.700-08:00</date-created> <date-end>2005-03-15T10:21:07.733-08:00</date-end> </row> </report-meeting-sessions> </results> report-meeting-session-slots Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Description Renvoie des informations sur le nombre de participants à la session de réunion spécifiée pour chaque période de 10 minutes. Paramètres sco-id Identifiant d’une session de réunion valide Pour obtenir cet identifiant, appelez l’API report-meeting-session-slots. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Par défaut, le tri est basé sur l’heure de début de la période. 104 Chapitre 4 : Informations de référence sur les API XML Eléments renvoyés report-meeting-session-slots Exemple de résultats <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 Disponibilité Breeze 4. Description Indique le nombre d’utilisateurs invités à la réunion spécifiée et le nombre d’invités et d’hôtes qui y ont assisté. Paramètres sco-id Identifiant d’une réunion. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-meeting-summary Exemple de résultats <results> <status code="ok" /> <report-meeting-summary num-unique-meetings="2" peak-users="" numinvitees="4" num-invitees-attended="1" ispublic="0" num-guests-attended="0"> <most-recent-session>2005-03-15T10:11:00.700-08:00</most-recent-session> </report-meeting-summary> </results> report-meeting-summary 105 report-my-courses Disponibilité Breeze 4. Description Renvoie des informations sur chaque cours auquel l’utilisateur connecté est inscrit. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-begin Filtrage et tri date-created Filtrage et tri date-modified Filtrage et tri expired Tri name Filtrage et tri sco-id Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés my-courses Exemple de résultats <results> <status code="ok"/> <my-courses> <course sco-id="555038" type="content" icon="course" permissionid="view"> <name>foooboo</name> <url>professor.ibreeze.macromedia.com/p38547860/</url> <date-created>2004-02-09T06:40:38.497-08:00</date-created> <date-modified>2005-02-13T13:21:33.937-08:00</date-modified> <date-begin>2004-02-09T06:30:00.000-08:00</date-begin> <date-end>2006-02-09T06:30:00.000-08:00</date-end> <url-path>/p38547860/</url-path> <expired>false</expired> <completed>true</completed> </course> 106 Chapitre 4 : Informations de référence sur les API XML <course sco-id="558906" type="content" icon="course" permissionid="view"> <name>1234test</name> <url>professor.ibreeze.macromedia.com/p50984837/</url> <date-created>2004-02-10T19:26:13.840-08:00</date-created> <date-modified>2004-02-10T19:33:51.763-08:00</date-modified> <date-begin>2004-02-10T19:00:00.000-08:00</date-begin> <date-end>2004-03-10T19:00:00.000-08:00</date-end> <url-path>/p50984837/</url-path> <expired>true</expired> <completed>false</completed> </course> </my-courses> </results> report-my-events Disponibilité Breeze 5.1. Description Renvoie des informations sur chaque événement auquel l’utilisateur connecté a prévu de participer. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-begin Filtrage et tri date-end Filtrage et tri description Filtrage et tri domain-name Filtrage et tri duration Tri icon Filtrage et tri sco-id Filtrage et tri url-path Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés my-events report-my-events 107 Exemple de résultats <results> <status code="ok" /> <my-events> <event sco-id="13923" type="event" icon="event" permission-id="host"> <name>1st Event</name> <domain-name>bcassidy02</domain-name> <url-path>/e95598585/</url-path> <date-begin>2005-03-05T13:00:00.000-08:00</date-begin> <date-end>2005-03-10T13:00:00.000-08:00</date-end> <expired>true</expired> <duration>5d 00:00:00.000</duration> </event> </my-events> </results> report-my-meetings Disponibilité Breeze 4. Description Renvoie des informations sur chaque réunion à laquelle l’utilisateur connecté a prévu de participer. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri active-participants Tri date-begin Tri date-end Tri duration Tri expired Tri icon Tri permission-id Tri sco-id Tri status Tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. 108 Chapitre 4 : Informations de référence sur les API XML Eléments renvoyés my-meetings Exemple de résultats <results> <status code="ok" /> <my-meetings> <meeting sco-id="10801" type="meeting" icon="meeting" permissionid="host" active-participants="3"> <name>1st Seminar</name> <domain-name>bcassidy02</domain-name> <url-path>/r21331159/</url-path> <date-begin>2005-02-25T10:00:00.000-08:00</date-begin> <date-end>2005-02-25T11:00:00.000-08:00</date-end> <expired>true</expired> <duration>01:00:00.000</duration> </meeting> </my-meetings> </results> report-principal-list Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Les informations sur les champs personnalisés renvoyées par report-principal-list ont été transférées dans des ACL dans Breeze 5.1. Pour plus de précisions, consultez les entrées consacrées aux API acl-field-info, acl-field-list et acl-field-update. Description Renvoie la liste de tous les mandants du compte. Cette API est similaire à l’API principal-list, mais renvoie des informations utilisateur complémentaires sur les champs personnalisés. Il s’agit de l’unique rapport dans lequel vous pouvez filtrer les utilisateurs en fonction des champs personnalisés du compte. Paramètres Aucun. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri all account custom fields Filtrage et tri has-children Filtrage et tri is-primary Filtrage et tri login Filtrage et tri name Filtrage et tri report-principal-list 109 Champ Filtrage/tri principal-id Filtrage et tri type Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-principal-list Exemple de résultats <results> <status code="ok" /> <report-principal-list> <row principal-id="8" type="user" has-children="false" isprimary="false"> <name>Enterprise Administrator</name> <login>[email protected]</login> <custom0 /> <custom1 /> </row> <row principal-id="17" type="admins" has-children="true" isprimary="true"> <name>Account Administrators</name> <login>Account Administrators</login> <custom0 /> <custom1 /> </row> <row principal-id="123" type="user" has-children="false" isprimary="false"> <name>test1 laxmi</name> <login>[email protected]</login> <custom0>ENGG</custom0> <custom1>100-07-7777</custom1> </row> </report-principal-list> </results> report-quiz-answer-distribution Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par des API qui gèrent les métadonnées de questionnaire. Pour plus d’informations, consultez les entrées relatives aux API report-quiz-interactions, reportquiz-question-answer-distribution, report-quiz-question-distribution etreport-quiz-question-response. 110 Chapitre 4 : Informations de référence sur les API XML Description Indique le nombre d’utilisateurs qui ont sélectionné une réponse spécifique à toutes les questions d’un questionnaire associé au SCO spécifié. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie le champ sur lequel baser le filtrage ou le tri des données. Champ Filtrage/tri question-number Tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-answer-distribution Exemple de résultats Le code XML ci-dessous contient des attributs relatifs aux options de réponse 1 à 8, même si la question ne comporte pas 8 réponses possibles. <results> <status code="ok" /> <report-quiz-answer-distribution> <row question-number="1" question-id="257" a1="0" a2="1" a3="0" a4="1" a5="0" a6="0" a7="0" a8="0" total="2"> <body>Who is Randy Johnson ?</body> </row> <row question-number="2" question-id="259" a1="1" a2="0" a3="1" a4="0" a5="0" a6="0" a7="0" a8="0" total="2"> <body>Who is Allan Iverson ?</body> </row> </report-quiz-answer-distribution> </results> Si le SCO ne contient pas de questionnaire, un élément report-quiz-answer-distribution vide est renvoyé, ainsi que l’illustre l’exemple ci-dessous. <results> <status code="ok" /> <report-quiz-answer-distribution /> </results> report-quiz-answer-distribution 111 report-quiz-definition-answers Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par des API qui gèrent les métadonnées de questionnaire. Pour plus d’informations, consultez les entrées relatives aux API report-quiz-interactions, reportquiz-question-answer-distribution, report-quiz-question-distribution etreport-quiz-question-response. Description Renvoie des informations sur chacune des réponses autorisées (à la fois correctes et incorrectes) du questionnaire spécifié. Si le SCO indiqué ne contient pas de questionnaire, un élément quizdefinition-answers vide est renvoyé. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Le tri primaire par défaut est basé sur les identifiants de question, triés par ordre croissant, le tri secondaire par défaut se fonde sur les identifiants de réponse, triés par ordre croissant. Eléments renvoyés quiz-definition-answers Exemple de résultats <results> <status code="ok" /> <quiz-definition-answers> <row answer-id="1" question-id="257" correct="0"> <body>22</body> </row> <row answer-id="2" question-id="257" correct="0"> <body>0</body> </row> <row answer-id="3" question-id="257" correct="1"> <body>4</body> </row> <row answer-id="1" question-id="258" correct="1"> <body>150,000,000 kilometers</body> </row> <row answer-id="2" question-id="258" correct="0"> <body>1 parsec</body> </row> <row answer-id="3" question-id="258" correct="0"> <body>100 kilometers</body> </row> 112 Chapitre 4 : Informations de référence sur les API XML <row answer-id="4" question-id="258" correct="0"> <body>300,000 kilometers</body> </row> <answer-text>ISO-9000</answer-text> </row> <row answer-id="1" question-id="259" correct="1"> <body>ECMA-262</body> </row> <row answer-id="2" question-id="259" correct="0"> <body>RFC 821</body> </row> <row answer-id="3" question-id="259" correct="0"> <body>ECMA-976</body> </row> </quiz-definition-answers> </results> report-quiz-definition-questions Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par des API qui gèrent les métadonnées de questionnaire. Pour plus d’informations, consultez les entrées relatives aux API report-quiz-interactions, report-quiz-question-answer-distribution, report-quiz-question-distribution etreport-quiz-question-response. Description Renvoie des informations sur chaque question d’un questionnaire. Si le SCO indiqué ne contient pas de questionnaire, un élément quiz-definition-questions vide est renvoyé. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri body Filtrage et tri chapter-id Filtrage et tri date-modified Filtrage et tri question-id Filtrage et tri question-number Filtrage et tri score Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. report-quiz-definition-questions 113 Eléments renvoyés quiz-definition-questions Exemple de résultats <results> <status code="ok" /> <quiz-definition-questions> <row question-number="1" question-id="257" score="20" chapter-id="1"> <body>What is 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>How far is it from Earth to the sun?</body> <date-modified>2004-01-13T17:09:40.230-08:00</date-modified> </row> <row question-number="3" question-id="259" score="20" chapter-id="1"> <body>Which international standard defines ECMAScript?</body> <date-modified>2004-01-13T17:09:40.240-08:00</date-modified> </row> </quiz-definition-questions> </results> report-quiz-interactions Disponibilité Breeze 4. Description Renvoie des informations sur toutes les interactions des utilisateurs avec le questionnaire spécifié. Une interaction est le choix effectué par un utilisateur dans le questionnaire. Ce rapport produit donc des informations sur toutes les réponses que chaque utilisateur a choisies pour chaque question du questionnaire. Dans les résultats renvoyés par cette API, l’attribut score indique la note reçue par le participant pour cette question. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. 114 Champ Filtrage/tri date-created Filtrage et tri description Filtrage et tri display-seq Filtrage et tri interaction-id Filtrage et tri Chapitre 4 : Informations de référence sur les API XML Champ Filtrage/tri name Filtrage et tri response Filtrage et tri score Filtrage et tri sco-name Filtrage et tri sco-id Filtrage et tri transcript-id Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-interactions Exemple de résultats <results> <status code="ok" /> <report-quiz-interactions> <row display-seq="1" transcript-id="17452" interaction-id="17442" scoid="17438" score="10"> <name>Barry Cassidy</name> <sco-name>All Question Types Quiz</sco-name> <date-created>2005-03-11T12:04:29.200-08:00</date-created> <description>A human being usually has <1> fingers.</description> <response>10</response> </row> </report-quiz-interactions> </results> report-quiz-question-answer-distribution Disponibilité Breeze 4. Description Indique le nombre d’utilisateurs qui ont sélectionné une réponse déterminée à une question de questionnaire indiquée (interaction). Utilisez les API report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l’identifiant d’une question. Cet identifiant sera passé comme paramètre interaction-id. Remarque : Les identifiants des questions ne correspondent pas nécessairement aux numéros affectés aux questions dans un questionnaire. Paramètres interaction-id sco-id Identifiant d’une question spécifique du questionnaire. Identifiant d’une présentation contenant un questionnaire. report-quiz-question-answer-distribution 115 Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri display_seq Filtrage et tri interaction_id Filtrage et tri num-selected Filtrage et tri response Filtrage et tri score Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-question-answer-distribution Exemple de résultats <results> <status code="ok" /> <report-quiz-question-answer-distribution> <row display-seq="1" interaction-id="17807" score="10" num-selected="1"> <response>D</response> </row> <row display-seq="0" interaction-id="17809" score="1" num-selected="1"> <response>0</response> </row> <row display-seq="0" interaction-id="17810" score="0" num-selected="1"> <response>2</response> </row> <row display-seq="0" interaction-id="17811" score="0" num-selected="1"> <response>C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E</response> </row> <row display-seq="1" interaction-id="17812" score="1" num-selected="1"> <response>1</response> </row> <row display-seq="2" interaction-id="17813" score="1" num-selected="1"> <response>2</response> </row> </report-quiz-question-answer-distribution> </results> 116 Chapitre 4 : Informations de référence sur les API XML report-quiz-question-distribution Disponibilité Breeze 4. Description Indique le nombre d’utilisateurs ayant répondu correctement à chaque question du questionnaire spécifié. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri description Filtrage et tri display-seq Filtrage et tri interaction-id Filtrage et tri name Filtrage et tri num-correct Tri num-incorrect Tri percentage-correct Tri score Tri total-responses Tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-question-distribution Exemple de résultats <results> <status code="ok" /> <report-quiz-question-distribution> <row display-seq="1" interaction-id="17807" num-correct="1" numincorrect="0" total-responses="1" percentage-correct="100" score="10"> <name>Interaction20008</name> <description>Which of the following is the capital city of California</ description> </row> </report-quiz-question-distribution> </results> report-quiz-question-distribution 117 report-quiz-question-response Disponibilité Breeze 4. Description Renvoie la liste de toutes les réponses choisies par des utilisateurs à une question particulière. Utilisez les API report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l’identifiant d’une question (cet identifiant sera passé comme paramètre question-id). Remarque : Les identifiants des questions ne correspondent pas nécessairement aux numéros affectés aux questions dans un questionnaire. Paramètres interaction-id sco-id Identifiant d’une question spécifique du questionnaire. Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-created Filtrage et tri interaction-id Filtrage et tri principal-id Filtrage et tri response Filtrage et tri user-name Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-quiz-question-response Exemple de résultats <results> <status code="ok" /> <report-quiz-question-response> <row principal-id="10021" interaction-id="17807"> <user-name>Barry Cassidy</user-name> <response>D</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> 118 Chapitre 4 : Informations de référence sur les API XML <row principal-id="10021" interaction-id="17809"> <user-name>Barry Cassidy</user-name> <response>0</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17810"> <user-name>Barry Cassidy</user-name> <response>2</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17811"> <user-name>Barry Cassidy</user-name> <response>C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17812"> <user-name>Barry Cassidy</user-name> <response>1</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17813"> <user-name>Barry Cassidy</user-name> <response>2</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> </report-quiz-question-response> </results> report-quiz-question-totals Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1. Cette API a été remplacée par l’API report-quiz-question-distribution. Description Indique le nombre total d’utilisateurs qui ont répondu à la question de questionnaire spécifiée et le nombre d’utilisateurs qui y ont répondu correctement. Utilisez les API report-quiz-definition-answers ou report-quiz-definition-questions pour déterminer l’identifiant d’une question (cet identifiant sera passé comme paramètre question-id). Remarque : Les identifiants des questions ne correspondent pas nécessairement aux numéros affectés aux questions dans un questionnaire. Paramètres question-id sco-id Identifiant d’une question spécifique du questionnaire. Identifiant d’une présentation contenant un questionnaire. report-quiz-question-totals 119 Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-quiz-question-totals Exemple de résultats <results> <status code="ok" /> <report-quiz-question-totals question-id="260" total-responses="8" num-correct-answers="5" /> </results> report-quiz-summary Disponibilité Breeze 4. Description Renvoie des informations sur les résultats d’un questionnaire. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-quiz-summary Exemple de résultats <results> <status code="ok" /> <report-quiz-summary> <row num-questions="0" average-score="10" low-score="10" high-score="10" numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> <date-created>2005-03-14T14:20:43.967-08:00</date-created> <passing-score>80</passing-score> </row> </report-quiz-summary> </results> 120 Chapitre 4 : Informations de référence sur les API XML report-quiz-takers Disponibilité Breeze 4. Description Renvoie des informations sur toutes les personnes ayant répondu à un questionnaire particulier. Pour obtenir la liste des SCO affichés par le mandant spécifié, passez le paramètre principal-id au lieu du paramètre sco-id. Vous pouvez en outre limiter la liste des SCO à un type déterminé en passant un paramètre type facultatif, indiqué dans le tableau ci-dessous. Type Description type=course Répertorie tous les cours auxquels a participé l’utilisateur. type=presentation Répertorie tous les contenus affichés par l’utilisateur. type=meeting Répertorie toutes les réunions auxquelles a assisté l’utilisateur. Si vous ne spécifiez pas de paramètre type, la liste de tous les cours, contenus et réunions associés à l’utilisateur est renvoyée. Paramètres sco-id Identifiant d’une présentation contenant un questionnaire. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri answered-survey Filtrage et tri attempts Filtrage et tri contact-id Filtrage et tri date-created Filtrage et tri login Filtrage et tri principal-id Filtrage et tri principal-name Filtrage et tri status Filtrage et tri score Filtrage et tri time-taken Filtrage et tri transcript-id Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. report-quiz-takers 121 Eléments renvoyés report-quiz-takers Exemple de résultats <results> <status code="ok" /> <report-quiz-takers> <row transcript-id="17466" sco-id="17438" principal-id="10021" status="user-failed" score="0" attempts="2" time-taken="152000" certificate="" answered-survey="1"> <name>All Question Types Quiz</name> <login>[email protected]</login> <date-created>2005-03-11T12:07:04.890-08:00</date-created> <principal-name>Barry Cassaly</principal-name> </row> <row transcript-id="17619" sco-id="17438" principal-id="11211" status="user-passed" score="60" attempts="1" time-taken="89360" certificate="17619" answered-survey="1"> <name>All Question Types Quiz</name> <login>[email protected]</login> <date-created>2005-03-11T14:52:34.903-08:00</date-created> <principal-name>George Best</principal-name> </row> </report-quiz-takers> </results> report-quotas Disponibilité Breeze 4. Description Renvoie des informations sur les quotas de compte. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-quotas 122 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> <report-quotas> <quota acl-id="181224" quota-id="2" used="6545516" limit="unlimited" softlimit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="download-quota" used="0" limit="unlimited" soft-limit="1000000000"> <date-begin>2004-03-24T13:13:18.467-08:00</date-begin> <date-end>2999-12-31T16:00:00.077-08:00</date-end> </quota> <quota acl-id="181224" quota-id="user-quota" used="6545516" limit="unlimited" soft-limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="course-quota" used="6545516" limit="unlimited" soft-limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> </report-quotas> </results> report-sco-slides Disponibilité Breeze 4. Description Indique le nombre de fois que chaque diapositive d’une présentation a été visionnée, ainsi que la date du dernier affichage. Paramètres sco-id asset-id Identifiant d’une présentation. Identifiant d’un actif. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-created Tri slide Tri views Tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. report-sco-slides 123 Eléments renvoyés report-sco-slides Exemple de résultats <results> <status code="ok" /> <report-sco-slides> <row slide="0" asset-id="17805" views="1"> <date-created>2005-03-14T14:20:46.733-08:00</date-created> </row> <row slide="1" asset-id="17805" views="1"> <date-created>2005-03-14T14:20:51.827-08:00</date-created> </row> <row slide="2" asset-id="17805" views="1"> <date-created>2005-03-14T14:21:01.937-08:00</date-created> </row> </report-sco-slides> </results> report-sco-views Disponibilité Breeze 4. Description Indique le nombre de fois que la présentation spécifiée a été visionnée, ainsi que la date du dernier affichage. Paramètres sco-id Identifiant d’une présentation. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés report-sco-views Exemple de résultats <results> <status code="ok" /> <report-sco-views> <row sco-id="17803" type="content" is-folder="0" views="1" principalid="10021" transcript-id="17808" asset-id="17805"> <name>One Question - New</name> <last-viewed-date>2005-03-14T14:20:43.967-08:00</last-viewed-date> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> </report-sco-views> </results> 124 Chapitre 4 : Informations de référence sur les API XML report-survey-question-response Disponibilité Cette API est gérée par Breeze 4, mais non par Breeze 5.1 Cette API a été remplacée par report-quiz-question-response. Description Renvoie la liste des utilisateurs qui ont répondu à la question spécifiée, ainsi que leur réponse. Paramètres question-id sco-id Identifiant de la question. Identifiant du SCO. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri principal-id Tri response Filtrage et tri user-name Tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés report-survey-question-response Exemple de résultats <results> <status code="ok" /> <report-survey-question-response> <row principal-id="8" question-number="1"> <user-name>Enterprise Administrator</user-name> <question>how are you?</question> <response>fine</response> </row> <row principal-id="123" question-number="1"> <user-name>test1 laxmi</user-name> <question>how are you?</question> <response>ok</response> </row> </report-survey-question-response> </results> report-survey-question-response 125 sco-build Disponibilité Breeze 4. Description Provoque la compilation du SCO spécifié par le serveur Breeze lorsque vous créez des présentations par le biais de l’API XML. (Pour plus d’informations, consultez sco-update et sco-upload.) Un SCO ne peut pas être visualisé tant qu’il n’a pas été compilé. Appelez cette API après avoir transféré un SCO par le biais de l’API sco-upload. Si vous transférez une nouvelle version d’un SCO existant, vous devez le recompiler en appelant l’API sco-build. Tant que la recompilation n’est pas exécutée, les utilisateurs continuent à voir l’ancienne version de ce SCO. Vous pouvez appeler l’API sco-info pour obtenir l’état de compilation actuel du SCO. L’état d’un SCO correspond initialement à en cours, indiquant ainsi que le contenu est en cours de compilation. Lorsque l’état devient actif, la compilation du contenu est terminée et ce dernier peut être affiché. Paramètres sco-id Identifiant d’un SCO à compiler. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> Voir aussi sco-upload sco-contents Disponibilité Breeze 4. Description Renvoie la liste des SCO du dossier spécifié. Dans la mesure où les dossiers sont eux-mêmes des SCO, la liste renvoyée comprend les dossiers contenus dans le dossier spécifié, mais cette liste ne comprend pas le contenu de ces sous-dossiers. 126 Chapitre 4 : Informations de référence sur les API XML Breeze gère les types de SCO suivants : SCO Description contenu Fichier accessible en lecture transféré sur le serveur Breeze, tel un fichier FLV, un fichier HTML, une image, un module, etc. curriculum Curriculum Breeze événement Evénement Breeze dossier Un dossier stocké sur le disque dur du serveur qui renferme un contenu Breeze. lien Une référence à un autre SCO, utilisée par un curriculum pour accéder à d’autres SCO. Lorsqu’un contenu est ajouté à un curriculum, un lien est établi entre ce dernier et le contenu. réunion Réunion Breeze arborescence La racine d’une arborescence de dossiers. La racine d’une arborescence est traitée en tant que hiérarchie indépendante. Vous ne pouvez pas déterminer le dossier parent d’une arborescence à partir de cette arborescence. sco-id Identifiant d’un dossier. Filtres Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données. Champ Filtrage/tri date-begin Filtrage et tri date-end Filtrage et tri date-modified Filtrage et tri duration Tri is-folder Tri name Filtrage et tri sco-id Filtrage et tri status Filtrage et tri type Filtrage et tri Pour plus d’informations sur le filtrage et le tri, consultez le Chapitre 2, Utilisation de filtres, page 21. Eléments renvoyés scos sco-contents 127 Exemple de résultats Les éléments name et date-modified sont systématiquement renvoyés, mais les éléments datebegin, date-end et duration sont réservés aux SCO dont l’attribut type correspond à course ou meeting. <results> <status code="ok" /> <scos> <sco sco-id="505677" status="no-content" type="folder" is-folder="1"> <name>PPT meeting tests</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>My Name</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>My Name 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> Voir aussi sco-expanded-contents sco-delete Disponibilité Breeze 4. Description Supprime un ou plusieurs SCO. Si le paramètre sco-id indiqué est un dossier, son contenu est également supprimé. Pour supprimer plusieurs SCO, transmettez plusieurs paramètres sco-id. Pour plus d’informations, consultez la section Présentation des paramètres, page 16. Paramètres sco-id Identifiant d’un SCO. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. 128 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> </results> Voir aussi sco-info, sco-move, sco-nav sco-expanded-contents Disponibilité Breeze 5.1. Description Répertorie tous les SCO d’un dossier. Paramètres sco-id Identifiant d’un dossier. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés expanded-scos Exemple de résultats <results> <status code="ok" /> <expanded-scos> <sco depth="0" sco-id="5400248" folder-id="5400246" type="link" icon="producer" lang="en" source-sco-id="5413507" display-seq="1" sourcesco-type="0"> <name>Beginning Electronics</name> <url-path>/l47843877/</url-path> <date-created>2005-03-31T12:16:54.840-08:00</date-created> <date-modified>2005-03-31T12:17:39.437-08:00</date-modified> </sco> </expanded-scos> </results> sco-info Disponibilité Breeze 4. Description Renvoie des informations sur un SCO. Pour obtenir des informations sur les SCO, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. sco-info 129 Paramètres sco-id Identifiant d’un SCO. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Les balises renvoyées dépendent du type SCO de l’élément indiqué. Principales balises susceptibles d’être renvoyées : sco, sco-author, sco-data, source-sco Exemple de résultats Exemple de code XML associé à un SCO dont l’attribut type correspond à sample : <results> <status code="ok" /> <sco folder-id="15" host-id="" lang="en" learning-time="" sco-data-id="625" sco-id="623" source-sco-id="" status="active" tree-id="14" type="meeting"> <date-begin>2004-07-07T10:00:00.000-07:00</date-begin> <date-created>2004-07-07T10:05:33.200-07:00</date-created> <date-end>2004-07-07T11:00:00.000-07:00</date-end> <date-modified>2004-07-09T15:09:41.390-07:00</date-modified> <name>test-mtg-1</name> <url-path>/r66599952/</url-path> </sco> <sco-data byte-count="" height="" length="" sco-data-id="625" slide-count="" version="0" width=""> <date-created>2004-07-07T10:05:33.200-07:00</date-created> <date-modified>2004-07-07T10:05:33.200-07:00</date-modified> <physical-path>7/623/</physical-path> </sco-data> <source-sco /> </results> Exemple de code XML associé à un SCO dont l’attribut type correspond à presentation : <results> <status code="ok" /> <sco folder-id="24" host-id="" lang="en" learning-time="" sco-data-id="29" sco-id="27" source-sco-id="" status="active" tree-id="11" type="presentation"> <author-info-1>l</author-info-1> <author-info-2>n</author-info-2> <date-created>2004-06-30T11:45:03.717-07:00</date-created> <date-modified>2004-06-30T11:53:33.250-07:00</date-modified> <name>test-slide</name> <url-path>/p27916084/</url-path> </sco> <sco-data byte-count="766632" height="540" length="11280" sco-data-id="29" slide-count="2" version="0" width="720"> <date-created>2004-06-30T11:45:03.717-07:00</date-created> <date-modified>2004-06-30T11:53:33.090-07:00</date-modified> <physical-path>7/27/</physical-path> </sco-data> <source-sco /> </results> 130 Chapitre 4 : Informations de référence sur les API XML Exemple de code XML associé à un SCO dont l’attribut type correspond à folder : <results> <status code="ok" /> <sco folder-id="24" host-id="" lang="en" learning-time="" sco-data-id="746" sco-id="744" source-sco-id="" status="active" tree-id="11" type="folder"> <date-created>2004-07-14T12:19:23.340-07:00</date-created> <date-modified>2004-07-14T12:19:23.340-07:00</date-modified> <name>test2</name> <url-path>/p33526645/</url-path> </sco> <sco-data byte-count="" height="" length="" sco-data-id="746" slide-count="" version="0" width=""> <date-created>2004-07-14T12:19:23.340-07:00</date-created> <date-modified>2004-07-14T12:19:23.340-07:00</date-modified> <physical-path>7/744/</physical-path> </sco-data> <source-sco /> </results> Exemple de code XML associé à un SCO dont l’attribut type correspond à course : <results> <status code="ok" /> <sco folder-id="10" host-id="" lang="en" learning-time="" sco-data-id="722" sco-id="727" source-sco-id="720" status="active" tree-id="10" type="course"> <date-begin>2004-07-13T10:30:00.000-07:00</date-begin> <date-created>2004-07-13T10:53:47.450-07:00</date-created> <date-modified>2004-07-13T10:53:51.763-07:00</date-modified> <name>quiz-course</name> <url-path>/p38917184/</url-path> </sco> <sco-data byte-count="1400615" height="540" length="31200" sco-data-id="722" slide-count="3" version="0" width="720"> <date-created>2004-07-13T10:46:48.000-07:00</date-created> <date-modified>2004-07-13T10:47:23.653-07:00</date-modified> <physical-path>7/720/</physical-path> </sco-data> <source-sco> <source-sco folder-id="12" host-id="" lang="en" learning-time="" sco-dataid="722" sco-id="720" source-sco-id="" status="active" tree-id="11" type="presentation"> <author-info-1>l</author-info-1> <date-created>2004-07-13T10:46:48.000-07:00</date-created> <date-modified>2004-07-13T10:47:23.810-07:00</date-modified> <name>test-quiz</name> <url-path>/p67601053/</url-path> </source-sco> </source-sco> </results> sco-info 131 sco-move Disponibilité Breeze 4. Description Déplace un SCO d’un dossier à un autre. Pour plus d’informations sur les règles de déplacement et les autorisations requises, consultez l’aide de Breeze. Paramètres folder-id sco-id Identifiant du dossier de destination. Identifiant du SCO à déplacer. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés status Exemple de résultats <results> <status code="ok" /> </results> Voir aussi sco-nav sco-nav Disponibilité Breeze 4. Description Décrit l’arborescence de dossiers contenant le SCO spécifié. Dans les résultats renvoyés, l’attribut depth de la balise sco indique le nombre de niveaux arborescents qui séparent le dossier du SCO spécifié. 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 sco-id Identifiant d’un SCO. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. 132 Chapitre 4 : Informations de référence sur les API XML Eléments renvoyés sco-nav Exemple de résultats <results> <status code="ok" /> <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>User Meetings</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>[email protected]</name> </sco> <sco sco-id="503545" tree-id="181230" type="meeting" depth="0"> <name>created with 402</name> </sco> </sco-nav> </results> Voir aussi sco-move sco-search Disponibilité Breeze 4. 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 présentations et des autres SCO contenant du texte est également analysé. Paramètres Chaîne à rechercher. Vous pouvez précéder les caractères ci-dessous d’une barre oblique inversée (\) pour un codage URL dans la chaîne de recherche : query + - && || ! ( ) { } [ ] ^ " ~ * ? : \ Filtres Vous pouvez limiter les données renvoyées à un nombre spécifique de lignes à l’aide des paramètres filter-rows et filter-start. Ainsi, le code suivant renvoie les cinq premières lignes de données : filter-rows=5&filter-start=0 Remarque : Le paramètre filter-rows spécifie le nombre de lignes à renvoyer, le paramètre filterstart indique où doit débuter le compte de lignes. Pour plus d’informations sur les filtres, consultez le Chapitre 2, Utilisation de filtres, page 21. sco-search 133 Eléments renvoyés sco-search-info Exemple de résultats <results> <status code="ok" /> <sco-search-info> <sco sco-id="5352494" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>quiz.ppt</name> <url-path>/p21028797/</url-path> <date-created>2005-03-30T16:32:30.840-08:00</date-created> <date-modified>2005-03-30T16:32:31.043-08:00</date-modified> <hit>1</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=1</hit-url> <thumbnail-path /> </sco> <sco sco-id="5352494" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>quiz.ppt</name> <url-path>/p21028797/</url-path> <date-created>2005-03-30T16:32:30.840-08:00</date-created> <date-modified>2005-03-30T16:32:31.043-08:00</date-modified> <hit>2</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=2</hit-url> <thumbnail-path /> </sco> <sco sco-id="5393671" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>/p68431203/</name> <url-path>/p68431203/</url-path> <date-created>2005-03-30T16:32:42.280-08:00</date-created> <date-modified>2005-03-30T16:32:42.280-08:00</date-modified> <hit>1</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=1</hit-url> <thumbnail-path /> </sco> <sco sco-id="5393671" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>/p68431203/</name> <url-path>/p68431203/</url-path> <date-created>2005-03-30T16:32:42.280-08:00</date-created> <date-modified>2005-03-30T16:32:42.280-08:00</date-modified> <hit>2</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=2</hit-url> <thumbnail-path /> </sco> </sco-search-info> </results> 134 Chapitre 4 : Informations de référence sur les API XML sco-shortcuts Disponibilité Breeze 4. Description Renvoie les identifiants d’un ensemble de dossiers dont le contenu concerne l’utilisateur connecté, à savoir 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 API avec l’adresse URL renvoyée par l’API sco-info dans la balise url-path. Raccourcis SCO Description user-courses Dossier qui contient tous les dossiers de cours de l’utilisateur. events Dossier d’événements partagés. user-events Dossier qui contient tous les dossiers d’événéments de l’utilisateur. seminars Dossier racine de l’arborescence des séminaires. shared-meeting-templates Dossier qui contient tous les modèles de réunions partagées. my-events Dossier des événements du gestionnaire d’événements. my-courses Dossier des cours du gestionnaire d’événements. my-meeting-templates Dossier qui contient tous les modèles de réunions privées. Paramètres Aucun. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés shortcuts Exemple de résultats <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-shortcuts 135 <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-expanded-contents sco-update Disponibilité Breeze 4. Description Crée ou actualise des présentations, des cours et des réunions. Si vous spécifiez un paramètre sco-id, cette API actualise le SCO indiqué. Si vous spécifiez un paramètre folder-id, cette API crée un nouveau SCO. Si vous créez un nouveau SCO, le code XML renvoyé 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 API, vous devez appeler l’API permissions-update pour attribuer les autorisations. Pour plus d’informations sur les autorisations, consultez la section Sécurité, page 18. Pour plus d’informations sur les SCO, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Les exemples suivants illustrent des utilisations de l’API sco-update. Pour utiliser sco-update avec une présentation Breeze : 1. Appelez sco-update en spécifiant le paramètre folder-id pour créer un SCO. Passez les paramètres suivants : folder-id, description, name, author-info-1 (nom de l’auteur), author-info-2 (titre de l’auteur), author-info-3 (raison sociale de la société), type=presentation et lang. 2. Appelez sco-upload pour associer un contenu à ce SCO : Remarque : Reportez-vous à sco-upload, qui contient un exemple de formulaire HTML qui associe un contenu à une présentation créée par le biais de l’API XML. 136 Chapitre 4 : Informations de référence sur les API XML 3. Appelez sco-build pour compiler le SCO. 4. Appelez permissions-update pour attribuer des autorisations au SCO. Pour utiliser sco-update avec un cours Breeze : 1. Appelez sco-update pour créer un cours et associez un contenu préexistant au cours par le biais du paramètre source-sco-id. Passez les paramètres suivants : folder-id, date-begin, date-end, description, name, type=course, source-sco-id et sco-tag. 2. Appelez permissions-update pour ajouter des personnes inscrites au cours. Pour utiliser sco-update avec une réunion Breeze : 1. Appelez sco-update pour créer la réunion. Passez les paramètres suivants : folder-id, date-begin, date-end, description, name et type=meeting. Remarque : Vous devez utiliser Breeze Manager pour associer un contenu à une réunion créée par le biais de l’API XML. 2. Appelez permissions-update en spécifiant les valeurs de paramètre suivantes pour définir un accès public ou privé à la réunion : // private: principal-id=public-access&permission-id=denied // public: principal-id=public-access&permission-id=view-hidden 3. Appelez permissions-update pour attribuer des autorisations de présentateur ou de participant à la réunion. Paramètres Date et heure de début prévues. Le format de date correspond à ISO 8601 (réservé aux réunions et aux cours). date-begin Date et heure de fin prévues. Le format de date correspond à ISO 8601 (réservé aux réunions et aux cours). date-end description Description du SCO, à l’intention des utilisateurs. Adresse e-mail de la personne à contacter pour le SCO. (Utilisé uniquement pour les présentations.) email first-name Prénom de la personne à contacter pour le SCO. (Utilisé uniquement pour les présentations.) Identifiant du dossier dans lequel le serveur créera le nouveau SCO. Ce paramètre est facultatif et ne peut pas être spécifié avec sco-id. folder-id Nom de la personne à contacter pour le SCO. (Utilisé uniquement pour les présentations.) last-name name Nom du SCO. sco-update 137 Identifiant d’un SCO à actualiser. Ce paramètre est facultatif et ne peut pas être spécifié avec folder-id. sco-id sco-tag Libellé d’un SCO. Ce paramètre peut contenir 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 sco-tag. (Utilisé uniquement pour les cours.) source-sco-id Identifiant du contenu du SCO. (Utilisé uniquement pour les cours.) Type du nouveau SCO. Pour plus d’informations sur les types, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. type Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Si vous actualisez un SCO existant, aucun élément n’est renvoyé. En cas de création d’un SCO, sco. Exemple de résultats L’exemple de code XML ci-dessous est renvoyé lorsque vous créez un 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>Test SCO</name> </sco> </results> L’exemple de code XML ci-dessous est renvoyé lorsque vous créez un SCO de type présentation : <results> <status code="ok" /> <sco folder-id="945" type="presentation" lang="en" sco-id="2152" status="nocontent" tree-id="11" sco-data-id="2154"> <author-info-2>sw</author-info-2> <author-info-3>macr</author-info-3> <url-path>/p74161709/</url-path> <description>testXMLAPIpreso-New</description> <author-info-1>laxmi n</author-info-1> <name>testAPI-preso-New</name> </sco> </results> Pour actualiser le titre, le résumé, le nom du conférencier, la langue et la société, remplacez le paramètre folder-id par le paramètre sco-id. Pour transférer un autre SCO et recompiler la présentation, appelez sco-upload, puis scobuild. 138 Chapitre 4 : Informations de référence sur les API XML Les exemples de résultats ci-dessous sont renvoyés lorsque vous actualisez une présentation : <results> <status code="ok" /> </results> L’exemple de code XML ci-dessous est renvoyé lorsque vous créez un cours : <results> <status code="ok" /> <sco folder-id="954" lang="1" type="course" sco-id="1520" source-scoid="720" status="active" tree-id="10" sco-data-id="722"> <date-begin>2004-07-26T24:41:58.330-07:00</date-begin> <date-end>2004-07-28T21:41:58.330-07:00</date-end> <sco-tag>test-3</sco-tag> <url-path>/p41607453/</url-path> <description>testXMLAPIcourse-3</description> <name>testAPI-course-3</name> </sco> </results> Pour actualiser la date de début, la date de fin, l’identifiant du cours, le résumé, la description, le nom et le contenu du cours, remplacez le paramètre folder-id par le paramètre sco-id. L’exemple de code XML ci-dessous est renvoyé lorsque vous actualisez un cours : <results> <status code="ok" /> </results> L’exemple de code XML ci-dessous est renvoyé lorsque vous créez une réunion : <results> <status code="ok" /> <sco folder-id="1426" lang="en" type="meeting" sco-id="1429" status="active" tree-id="14" sco-data-id="1431"> <date-begin>2004-07-22T21:41:58.330-07:00</date-begin> <date-end>2004-07-22T21:51:58.330-07:00</date-end> <url-path>/r54578750/</url-path> <description>testXMLAPI-mtg</description> <name>testAPI-mtg</name> </sco> </results> Vous pouvez actualiser les heures de début et de fin d’une réunion, son nom et sa description en remplaçant le paramètre folder-id par le paramètre sco-id. L’exemple de code XML ci-dessous est renvoyé lorsque vous actualisez une réunion : <results> <status code="ok" /> </results> Voir aussi sco-build, sco-upload sco-update 139 sco-upload Disponibilité Breeze 4. Description Transfère un fichier vers le serveur Breeze lorsque vous créez une présentation par le biais de l’API XML. (Pour plus d’informations, consultez sco-update et sco-build.) Les paramètres de cette API doivent être transmis sous la forme MIME multipartie (multipart/ form-data media type). Pour créer le paramètre file, le plus simple consiste à utiliser un contrôle de formulaire de type file dans un formulaire de page Web. Après avoir transféré un fichier, appelez l’API sco-build pour le compiler. L’exemple de code HTML ci-dessous correspond à un formulaire destiné à associer un contenu à une présentation par le biais de l’API XML : <FORM action="http://<domain-name>/api/xml?action=sco-upload&scoid=xx&summary=xxx&title=xxx" enctype="multipart/form-data" method="post"> <P> What files are you sending? <INPUT type="file" name="file"> <BR> <INPUT type="submit" value="Send"> <INPUT type="reset"> </FORM> Ce formulaire transfère un fichier unique. Pour transférer plusieurs fichiers (tels un fichier PPT et un fichier PPC), vous devez passer un autre paramètre file : <FORM action="http://<domain-name>/api/xml?action=sco-upload&scoid=xxx&summary=xxx&title=xxxx" enctype="multipart/form-data" method="post"> <P> PPT files you are sending <INPUT type="file" name="file"><BR> PPC files you are sending <INPUT type="file" name="file"><BR> <INPUT type="submit" value="Send"> <INPUT type="reset"> </FORM> Remarque : Appelez l’API sco-info pour obtenir l’état du SCO le plus récent. L’état d’un SCO correspond initialement à en cours, indiquant ainsi que le contenu est en cours de compilation. Lorsque l’état devient actif, la compilation du contenu est terminée et ce dernier peut être affiché. Paramètres 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. file sco-id Identifiant du nouveau SCO. Le type de ce SCO doit avoir été défini auparavant, par exemple à l’aide de sco-update. summary Bref résumé des informations générales sur le SCO. Ce résumé, qui apparaît dans les listes de contenu, est renvoyé par l’API sco-info. Ce paramètre est facultatif. title 140 Titre du nouveau SCO. Chapitre 4 : Informations de référence sur les API XML Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés files Exemple de résultats <results> <status code="ok"/> <files> <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> </files> </results> Voir aussi sco-build, sco-update user-accounts Disponibilité Breeze 4. Description Renvoie la liste des comptes auxquels appartient l’utilisateur spécifié. Dans un système Breeze d’entreprise (non hébergé), il n’existe en général qu’un seul compte. Il est donc peu probable que vous ayez besoin d’utiliser cette action dans un système d’entreprise Breeze. Paramètres Nom de connexion de l’utilisateur, qui correspond généralement à son adresse électronique. login password Mot de passe de l’utilisateur. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Par défaut, le tri est basé sur la valeur accountname. Eléments renvoyés users user-accounts 141 Exemple de résultats <results> <status code="ok" /> <users> <user user-id="211729" account-id="211655"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="212988" account-id="212928"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="214251" account-id="214191"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> </users> </results> user-transcript-update Disponibilité Breeze 5.1. Description Cette API vous permet de remplacer le score d’un élément dans un curriculum. Vous pouvez ainsi attribuer un score à l’utilisateur pour une formation externe qu’il a effectuée. Cette API ne fonctionne que dans le cadre d’un curriculum et requiert des autorisations de gestion sur le dernier. Paramètres curriculum-id Elément du curriculum dont le score sera remplacé. sco-id status failed Identifiant du curriculum. Gère l’une des valeurs suivantes : completed, incomplete, user-passed, userou not-attempted. score user-id Nombre entier représentant le score obtenu par l’utilisateur pour ce SCO. Identifiant de l’utilisateur dont le relevé de notes sera remplacé. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. 142 Chapitre 4 : Informations de référence sur les API XML Exemple de résultats <results> <status code="ok" /> </results> Voir aussi learning-path-info, learning-path-update user-update-pwd Disponibilité Breeze 4. Description Modifie le mot de passe d’un utilisateur. Paramètres password Nouveau mot de passe. password-old Mot de passe actuel de l’utilisateur. password-verify user-id Confirmation du nouveau mot de passe à titre de vérification. Identifiant de l’utilisateur. Filtres Vous ne pouvez ni filtrer, ni trier les résultats. Eléments renvoyés Aucun. Exemple de résultats <results> <status code="ok" /> </results> user-update-pwd 143 144 Chapitre 4 : Informations de référence sur les API XML CHAPITRE 5 Informations de référence sur les résultats XML Le présent chapitre décrit les balises, les données et les codes d’état XML renvoyés par le serveur Macromedia Breeze en réponse à un appel API. Pour plus d’informations sur les API que vous pouvez appeler sur le serveur, consultez le Chapitre 4, Informations de référence sur les API XML, page 41. Code XML renvoyé Lorsque vous appelez une API sur le serveur Breeze, ce dernier renvoie un bloc de code XML. La balise parente du code XML est toujours une balise results. La balise results contient une balise status, qui indique si l’appel de l’API s’est terminé normalement. Si tel est le cas, la balise results contient généralement d’autres balises, qui regroupent les données renvoyées par l’API. Par exemple, une API common-info peut renvoyer les résultats suivants : <results> <status code="ok"/> <common locale="en"> <cookie>breezcywdihbvipp9kcrg.P01BRZPR36</cookie> <date>2005-02-24T17:10:05.190-08:00</date> <host>http://admin.breezecentral.com</host> <url>/api/xml?action=common-info</url> <version>breeze_500_r271</version> <account account-id="38181499"/> <user user-id="38181502" type="user"> <name>Joan Beckworth</name> <login>[email protected]</login> </user> <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> </common> </results> Le présent chapitre présente les balises par ordre alphabétique. A chaque balise correspond une section distincte. Pour plus d’informations sur les valeurs gérées de la balise status, consultez la section status. 145 Pour plus d’informations sur les balises renvoyées pour une API donnée, consultez la section correspondant à cette API au Chapitre 4, Informations de référence sur les API XML, page 41. Si aucune donnée n’est disponible pour une balise résultant normalement d’un appel d’API, cette balise n’est pas renvoyée. Dans l’exemple précédent, si l’application d’appel n’a pas spécifié 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 3, Tâches courantes, page 27. Exemple de balise XML L’exemple ci-dessous illustre les conventions utilisées pour toutes les balises XML. Les entrées sont classées par ordre alphabétique. Titre de l’entrée Elément qui identifie le nom de la balise. Description Cette section décrit les données que contient la balise. Attributs Cette section répertorie les attributs de la balise. Balises imbriquées Cette section répertorie toute balise imbriquée dans la balise principale. Renvoyée par Cette section identifie l’API qui renvoie la balise XML. Exemple Cette section illustre les données que contient la balise XML. Voir aussi Cette section identifie les balises associées à la balise. Balises XML classées par ordre alphabétique Le tableau ci-dessous répertorie les balises XML passées en revue dans ce chapitre, classées par ordre alphabétique. 146 Balise Description access-key (conteneur) Contient des informations sur une clé d’accès spéciale fournie par un SCO (Shareable Content Object). access-key (clé) Contient une clé d’accès spéciale à utiliser pour l’autoinscription. Chapitre 5 : Informations de référence sur les résultats XML Balise Description access-key-group Contient des informations sur le groupe auquel appartient automatiquement l’utilisateur s’il s’inscrit lui-même par le biais de la clé d’accès spéciale. access-keys Contient une ou plusieurs clés d’accès. account Identifiant du compte. acl Contient des informations sur une liste de contrôle des accès. acl-field-list Contient la liste des champs personnalisés associés à une liste de contrôle des accès. acl-fields Contient des informations sur les champs personnalisés associés à une liste de contrôle des accès. action Nom d’une API. answer-correct Texte d’une réponse correcte. answer-text Texte d’une réponse à une question de questionnaire intégré aux résultats renvoyés par une API de génération de rapport. body Texte d’un élément renvoyé, tel que le texte d’une réponse dans un rapport associé à un questionnaire. comment Commentaire associé au champ personnalisé, compris entre 0 et 60 caractères. common Contient des informations sur le serveur et l’utilisateur connecté. contact Contient des informations sur un contact. cookie Contient la valeur du cookie de session du servlet Java, appelé BREEZESESSION. course Contient des informations sur un cours. custom-fields Contient des informations sur les champs personnalisés d’un compte. date Renvoie la date et l’heure en cours du serveur, exprimées au format de date ISO 8601. date-begin Contient la date et l’heure prévues de lancement du SCO, exprimées au format de date ISO 8601. date-closed Indique l’heure (exprimée au format ISO 8601) à laquelle l’utilisateur a fermé la fenêtre de la réunion, quittant ainsi la réunion. date-created Contient la date et l’heure de création d’un SCO, exprimées au format de date ISO 8601. date-end Contient la date et l’heure prévues de fin du SCO, exprimées au format de date ISO 8601. date-expired Contient la date d’expiration prévue d’un compte, exprimée au format de date ISO 8601. Balises XML classées par ordre alphabétique 147 148 Balise Description date-last-taken Contient la date à laquelle un cours a été effectué pour la dernière fois, exprimée au format de date ISO 8601. date-modified Indique la dernière date de modification d’un élément, exprimée au format de date ISO 8601. date-taken Indique la date à laquelle un utilisateur spécifique a répondu à un questionnaire donné, exprimée au format de date ISO 8601. date-time-attempted Indique la date à laquelle un utilisateur spécifique a répondu à un questionnaire. description Contient la description d’un mandant. domain-name Contient le nom de domaine complet de l’emplacement d’un SCO. duration Durée d’un SCO. email Adresse e-mail d’un utilisateur. event Contient des informations sur un événement. expanded-scos Contient des informations sur le contenu d’un SCO. expired Valeur booléenne indiquant si un SCO a expiré. field Contient des informations sur les champs personnalisés. file Contient des informations sur le chemin d’un SCO transféré. files Contient des informations sur le chemin d’un SCO transféré. first-name Indique le prénom d’un utilisateur. hit Valeur numérique identifiant la diapositive qui contient un terme recherché. host URL de l’hôte sur lequel tourne le serveur Breeze. invalid Explique pourquoi un appel spécifique à une API n’est pas valide. last-name Indique le nom d’un utilisateur. last-viewed Contient la date et l’heure du dernier affichage d’un SCO, exprimées au format de date ISO 8601. last-viewed-date Contient la date et l’heure du dernier affichage du SCO, exprimées au format de date ISO 8601. learning-path Contient des informations sur un cursus de formation dans un curriculum. learning-paths Contient des informations sur les cursus de formation dans un curriculum. login Indique le nom de connexion de l’utilisateur, qui correspond généralement à son adresse électronique. meeting Contient des informations sur une réunion. Chapitre 5 : Informations de référence sur les résultats XML Balise Description most-recent-session Heure de la session la plus récente d’un SCO. my-courses Contient des informations sur un ou plusieurs cours. my-events Contient des informations sur un ou plusieurs événements. my-meetings Contient des informations sur une ou plusieurs réunions. name Indique le nom d’un utilisateur. participant-name Nom d’un participant à une réunion. path Chemin d’un SCO transféré. permission Contient des informations sur un mandant déterminé et les autorisations correspondantes. permissions Contient des informations sur un ou plusieurs mandants et les autorisations correspondantes. physical-path Chemin d’un SCO sur le serveur. preferences Contient des informations sur les préférences utilisateur. presentation-name Nom d’une présentation Breeze. principal Contient des informations sur un mandant. principal-list Contient une ou plusieurs balises principal. principal-name Nom d’un mandant. question Texte d’une question de questionnaire. question-text Texte d’une question de questionnaire. quiz-definition-answers Contient une ou plusieurs balises row, dont chacune comporte des informations sur une réponse déterminée à une question de questionnaire donnée. quiz-definition-questions Contient une ou plusieurs balises row, dont chacune comporte des informations sur une question de questionnaire donnée. quiz-name Nom d’un questionnaire. quota Contient des informations sur les quotas de comptes. report-account-meeting-attendance Contient des balises row, qui comportent des informations sur le journal de participation aux réunions associé au compte. report-active-meeting-presenters Contient la liste des utilisateurs qui sont actuellement présentateurs de réunions. report-active-meetings Contient la liste des réunions en cours. report-bandwidth Indique la bande passante totale utilisée par le compte actif depuis sa création, en octets. report-bulk-content-quiz Contient des lignes d’informations sur tous les questionnaires du contenu, ainsi qu’une liste de questionnaires. Balises XML classées par ordre alphabétique 149 150 Balise Description report-bulk-content-quiz-results Contient des lignes d’informations sur les résultats d’un questionnaire de contenu. report-bulk-course-quiz Contient des lignes d’informations sur tous les questionnaires du cours, ainsi qu’une liste de questionnaires. report-bulk-course-quiz-results Contient des informations sur les résultats d’un questionnaire du cours, y compris des informations sur chaque utilisateur et chaque question. report-bulk-meeting Contient des informations sur toutes les réunions. report-bulk-meeting-attendance Contient des informations sur tous les participants aux réunions. report-bulk-questions Renvoie des informations sur toutes les questions de questionnaires d’un compte. report-bulk-slide-views Contient des données d’affichage des diapositives. report-bulk-users Contient des informations sur tous les utilisateurs d’un compte. report-course-status Contient des informations sur l’état d’un cours. report-disk-usage Indique l’espace disque occupé par le contenu Breeze, en octets. report-meeting-attendance Contient une ou plusieurs balises row, dont chacune comporte des informations sur un utilisateur qui a participé à une réunion spécifique. report-meeting-concurrent-users Indique le nombre maximal d’utilisateurs qui ont participé simultanément à la réunion spécifiée. report-meeting-session Contient des informations sur une réunion. report-meeting-sessions Contient des informations sur toutes les sessions d’une réunion. report-meeting-session-slots Contient une ou plusieurs balises row, dont chacune comporte des informations sur une période de session déterminée. report-meeting-summary Indique le nombre d’utilisateurs invités à la réunion spécifiée et le nombre d’invités et d’hôtes qui y ont réellement assisté. report-principal-list Contient des informations sur les mandants. report-quiz-answer-distribution Contient une ou plusieurs balises row, dont chacune indique le nombre d’utilisateurs ayant sélectionné chaque réponse du questionnaire spécifié. report-quiz-interactions Contient une ou plusieurs balises row, dont chacune comporte des informations sur l’interaction entre un utilisateur et le questionnaire spécifié. report-quiz-question-answerdistribution Contient une ou plusieurs balises row, dont chacune indique le nombre d’utilisateurs ayant choisi une réponse donnée à la question de questionnaire spécifiée. Chapitre 5 : Informations de référence sur les résultats XML Balise Description report-quiz-question-distribution Contient une ou plusieurs balises row, dont chacune indique le nombre d’utilisateurs ayant répondu correctement à une question du questionnaire spécifié. report-quiz-question-response Contient une ou plusieurs balises row, dont chacune décrit la réponse apportée par un utilisateur à la question du questionnaire spécifiée. report-quiz-question-totals Indique le nombre total d’utilisateurs qui ont répondu à la question spécifiée du questionnaire et le nombre d’utilisateurs qui y ont répondu correctement. report-quiz-results Indique le nombre d’utilisateurs qui ont participé au questionnaire spécifié et la plage de scores correspondante. report-quiz-summary Contient des informations sur un questionnaire. report-quiz-takers Contient une ou plusieurs balises row, dont chacune comporte des informations sur un utilisateur qui a participé au cours ou au questionnaire spécifié. report-quotas Contient des informations sur les quotas de comptes. report-sco-slides Contient une ou plusieurs balises row, dont chacune indique la fréquence d’affichage de l’une des diapositives de la présentation, ainsi que la date et l’heure de la dernière consultation. report-sco-views Contient une ou plusieurs balises row, dont chacune indique la fréquence d’affichage de la présentation spécifiée, ainsi que la date et l’heure de la dernière consultation. report-survey-question-response Contient des informations sur la liste d’utilisateurs qui ont répondu à la question spécifiée, ainsi que leur réponse. report-training-concurrent-users Indique le plus grand nombre d’utilisateurs ayant utilisé simultanément le système. response Réponse d’un utilisateur à une question d’enquête. results Contient tous les résultats renvoyés par toute API. row Contient un enregistrement unique d’informations dans un rapport. sco Contient des balises qui comportent des informations sur un SCO (document Breeze unique). sco-author Contient des balises qui fournissent des informations sur l’auteur d’un SCO. sco-data Contient des informations sur le fichier de données sousjacent (tel que le fichier intégrant une présentation) utilisé dans un SCO. sco-name Nom d’un SCO déterminé, tel le nom d’une réunion. sco-nav Contient des balises qui comportent des informations sur l’arborescence de dossiers renfermant le SCO spécifié. Balises XML classées par ordre alphabétique 151 152 Balise Description sco-search-info Contient une ou plusieurs balises sco, dont chacune comporte des informations sur un SCO correspondant au texte de recherche spécifié. scos Contient une ou plusieurs balises sco. Chacune d’elles comporte des informations sur un dossier dont le contenu se rapporte à l’utilisateur connecté. shortcuts Contient une ou plusieurs balises sco. Chacune d’elles comporte des informations sur un dossier dont le contenu se rapporte à l’utilisateur connecté. source-sco Contient des informations sur le SCO qui se rapportent au contenu d’un cours. status Code d’état renvoyé par le serveur Breeze à chaque appel d’une API. time-slot-begin Date et heure de début d’une session de réunion. time-slot-end Date et heure de fin d’une session de réunion. time-taken Heure de participation à un cours. url URL. url-path Chemin du SCO spécifié sur le serveur Breeze. user (common-info) Contient des informations sur un utilisateur. user (user-accounts) Contient des informations sur un utilisateur et un compte. user-agent Description du navigateur d’un hôte. user-first-name Prénom d’un utilisateur. user-last-name Nom d’un utilisateur. user-login Adresse de connexion d’un utilisateur, qui correspond généralement à son adresse e-mail. user-name Nom d’un utilisateur. users Contient une ou plusieurs balises user, dont chacune comporte des informations sur un utilisateur et un compte. value Valeur d’un champ personnalisé. version Numéro de version de Breeze. view-date-time Date et heure d’affichage d’une diapositive. Chapitre 5 : Informations de référence sur les résultats XML access-key (conteneur) Il existe deux balises access-key, décrites dans des sections différentes. Description Balise conteneur, qui contient des informations sur une clé d’accès spéciale fournie par un SCO. Attributs acl-id Identifiant du SCO associé à la clé d’accès. action Indique le type d’auto-inscription. Valeurs gérées : "action-self-reg-meeting" et "action-self-reg-course". Balises imbriquées access-key (clé), date-created Renvoyée par accesskey-info Exemple <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> Voir aussi access-key (clé), access-keys access-key (clé) Il existe deux balises access-key, décrites dans des sections différentes. Description Clé d’accès spéciale à utiliser pour l’auto-inscription. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par accesskey-info Exemple <access-key>vb7gmg6ohtz4y7k6</access-key> Voir aussi access-key (conteneur), access-keys access-key (clé) 153 access-key-group Description Balise conteneur, qui contient des informations sur le groupe auquel appartient automatiquement l’utilisateur s’il s’inscrit lui-même par le biais de la clé d’accès spéciale. Contient également un nom de connexion et une balise name. Attributs Identifiant du compte dont le mandant est membre. Cet attribut est renvoyé par l’API principal-info uniquement. account-id Indique si le mandant possède des enfants. Les groupes peuvent avoir des enfants, mais pas les utilisateurs. Par conséquent, cet attribut indique si le mandant est un groupe. has-children Indique si le mandant est un groupe primaire (également appelé groupe prédéfini). Pour plus d’informations, reportez-vous à l’attribut type. is-primary principal-id type Identifiant du mandant. Type du mandant. Parmi les valeurs gérées figurent : ■ admins ■ authors ■ course-admins ■ dt-authors ■ dt-reviewers ■ event-adminsBuilt ■ event-group ■ everyone ■ external-group ■ external-user ■ group ■ guest ■ hosted-admins ■ hosted-sales ■ hosted-support ■ learners ■ live-admins ■ seminar-admins ■ user Balises imbriquées login, name Renvoyée par accesskey-info 154 Chapitre 5 : Informations de référence sur les résultats XML Exemple <access-key-group account-id="7" has-children="true" is-primary="false" principal-id="630" type="group"> <login>COURSE-test1-self-reg-group</login> <name>COURSE-test1-self-reg-group</name> </access-key-group> access-keys Description Balise conteneur, qui contient une ou plusieurs clés d’accès. Attributs Aucun. Balises imbriquées access-key (conteneur) Renvoyée par accesskey-info Exemple <access-keys> <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-keys> account Description Identifiant du compte. Attributs account-id Identifiant du compte. Balises imbriquées Aucune (balise vide). Renvoyée par common-info Exemple <account account-id="222914"/> account 155 acl Description Balise conteneur, qui contient des informations sur une liste de contrôle des accès (ACL). Attributs acl-id Identifiant d’une ACL. Balises imbriquées value Renvoyée par acl-field-list Exemple <acl acl-id="38140560"> <value>Mary</value> </acl> acl-field-list Description Balise conteneur, qui contient des informations sur les ACL. Attributs Aucun. Balises imbriquées acl Renvoyée par acl-field-list Exemple <acl-field-list> <acl acl-id="38122317"> <value>Stephanie</value> </acl> <acl acl-id="38130237"> <value>Mike</value> </acl> <acl acl-id="38140560"> <value>Mary</value> </acl> </acl-field-list> 156 Chapitre 5 : Informations de référence sur les résultats XML acl-fields Description Balise conteneur, qui contient des informations sur les champs ACL. Attributs Aucun. Balises imbriquées field Renvoyée par acl-field-info Exemple <acl-fields> <field acl-id="38351541" field-id="x-tel-conference-number"/> <field acl-id="38351541" field-id="x-tel-participant-code"/> <field acl-id="38351541" field-id="x-tel-moderator-code"/> </acl-fields> action Description Nom d’une API. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par action-list Exemple <action>user-accounts</action> actions Description Balise conteneur, qui contient une liste d’API. Attributs Aucun. Balises imbriquées action actions 157 Renvoyée par action-list Exemple <actions> <action>accesskey-exec</action> <action>accesskey-info</action> <action>action-list</action> ... [other APIs listed here] ... <action>user-accounts</action> <action>user-update-pwd</action> </actions> answer-correct Description Texte d’une réponse correcte. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-content-quiz Exemple <answer-correct>YES</answer-correct> answer-text Description Texte d’une réponse à une question de questionnaire, intégré aux résultats renvoyés par une API de génération de rapport. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-quiz-answer-distribution, report-quiz-question-response Exemple <answer-text>ECMA-262</answer-text> 158 Chapitre 5 : Informations de référence sur les résultats XML body Description Contient le texte d’un élément renvoyé, tel que le texte d’une réponse dans un rapport associé à un questionnaire. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-quiz-answer-distribution, report-quiz-definition-answers, report-quiz-definition-questions, report-quiz-question-distribution, report-quiz-question-response Exemple <body>What is 2+2?</body> comment Description Commentaire sur le champ personnalisé, compris entre 0 et 60 caractères. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par custom-field-update Exemple <comments>any comment goes here</comments> common Description Balise conteneur, qui contient des balises qui fournissent des informations sur le serveur et l’utilisateur connecté. Si vous appelez common-info avant d’établir une connexion, les mêmes informations sont renvoyées, sauf pour la balise user. common 159 Attributs locale Indique la zone géographique de l’utilisateur connecté. Balises imbriquées account, cookie, date, host, url, user (common-info), version, Renvoyée par common-info Exemple <common locale="en"> <cookie>breezcywdihbvipp9kcrg.P01BRZPR36</cookie> <date>2005-02-24T17:10:05.190-08:00</date> <host>http://admin.breezecentral.com</host> <url>/api/xml?action=common-info</url> <version>breeze_500_r271</version> <account account-id="38181499"/> <user user-id="38181502" type="user"> <name>Sonya Blye</name> <login>[email protected]</login> </user> <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> </common> contact Description Balise conteneur, qui contient des informations sur un contact. Attributs contact-id Identifiant d’un contact. Balises imbriquées email, first-name, last-name Renvoyée par principal-info Exemple <contact contact-id="654"> <email>[email protected]</email> <first-name>test4</first-name> <last-name>laxmi</last-name> </contact> 160 Chapitre 5 : Informations de référence sur les résultats XML cookie Description Valeur du cookie de session du servlet Java, appelé BREEZESESSION. Ce cookie accompagne tout appel d’API pour identifier l’utilisateur d’origine. Si vous appelez common-info avant de vous connecter, le serveur renvoie un nouveau cookie. Vous avez besoin de ce cookie lorsque, par exemple, vous créez une nouvelle fenêtre de navigateur ou lancez un SCO. Selon l’implémentation du système externe, il peut être plus pratique d’acquérir le cookie à partir du serveur à l’aide de common-info que de laisser cette couche de code déterminer le cookie à envoyer lors d’un appel d’API. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par common-info Exemple <cookie>breezm5qtgnye46zpckbf.MARIANNE</cookie> course Description Balise conteneur, qui contient des informations sur un cours. Attributs sco-id Identifiant du cours. Indique si un cours est actif. Valeurs gérées : "no-content", qui indique que le cours vient d’être créé et ne comporte aucun contenu et "active". status type Indique que ce SCO est un cours. La valeur est toujours "course". Balises imbriquées date-begin, date-created, date-end, date-modified, expired, name, url, url-path Renvoyée par report-my-courses course 161 Exemple <course sco-id="555038" status="active" type="course"> <name>My Name</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> custom-fields Description Balise conteneur, qui contient des informations sur les champs personnalisés d’un compte. Attributs Aucun. Balises imbriquées field Renvoyée par custom-fields Exemple <custom-fields> <field field-id="1329" custom-seq="1" account-id="7" type="optional"> <name>Department</name> <comments>this is optional</comments> </field> <field field-id="1330" custom-seq="2" account-id="7" type="required"> <name>SSN</name> </field> </custom-fields> date Description Date et heure en cours du serveur, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). 162 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par common-info Exemple <date>2004-02-12T15:53:19.797-07:00</date> date-begin Description Date et heure prévues de lancement du SCO, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-active-meetings, report-meeting-session, report-meeting-sessions, report-my-courses, report-my-meetings, sco-contents Exemple <date-begin>2003-09-02T21:41:58.330-07:00</date-begin> date-closed Description Indique l’heure (exprimée au format ISO 8601) à laquelle l’utilisateur a fermé la fenêtre de la réunion, quittant ainsi la réunion. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-attendance Exemple <date-closed>2004-01-29T00:59:41.470-08:00</date-closed> date-created Description Indique la date et l’heure de création d’un SCO, exprimées au format de date ISO 8601. date-created 163 Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par accesskey-info, report-active-meeting-presenters, report-meeting-attendance, report-my-courses, report-quiz-interactions, sco-info, sco-search Exemple <date-created>2004-02-09T14:40:38.497-08:00</date-created> date-end Description Contient la date et l’heure prévues de fin du SCO, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-session, report-my-courses, report-my-meetings, sco-contents Exemple <date-end>2004-02-09T14:30:00.000-08:00</date-end> date-expired Description Indique la date d’expiration prévue d’un compte, exprimée au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par user-accounts Exemple <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> 164 Chapitre 5 : Informations de référence sur les résultats XML date-last-taken Description Indique la date à laquelle un cours a été effectué pour la dernière fois, exprimée au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-course-status Exemple <date-last-taken>2004-07-13T10:55:28.763-07:00</date-last-taken> date-modified Description Indique la date de dernière modification d’un élément, exprimée au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-my-courses, report-quiz-definition-questions, sco-contents, sco-info, sco-search Exemple <date-modified>2004-02-09T14:40:44.623-08:00</date-modified> date-taken Description Indique la date à laquelle un utilisateur spécifique a répondu à un questionnaire donné, exprimée au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). date-taken 165 Renvoyée par report-quiz-takers Exemple <date-taken>2004-01-13T01:33:49.460-08:00</date-taken> date-time-attempted Description Indique la date à laquelle un utilisateur spécifique a répondu à un questionnaire donné, exprimée au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-content-quiz-results, report-bulk-course-results Exemple <date-time-attempted>2004-07-13T10:52:23.780-07:00</date-time-attempted> description Description Contient la description d’un mandant. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par principal-info, principal-list Exemple <description>Account administrators group</description> domain-name Description Contient le nom de domaine complet de l’emplacement d’un SCO. 166 Chapitre 5 : Informations de référence sur les résultats XML Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-my-meetings, sco-shortcuts Exemple <domain-name>admin.breeze.example.com</domain-name> duration Description Durée d’un SCO. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par sco-contents, meeting Exemple <duration>1900-01-02T/+:00:00.000+00:00</duration> email Description Adresse e-mail d’un utilisateur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par principal-list, sco-info Exemple <email>[email protected]</email> email 167 event Description Balise conteneur, qui contient des informations sur un événement. Attributs Aucun. Balises imbriquées name, domain-name, url-path, date-begin, date-end, expired, duration Renvoyée par my-events Exemple <event sco-id="13923" type="event" icon="event" permission-id="host"> <name>1st Event</name> <domain-name>bcassidy02</domain-name> <url-path>/e95598585/</url-path> <date-begin>2005-03-05T13:00:00.000-08:00</date-begin> <date-end>2005-03-10T13:00:00.000-08:00</date-end> <expired>true</expired> <duration>5d 00:00:00.000</duration> </event> expanded-scos Description Balise conteneur, qui contient des informations sur le contenu d’un SCO. Attributs Aucun. Balises imbriquées sco Renvoyée par sco-expanded-contents Exemple <expanded-scos> <sco depth="0" sco-id="5400248" folder-id="5400246" type="link" icon="producer" lang="en" source-sco-id="5413507" display-seq="1" sourcesco-type="0"> <name>Beginning Electronics</name> <url-path>/l47843877/</url-path> <date-created>2005-03-31T12:16:54.840-08:00</date-created> <date-modified>2005-03-31T12:17:39.437-08:00</date-modified> </sco> </expanded-scos> 168 Chapitre 5 : Informations de référence sur les résultats XML expired Description Valeur booléenne indiquant si un SCO a expiré. Un SCO expire lorsqu’il atteint sa date de fin. Il n’est alors plus disponible. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-my-courses, report-my-meetings Exemple <expired>true</expired> field Description Balise conteneur, qui contient des informations sur un nouveau champ personnalisé. Attributs Identifiant du champ. field-id account-id Identifiant d’une ACL. acl-id custom-seq type Identifiant du compte. Numéro du champ personnalisé. Type du champ personnalisé. Les types gérés sont les suivants : Valeur Description required Champ personnalisé de compte obligatoire optional Type facultatif, affiché lors de l’auto-inscription optional-no-self-reg Type facultatif, masqué lors de l’auto-inscription Remarque : Certaines API ne renvoient pas tous les attributs. Remarque : La fonctionnalité d’auto-inscription n’est plus prise en charge par Breeze 5.1. Balises imbriquées comment, name, value Remarque : Certaines API ne renvoient pas toutes les balises. Renvoyée par acl-field-info, custom-field-update field 169 Exemple <field field-id="1562" account-id="7" custom-seq="4" type="optional"> <comments>none</comments> <name>Manager</name> <value>411</value> </field> file Description Balise conteneur, qui contient des informations sur les fichiers SCO transférés. Attributs Aucun. Balises imbriquées path Renvoyée par sco-upload Exemple <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> files Description Balise conteneur, qui contient des informations sur les fichiers SCO transférés. Attributs Aucun. Balises imbriquées file Renvoyée par sco-upload Exemple <files> <file> <path>38181499/38111519-1/input/Test.ppt</path> </file> </files> 170 Chapitre 5 : Informations de référence sur les résultats XML first-name Description Prénom d’un utilisateur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par sco-info, sco-search Exemple <first-name>Pat</first-name> hit Description Valeur numérique identifiant la diapositive qui contient un terme recherché. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par sco-search Exemple <hit>5</hit> host Description URL de l’hôte sur lequel tourne le serveur Breeze. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par common-info host 171 Exemple <host>http://admin.breeze.example.com</host> invalid Description Balise conteneur, qui explique pourquoi un appel spécifique à une API n’est pas valide. Cet élément s’affiche uniquement dans une balise status et seulement lorsque l’attribut code de cette balise est réglé sur "invalid". Le serveur renvoie uniquement une balise invalid pour une requête donnée, même s’il manque plusieurs paramètres obligatoires. Pour résoudre les erreurs liées aux paramètres manquants, ajoutez les paramètres requis à l’API. Pour plus d’informations sur les paramètres obligatoires, consultez la section consacrée à l’API qui vous intéresse dans le Chapitre 4, Informations de référence sur les API XML, page 41. Attributs Nom du paramètre non valide. field subcode Motif de non-validité du paramètre. Le tableau ci-dessous indique les valeurs gérées de cet attribut. Valeur Description duplicate L’appel a tenté d’ajouter un élément dupliqué dans un contexte imposant des éléments 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 opération non valide). missing Vous n’avez pas spécifié un paramètre obligatoire. no-such-item Les informations requises n’existent pas. range La valeur excède la plage autorisée. type Type de paramètre, tel que "id", "long" ou "string". Balises imbriquées Aucune (balise vide). Renvoyée par Toute API non valide. Exemple <invalid field="sco-id" type="id" subcode="missing" /> 172 Chapitre 5 : Informations de référence sur les résultats XML last-name Description Nom d’un utilisateur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par sco-info, sco-search Exemple <last-name>Tennant</last-name> last-viewed Description Indique la date et l’heure du dernier affichage d’un SCO, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-sco-slides Exemple <last-viewed>2004-01-13T16:35:39.517-08:00</last-viewed> last-viewed-date Description Indique la date et l’heure du dernier affichage d’un SCO, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-sco-views last-viewed-date 173 Exemple <last-viewed-date>2004-01-13T17:11:47.923-08:00</last-viewed-date> learning-path Description Balise conteneur, qui contient des informations sur les cursus de formation dans un curriculum. Attributs curriculum-id current-sco-id target-sco-id path-type Balises imbriquées name Renvoyée par learning-path-info Exemple <learning-path curriculum-id="38184158" current-sco-id="38184158" target-scoid="38345286" path-type="completion-required"> <name>Tester</name> </learning-path> learning-paths Description Balise conteneur, qui contient des informations sur les cursus de formation dans un curriculum. Attributs Aucun. Balises imbriquées learning-path Renvoyée par learning-path-info 174 Chapitre 5 : Informations de référence sur les résultats XML Exemple <learning-paths> <learning-path curriculum-id="38184158" current-sco-id="38184158" targetsco-id="38345286" path-type="completion-required"> <name>Tester</name> </learning-path> <learning-path curriculum-id="38184158" current-sco-id="38184158" targetsco-id="39477240" path-type="completion-required"> <name>Slides Test</name> </learning-path> <learning-path curriculum-id="38184158" current-sco-id="38184158" targetsco-id="39526516" path-type="completion-required"> <name>This is a Test</name> </learning-path> </learning-paths> login Description Indique le nom de connexion de l’utilisateur, qui correspond généralement à son adresse électronique. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par common-info, permissions-info, principal-info, principal-list, report-course-takers, report-meeting-attendance, report-quiz-takers Exemple <login>[email protected]</login> meeting Description Balise conteneur, qui contient des informations sur une réunion. Attributs active-participants Nombre actuel de participants. permission-id Autorisations de l’utilisateur dans le cadre de la réunion. Pour plus d’informations, consultez la section Sécurité, page 18. sco-id Identifiant de la réunion. status Etat de la réunion. Valeurs gérées : "no-content", qui indique que la réunion vient d’être créée, mais n’a pas encore reçu de contenu, "in-progress", qui désigne une réunion en cours et "active". meeting 175 type Indique que le SCO est une réunion. La valeur correspond toujours "meeting". Balises imbriquées date-begin, date-end, domain-name, duration, expired, name, url-path Renvoyée par report-my-meetings Exemple <meeting sco-id="10801" type="meeting" icon="meeting" permission-id="host" active-participants="3"> <name>1st Seminar</name> <domain-name>bcassidy02</domain-name> <url-path>/r21331159/</url-path> <date-begin>2005-02-25T10:00:00.000-08:00</date-begin> <date-end>2005-02-25T11:00:00.000-08:00</date-end> <expired>true</expired> <duration>01:00:00.000</duration> </meeting> most-recent-session Description Heure de début de la session la plus récente d’une réunion. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par report-meeting-summary Exemple <most-recent-session>2005-02-28T17:05:54.953-08:00</most-recent-session> my-courses Description Balise conteneur, qui contient des informations sur un ou plusieurs cours. Attributs Aucun. Balises imbriquées course 176 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par report-my-courses Exemple <my-courses> <course sco-id="555038" status="active" type="course"> <name>My Name</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> </my-courses> my-events Description Balise conteneur, qui contient des informations sur un ou plusieurs événements. Attributs Aucun. Balises imbriquées event Renvoyée par report-my-events Exemple <my-events> <event sco-id="13923" type="event" icon="event" permission-id="host"> <name>1st Event</name> <domain-name>bcassidy02</domain-name> <url-path>/e95598585/</url-path> <date-begin>2005-03-05T13:00:00.000-08:00</date-begin> <date-end>2005-03-10T13:00:00.000-08:00</date-end> <expired>true</expired> <duration>5d 00:00:00.000</duration> </event> </my-events> my-meetings Description Balise conteneur, qui contient des informations sur une ou plusieurs réunions. my-meetings 177 Attributs Aucun. Balises imbriquées meeting Renvoyée par report-my-meetings Exemple <my-meetings> <meeting sco-id="10801" type="meeting" icon="meeting" permission-id="host" active-participants="3"> <name>1st Seminar</name> <domain-name>bcassidy02</domain-name> <url-path>/r21331159/</url-path> <date-begin>2005-02-25T10:00:00.000-08:00</date-begin> <date-end>2005-02-25T11:00:00.000-08:00</date-end> <expired>true</expired> <duration>01:00:00.000</duration> </meeting> </my-meetings> name Description Indique le nom d’un utilisateur. Par exemple, selon le contexte, la balise peut contenir le nom d’une personne, le nom d’un groupe, le nom d’un SCO, une adresse e-mail ou toute autre sorte de nom. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par permissions-info, principal-info, principal-list, report-active-meetingpresenters, report-active-meetings, report-meeting-session, report-meetingsessions, report-my-courses, report-my-meetings, report-quiz-takers, report-sco-views, sco-build, sco-contents, sco-info, sco-nav, sco-search, user-accounts Exemple <name>Math Test</name> 178 Chapitre 5 : Informations de référence sur les résultats XML participant-name Description Nom d’un participant à une réunion. Le nom est présenté sous la forme correspondant aux paramètres régionaux. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-attendance Exemple <participant-name>Tennant, Pat</participant-name> path Description Chemin d’un fichier SCO transféré. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par sco-upload Exemple <path>38181499/38111519-1/input/Test.ppt</path> permission Description Contient des informations sur un mandant déterminé et les autorisations correspondantes. Attributs acl-id Identifiant d’un SCO spécifique. permission-id Autorisations du mandant sur le SCO spécifié. Cet attribut est renvoyé uniquement par l’API permissions-info. principal-id Identifiant du mandant. permission 179 Balises imbriquées Aucune (balise vide). Renvoyée par permissions-info Exemple <permission acl-id="27" permission-id="manage" principal-id="8" /> permissions Description Balise conteneur, qui contient des informations sur un ou plusieurs mandants et les autorisations correspondantes. Pour plus d’informations sur les mandants, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Pour plus d’informations sur les autorisations, consultez la section Sécurité, page 18. Attributs Aucun. Balises imbriquées principal Renvoyée par permissions-info Exemple <permissions> <principal principal-id="181248" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Englesberg, Ari</name> <login>[email protected]</login> </principal> </permissions> physical-path Description Chemin d’un SCO sur le serveur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). 180 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par sco-info Exemple <physical-path>222914/503227/</physical-path> preferences Description Contient des informations sur les préférences utilisateur. Attributs Identifiant de l’utilisateur dont vous actualisez les préférences. acl-id lang Paramètre de langue. Breeze gère actuellement les cinq langues suivantes : Langue Valeur du paramètre Anglais en Français fr Allemand de Japonais ja Coréen ko time-zone-id Paramètre du fuseau horaire. Breeze gère actuellement les 75 fuseaux horaires suivants : Fuseau horaire Paramètre Ligne de changement de date internationale (ouest) (GMT-12:00) 0 Midway, Samoa (GMT-11:00) 1 Hawaï (GMT-10:00) 2 Alaska (GMT-09:00) 3 Pacifique (USA et Canada), Tijuana (GMT-08:00) 4 Montagnes rocheuses (USA et Canada) (GMT-07:00) 10 Chihuahua, La Paz, Mazatlan (GMT-07:00) 13 Arizona (GMT-07:00) 15 Centre (USA et Canada) (GMT-06:00) 20 Saskatchewan (GMT-06:00) 25 Guadalajara, Mexico, Monterrey (GMT-06:00) 30 Amérique centrale (GMT-06:00) 33 Est (US et Canada) (GMT-05:00) 35 Indiana (Est) (GMT-05:00) 40 preferences 181 182 Fuseau horaire Paramètre Bogota, Lima, Quito (GMT-05:00) 45 Atlantique (Canada) (GMT-04:00) 50 Caracas, La Paz (GMT-04:00) 55 Santiago (GMT-04:00) 56 Terre-Neuve (GMT-03:30) 60 Brasilia (GMT-03:00) 65 Buenos Aires, Georgetown (GMT-03:00) 70 Groenland (GMT-03:00) 73 Centre-Atlantique (GMT-02:00) 75 Açores (GMT-01:00) 80 Iles du Cap-Vert (GMT-01:00) 83 Dublin, Edimbourg, Lisbonne, Londres (GMT) 85 Casablanca, Monrovia (GMT) 90 Belgrade, Bratislava, Budapest, Ljubljana, Prague (GMT+01:00) 95 Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) 100 Bruxelles, Copenhagen, Madrid, Paris (GMT+01:00) 105 Amsterdam, Berlin, Berne, Rome, Stockholm, Vienne (GMT+01:00) 110 Afrique centrale - Ouest (GMT+01:00) 113 Bucarest (GMT+02:00) 115 Caire(GMT+02:00) 120 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) 125 Athènes, Istanbul, Minsk (GMT+02:00) 130 Jérusalem (GMT+02:00) 135 Harare, Pretoria (GMT+02:00) 140 Moscou, St. Petersburg, Volgograd (GMT+03:00) 145 Koweït, Riyad (GMT+03:00) 150 Nairobi (GMT+03:00) 155 Baghdad (GMT+03:00) 158 Téhéran (GMT+03:30) 160 Abu Dhabi, Muscat (GMT+04:00) 165 Baku, Tbilissi, Erevan (GMT+04:00) 170 Kabul (GMT+04:30) 175 Ekaterinburg (GMT+05:00) 180 Islamabad, Karachi, Tashkent (GMT+05:00) 185 Chapitre 5 : Informations de référence sur les résultats XML Fuseau horaire Paramètre Chennai, Kolkata, Mumbai, New Delhi (GMT+05:30) 190 Katmandou (GMT+05:45) 193 Astana, Dhaka (GMT+06:00) 195 Sri Jayawardenepura (GMT+06:00) 200 Almaty, Novosibirsk (GMT+06:00) 201 Rangoon (GMT+06:30) 203 Bangkok, Hanoi, Djakarta (GMT+07:00) 205 Krasnoïarsk (GMT+07:00) 207 Pékin, Chongqing, Hong Kong, Urumqi (GMT+08:00) 210 Kuala Lumpur, Singapour (GMT+08:00) 215 Taipei (GMT+08:00) 220 Perth (GMT+08:00) 225 Irkoutsk, Oulan-Bator (GMT+08:00) 227 Séoul (GMT+09:00) 230 Osaka, Sapporo, Tokyo (GMT+09:00) 235 Iakutsk (GMT+09:00) 240 Darwin (GMT+09:30) 245 Adelaïde (GMT+09:30) 250 Canberra, Melbourne, Sydney (GMT+10:00) 255 Brisbane (GMT+10:00) 260 Hobart (GMT+10:00) 265 Vladivostok (GMT+10:00) 270 Guam, Port Moresby (GMT+10:00) 275 Magadan, Iles Salomon, Nouvelle Calédonie (GMT+11:00) 280 Iles Fidji, Kamchatka, Iles Marshall (GMT+12:00) 285 Auckland, Wellington (GMT+12:00) 290 Nuku’alofa (GMT+13:00) 300 Balises imbriquées Aucun. Renvoyée par principal-info Exemple <preferences acl-id="653" lang="en" time-zone-id="4" /> preferences 183 presentation-name Description Nom d’une présentation Breeze. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-content-quiz, report-bulk-slide-views Exemple <presentation-name>test-quiz</presentation-name> principal Description Contient des informations sur un mandant. Pour obtenir des informations générales sur les mandants, consultez la section Présentation des mandants, des SCO et des identifiants, page 17. Attributs Identifiant du compte dont le mandant est membre. Cet attribut est renvoyé par l’API principal-info uniquement. account-id Indique si le mandant possède des enfants. Les groupes peuvent avoir des enfants, mais pas les utilisateurs. Par conséquent, cet attribut indique si le mandant est un groupe. has-children is-primary Indique si le mandant est un groupe primaire (également appelé groupe prédéfini). Pour plus d’informations, reportez-vous à l’attribut type. permission-id Autorisations du mandant sur le SCO spécifié. Cet attribut est renvoyé uniquement par l’API permissions-info. principal-id type 184 Identifiant du mandant. Type du mandant. Parmi les valeurs gérées figurent : ■ admins ■ authors ■ course-admins ■ dt-authors ■ dt-reviewers ■ event-admins ■ event-group Chapitre 5 : Informations de référence sur les résultats XML ■ everyone ■ external-group ■ external-user ■ group ■ guest ■ hosted-admins ■ hosted-sales ■ hosted-support ■ learners ■ live-admins ■ seminar-admins ■ user is-hidden Indique si un mandant est masqué (true) ou affiché (false). Balises imbriquées login, name, email, first-name, last-name Renvoyée par permissions-info, principal-update, principal-info Exemple <principal account-id="38181499" has-children="false" is-hidden="false" isprimary="false" principal-id="38181502" type="user"> <login>[email protected]</login> <name>Sonya Blye</name> <email>[email protected]</email> <first-name>Sonya</first-name> <last-name>Blye</last-name> </principal> principal-list Description Balise conteneur, qui contient une ou plusieurs balises principal. Attributs Aucun. Balises imbriquées principal Renvoyée par principal-list principal-list 185 Exemple <principal-list> <principal principal-id="222917" type="admins" has-children="true" is-primary="true" is-hidden="0"> <name>Account Administrators</name> <login>Account Administrators</login> <description>Account administrators group</description> </principal> </principal-list> principal-name Description Nom d’un mandant, exprimé au format standard des paramètres régionaux. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-course-takers, report-quiz-takers Exemple <principal-name>Chiang, Ed</principal-name> question Description Texte d’une question de questionnaire. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-quiz-interactions, report-survey-question-response Exemple <question>What is 2+2?</question> 186 Chapitre 5 : Informations de référence sur les résultats XML question-text Description Texte d’une question de questionnaire. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-quiz-question-answer-distribution, report-bulk-content-quiz Exemple <question-text>What is 2+2?</question-text> quiz-name Description Nom d’un questionnaire. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-content-quiz Exemple <question-text>Who is Randy Johnson?</question-text> quiz-definition-answers Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte une réponse déterminée à une question du questionnaire. Attributs Aucun. Balises imbriquées row quiz-definition-answers 187 Renvoyée par report-quiz-definition-answers Exemple <quiz-definition-answers> <row answer-id="1" question-id="257" <body>1</body> </row> <row answer-id="2" question-id="257" <body>2</body> </row> <row answer-id="1" question-id="258" <body>1</body> </row> <row answer-id="2" question-id="258" <body>2</body> </row> </quiz-definition-answers> correct="0"> correct="1"> correct="1"> correct="0"> quiz-definition-questions Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte des informations sur une question de questionnaire déterminée. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-definition-questions Exemple <quiz-definition-questions> <row question-number="1" question-id="257" score="20" chapter-id="1"> <body>What is 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>How far is it from Earth to the sun?</body> <date-modified>2004-01-13T17:09:40.230-08:00</date-modified> </row> </quiz-definition-questions> quiz-name Description Nom d’un questionnaire. 188 Chapitre 5 : Informations de référence sur les résultats XML Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-content-quiz Exemple <quiz-name>Quiz test 1</quiz-name> quota Description Balise conteneur, qui contient des informations sur les quotas de comptes. Attributs Identifiant d’un SCO de compte. acl-id Identifiant d’un quota. Breeze impose des quotas différents, tels le nombre maximal de participants simultanés à une formation, le nombre de téléchargements utilisés, le nombre d’auteurs utilisés, etc. A chaque quota correspond un identifiant unique. quota-id used Proportion du quota utilisé. Ainsi, si le compte autorise cinq auteurs au plus et que trois auteurs figurent dans le compte, la valeur de used correspond à 3. limit Limite d’origine du quota. Cette valeur est utilisée pour l’équilibrage de charge. soft-limit Limite supérieure du quota. Cette valeur est utilisée pour les modèles de tarification de Breeze, qui permettent aux clients d’augmenter rapidement l’échelle de leur licence. Balises imbriquées date-begin, date-end Renvoyée par report-quotas Exemple <quota acl-id="181224" quota-id="2" used="6545516" limit="unlimited" softlimit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> quota 189 report-account-meeting-attendance Description Balise conteneur, qui contient des balises row comportant des informations sur le journal de participation aux réunions associé au compte. Attributs Aucun. Balises imbriquées row Renvoyée par report-account-meeting-attendance Exemple <report-account-meeting-attendance> <row account-id="7" transcript-id="670" sco-id="623" principal-id="8" contact-id="3"> <login>[email protected]</login> <session-name>Enterprise Administrator</sessionname> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T13:00:28.920-07:00</datecreated> <date-closed>2004-07-09T13:02:55.810-07:00</dateclosed> <participant-name>Enterprise Administrator</participantname> </row> <row account-id="7" transcript-id="685" sco-id="623" principal-id="8" contact-id="3"> <login>[email protected]</login> <session-name>Enterprise Administrator</sessionname> <sco-name>test-mtg-1</sco-name> <date-created>2004-07-09T14:33:06.577-07:00</datecreated> <date-closed>2004-07-09T14:33:43.547-07:00</dateclosed> <participant-name>Enterprise Administrator</participantname> </row> </report-account-meeting-attendance> report-active-meeting-presenters Description Balise conteneur, qui contient la liste des utilisateurs qui présentent actuellement des réunions. 190 Chapitre 5 : Informations de référence sur les résultats XML Attributs Aucun. Balises imbriquées sco Renvoyée par report-active-meeting-presenters Exemple <report-active-meeting-presenters> <sco sco-id="190298"> <name>Jack Monson</name> <date-created>2004-02-17T17:06:23.920-08:00</date-created> </sco> <sco sco-id="566058"> <name>Hans Gay</name> <date-created>2004-02-17T16:50:00.327-08:00</date-created> </sco> </report-active-meeting-presenters> report-active-meetings Description Balise conteneur, qui contient la liste des réunions en cours. Attributs Aucun. Balises imbriquées sco Renvoyée par report-active-meetings Exemple <report-active-meetings> <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path> <date-created>2005-02-28T16:09:28.510-08:00</date-created> </sco> <sco sco-id="38345152" active-participants="1" length-minutes="1"> <name>Status Meeting</name> <url-path>/status/</url-path> <date-created>2005-02-28T16:10:21.353-08:00</date-created> </sco> </report-active-meetings> report-active-meetings 191 report-bandwidth Description Indique la bande passante totale utilisée par le compte actif depuis sa création, en octets. Attributs total Montant total de bande passante, en octets. Balises imbriquées Aucune (balise vide). Renvoyée par report-bandwidth Exemple <report-bandwidth total="71000000" /> report-bulk-consolidated-transactions Description Balise conteneur, qui contient des informations sur toutes les transactions associées à un compte. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-consolidated-transactions Exemple <report-bulk-consolidated-transactions> <row transaction-id="3777813" principal-id="2564976" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>[email protected]</login> <user-name>Ben Harm</user-name> <status>completed</status> <date-created>2005-01-29T14:02:04.733-08:00</date-created> </row> <row transaction-id="4832819" principal-id="181271" score="0"> <name>Default Meeting Template</name> <url>/r-182228/</url> <login>[email protected]</login> <user-name>Gung Ho</user-name> <status>completed</status> <date-created>2005-01-04T10:10:09.077-08:00</date-created> </row> </report-bulk-consolidated-transactions> 192 Chapitre 5 : Informations de référence sur les résultats XML report-bulk-content-quiz Description Balise conteneur, qui contient des lignes d’informations sur tous les questionnaires du contenu, ainsi qu’une liste de questionnaires. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-content-quiz Exemple <report-bulk-content-quiz> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="1"> <presentation-name>test-quiz</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answertext> <answer-correct>YES</answer-correct> </row> <row presentation-id="720" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="2"> <presentation-name>test-quiz</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson?</question-text> <answer-text>A basketball player with the New Jersey Nets</answer-text> <answer-correct>NO</answer-correct> </row> </report-bulk-content-quiz> report-bulk-content-quiz-results Description Balise conteneur, qui contient des lignes d’informations sur les résultats d’un questionnaire de contenu. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-content-quiz-results report-bulk-content-quiz-results 193 Exemple <report-bulk-content-quiz-results> <row user-id="8" presentation-attempt-id="725" presentation-id="720" quizid="1" question-number="1" user-response="1"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:51:35.047-07:00</date-time-attempted> <time-taken>00:00:28.017</time-taken> </row> <row user-id="8" presentation-attempt-id="726" presentation-id="720" quizid="1" question-number="2" user-response="3"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:52:23.780-07:00</date-time-attempted> <time-taken>00:00:14.017</time-taken> </row> </report-bulk-content-quiz-results> report-bulk-course-quiz Description Balise conteneur, qui contient des lignes d’informations sur tous les questionnaires du cours, ainsi qu’une liste de questionnaires. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-course-quiz Exemple <report-bulk-course-quiz> <row course-id="727" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="1"> <presentation-name>quiz-course-ln</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson?</question-text> <answer-text>A baseball pitcher with the Arizona Diamondbacks</answertext> <answer-correct>YES</answer-correct> </row> <row course-id="727" quiz-id="1" quiz-passing-score="10" questionnumber="1" question-value="10" answer-id="2"> <presentation-name>quiz-course-ln</presentation-name> <quiz-name>Quiz test 1</quiz-name> <question-text>Who is Randy Johnson?</question-text> <answer-text>A basketball player with the New Jersey Nets</answer-text> <answer-correct>NO</answer-correct> </row> </report-bulk-course-quiz> </results> 194 Chapitre 5 : Informations de référence sur les résultats XML report-bulk-course-quiz-results Description Balise conteneur, qui contient des informations sur les résultats d’un questionnaire du cours, y compris des informations sur chaque utilisateur et question. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-course-results Exemple <report-bulk-course-quiz-results> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="1" user-response="2"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-attempted> <time-taken>00:00:43.017</time-taken> </row> <row user-id="8" course-attempt-id="730" course-id="727" quiz-id="1" question-number="2" user-response="1"> <user-login>[email protected]</user-login> <date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-attempted> <time-taken>00:00:67.017</time-taken> </row> </report-bulk-course-quiz-results> report-bulk-meeting Description Balise conteneur, qui contient des informations sur toutes les réunions. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-meeting report-bulk-meeting 195 Exemple <report-bulk-meeting> <row meeting-id="623" invited-participants="3"> <meeting-name>test-mtg-1</meeting-name> <meeting-scheduled-date-time>2004-07-07T10:00:00.000-07:00</meetingscheduled-date-time> </row> <row meeting-id="679" invited-participants="2"> <meeting-name>test-mtg-2</meeting-name> <meeting-scheduled-date-time>2004-07-09T14:00:00.000-07:00</meetingscheduled-date-time> </row> </report-bulk-meeting> report-bulk-meeting-attendance Description Balise conteneur, qui contient des informations sur tous les participants à une réunion. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-meeting-attendance Exemple <report-bulk-meeting-attendance> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T13:00:28.920-07:00</attendee-join> <attendee-exit>2004-07-09T13:02:55.810-07:00</attendee-exit> </row> <row meeting-id="623" meeting-attendee="8"> <meeting-name>test-mtg-1</meeting-name> <attendee>Enterprise Administrator</attendee> <attendee-join>2004-07-09T14:33:06.577-07:00</attendee-join> <attendee-exit>2004-07-09T14:33:43.547-07:00</attendee-exit> </row> </report-bulk-meeting-attendance> 196 Chapitre 5 : Informations de référence sur les résultats XML report-bulk-objects Description Balise conteneur, qui contient des informations sur tous les participants à une réunion. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-objects Exemple <report-bulk-objects> <row> <url>/pf232654/</url> <type>presentation</type> <name>232654</name> <date-modified>2003-10-30T12:14:52.740-08:00</date-modified> </row> <row> <url>/p30542007/</url> <type>presentation</type> <name>181438 Bullet Animation Test.ppt</name> <date-modified>2003-07-14T14:52:32.327-07:00</date-modified> </row> <row> <url>/p77876740/</url> <type>presentation</type> <name>Background</name> <date-modified>2003-07-14T14:53:08.700-07:00</date-modified> </row> <row> <url>/p82537206/</url> <type>presentation</type> <name>Huge</name> <date-modified>2003-07-14T14:54:16.757-07:00</date-modified> </row> <row> <url>/p39862939/</url> <type>presentation</type> <name>Animated</name> <date-modified>2003-07-14T14:55:15.160-07:00</date-modified> </row> </report-bulk-objects> report-bulk-objects 197 report-bulk-questions Description Balise conteneur, qui contient des informations sur toutes les questions de questionnaires d’un compte. Attributs Aucun. Balises imbriquées row Renvoyée par report-bulk-questions Exemple <report-bulk-questions> <row transaction-id="38484112" score="10" principal-id="38181502"> <question>Is a capacitor active?</question> <response>false</response> <date-created>2005-03-24T16:36:36.100-08:00</date-created> </row> <row transaction-id="5335430" score="10" principal-id="4975764"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{green,red,Bob’s}</response> <date-created>2005-03-24T15:16:39.030-08:00</date-created> </row> <row transaction-id="5335151" score="0" principal-id="4954032"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{j,k,Bob’s}</response> <date-created>2005-03-24T11:52:14.280-08:00</date-created> </row> <row transaction-id="5335144" score="10" principal-id="4954032"> <question>Apples can be <1> or <2>. The name of the grocery store is <3></question> <response>{red,green,Bob’s}</response> <date-created>2005-03-24T11:46:53.950-08:00</date-created> </row> </report-bulk-questions> report-bulk-slide-views Description Balise conteneur, qui contient des données sur l’affichage des diapositives. Attributs Aucun. 198 Chapitre 5 : Informations de référence sur les résultats XML Balises imbriquées row Renvoyée par report-bulk-slide-views, report-bulk-content-slide-views Exemple Les données ci-dessous ont été renvoyées par l’API report-bulk-slide-views : <report-bulk-slide-views> <row transaction-id="38484112" principal-id="38181502"> <page>0</page> <date-created>2005-03-24T16:36:41.820-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>4</page> <date-created>2005-03-24T16:37:53.070-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>5</page> <date-created>2005-03-24T16:38:09.070-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>1</page> <date-created>2005-03-24T16:36:47.663-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>2</page> <date-created>2005-03-24T16:37:04.303-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>3</page> <date-created>2005-03-24T16:37:15.710-08:00</date-created> </row> <row transaction-id="38484112" principal-id="38181502"> <page>6</page> <date-created>2005-03-24T16:38:29.833-08:00</date-created> </row> </report-bulk-slide-views> report-bulk-users Description Balise conteneur, qui contient des données sur tous les utilisateurs d’un compte. Attributs Aucun. Balises imbriquées row report-bulk-users 199 Renvoyée par report-bulk-users Exemple <report-bulk-users> <row principal-id="181231"> <login>[email protected]</login> <name>Nathan Son</name> <email>[email protected]</email> <manager>[email protected]</manager> <type>user</type> </row> <row principal-id="182532"> <login>[email protected]</login> <name>laxmi vish</name> <email>[email protected]</email> <type>user</type> </row> <row principal-id="3914851"> <login>[email protected]</login> <name>Apple Cobbler</name> <email>[email protected]</email> <manager>[email protected]</manager> <type>user</type> </row> </report-bulk-users> report-course-status Description Balise conteneur, qui contient des informations sur l’état d’un cours. Attributs total-course-completions Nombre total de cours terminés. total-unique-course-completions Nombre total de cours individuels terminés. num-passed Nombre de cours réussis par l’utilisateur. num-failed Nombre de cours auquel l’utilisateur a échoué. num-enrollees Nombre de personnes inscrites à un cours. Balise imbriquée date-last-taken Renvoyée par report-course-status Exemple <report-course-status total-course-completions="2" total-unique-coursecompletions="1" num-passed="1" num-failed="1" num-enrollees="3"> <date-last-taken>2004-07-13T10:55:28.763-07:00</date-last-taken> </report-course-status> 200 Chapitre 5 : Informations de référence sur les résultats XML report-disk-usage Description Indique l’espace disque occupé par le contenu Breeze, en octets. Tout le contenu et les archives sont inclus. Attributs total Quantité totale d’espace disque utilisée, en octets. Balises imbriquées Aucune (balise vide). Renvoyée par report-disk-usage Exemple <report-disk-usage total="849327881" /> report-meeting-attendance Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte des informations sur un utilisateur qui a participé à une réunion spécifique. Attributs Aucun. Balises imbriquées row Renvoyée par report-meeting-attendance Exemple <report-meeting-attendance> <row transcript-id="18308" sco-id="18302" principal-id="10021" answeredsurvey="0"> <login>[email protected]</login> <session-name>Bart Cassaly</session-name> <sco-name>8th Meeting</sco-name> <date-created>2005-03-15T10:11:00.700-08:00</date-created> <date-closed>2005-03-15T10:13:12.810-08:00</date-closed> <participant-name>Bart Cassaly</participant-name> </row> </report-meeting-attendance> report-meeting-attendance 201 report-meeting-concurrent-users Description Indique le nombre maximal d’utilisateurs qui ont participé simultanément à la réunion spécifiée. La valeur renvoyée diffère du nombre d’utilisateurs qui ont participé simultanément à une réunion, car le quota risque de ne pas avoir été atteint. Ainsi, un compte peut autoriser la participation simultanée de 125 utilisateurs à une réunion, mais n’en posséder que 2. Attributs max-participants-freq Nombre de fois où le nombre maximum d’utilisateurs a été atteint au cours du mois en cours. max-users Nombre maximum d’utilisateurs. Balises imbriquées Aucune (balise vide). Renvoyée par report-meeting-concurrent-users Exemple <results> <status code="ok" /> <report-meeting-concurrent-users max-users="2" max-participants-freq="5" /> report-meeting-session Description Balise conteneur, qui contient des informations sur une réunion. Attributs Nombre de participants qui se sont connectés en tant qu’observateurs et non pas en tant que participants inscrits. num-guests num-participants sco-id Nombre total de participants à la réunion. Identifiant de la réunion mère. Identifiant unique de session individuelle. Cette valeur correspond à celle de passé en tant que paramètre de l’API report-meeting-session. session-sco-id sco-id Balises imbriquées date-created, date-end Renvoyée par report-meeting-session 202 Chapitre 5 : Informations de référence sur les résultats XML Exemple <report-meeting-sessions> <row sco-id="18302" asset-id="18304" num-participants="1"> <date-created>2005-03-15T09:30:28.233-08:00</date-created> <date-end>2005-03-15T09:45:36.903-08:00</date-end> </row> <row sco-id="18302" asset-id="18309" num-participants="1"> <date-created>2005-03-15T10:11:00.700-08:00</date-created> <date-end>2005-03-15T10:21:07.733-08:00</date-end> </row> </report-meeting-session> report-meeting-sessions Description Balise conteneur, qui contient des informations sur toutes les sessions d’une réunion. Attributs Aucun. Balises imbriquées row Renvoyée par report-meeting-sessions Exemple <report-meeting-sessions> <row sco-id="622852" num-participants="1" num-guests="0" num-polls="0"> <name>My Meeting</name> <date-begin>2004-03-05T10:33:09.030-08:00</date-begin> </row> </report-meeting-sessions> report-meeting-session-slots Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte des informations sur une période de session donnée. Attributs Aucun. Balises imbriquées row report-meeting-session-slots 203 Renvoyée par report-meeting-session-slots Exemple <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 Balise conteneur, qui indique le nombre d’utilisateurs invités à la réunion spécifiée et le nombre d’invités et d’hôtes qui y ont réellement assisté. Attributs num-unique-meetings Nombre de réunions individuelles. Nombre le plus élevé de participants simultanés dans la salle. peak-users num-invitees Nombre d’utilisateurs qui ont été invités à la réunion. num-invitees-attended is-public Nombre d’utilisateurs invités qui ont participé à la réunion. Valeur booléenne qui indique si la salle est publique (true) ou non (false). Nombre de participants qui se sont connectés en tant qu’observateurs et non pas en tant que participants inscrits. num-guests-attended Balises imbriquées most-recent-session Renvoyée par report-meeting-summary Exemple <report-meeting-summary num-unique-meetings="2" peak-users="" num-invitees="4" num-invitees-attended="1" ispublic="0" num-guests-attended="0"> <most-recent-session>2005-03-15T10:11:00.700-08:00</most-recent-session> </report-meeting-summary> 204 Chapitre 5 : Informations de référence sur les résultats XML report-principal-list Description Balise conteneur, qui contient des informations sur les mandants. Attributs Aucun. Balises imbriquées row Renvoyée par report-principal-list Exemple <report-principal-list> <row principal-id="8" type="user" has-children="false" is-primary="false"> <name>Enterprise Administrator</name> <login>[email protected]</login> <custom0 /> <custom1 /> </row> <row principal-id="17" type="admins" has-children="true" is-primary="true"> <name>Account Administrators</name> <login>Account Administrators</login> <custom0 /> <custom1 /> </row> <row principal-id="123" type="user" has-children="false" is-primary="false"> <name>test1 laxmi</name> <login>[email protected]</login> <custom0>ENGG</custom0> <custom1>100-07-7777</custom1> </row> </report-principal-list> report-quiz-answer-distribution Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles indique le nombre d’utilisateurs qui ont sélectionné chaque réponse à la question de questionnaire spécifiée. Attributs Aucun. Balises imbriquées row report-quiz-answer-distribution 205 Renvoyée par report-quiz-answer-distribution Exemple <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>How far is it from Earth to the sun?</body> </row> <row question-number="3" question-id="259" a1="8" a2="0" a3="0" a4="0" total="8"> <body>Which international standard defines ECMAScript?</body> </row> </report-quiz-answer-distribution> report-quiz-interactions Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte des informations sur une interaction entre un utilisateur et le questionnaire spécifié. Pour plus d’informations sur les interactions, reportez-vous à l’API report-quiz-interactions. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-interactions Exemple <report-quiz-interactions> <row display-seq="1" transcript-id="17452" interaction-id="17442" scoid="17438" score="10"> <name>Barry Cassidy</name> <sco-name>All Question Types Quiz</sco-name> <date-created>2005-03-11T12:04:29.200-08:00</date-created> <description>A human being usually has <1> fingers.</description> <response>10</response> </row> </report-quiz-interactions> 206 Chapitre 5 : Informations de référence sur les résultats XML report-quiz-question-answer-distribution Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles indique le nombre d’utilisateurs ayant choisi une réponse donnée à la question de questionnaire spécifiée. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-question-answer-distribution Exemple <report-quiz-question-answer-distribution> <row question-id="259" answer-id="1" correct="0" total-responses="1" percentage-responded="10"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ISO-9000</answer-text> </row> <row question-id="259" answer-id="2" correct="0" total-responses="3" percentage-responded="30"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>RFC 821</answer-text> </row> <row question-id="259" answer-id="3" correct="0" total-responses="2" percentage-responded="20"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-976</answer-text> </row> <row question-id="259" answer-id="4" correct="1" total-responses="4" percentage-responded="40"> <question-text>Which international standard defines ECMAScript?</question-text> <answer-text>ECMA-262</answer-text> </row> </report-quiz-question-answer-distribution> report-quiz-question-answer-distribution 207 report-quiz-question-distribution Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles indique le nombre d’utilisateurs ayant répondu correctement à la question de questionnaire spécifiée. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-question-distribution Exemple <report-quiz-question-distribution> <row question-id="257" question-number="1" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> <body>What is 2+2?</body> </row> <row question-id="258" question-number="2" num-correct="8" num-incorrect="0" percentage-correct="100" score="20"> <body>How far is it from Earth to the sun?</body> </row> <row question-id="259" question-number="3" num-correct="4" num-incorrect="6" percentage-correct="40" score="20"> <body>Which international standard defines ECMAScript?</body> </row> </report-quiz-question-distribution> report-quiz-question-response Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles décrit la réponse apportée à la question de questionnaire spécifiée. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-question-response 208 Chapitre 5 : Informations de référence sur les résultats XML Exemple <report-quiz-question-response> <row principal-id="10021" interaction-id="17807"> <user-name>Barry Cassidy</user-name> <response>D</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17809"> <user-name>Barry Cassidy</user-name> <response>0</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17810"> <user-name>Barry Cassidy</user-name> <response>2</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17811"> <user-name>Barry Cassidy</user-name> <response>C11101BA001B%2Eo4E%7E%24KQ%2AWO2Jj110BKEBDB1B1EBCB0B0EBBB0B0EBAB0 B0E</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17812"> <user-name>Barry Cassidy</user-name> <response>1</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <row principal-id="10021" interaction-id="17813"> <user-name>Barry Cassidy</user-name> <response>2</response> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> </report-quiz-question-response> report-quiz-question-totals Description Indique le nombre total d’utilisateurs qui ont répondu à la question de questionnaire spécifiée et le nombre d’utilisateurs qui y ont répondu correctement. Attributs num-correct-answers question-id Nombre d’utilisateurs qui ont répondu correctement à la question. Identifiant de la question. total-responses Nombre total d’utilisateurs qui ont répondu à la question. Balises imbriquées Aucune (balise vide). report-quiz-question-totals 209 Renvoyée par report-quiz-question-totals Exemple <report-quiz-question-totals question-id="260" total-responses="8" num-correct-answers="5" /> report-quiz-results Description Indique le nombre d’utilisateurs qui ont participé au questionnaire spécifié et la plage de scores correspondante. Attributs average-score high-score low-score Moyenne des scores des utilisateurs qui ont répondu au questionnaire. Score le plus élevé. Score le plus faible. numdistincttaken numtaken Nombre d’utilisateurs individuels qui ont répondu au questionnaire. Nombre d’utilisations du questionnaire. Balises imbriquées Aucune (balise vide). Renvoyée par report-quiz-summary Exemple <report-quiz-results average-score="95" low-score="90" high-score="100" numtaken="8" numdistincttaken="1" /> report-quiz-summary Description Balise conteneur, qui contient des informations sur un questionnaire. Attributs Aucun. Balises imbriquées row Renvoyée par report-quiz-summary 210 Chapitre 5 : Informations de référence sur les résultats XML Exemple <report-quiz-summary> <row num-questions="0" average-score="10" low-score="10" high-score="10" numtaken="1" numdistincttaken="1" principal-id="10021" asset-id="17805" maxpossiblescore="10"> <date-created>2005-03-14T14:20:43.967-08:00</date-created> <passing-score>80</passing-score> </row> </report-quiz-summary> report-quiz-takers Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles comporte des informations sur un utilisateur qui a participé au cours ou au questionnaire spécifié. Attributs Aucun. Balises imbriquées row Renvoyée par report-course-takers, report-quiz-takers Exemple <report-quiz-takers> <row transcript-id="17466" sco-id="17438" principal-id="10021" status="userfailed" score="0" attempts="2" time-taken="152000" certificate="" answeredsurvey="1"> <name>All Question Types Quiz</name> <login>[email protected]</login> <date-created>2005-03-11T12:07:04.890-08:00</date-created> <principal-name>Bart Cassaly</principal-name> </row> <row transcript-id="17619" sco-id="17438" principal-id="11211" status="userpassed" score="60" attempts="1" time-taken="89360" certificate="17619" answered-survey="1"> <name>All Question Types Quiz</name> <login>[email protected]</login> <date-created>2005-03-11T14:52:34.903-08:00</date-created> <principal-name>George Best</principal-name> </row> </report-quiz-takers> report-quiz-takers 211 report-quotas Description Balise conteneur, qui contient des informations sur les quotas de comptes. Attributs Aucun. Balises imbriquées quota Renvoyée par report-quotas Exemple <report-quotas> <quota acl-id="181224" quota-id="2" used="6545516" limit="unlimited" softlimit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="download-quota" used="0" limit="unlimited" soft-limit="1000000000"> <date-begin>2004-03-24T13:13:18.467-08:00</date-begin> <date-end>2999-12-31T16:00:00.077-08:00</date-end> </quota> <quota acl-id="181224" quota-id="user-quota" used="6545516" limit="unlimited" soft-limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> <quota acl-id="181224" quota-id="course-quota" used="6545516" limit="unlimited" soft-limit="1000000000"> <date-begin>2003-08-15T13:12:33.260-07:00</date-begin> <date-end>2999-12-31T16:00:00.000-08:00</date-end> </quota> </report-quotas> report-sco-slides Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles indique la fréquence d’affichage de l’une des diapositives de la présentation, ainsi que la date et l’heure de la dernière consultation. Attributs Aucun. Balises imbriquées row 212 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par report-sco-slides Exemple <report-sco-slides> <row slide="1" views="5"> <date-created>2004-01-13T16:35:39.517-08:00</date-created> </row> <row slide="2" views="8"> <date-created>2004-01-13T16:35:42.350-08:00</date-created> </row> <row slide="3" views="7"> <date-created>2004-01-13T16:35:44.933-08:00</date-created> </row> </report-sco-slides> report-sco-views Description Balise conteneur, qui contient une ou plusieurs balises row. Chacune d’elles indique la fréquence d’affichage de la présentation spécifiée, ainsi que la date et l’heure de la dernière consultation. Attributs Aucun. Balises imbriquées row Renvoyée par report-sco-views Exemple <report-sco-views> <row sco-id="17803" type="content" is-folder="0" views="1" principalid="10021" transcript-id="17808" asset-id="17805"> <name>One Question - New</name> <last-viewed-date>2005-03-14T14:20:43.967-08:00</last-viewed-date> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> <report-sco-views> report-survey-question-response Description Balise conteneur, qui contient des informations sur la liste d’utilisateurs qui ont répondu à la question spécifiée, ainsi que leur réponse. Attributs Aucun. report-survey-question-response 213 Balises imbriquées row Renvoyée par report-survey-question-response Exemple <report-survey-question-response> <row principal-id="8" question-number="1"> <user-name>Enterprise Administrator</user-name> <question>how are you?</question> <response>fine</response> </row> <row principal-id="123" question-number="1"> <user-name>test1 laxmi</user-name> <question>how are you?</question> <response>ok</response> </row> </report-survey-question-response> report-training-concurrent-users Description Indique le plus grand nombre d’utilisateurs ayant utilisé le système en même temps. Attributs account-id Identifiant du compte actuel. Nombre maximum d’utilisateurs pouvant accéder au système en même temps, conformément aux spécifications de la licence de votre compte. limit max-num-sessions Nombre le plus élevé de sessions ouvertes simultanément. Balises imbriquées name Renvoyée par sco-build Exemple <report-training-concurrent-users account-id="181224" max-num-sessions="2" limit="1000000000"> <name>Professor Test Account</name> </report-training-concurrent-users> 214 Chapitre 5 : Informations de référence sur les résultats XML response Description Réponse d’un utilisateur à une question d’enquête. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-survey-question-response Exemple <response>fine</response> results Description Balise conteneur, qui contient tous les résultats renvoyés par toute API. Attributs Aucun. Balises imbriquées Toute balise. Renvoyée par Toutes les API. Exemple <results> <status code="ok" /> </results> row Description Contient un enregistrement unique d’informations dans un rapport. Pour obtenir des exemples d’attributs et de balises imbriquées gérés, consultez les exemples de résultats qui illustrent la section consacrée à l’API appelée. Attributs Les attributs de la balise row varient considérablement selon l’API à laquelle répond la balise. row 215 Balises imbriquées Les balises imbriquées dans la balise row varient considérablement selon l’API à laquelle répond la balise et sont susceptibles d’inclure des balises personnalisées. Renvoyée par report-bulk-consolidated-transactions, report-bulk-content-quiz, report-bulkcontent-quiz-results, report-bulk-content-slide-views, report-bulk-course-quiz, report-bulk-course-results, report-bulk-meeting, report-bulk-meeting-attendance, report-bulk-objects report-bulk-questions, report-bulk-slide-views, report-bulkusers, report-course-takers, report-meeting-attendance, report-meeting-sessionslots, report-meeting-sessions, report-principal-list, report-quiz-answer-distribution, report-quiz-definition-answers, report-quizdefinition-questions, report-quiz-interactions, report-quiz-question-answerdistribution, report-quiz-question-distribution, report-quiz-question-response, report-quiz-summary, report-quiz-takers, report-sco-slides, report-sco-views, report-survey-question-response Exemple <row sco-id="17803" type="content" is-folder="0" views="1" principalid="10021" transcript-id="17808" asset-id="17805"> <name>One Question - New</name> <last-viewed-date>2005-03-14T14:20:43.967-08:00</last-viewed-date> <date-created>2005-03-14T14:20:43.967-08:00</date-created> </row> sco Description Balise conteneur, qui contient des informations sur un SCO (document Breeze unique). Pour obtenir des exemples d’attributs et de balises imbriquées gérés, consultez les exemples de résultats qui illustrent la section consacrée à l’API appelée. Attributs Les attributs de la balise sco varient considérablement selon l’API à laquelle répond la balise. Balises imbriquées Les balises imbriquées dans la balise sco varient considérablement selon l’API à laquelle répond la balise. Renvoyée par report-active-meeting-presenters, report-active-meetings, sco-contents, scoexpanded-contents, sco-info, sco-nav, sco-search, sco-shortcuts, sco-update Exemple <sco author-contact-id="185" folder-id="71" host-id="" learning-time="-1" sco-data-id="173" sco-id="235" source-sco-id="" status="active" tree-id="25" type="session"> 216 Chapitre 5 : Informations de référence sur les résultats XML <date-begin>2003-06-30T19:33:38.317+00:00</date-begin> <date-created>2003-06-30T19:33:38.317+00:00</date-created> <date-end>2003-07-10T13:05:42.180+00:00</date-end> <date-modified>2003-06-30T19:33:38.317+00:00</date-modified> <name>another - 06/30/2003 12:33 PM</name> <url-path>/p62559548/</url-path> </sco> L’exemple ci-dessous est renvoyé par l’API report-active-meetings : <sco sco-id="38130439" active-participants="1" length-minutes="2"> <name>022305 Stephanie Test</name> <url-path>/r27873068/</url-path> <date-created>2005-02-28T16:09:28.510-08:00</date-created> </sco> sco-author Description Balise conteneur, qui contient des informations sur l’auteur d’un SCO. Attributs Aucun. Balises imbriquées email, first-name, last-name Renvoyée par sco-info Exemple <sco-author> <email>[email protected]</email> <first-name>Pat</first-name> <last-name>Tennant</last-name> </sco-author> sco-data Description Balise conteneur, qui contient des informations sur le fichier de données sous-jacent (tel que le fichier contenant une présentation) utilisé dans un SCO. Attributs byte-count Taille du fichier de données du SCO, en octets. height Hauteur du SCO, en pixels. length Durée d’une présentation, en millisecondes. sco-data-id Identifiant du fichier de données du SCO. sco-data 217 Nombre de diapositives du SCO. Une valeur de -1 indique que le nombre de diapositives ne s’applique pas. Ainsi, si le SCO est une réunion et non pas une présentation, le nombre de diapositives correspond à -1. slide-count Numéro de version du SCO. version width Largeur du SCO, en pixels. Balises imbriquées date-created, date-modified, physical-path Renvoyée par sco-info Exemple <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> sco-name Description Nom d’un SCO déterminé, tel le nom d’une réunion. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-attendance Exemple <sco-name>My Meeting</sco-name> sco-nav Description Contient des informations sur l’arborescence de dossiers renfermant le SCO spécifié. Attributs Aucun. Balises imbriquées sco 218 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par sco-nav Exemple <sco-nav> <sco sco-id="181230" tree-id="181230" type="folder" depth="2"> <name>User Meetings</name> </sco> <sco sco-id="181576" tree-id="181230" type="folder" depth="1"> <name>[email protected]</name> </sco> </sco-nav> sco-search-info Description Balise conteneur, qui contient une ou plusieurs balises sco. Chacune d’elles comporte des informations sur un SCO correspondant au texte de recherche spécifié. Attributs Aucun. Balises imbriquées sco Renvoyée par sco-search Exemple <sco-search-info> <sco sco-id="5393671" folder-id="5393514" type="content" icon="producer" byte-count="1575"> <name>/p68431203/</name> <url-path>/p68431203/</url-path> <date-created>2005-03-30T16:32:42.280-08:00</date-created> <date-modified>2005-03-30T16:32:42.280-08:00</date-modified> <hit>2</hit> <hit-type>slide</hit-type> <hit-url>/Viewer.swf?slide=2</hit-url> <thumbnail-path /> </sco> </sco-search-info> sco-search-info 219 scos Description Balise conteneur, qui contient une ou plusieurs balises sco. Chacune d’elles comporte des informations sur un SCO à l’intérieur du dossier spécifié. Attributs Aucun. Balises imbriquées sco Renvoyée par sco-contents Exemple <scos> <sco sco-id="505677" status="no-content" type="folder" is-folder="1"> <name>PPT meeting tests</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>My Name</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, qui contient une ou plusieurs balises sco. Chacune d’elles comporte des informations sur un dossier dont le contenu se rapporte à l’utilisateur connecté. Pour plus d’informations, consultez l’API sco-shortcuts API. Attributs Aucun. Balises imbriquées sco Renvoyée par sco-shortcuts 220 Chapitre 5 : Informations de référence sur les résultats XML Exemple <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> ... [Other sco tags here.] ... <sco tree-id="181230" sco-id="181230" type="user-meetings"> <domain-name>http://admin.breeze.example.com</domain-name> </sco> </shortcuts> source-sco Description Balise conteneur, qui contient des informations sur le SCO qui se rapportent au contenu d’un cours. Attributs Aucun. Balises imbriquées source-sco Renvoyée par sco-info Exemple <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>Simple test presentation</description> <name>Math Test</name> <url-path>/p60802018/</url-path> </source-sco> </source-sco> source-sco 221 status Description Code d’état renvoyé par le serveur Breeze à chaque appel d’une API. Cette section propose des informations sur tous les codes et sous-codes d’état que Breeze peut renvoyer. Attributs code Etat de l’API. Le tableau ci-dessous indique les valeurs gérées de cet attribut. Valeur Description invalid Indique qu’un appel n’est pas valide, sans plus de précisions. Si l’attribut code est réglé 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’API. Ce problème risque de se produire dans diverses situations. La valeur de l’attribut subcode fournit plus de détails. Si vous spécifiez 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 réponse à une API qui renvoie normalement des données). Ce résultat signifie généralement qu’aucun élément ne correspond à l’identifiant spécifié. Pour résoudre cette erreur, modifiez l’identifiant spécifié de façon à ce qu’il corresponde à un élément existant. ok Indique que l’API s’est terminée normalement. too-much-data Indique que l’API 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 passe et que vous appelez l’API login qui utilise ce nom et ce mot de passe en tant que paramètres, le système ne peut pas déterminer votre identité lors de la connexion et renvoie l’erreur "too-muchdata". Parfois utilisé pour fournir plus de détails sur l’état de l’API. Par exemple, les valeurs permettent de détecter les situations où code est défini sur no-access. Le tableau cidessous indique les valeurs gérées de cet attribut. subcode subcode Valeur Description account-expired Le compte utilisateur a expiré. denied Vos informations d’identification ne vous autorisent pas à appeler l’API. no-login Vous ne vous êtes pas connecté. Pour résoudre cette erreur, connectez-vous (par le biais de l’API login) avant d’appeler l’API. Pour plus d’informations, consultez l’API login. no-quota Les limites du compte ont été atteintes ou dépassées. not-available La ressource requise n’est pas disponible. not-secure Vous devez utiliser SSL pour appeler cette API. pending-activation Le compte n’a pas encore été activé. 222 Chapitre 5 : Informations de référence sur les résultats XML Valeur Description pending-license Le contrat de licence du compte n’a pas encore été accepté. sco-expired Le cours ou le contenu de suivi a expiré. sco-not-started La réunion ou le cours n’a pas encore débuté. Balises imbriquées invalid Renvoyée par Toutes les API. Exemple <status code="ok" /> time-slot-begin Description Date et heure de début d’une session de réunion, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-session-slots Exemple <time-slot-begin>2004-02-14T06:50:00.000-08:00</time-slot-begin> time-slot-end Description Date et heure de fin d’une session de réunion, exprimées au format de date ISO 8601. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-meeting-session-slots time-slot-end 223 Exemple <time-slot-end>2004-02-14T07:00:00.000-08:00</time-slot-end> time-taken Description Heure de participation à un cours. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-bulk-course-results Exemple <time-taken>00:34:23.011</time-taken> url Description Une URL. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par common-info, report-my-courses Exemple <url>/api/xml?action=common-info</url> url-path Description Chemin du SCO spécifié sur le serveur Breeze. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). 224 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par report-my-courses, report-my-meetings, sco-info, sco-search Exemple <url-path>/r99718924/<url-path> user (common-info) Description Balise conteneur, qui contient des informations sur un utilisateur. Attributs user-id Identifiant de l’utilisateur. Balises imbriquées login, name Renvoyée par common-info Exemple <user user-id="503562"> <name>Greg Erweck</name> <login>[email protected]</login> </user> user (user-accounts) Description Balise conteneur, qui contient des informations sur un utilisateur et un compte. Attributs user-id Identifiant de l’utilisateur. account-id Identifiant d’un compte. Balises imbriquées date-expired, name Renvoyée par user-accounts Exemple <user user-id="211729" account-id="211655"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> user (user-accounts) 225 user-agent Description Informations sur le navigateur d’un hôte. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par common-info Exemple <user-agent> Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0 </user-agent> user-first-name Description Prénom d’un utilisateur. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par report-bulk-content-slide-views Exemple <user-first-name>Enterprise</user-first-name> user-last-name Description Nom d’un utilisateur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). 226 Chapitre 5 : Informations de référence sur les résultats XML Renvoyée par report-bulk-content-slide-views Exemple <user-last-name>Administrator</user-last-name> user-login Description Nom de connexion d’un utilisateur. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par report-bulk-content-quiz-results Exemple <user-login>[email protected]</user-login> user-name Description Nom d’un utilisateur. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par report-survey-question-response Exemple <user-name>Enterprise Administrator</user-name> user-name 227 users Description Balise conteneur, qui contient une ou plusieurs balises user. Chacune d’elles comporte des informations sur un utilisateur et un compte. Attributs Aucun. Balises imbriquées user (user-accounts) Renvoyée par user-accounts Exemple <users> <user user-id="211729" account-id="211655"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> <user user-id="212988" account-id="212928"> <name>[email protected]</name> <date-expired>2004-01-24T00:59:59.000-07:00</date-expired> </user> </users> value Description Valeur d’un champ personnalisé. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par acl-field-list, principal-info Exemple <value>408-1111-111</value> 228 Chapitre 5 : Informations de référence sur les résultats XML version Description Numéro de version de Breeze. Attributs Aucun. Balises imbriquées Aucune (contenu uniquement). Renvoyée par common-info Exemple <version>breeze_402_r116</version> view-date-time Description Date et heure d’affichage d’une diapositive. Attributs Aucun. Balises imbriquées Aucun. Renvoyée par report-bulk-content-slide-views Exemple <view-date-time>2004-06-30T11:46:12.500-07:00</view-date-time> view-date-time 229 230 Chapitre 5 : Informations de référence sur les résultats XML INDEX A access-key, balise 153 access-key-group, balise 154 access-keys, balise 155 accesskey-exec, action 52 accesskey-info, action 53 account, balise 155 ACL 19 acl, balise 156 acl-field-info, action 54 acl-field-list, action 56 acl-field-list, balise 156 acl-field-update, action 57 acl-fields, balise 157 acl-id, paramètres 18 acl-preference-update, action 58 action, balise 157 action-list, action 61 actions accesskey-exec 52 accesskey-info 53 acl-field-info 54 acl-field-list 56 acl-field-update 57 acl-preference-update 58 action-list 61 appel 15 common-info 37, 62 custom-field-update 63 custom-fields 64 custom-fields-delete 65 définition 9 group-membership-update 31, 65 learning-path-info 33, 66 learning-path-update 33, 68 login 33, 69 logout 71 modifications intégrées à Breeze 5.1 9, 10 noms 157 obsolètes 10 permissions-info 71 permissions-reset 73 permissions-update 73 principal-info 36, 74 principal-list 34, 76 principal-list-by-field 77 principal-update 31, 78 principals-delete 35, 79 report-account-meeting-attendance 80 report-active-meeting-presenters 81 report-active-meetings 82 report-bandwidth 83 report-bulk-consolidated-transactions 83 report-bulk-content-quiz 85 report-bulk-content-quiz-results 86 report-bulk-content-slide-views 87 report-bulk-course-quiz 88 report-bulk-course-results 89 report-bulk-meeting 90 report-bulk-meeting-attendance 91 report-bulk-objects 92 report-bulk-questions 94 report-bulk-slide-views 95 report-bulk-users 96 report-course-status 98 report-course-takers 99 report-disk-usage 100 report-meeting-attendance 101 report-meeting-concurrent-users 102 report-meeting-session 103 report-meeting-session-slots 104 report-meeting-sessions 103 report-meeting-summary 105 report-my-courses 31, 37, 106 231 report-my-events 31 report-my-meetings 31, 38, 107, 108 report-principal-list 109 report-quiz-answer-distribution 111 report-quiz-definition-answers 112 report-quiz-definition-questions 113 report-quiz-interactions 114 report-quiz-question-answer-distribution 115 report-quiz-question-distribution 117 report-quiz-question-response 118 report-quiz-question-totals 119 report-quiz-summary 120 report-quiz-takers 40, 121 report-quotas 122 report-sco-slides 123 report-sco-views 124 report-survey-question-response 125 sco-build 126 sco-contents 38, 126 sco-delete 128 sco-expanded-content 51 sco-expanded-contents 129 sco-info 39, 129 sco-move 132 sco-nav 132 sco-search 133 sco-shortcuts 32, 38, 135 sco-update 32, 136 sco-upload 140 terminées avec succès 34 user-accounts 141 user-transcript-update 33, 142 user-update-pwd 143 Voir aussi services Web actions, balise 157 actualisation appartenance au groupe 65 autorisations 73 informations utilisateur 36 mandants 78 mots de passe 142, 143 SCO 136 adresses électroniques comme nom de connexion 175 affichage diapositives 123 présentations 124 analyse du code XML renvoyé 34 answer-correct, balise 158 answer-text, balise 158 API Voir actions 232 Index appel d’actions 15 arborescences 18, 127 arborescences de dossiers 132 attributs, recherche 34 auto-inscription 153, 155 autorisations affectation 136 présentation 19 Voir aussi SCO autorisations, configuration 73 B balises access-key 153 access-key-group 154 access-keys 155 account 155 acl 156 acl-field-list 156 acl-fields 157 action 157 actions 157 answer-correct 158 answer-text 158 body 159 cfhttp (en CFML) 34 comment 159 common 159 contact 160 cookie 161 course 161 custom-fields 162 date 162 date-begin 163 date-closed 163 date-created 163 date-end 164 date-expired 164 date-last-taken 165 date-modified 165 date-taken 165 date-time-attempted 166 description 166 domain-name 166 duration 167 email 167 event 168 expanded-scos 168 expired 169 field 169 file 170 files 170 first-name 171 hit 171 host 171 invalid 172 last-name 173 last-viewed 173 last-viewed-date 173 learning-path 174 learning-paths 174 login 175 meeting 175 most-recent-session 176 my-courses 176 my-events 177 my-meetings 177 name 178 participant-name 179 path 179 permission 179 permissions 180 physical-path 180 preferences 181 présentation 145 presentation-name 184 principal 184 principal-list 185 principal-name 186 question 186 question-text 187 quiz-definition-answers 187 quiz-definition-questions 188 quiz-name 187, 188 quota 189 raccourcis 220 report-account-meeting-attendance 190 report-active-meeting-presenters 190 report-active-meetings 191 report-bandwidth 192 report-bulk-consolidated-transactions 192 report-bulk-content-quiz 193 report-bulk-content-quiz-results 193 report-bulk-course-quiz 194 report-bulk-course-quiz-results 195 report-bulk-meeting 195 report-bulk-meeting attendance 196 report-bulk-objects 197 report-bulk-questions 198 report-bulk-slide-views 198 report-bulk-users 199 report-course-status 200 report-disk-usage 201 report-meeting-attendance 201 report-meeting-concurrent-users 202 report-meeting-session 202 report-meeting-session-slots 203 report-meeting-sessions 203 report-meeting-summary 204 report-principal-list 205 report-quiz-answer-distribution 205 report-quiz-interactions 206 report-quiz-question-answer-distribution 207 report-quiz-question-distribution 208 report-quiz-question-response 208 report-quiz-question-totals 209 report-quiz-results 210 report-quiz-summary 210 report-quiz-takers 211 report-quotas 212 report-sco-slides 212 report-sco-views 213 report-survey-question-response 213 report-training-concurrent-users 214 response 215 results 145, 215 row 40, 215 sco 216 sco-author 217 sco-data 217 sco-name 218 sco-nav 218 sco-search-info 219 scos 220 source-sco 221 status 145, 222 time-slot-begin 223 time-slot-end 223 url 224 url-path 224 user 225 user-agent 226 user-first-name 226 user-last-name 226 user-login 227 user-name 227 users 228 value 228 version 229 view-date-time 229 Index 233 bande passante, rapport 83 body, balise 159 Breeze portail, intégration 37 serveur, interactions 14 Voir aussi utilisateurs BREEZESESSION, cookies conflits entre les noms de cookie 20 cookie, balise 161 exemple de code 33 invalidation 71 login, action 69 présentation 16, 29 sécurité 18 C cas courants d’utilisation 27 cfhttp, balise (en CFML) 34 CFML création de code XML 12 exemples de code 15 chaînes de requête, création chemin d’accès à du contenu 39 clés d’accès obtention 53 spéciales 153, 155 codes d'état invalid 172 présentation 222 XML, résultats 29 ColdFusion Markup Language. Voir CFML comment, balise 159 common, balise 159 common-info, action 37, 62 compilation de SCO 126, 140 comptes limites 102 liste 141 connexion 18, 33, 37, 69 contact, balise 160 contenu dossier 126 extraction de l’URL 39 lancement 20 recherche 39 spécifique, affichage 38 conventions typographiques 12 cookie, balise 161 234 Index cookies BREEZESESSION BREEZESESSION, action login 69 Voir aussi BREEZESESSION, cookies cours affichage 31 lancement 20 liste 37, 106 participants inscrits 99 présentation recherche 37 Voir aussi SCO course, balise 161 création chaînes de requête mandants 78 SCO 136 utilisateurs 35 utilisateurs administratifs 33 CSV (données séparées par des virgules) 40 CSV, format 40 cursus de formation, création et gestion 33 custom-field-update, action 63 custom-fields, action 64 custom-fields, balise 162 custom-fields-delete, action 65 D date, balise 162 date, format 12, 23 date-begin, balise 163 date-closed, balise 163 date-created, balise 163 date-end, balise 164 date-expired, balise 164 date-last-taken, balise 165 date-modified, balise 165 date-taken, balise 165 date-time-attempted, balise 166 déconnexion 71 Denied, autorisation 19 dépannage 222 déplacement de SCO 132 description, balise 166 diapositives nombre 218 nombre de visionnages 123 documentation et mises à jour 11 domain-name, balise 166 dossiers arborescences 132 autorisations 19 communs 135 contenu 126 liste des contenus 38 my-content (Mon contenu) 38 présentation relatifs à l’utilisateur actuel 135 Voir aussi SCO dossiers parents 132 duration, balise 167 E éléments XML renvoyés 41, 145 email, balise 167 entrée API, exemple 41 erreur, recherche 34 espace disque, quantité utilisée par contenu Breeze 100 étudiants inscrits au cours 99 événements, affichage 31 event, balise 168 exemples balise XML 146 code 27 filtres 23 exemples de code analyse du code XML renvoyé 34 présentation 27 utilisation de CFML 15 exemples de tâches courantes 27 expanded-scos, balise 168 expired, balise 169 extraction de l’URL 39, 135 F field, balise 169 file, balise 170 files, balise 170 filtres exemples 22, 23 présentation 21 spéciaux 23, 24 syntaxe 24 test dans un navigateur 25 tri 23 first-name, balise 171 flux de données 14 flux de travail 14 folder-id, paramètres 18 G génération de rapports 40 gras, convention d'utilisation 12 group-id, paramètres 18 group-membership-update, action 65 groupes autorisations 20 membres, actualisation 65 prédéfinis 17 présentation 17 Voir aussi mandants utilisateurs 17 groupes prédéfinis autorisations définition 17 groupes primaires. Voir groupes prédéfinis H heure, format 12 hit, balise 171 host, balise 171 HTTP paramètres 34 requêtes GET et POST 15 I identifiants autorisations 19 compte 155 présentation questions de questionnaires utilisateurs, extraction 37 identité, vérification 69 informations affichage dans un tableau 38 sur les mandants 74 sur les SCO 129 sur les serveurs, obtenir 62 informations d'identification, sécurité 18, 69 intégration de Breeze à un portail 37 interactions avec les questionnaires 114 interfaces, conversion 13 invalid, balise 172 invités, nombre 105 ISO 8601, format de date 12 italique, convention d'utilisation 12 Index 235 L lancement du contenu 20 last-name, balise 173 last-viewed, balise 173 last-viewed-date, balise 173 LDAP 33 learning-path, balise 174 learning-path-info, action 66 learning-path-update, action 68 learning-paths, balise 174 liens hypertexte, création 39 Lightweight Directory Access Protocol (LDAP) 33 limites des comptes 102 listes comptes 141 contenu des dossiers 38, 126 cours 37, 106 mandants 76, 77 présentateurs 81 questions de questionnaires 113 réunions 38, 82 stagiaires 99 listes de contrôle des accès (ACL) 19 login, action 18, 69 login, balise 175 logos 18, 127 logout, action 71 M Manage, autorisation 19 mandants ajout à un groupe 65 autorisations 19, 71, 73 création 78 informations, obtenir 74 liste 76, 77 présentation 17 Voir aussi utilisateurs utilisateurs Voir aussi mandants ; groupes 17 meeting, balise 175 modification appartenance au groupe 65 autorisations 73 mandants 78 most-recent-session, balise 176 mots de passe modification 142, 143 vérification 37 236 Index my-content (Mon contenu), dossier 38 my-courses, balise 176 my-events, balise 177 my-meetings, balise 177 N name, balise 178 noms d'actions 157 noms de connexion, obtention 74 noms de domaine, extraction 38 notes des questionnaires 114 numéro de version, Breeze 229 P paramètres facultatif 16 identifiant 18 multiples, spécification 16, 73, 79, 128 présentation 16 session 20 spécification 15 paramètres facultatifs 16 paramètres requis 16 parent-acl-id, paramètres 18 participant-name, balise 179 participation aux réunions 101 maximum 102 participation maximale à une réunion 102 path, balise 179 périodes de session de réunion 104 permission, balise 179 permissions, balise 180 permissions-info, action 71 permissions-reset, action 73 permissions-update, action 73 physical-path, balise 180 planning de réunions 107, 108 police du code, convention d'utilisation 12 portails, intégration de Breeze 37 POST, requêtes (HTTP) 15, 34 preferences, balise 181 prérequis 9 présentateurs autorisations 19 de réunions 81 presentation-name, balise 184 présentations nombre de diapositives 218 nombre de visionnages 123, 124 présentation recherche 39 Voir aussi SCO présentations ; réunions ; dossiers ; SCO Voir aussi cours principal, balise 184 principal-id, paramètres 18 principal-info, action 36, 74 principal-list, action 34, 76 principal-list, balise 185 principal-list-by-field, action 77 principal-name, balise 186 principal-update, action 35, 78 principals-delete, action 35, 79 publish, autorisation 19 Q question, balise 186 question-text, balise 187 questionnaires date de participation 165 interactions 114 nombre d’utilisateurs ayant répondu 119 questions 113 réponses correctes aux questions 117 réponses, distribution 115 réponses, texte 158 résumé des résultats 120 score 114 utilisateurs ayant répondu 121 Voir aussi SCO 114 questions de questionnaires identifiant, extraction 118 liste 113 Voir aussi questionnaires quiz-definition-answers, balise 187 quiz-definition-questions, balise 188 quiz-name, balise 187, 188 quota, balise 189 R raccourcis 38, 135 rapports CSV, format 40 génération 40 par lots 83 recherche de contenu 39 SCO 51, 133 recherche d’erreurs 34 recompilation de SCO 126 réinitialisation des autorisations 73 réponses aux questions de questionnaires distribution 115 interactions 114 réponses correctes 117 texte 158 Voir aussi questionnaires report-account-meeting-attendance, action 80 report-account-meeting-attendance, balise 190 report-active-meeting-presenters, action 81 report-active-meeting-presenters, balise 190 report-active-meetings, action 82 report-active-meetings, balise 191 report-bandwidth, action 83 report-bandwidth, balise 192 report-bulk-consolidated-transactions, action 83 report-bulk-consolidated-transactions, balise 192 report-bulk-content-quiz, action 85 report-bulk-content-quiz, balise 193 report-bulk-content-quiz-results, action 86 report-bulk-content-quiz-results, balise 193 report-bulk-content-slide-views, action 87 report-bulk-course-quiz, action 88 report-bulk-course-quiz, balise 194 report-bulk-course-quiz-results, balise 195 report-bulk-course-results, action 89 report-bulk-meeting, action 90 report-bulk-meeting, balise 195 report-bulk-meeting-attendance, action 91 report-bulk-meeting-attendance, balise 196 report-bulk-objects, action 92 report-bulk-objects, balise 197 report-bulk-questions, action 94 report-bulk-questions, balise 198 report-bulk-slide-views, action 95 report-bulk-slide-views, balise 198 report-bulk-users, action 96 report-bulk-users, balise 199 report-course-status, action 98 report-course-status, balise 200 report-course-takers, action 99 report-disk-usage, action 100 report-disk-usage, balise 201 report-meeting-attendance, action 101 report-meeting-attendance, balise 201 Index 237 report-meeting-concurrent-users, action 102 report-meeting-concurrent-users, balise 202 report-meeting-session, action 103 report-meeting-session, balise 202 report-meeting-session-slots, action 104 report-meeting-session-slots, balise 203 report-meeting-sessions, action 103 report-meeting-sessions, balise 203 report-meeting-summary, action 105 report-meeting-summary, balise 204 report-my-courses, action 37, 106 report-my-meetings, action 38, 107, 108 report-principal-list, action 109 report-principal-list, balise 205 report-quiz-answer-distribution, action 111 report-quiz-answer-distribution, balise 205 report-quiz-definition-answers, action 112 report-quiz-definition-questions, action 113 report-quiz-interactions, action 114 report-quiz-interactions, balise 206 report-quiz-question-answer-distribution, action 115 report-quiz-question-answer-distribution, balise 207 report-quiz-question-distribution, action 117 report-quiz-question-distribution, balise 208 report-quiz-question-response, action 118 report-quiz-question-response, balise 208 report-quiz-question-totals, action 119 report-quiz-question-totals, balise 209 report-quiz-results, balise 210 report-quiz-summary, action 120 report-quiz-summary, balise 210 report-quiz-takers, action 40, 121 report-quiz-takers, balise 211 report-quotas, action 122 report-quotas, balise 212 report-sco-slides, action 123 report-sco-slides, balise 212 report-sco-views, action 124 report-sco-views, balise 213 report-survey-question-response, action 125 report-survey-question-response, balise 213 report-training-concurrent-users, balise 214 requêtes GET et POST (HTTP) 15, 34 response, balise 215 ressources bande passante, rapport 83 documentation, ressources supplémentaires 12 rapport sur l’espace disque utilisé 100 ressources en ligne 12 238 Index résultats actions 145 des questionnaires 120 results, balise 145, 215 résumé des résultats d’un questionnaire 120 réunions actives 82 affichage 31 autorisations 19 création 32, 39 création à partir d'un modèle 32 invités, nombre 105 lancement 20 liste 38, 82 planifiées 107, 108 planning de réunions 103 présentateurs 81 présentation recherche 38 sessions 103 vides 103 Voir aussi SCO réunions actives liste 82 présentateurs 81 réunions, participation liste des utilisateurs 101 maximum 102 nombre de participants 103 participants par période de 10 minutes 104 résumé 105 row, balise 40, 215 S scénarios courants 27 questionnaires 17 SCO actualisation 136 arborescences de dossiers 132 autorisations du parent 19 autorisations, actualisation 73 autorisations, affichage des informations 71 autorisations, vue d'ensemble 19 compilation 126, 140 couramment utilisés 135 création 136 déplacement 132 dossiers parents 132 expiration, définition 169 extraction de l’URL 135 liste des SCO d’un dossier 126 obtention d’informations 129 parent, autorisations 19 présentation recherche 39, 51, 133 réinitialisation des autorisations 73 suppression 128 transfert 140 sco, balise 216 sco-author, balise 217 sco-build, action 126 sco-contents, action 38, 126 sco-data, balise 217 sco-delete, action 128 sco-expanded-content, action 51 sco-expanded-contents, action 129 sco-id, paramètres 18 sco-info, action 39, 129 sco-move, action 132 sco-name, balise 218 sco-nav, action 132 sco-nav, balise 218 sco-search, action 133 sco-search-info, balise 219 sco-shortcuts, action 38, 135 sco-update, action 136 sco-upload, action 140 scos, balise 220 sécurité, vue d'ensemble 18 serveurs, informations 62 services d’annuaire, synchronisation 33 services Web 14 introduction 12 vue d'ensemble de l'architecture 13 Voir aussi actions services Web XML. Voir actions session, paramètre 29 session, paramètre de requête 20 sessions de réunions 103, 104 shortcuts, balise 220 SOAP (Simple Object Access Protocol) 13 source-sco, balise 221 sous-dossiers, liste 126 spécification de paramètres multiples actualisation des autorisations 73 mandants, suppression 79 présentation 16 SCO, suppression 128 stagiaires, liste 99 status, balise 34, 145, 222 supports pédagogiques 11 suppression mandants 79 mandants d'un groupe 65 SCO 128 utilisateurs 35 synchronisation avec des services d’annuaire 33 systèmes d'aide 11 T tableaux, affichage 38 tâches courantes 27 texte, recherche dans des SCO 51, 133 time-slot-begin, balise 223 time-slot-end, balise 223 transaction 83 transfert de SCO 126, 140 tri, filtres 23 typographie, conventions 12 U url, balise 224 url-path, balise 224 user, balise 225 user-accounts, action 141 user-agent, balise 226 user-first-name, balise 226 user-id, paramètres 18 user-last-name, balise 226 user-login, balise 227 user-name, balise 227 user-transcript-update, action 142 user-update-pwd, action 143 users, balise 228 groupes 17 utilisateurs actualisation des informations 36 administratifs 33 ajout ajout à un groupe 31 autorisations 71 ayant répondu à un questionnaire 121 connexion 37, 69 création 31 déconnexion 71 dossiers 135 groupes, changement d’appartenance 65 identifiant, extraction 37 informations, obtenir 62, 74 Index 239 inscription à des cours 37, 106 inscrits à des cours 99 liste 34 liste des comptes 141 mots de passe, modification 142, 143 participation à une réunion, nombre maximal 102 présentation 17 réunions planifiées 38, 107, 108 réunions, participation 101 suppression 35 utilisateurs administratifs 33 V value, balise 228 vérification de l’identité 69 version, balise 229 View, autorisation 19 view-date-time, balise 229 vue d'ensemble de l'architecture 13 X XML balises, classées par ordre alphabétique 146 création avec CFML 12 éléments renvoyés 41 XML, résultats analyse 34 présentation 145 XSLT (XSL Transformations) 12, 40 240 Index ">
Публичная ссылка обновлена
Публичная ссылка на ваш чат обновлена.