ADOBE Breeze 5.0 Guide d’intégration [fr]

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

Appel d’une API sur le serveur. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Présentation des paramètres. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Présentation des mandants, des SCO et des identifiants. . . . . . . . . . . . . . . . . . . . . 17

Sécurité . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CHAPITRE 2 : Utilisation de filtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Présentation des filtres. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Présentation des filtres de tri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Exemples de filtres spéciaux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Liste des filtres gérés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Test du code dans un navigateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Pour en savoir plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CHAPITRE 3 : Tâches courantes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Appel de la première API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Connexion à Breeze. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Création d’un utilisateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Ajout d’un utilisateur dans un groupe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Affichage des réunions, des cours et des événements d’un utilisateur . . . . . . . . . . . 31

Création d’une réunion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Création d’une réunion à partir d’un modèle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

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

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

4Table des matières

report-meeting-concurrent-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

report-meeting-session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

report-meeting-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

report-meeting-summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

report-my-courses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

report-my-events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

report-my-meetings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

report-principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

report-quiz-answer-distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

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

report-quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

report-sco-slides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

report-sco-views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

report-survey-question-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

sco-build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

sco-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

sco-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

sco-expanded-contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

sco-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

sco-move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

sco-nav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

sco-search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

sco-shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

sco-update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

sco-upload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

user-accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

user-transcript-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

user-update-pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

CHAPITRE 5 : Informations de référence sur les résultats XML. . . . . . . . . . . . . 145

Code XML renvoyé. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Exemple de balise XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Balises XML classées par ordre alphabétique . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

access-key (conteneur). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

access-key (clé) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

access-key-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

access-keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

acl-field-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Table des matières 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

6Table des matières

permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

physical-path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

presentation-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

principal-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

principal-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

question-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

quiz-definition-answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

quiz-definition-questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

quiz-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

quota. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

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-sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

report-meeting-session-slots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

Table des matières 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

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

Les API de champs personnalisés vous permettent d’ajouter et de mettre à jour des champs

personnalisés, ainsi que d’en extraire des informations :

acl-field-update.

De nouvelles API de génération de rapports vous permettent d’extraire des données du serveur

Breeze :

questions
my-events

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

report-bulk-consolidated-transactions, report-bulk-objects, report-bulk-

, report-bulk-slide-views, report-bulk-users, report-bandwidth et report-
.

personnalisés.

Les API SCO mises à jour gèrent de nouveaux types de SCO (Shareable Content Object) et de

contenus.

acl-field-info, acl-field-list,

9

Les nouvelles API SCO répertorient tous les SCO d’un compte. Utilisez l’API sco-expanded-

contents

Les API de type curriculum vous permettent de collecter des informations sur les curriculums et

de mettre à jour ces derniers :

associée à des filtres pour localiser des SCO déterminés.

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 :

• 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

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

« Leveraging XML with ColdFusion » (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.

La spécification XSL Transformations (XSLT) (www.w3.org/TR/xslt) présente le code XSLT,

que vous pouvez utiliser pour convertir les données en d’autres formats.

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

datetime) 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.

Etape 2 : Le serveur
Web trouve la page
et la passe au serveur
d’applications.

Etape 3 : Le serveur
d’applications
exécute du code.

Etape 4 : Le serveur
d’applications appelle
l’API sur le serveur
Breeze.

Requête

Serveur Web

<HTML>

<code>

</HTML>

Serveur d'applications

Action

Réponse

<HTML>
<p>Hi</p>
</HTML>

Données XML

Etape 7 : Le serveur
Web envoie la page
finale au navigateur
ayant émis la requête.

Etape 6 : Le serveur
d’applications insère
des données dans la
page, puis la passe au
serveur Web.

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 Bree z e :

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 à l’URL du servlet de services Web, suivi d’une chaîne de requête, comme suit :

http://server_name/api/xml?action=action_name

action, qui indique leur nom. Vous ajoutez le paramètre

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

la au serveur sous forme de requête HTTP
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

api/xml?action=nom_action

. Les paramètres de l’API sont ajoutés en option et séparés par

des symboles &.

GET ou POST, le type de contenu HTTP étant réglé

http://breeze.example.com/

• Créez un objet XML contenant les paramètres sous forme de balises param imbriquées dans

une balise
HTTP étant réglé sur

Le code suivant appelle l’API

http://admin.breezecentral.com/api/

Le code ci-dessous est équivalent au code précédent, mais utilise POST plutôt que GET :

<params>

</params>

Pour consulter un exemple de code indiquant comment appeler une API, reportez-vous au

Chapitre 3, Tâc h e s c o u ra n t e s , page 27.

params, puis envoyez une requête HTTP POST au serveur, le type de contenu

text/xml ou application/xml.

login par le biais d’une requête HTTP GET :

xml?action=login&login=[e-mail]&password=foobar

<param name="action">login</param>
<param name="login">[e-mail]</param>
<param name="password">foobar</param>

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

POST. En raison de la façon

Connexion à Breeze au préalable

Seuls les utilisateurs connectés peuvent appeler la plupart des API. Par conséquent, vous devez
appeler l’API
suivantes sans vous connecter :

login avant d’appeler la plupart des autres API. (Vous pouvez appeler les API

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é
Lorsque vous recevez les résultats d’un appel
inclure la valeur du cookie

BREEZESESSION dans toutes les requêtes transmises ultérieurement

login, enregistrez la valeur de ce cookie. Vous devez

BREEZESESSION.

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

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âc h e s c o u ra n t e s , 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

action est obligatoire.) Pour plus d’informations, consultez la section

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
l’utilisation des variables

baseurl et loginCookie, que vous définissez lors du processus de

principal-id. Cet exemple requiert

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

id=#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 group-

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

, group-id, parent-acl-id, principal-id, sco-id et user-id.

id

acl-id, folder-

Ainsi, pour mettre à jour un mot de passe utilisateur, appelez l’API
l’identifiant de l’utilisateur sous la forme du paramètre
d’utilisateur, appelez l’API
du paramètre

principal-id.

Quelques autres types d’identifiants, tels

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

principal-info et indiquez l’identifiant de l’utilisateur sous la forme

account-id, answer-id, permission-id et

-id indique que la valeur correspondante est un identifiant de

user-id. Pour déterminer un nom

user-update-pwd et indiquez

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

18 Chapitre 1 : Utilisation des API XML de Breeze

status.

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

permissions-info. Pour modifier les autorisations d’un mandant, appelez l’API principal-

.

update

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 ci­dessus 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

pour ajouter un membre à un groupe. Utilisez l’API permissions-update pour définir

update

group-membership-

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

BREEZESESSION, ainsi que l’illustre

• 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

nom du champ (tel

Type-Modifier-FieldName=Value

like), le nom du champ (tel name), le cas échéant, et enfin la valeur du

Java). Le format du filtre est le suivant :

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
Associée à un filtre portant sur le nom des cours, tel

name=Java

cas Java. Si vous ajoutez un filtre de tri tel que

name=Java&sort-date-begin=desc

report-my-courses renvoie la liste des cours auxquels vous vous êtes inscrits.

report-my-courses&filter-like-

, cette même API extrait les cours dont le titre contient le texte indiqué, soit dans ce

report-my-course&filter-like-

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

like, Breeze renvoie les cours dont le titre correspond exactement à Java, plutôt que

like au champ name et spécifie la valeur Java. Si vous n’indiquez pas le

ceux dont le titre inclut Java. L’utilisation du filtre de tri sans modificateur sur le champ

avec la valeur desc spécifie un ordre de tri décroissant.

begin

Le tableau ci-dessous indique quelques autres exemples qui vous permettront d’assimiler les
principes de base des filtres.

date-

Filtre Description

filter-name=Analyse des objectifs

filter-like-name=Objectifs

filter-out-name=Etat

filter-like-name=Objectifs &filter-out-

status=active

filter-gt-date-begin=2004-05-01&sort-

name=asc

filter-gt-date-begin=2004-05-

01&filter-lt-date-begin=2004-05-31

22 Chapitre 2 : Utilisation de filtres

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.

Renvoie tous les éléments dont le nom comporte le
terme « Objectifs », tel « Analyse des objectifs » ou
« Objectifs trimestriels ».

Exclut tous les éléments dont le champ name contient
le terme « Etat ».

Renvoie tous les éléments dont le nom contient le
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.

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.

Renvoie tous les éléments débutés en mai 2004.

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
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-05-28, 16:23 le 28 mai 2004

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

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

principal-list pour répertorier les mandants, vous pouvez effectuer un tri primaire sur

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

name par ordre croissant :

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

filter-type=folder&filter-type=meeting

L’exemple suivant affiche tous les types de données, à l’exception de folder (dossier) et

meeting (réunion) :

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

folder (dossier) et meeting (réunion) :

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

modified=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.

Type Modificateur Description

filter (aucun)

filter like

filter out

filter rows

filter start

filter gt

filter lt

24 Chapitre 2 : Utilisation de filtres

Le champ doit correspondre exactement à la valeur indiquée.

Le champ doit impérativement contenir une valeur.

Le champ ne doit pas contenir la valeur spécifiée.

Limite les résultats renvoyés au nombre de lignes indiqué par la valeur.
Les noms de champ ne sont pas utilisés.

Limite les résultats renvoyés au nombre de lignes indiqué par la valeur.
Les noms de champ ne sont pas utilisés.

Sélectionne tous les éléments supérieurs à la valeur indiquée.
Cette syntaxe est réservée aux dates.

Sélectionne tous les éléments supérieurs à la valeur indiquée.
Cette syntaxe est réservée aux dates.

Type Modificateur Description

filter gte

filter lte

sort (aucun)

Sélectionne tous les éléments supérieurs ou égaux à la valeur indiquée.
Cette syntaxe est réservée aux dates.

Sélectionne tous les éléments inférieurs ou égaux à la valeur indiquée.
Cette syntaxe est réservée aux dates.

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
l’URL ci-dessous en substituant votre serveur à

http://breezedev.mycompany.com/api/xml?action=report-my-courses&filter-like-

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

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

breezedev.mycompany.com. Connectez-vous d’abord au serveur, puis tapez

breezedev.mycompany.com :

as date and range filtering.</description>

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

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

action-list,

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
réponse inclut le cookie
variable, telle

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, ";"), "=")>

loginCookie. Passez ensuite la variable loginCookie sous forme de paramètre

login, si le résultat XML comprend le code d’état ok, l’en-tête de

BREEZESESSION. Capturez le cookie et enregistrez les résultats dans une

<cfif xml.XmlRoot.status.XMLAttributes['code'] EQ "OK">

<!-- Connexion réussie. -->

<cfhttp url="#baseurl#/api/xml?action=report-my-

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

</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).

<input type="submit" name="submit" value="Submit"><br>

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

<cfset baseurl = "http://

breezeserveraddress">

<cfhttp url="#baseurl#/api/

xml?action=login&login=#FORM.username#&
password=#FORM.password#" method="GET"/
>

<cfset response = CFHTTP.FileContent/>

<cfset xml = XMLParse(response)>

<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-my­meetings&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>

name="submit" value="Submit"><br>
</form>
</cfif>

<input type="submit"

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.

Si la variable username est définie, ce code règle la
variable
utilise la variable
pour appeler l’API
L’API

password, qu’un utilisateur tape dans un formulaire.

Place les données renvoyées par l’appel <cfhttp>
dans la variable
convertit les données de chaîne placées dans la
variable
mémorise dans la variable

Place les données extraites de l’en-tête renvoyées
par l’appel
La deuxième ligne analyse l’en-tête pour extraire la
valeur du cookie
dans la variable

Vérifie si l’attribut du code d’état que contient la
réponse XML correspond à

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
en tant que paramètre
comme un utilisateur connecté et appeler toute
API.
Ce code appelle l’API report-my-meetings,
place la réponse dans la variable
convertit la variable
XML.

Si l’attribut du code d’état figurant dans la réponse
XML de l’API login ne correspondait pas à
imprimez

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.

baseurl sur le nom du serveur Breeze. Il

baseurl dans la balise <cfhttp>

login sur le serveur Breeze.

login nécessite deux paramètres, login et

response. La seconde ligne

response en un document XML et les

xml.

<cfhttp> dans la variable loginHeader.

BREEZESESSION et la mémorise

loginCookie.

ok.

loginCookie

session pour vous conduire

meetings et

meetings en objet document

ok,

Login Failed.

30 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

http://breezeserveraddress/api/xml?action=principal-update&first-

name=Will&last-name=Tip&login=[e-mail]&password=66Mustang&has­children=0&type=user

breezeserveraddress :

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

name=Will&last-name=Tip&login=[e-mail]&password=66Mustang&has­children=0&type=user

2.

Dans le code XML renvoyé, recherchez ce nouvel utilisateur ou un utilisateur en cours et prenez
la valeur de

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

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

■ Utilisez le paramètre is-member pour ajouter ou supprimer un utilisateur : true ajoute

l’utilisateur,

principal-id.

group-id.

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

begin=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&date-

begin=2005-01-01T01:00:00.000-05:00&date-end=2005-01-02T01:00:00.000­05: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
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 :

sco-shortcuts et prenez la valeur sco-id du dossier

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

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="[e-mail]">
<cfset password="abcdefg">
<cfset baseurl="http://breeze.example.com/">

BREEZESESSION. Ce paramètre est nécessaire pour appeler les API suivantes.

<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

Si le code d’état ne correspond pas à

ok, déterminez l’origine de l’erreur et prenez les mesures

status.

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

list

.

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

plutôt que GET, car seul POST permet de

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

L’exemple ci-dessous place la liste de tous les utilisateurs de Breeze dans le tableau

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

type correspond à user.

allUsers.

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= "[e-mail]">
<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

10.

Pour chaque utilisateur supprimé, vérifiez que le code d’état correspond à ok dans le code XML

principals-delete et en spécifiant l’identifiant de l’utilisateur.

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

ou 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". --->

principal-

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

ok, l’en-tête de réponse comprend le cookie BREEZESESSION.

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

<cfset response= cfhttp.FileContent >
<cfset xml= XmlParse(response)>
<cfset contentScoElement= XmlSearch(xml, "//sco[@type='my-content']")>
<cfset contentSco= contentScoElement[1].XmlAttributes["sco-id"]>

4.

Si vous souhaitez fournir des liens (sous forme d’adresses URL absolues) vers les éléments de

sco renvoyées :

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
complète en insérant le contenu de la balise

sco-info pour chaque élément et déterminez son adresse URL

url-path renvoyée après le nom de domaine que

vous avez obtenu précédemment.

Vous obtenez ainsi une adresse URL complète, 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

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

4.

Assurez-vous que l’API s’exécute normalement en vérifiant le contenu de la balise status

sco-id.

sco-shortcuts.

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

row, dont chacune fournit des informations sur un

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

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âc he s c ou ra nt es , 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.

results contenant une ou plusieurs autres balises, dont une

results et status étant implicite.

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.

API Description

sco-build Provoque la compilation du SCO spécifié par le serveur

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

42 Chapitre 4 : Informations de référence sur les API XML

Breeze lorsque vous créez des présentations par le biais de
l’API XML.

recherche.

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

sco-upload Transfère un fichier vers le serveur Breeze lorsque vous créez

réunions.

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

user-transcript-update Réinitialise le relevé de notes d’un utilisateur pour un objet

dans un curriculum.

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-field-list Renvoie la liste des valeurs et identifiants des ACL associées

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

custom-fields-delete Supprime le champ personnalisé associé au compte spécifié.

ACL.

au compte de connexion pour l’identifiant de champ spécifié.

le profil de l’utilisateur.

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

login Connecte un utilisateur.

logout Déconnecte un utilisateur en invalidant le cookie reçu par

actuels.

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

permissions-reset Réinitialise les autorisations de tous les mandants sur le SCO

permissions-update Actualise les autorisations d’un ou de plusieurs mandants sur

autorisations dont ils disposent sur le SCO indiqué.

indiqué. Les autorisations sur le parent de ce SCO
s’appliquent alors à tous les mandants.

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 :

API Description

report-active-meeting-presenters Renvoie la liste des utilisateurs qui sont actuellement

report-active-meetings Renvoie la liste des réunions en cours.

report-bulk-consolidated­transactions

44 Chapitre 4 : Informations de référence sur les API XML

présentateurs de réunions.

Renvoie des informations sur toutes les transactions
associées à un compte. Une transaction correspond à une
occurrence de mandant participant à un SCO.

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

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 :

API Description

group-membership-update Ajoute un ou plusieurs mandants à un groupe ou supprime un

principal-info Fournit des informations sur le mandant spécifié (utilisateur

principal-list Renvoie la liste complète des utilisateurs et des groupes, y

principal-list-by-field Vous permet de répertorier les mandants associés à une

principal-update Actualise les informations relatives à un mandant du compte

principals-delete Supprime un ou plusieurs mandants.

user-accounts Renvoie la liste des comptes auxquels appartient l’utilisateur

user-update-pwd Modifie le mot de passe d’un utilisateur.

ou plusieurs mandants d’un groupe.

ou groupe).

compris les groupes primaires.

valeur de champ déterminée.

actuel ou crée un nouveau mandant.

spécifié.

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

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-consolidated­transactions

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.

48 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-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é.

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

50 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

user-accounts Renvoie la liste des comptes auxquels appartient l’utilisateur

sco-update et sco-build.)

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
réside dans le fait qu’il est possible d’appeler

accesskey-exec et principal-update pour créer un nouvel utilisateur

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 en tant que paramètres supplémentaires sous forme de paires nom-valeur, ainsi

accesskey-exec. Pour ce faire, passez les champs personnalisés à

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

first-name Prénom du nouvel utilisateur.

has-children Ce paramètre doit toujours être mis à 0 pour l’inscription d’un nouvel

Clé d’accès spéciale qui permet à l’utilisateur de s’inscrire lui-même.

utilisateur.

last-name Nom du nouvel utilisateur.

login Nom de connexion du nouvel utilisateur, qui correspond généralement à son adresse

électronique.

52 Chapitre 4 : Informations de référence sur les API XML

password Mot de passe du nouvel utilisateur.

type Ce paramètre doit systématiquement correspondre à user pour l’inscription d’un nouvel

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>

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 lui­mê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

Filtres

Identifiant d’un SCO.

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

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

access-key-group :

L’exemple de résultats ci-dessous est renvoyé lorsqu’un groupe existe et comprend de ce fait un
élément

<results>

</results>

accesskey-group :

<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-acl­id="630">

<access-key>2cw6np2kx2dtdop2</access-key>

<date-created>2004-07-07T12:27:04.590-07:00</date-created>

</access-key>
</access-keys>

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

Ce paramètre peut correspondre à

54 Chapitre 4 : Informations de référence sur les API XML

Identifiant de l’ACL dont vous voulez renvoyer des informations sur les champs.

sco-id, account-id ou principal-id.

principal-list pour déterminer les

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>[e-mail]</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">

com.macromedia.breeze_ext.premiere.gateway.PTekGateway

</results>

<value>

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

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
l’autorisation Administrateur sur le compte de connexion.

field-id=first-name. Pour appeler cette API, vous devez disposer de

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

Filtres

Identifiant du champ vous voulez renvoyer les valeurs.

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

56 Chapitre 4 : Informations de référence sur les API XML

, acl-field-update

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
principal-id, sco-id ou account-id.

field-id Identifiant du champ que vous voulez modifier.

valeur 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

http://server_name/api/xml?action=acl-field-update&acl-id=38140560&field-

Les résultats sont les suivants :

<results>

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

Identifiant de l’ACL que vous voulez modifier. Cet identifiant peut correspondre à

acl-field-list pour déterminer cette valeur) :

id=first-name&value=Mary%20Sue

<status code="ok"/>

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

acl-id

lang Paramètre de langue. Breeze gère actuellement les cinq langues suivantes :

Langue Paramètre

Anglais

Français

Allemand

Japonais

Coréen

time-zone-id Paramètre du fuseau horaire. Breeze gère actuellement les 75 fuseaux horaires

Identifiant de l’utilisateur dont vous voulez modifier les préférences.

en

fr

de

ja

ko

suivants :

Fuseau horaire Paramètre

(GMT-12:00) Ligne de changement de date internationale (ouest)

(GMT-11:00) Midway, Samoa

(GMT-10:00) Hawaï

58 Chapitre 4 : Informations de référence sur les API XML

0

1

2

Fuseau horaire Paramètre

(GMT-09:00) Alaska

(GMT-08:00) Pacifique (USA et Canada), Tijuana

(GMT-07:00) Montagnes rocheuses (USA et Canada)

(GMT-07:00) Chihuahua, La Paz, Mazatlan

(GMT-07:00) Arizona

(GMT-06:00) Centre (USA et Canada)

(GMT-06:00) Saskatchewan

(GMT-06:00) Guadalajara, Mexico, Monterrey

(GMT-06:00) Amérique centrale

(GMT-05:00) Est (USA et Canada)

(GMT-05:00) Indiana (Est)

(GMT-05:00) Bogota, Lima, Quito

(GMT-04:00) Atlantique (Canada)

(GMT-04:00) Caracas, La Paz

(GMT-04:00) Santiago

(GMT-03:30) Terre-Neuve

(GMT-03:00) Brasilia

(GMT-03:00) Buenos Aires, Georgetown

(GMT-03:00) Groenland

(GMT-02:00) Centre-Atlantique

(GMT-01:00) Açores

(GMT-01:00) Iles du Cap-Vert

(GMT) Heure de Greenwich : Dublin, Edimbourg, Lisbonne, Londres

(GMT) Casablanca, Monrovia

(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague

(GMT+01:00) Sarajevo, Skopje, Varsovie, Zagreb

(GMT+01:00) Bruxelles, Copenhague, Madrid, Paris

(GMT+01:00) Amsterdam, Berlin, Berne, Rome, Stockholm, Vienne

(GMT+01:00) Afrique centrale -Ouest

(GMT+02:00) Bucarest

(GMT+02:00) Le Caire

(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius

(GMT+02:00) Athènes, Istanbul, Minsk

3

4

10

13

15

20

25

30

33

35

40

45

50

55

56

60

65

70

73

75

80

83

85

90

95

100

105

110

113

115

120

125

130

acl-preference-update 59

Fuseau horaire Paramètre

(GMT+02:00) Jérusalem

(GMT+02:00) Harare, Pretoria

(GMT+03:00) Moscou, St-Petersbourg, Volgograd

(GMT+03:00) Koweït, Riyad

(GMT+03:00) Nairobi

(GMT+03:00) Bagdad

(GMT+03:30) Téhéran

(GMT+04:00) Abu Dhabi, Muscat

(GMT+04:00) Baku, Tbilissi, Erevan

(GMT+04:30) Kabul

(GMT+05:00) Ekaterinbourg

(GMT+05:00) Islamabad, Karachi, Tachkent

(GMT+05:30) Chiennai, Calcutta, Mumbai, New Delhi

(GMT+05:45) Katmandou

(GMT+06:00) Astana, Dhaka

(GMT+06:00) Sri Jayawardenepura

(GMT+06:00) Almaty, Novossibirsk

(GMT+06:30) Rangoon

(GMT+07:00) Bangkok, Hanoi, Djakarta

(GMT+07:00) Krasnoïarsk

(GMT+08:00) Pékin, Chongqoing, Hong Kong, Urumqi

(GMT+08:00) Kuala Lumpur, Singapour

(GMT+08:00) Taipei

(GMT+08:00) Perth

(GMT+08:00) Irkoutsk, Oulan-Bator

(GMT+09:00) Séoul

(GMT+09:00) Osaka, Sapporo, Tokyo

(GMT+09:00) Iakutsk

(GMT+09:30) Darwin

(GMT+09:30) Adélaïde

(GMT+10:00) Canberra, Melbourne, Sydney

(GMT+10:00) Brisbane

(GMT+10:00) Hobart

135

140

145

150

155

158

160

165

170

175

180

185

190

193

195

200

201

203

205

207

210

215

220

225

227

230

235

240

245

250

255

260

265

60 Chapitre 4 : Informations de référence sur les API XML

Fuseau horaire Paramètre

(GMT+10:00) Vladivostok

(GMT+10:00) Guam, Port Moresby

(GMT+11:00) Magadan, Îles Salomon, Nouvelle Calédonie

(GMT+12:00) Iles Fidji, Kamchatka, Iles Marshall

(GMT+12:00) Auckland, Wellington

(GMT+13:00) Nuku’alofa

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.

270

275

280

285

290

300

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
renvoyées, à l’exception de la balise
différente.

Paramètres

Aucun.

Filtres

Vous ne pouvez ni filtrer, ni trier les résultats.

Eléments renvoyés

common

common-info sans vous être connecté au préalable, les mêmes informations sont

user. De plus, la valeur de account-id risque d’être

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>[e-mail]</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

Description

Actualise le champ personnalisé associé au compte spécifié. Le cas échéant, crée un champ
personnalisé.

Paramètres

field-id

custom-fields. Ce paramètre ne doit être spécifié que lorsque vous actualisez un champ

Identifiant du champ à actualiser, que vous pouvez obtenir en appelant l’API

existant.

name Nom du champ personnalisé, compris entre 1 et 60 caractères.

comments Commentaire sur le champ personnalisé, compris entre 0 et 60 caractères.

Ce paramètre est facultatif.

type Type du champ personnalisé. Les types gérés sont les suivants :

Valeur Description

required

optional

optional-no-self-reg

acl-field-update.

Champ personnalisé de compte obligatoire

Facultatif, affiché lors de l’auto-inscription

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

Exemple de résultats

field.

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

Description

acl-field-list.

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

Eléments renvoyés

custom-fields

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>

, field

field-id, par ordre croissant.

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

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

Identifiant du champ à supprimer, que vous pouvez obtenir en appelant l’API

, 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

principal-id Identifiant du mandant dont vous souhaitez actualiser l’appartenance.

is-member 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.

Identifiant du groupe dont vous souhaitez actualiser l’appartenance.

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

Paramètres

curriculum-id

sco-expanded-contents.

Identifiant du curriculum auquel appartient l’objet d’étude.

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

curriculum-id

name

path-type

permission-id

target-sco-id

Le champ

target-sco-id contient l’identifiant de l’objet d’étude qui limite les accès à l’objet

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

d’étude actuel. Ainsi, si un objet d’étude est associé à des conditions préalables, le SCO
correspondant est

66 Chapitre 4 : Informations de référence sur les API XML

target-sco-id.

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

.

path

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

sco-id="5400247" path-type="completion-required">

<name>New Hire Safety</name>
</learning-path>
<learning-path curriculum-id="5400246" current-sco-id="5400246" target-

sco-id="5400248" path-type="completion-required">

<name>Beginning Electronics</name>
</learning-path>
<learning-path curriculum-id="5400246" current-sco-id="5400246" target-

sco-id="5400413" path-type="completion-required">

<name>Electronics 2</name>
</learning-path>
<learning-path curriculum-id="5400246" current-sco-id="5400246" target-

sco-id="5400414" path-type="completion-required">

<name>Electronics 3</name>
</learning-path>
<learning-path curriculum-id="5400246" current-sco-id="5400249" target-

sco-id="5400248" path-type="prereq-suggested">

<name>Beginning Electronics</name>
</learning-path>
<learning-path curriculum-id="5400246" current-sco-id="5400413" target-

sco-id="5400248" path-type="prereq-required">

<name>Beginning Electronics</name>
</learning-path>

learning-path-info 67

<learning-path curriculum-id="5400246" current-sco-id="5400414" target-

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

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.

Identifiant du curriculum auquel appartient 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.

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

path-type correspond à prereq-req et target-sco-id à « Programmation avancée ».

path-type Le champ path-type gère les valeurs suivantes :

current-sco-id, l’attribut

• completion-none

• completion-required

• preass-blocked

• preass-hidden

• preass-none

• prereq-hidden

• prereq-none

• preass-optional

• prereq-required

• prereq-suggested

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

BREEZESESSION,

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="[e-mail]"
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

account-id

organisation ne dispose que d’un seul compte, ne spécifiez pas le paramètre

login Nom de connexion de l’utilisateur, qui correspond généralement à son adresse

Identifiant du compte associé à cet utilisateur. Ce paramètre est facultatif. Si votre

account-id.

électronique.

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
informations sur les autorisations dont dispose un mandant déterminé.

Pour déterminer l’identifiant à utiliser en tant que paramètre

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

principal-id Identifiant d’un mandant spécifique. Ce paramètre est facultatif.

Identifiant d’un SCO spécifique.

principal-id pour extraire des

principal-id, appelez l’API

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

has-children

is-primary

login

name

permission-id

type

Remarque : Les champs logged-in-access et public-access sont systématiquement renvoyés,
quels que soient les filtres utilisés.

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

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

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>[e-mail]</login>

</principal>
<principal principal-id="181249" is-primary="false" type="user"

has-children="false" permission-id="view">
<name>Milligan, Susan</name>
<login>[e-mail]</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

Filtres

Vous ne pouvez ni filtrer, ni trier les résultats.

Eléments renvoyés

Aucun.

Exemple de résultats

<results>

</results>

Identifiant d’un SCO.

<status code="ok" />

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
section Présentation des paramètres, page 16.

acl-id, permission-id et principal-id. Pour plus d’informations, consultez la

permissions-update 73

Paramètres

acl-id

permission-id Identifiant d’une autorisation.

principal-id Identifiant d’un mandant (utilisateur ou groupe).

Filtres

Identifiant d’un SCO.

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-list (le cas échéant, utilisez un filtre pour limiter les données renvoyées).

principal-id, appelez l’API

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

Filtres

Identifiant d’un mandant spécifique.

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>[e-mail]</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>[e-mail]</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

description

has-children

is-hidden

is-primary

login

name

principal-list

type

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

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" has­children="false" is-primary="false" is-hidden="0">

<name>Enterprise Administrator</name>
<login>[e-mail]</login>

<email>[e-mail]</email>
</principal>
<principal principal-id="18" contact-id="" type="authors" has-

children="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

Filtres

Valeur du champ sur lequel vous voulez baser la recherche.

Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données.

Champ Filtrage/tri

account-id

principal-id

type

has-children

is-primary

name

login

description

Filtrage et tri
Filtrage et tri
Filtrage et tri
Filtrage et tri
Filtrage et tri
Filtrage et tri
Filtrage et tri
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" has-

children="false" is-primary="false" is-hidden="false">

<name>John Doe</name>

<login>[e-mail]</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-id. Si vous créez un mandant, le code XML renvoyé contient les informations sur le

principal-update sans spécifier le paramètre

nouveau mandant, y compris son identifiant.

Dans Breeze 4, l’API
Dans Breeze 5.1, vous devez appeler

Paramètres

description

principal-update vous autorisait à actualiser les champs personnalisés.

acl-field-update pour les actualiser.

Description du nouveau groupe. Utilisé uniquement lors de la création d’un

nouveau groupe.

first-name Nouveau prénom à affecter à l’utilisateur. Utilisé uniquement lors de la création ou

de l’actualisation d’un utilisateur.

has-children 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.

last-name Nouveau nom à affecter à l’utilisateur. Utilisé uniquement lors de la création ou de

l’actualisation d’un utilisateur.

78 Chapitre 4 : Informations de référence sur les API XML

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

name Nom du nouveau groupe. Utilisé uniquement lors de la création d’un nouveau groupe.

password Mot de passe du nouvel utilisateur. Utilisé uniquement lors de la création d’un

nouvel utilisateur.

principal-id Identifiant du mandant dont vous modifiez les données. Si vous ne précisez pas

ce paramètre, l’API

type Type du nouveau mandant. Utilisé uniquement lors de la création d’un nouveau

principal-update crée un nouveau mandant.

mandant. Pour plus d’informations sur les types disponibles, consultez la section Présentation des

mandants, des SCO et des identifiants, page 17.

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,
renvoyés pour

Exemple de résultats

principal-info).

principal est renvoyé (dans le même format que les éléments

Exemples de résultats renvoyés lors de la création d’un nouveau mandant :

<results>

<status code="ok" />
<principal type="user" principal-id="2500848" has-children="0" account­id="181224">

<login>[e-mail]</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
d’informations, consultez la section Présentation des paramètres, page 16.

Paramètres

principal-id

Identifiant d’un mandant à supprimer.

principal-id. Pour plus

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

attendance

Description

ou report-bulk-consolidated-transactions.

report-meeting-

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

date-created

login

participant-name

principal-id

sco-name

tr.sco_id

transcript-id

Eléments renvoyés

report-account-meeting-attendance

Filtrage et tri

Filtrage et tri

Filtrage et tri

Tri

Filtrage et tri

Tri

Filtrage et tri

Filtrage et tri

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>[e-mail]</login>

<sco-name>test-mtg-1</sco-name>

<date-closed>2004-07-09T13:02:55.810-07:00</date-closed>

<login>[e-mail]</login>
<session-name>Enterprise Administrator</session­ name>
<sco-name>test-mtg-1</sco-name>
<date-created>2004-07-09T14:33:06.577-07:00</date­ created>
<date-closed>2004-07-09T14:33:43.547-07:00</date­ closed>
<participant-name>Enterprise Administrator</participant­ name>

</report-account-meeting-attendance>
</results>

<session-name>Enterprise Administrator</session-name>

<date-created>2004-07-09T13:00:28.920-07:00</date-created>

<participant-name>Enterprise Administrator</participant-name>
</row>
<row account-id="7" transcript-id="685" sco-id="623" principal-id="8"

contact-id="3">

</row>

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

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

Identifiant d’une réunion ; si ce paramètre est spécifié, le rapport renvoie des

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

login

name

principal-id

score

status

transaction-id

url

user-name

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>[e-mail]</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>[e-mail]</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>

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

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

number="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</answer-

text>
<answer-correct>YES</answer-correct>
</row>

- <row presentation-id="720" quiz-id="1" quiz-passing-score="10" question-

number="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-questions et

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

quiz-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
est incorrect, téléchargez le programme de mise à jour du site Licensed Support Center.

Paramètres

renvoie des données XML plutôt que des données CSV.

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

presentation-attempt-id

presentation-id

question-number

quiz-id

user-id

user-login

user-response

report-quiz-interactions,

report-bulk-

Filtrage uniquement

Filtrage uniquement

Filtrage uniquement

Filtrage et tri

Filtrage uniquement

Filtrage et tri

Filtrage uniquement

Filtrage uniquement

time-taken

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>[e-mail]</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"

quiz-id="1" question-number="2" user-response="3">

<user-login>[e-mail]</user-login>

<date-time-attempted>2004-07-13T10:52:23.780-07:00</date-time-

attempted>

<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

Description

report-bulk-slide-views.

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

presentation-name

slide-number

user-first-name

user-last-name

user-login

view-date-time

Tri

Tri

Filtrage et tri

Tri

Tri

Tri

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>[e-mail]</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">

</results>

<user-login>[e-mail]</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>

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

number="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</answer-

text>

<answer-correct>YES</answer-correct>
</row>
<row course-id="727" quiz-id="1" quiz-passing-score="10" question-

number="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

Description

report-quiz-interactions.

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

course-id

date-time-attempted

quiz-id

question-number

Tri

Tri

Tri

Tri

Filtrage et tri

report-bulk-course-results 89

Champ Filtrage/tri

time-taken

user-id

user-login

user-response

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>[e-mail]</user-login>
<date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-

attempted>

<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>[e-mail]</user-login>
<date-time-attempted>2004-07-13T10:54:09.030-07:00</date-time-

attempted>
<time-taken>00:00:34.017</time-taken>
</row>
</report-bulk-course-quiz-results>
</results>

Attention : Le formatage de la balise XML
par le programme de mise à jour de Breeze 4.1. Si le format du contenu d’une balise XML
est incorrect, téléchargez le programme de mise à jour du site Licensed Support Center.

Tri

Filtrage et tri

Tri

Tri

time-taken était incorrect, mais le problème a été résolu

time-taken

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
que l’illustre l’exemple suivant :

http://breezeserver/api/xml?action=report-bulk-objects&filter-like-

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

report-bulk-objects pour le champ type, ainsi

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

scheduled-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</meeting-

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

attendee-exit

attendee-join

meeting-attendee

Tri

Tri

Tri

Tri

report-bulk-meeting-attendance 91

Champ Filtrage/tri

meeting-id

meeting-name

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

Tri

Tri

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

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

name

type

url

Filtrage et tri

Filtrage et tri

Filtrage et tri

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

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

like. Par exemple, dans le code ci-dessous, la première

Voir aussi

report-bulk-consolidated-transactions

, report-bulk-users

views

, report-bulk-questions, report-bulk-slide-

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

principal-id

question

response

score

transaction-id

Eléments renvoyés

report-bulk-questions

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

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

views

, report-bulk-consolidated-transactions, report-bulk-slide-

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

page

principal-id

transaction-id

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>

Filtrage et tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

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
transactions

, report-bulk-users

report-bulk-users

, report-bulk-questions, report-bulk-consolidated-

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

name=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.

Champ Filtrage/tri

email

login

96 Chapitre 4 : Informations de référence sur les API XML

Filtrage et tri

Filtrage et tri

Champ Filtrage/tri

manager

name

principal-id

type

Filtrage et tri

Filtrage et tri

Filtrage et tri

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

http://breezeserver/api/xml?action=report-bulk-objects&filter-like-

type=presentation

Eléments renvoyés

report-bulk-users

Exemple de résultats

<results>

<status code="ok" />
<report-bulk-users>

<row principal-id="181231">

<login>[e-mail]</login>

<name>Nathan Son</name>

<email>[e-mail]</email>

<manager>[e-mail]</manager>

<type>user</type>
</row>
<row principal-id="182532">

<login>[e-mail]</login>

<name>laxmi vish</name>

<email>[e-mail]</email>

<type>user</type>
</row>
<row principal-id="3914851">

<login>[e-mail]</login>

<name>Apple Cobbler</name>

<email>[e-mail]</email>

<manager>[e-mail]</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 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-course­ completions="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-course-

completions="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>

Identifiant du mandant pour lequel l’état du cours a été demandé.

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

Description

Renvoie la liste des utilisateurs inscrits au cours spécifié.

Paramètres

sco-id

Filtres

Identifiant d’un cours.

Le tableau ci-dessous répertorie les champs sur lesquels baser le filtrage ou le tri des données.

Champ Filtrage/tri

answered-survey

date-taken

certificate

login

percentage-score

principal-name

sco-id

status

transcript-id

time-taken

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

report-quiz-takers.

Tri

Filtrage et tri

Tri

Tri

Filtrage et tri

Tri

Filtrage et tri

Filtrage et tri

Filtrage et tri

Tri

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-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>[e-mail]</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>[e-mail]</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>[e-mail]</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