MeetingHub MeetingHub Télécharger la collection Postman

Déposer une liste d'inscrits

Inscrire une classe entière en une requête.

Une rentrée, c'est des centaines d'inscriptions le même jour. Votre système les dépose en une fois : MeetingHub rattache les personnes qui ont déjà un compte, et crée celles qui n'en ont pas. Chaque champ est détaillé dans la référence : Listes d'inscrits.

Il faut une clé de portée roster:write, et que la classe existe déjà — par exemple créée par un dépôt d'emploi du temps qui la cite dans group.ref. Dans les adresses ci-dessous, :institutionId est l'identifiant de votre établissement, rendu par GET /api/me.

Le dépôt

PUT /api/institutions/:institutionId/classes/by-ref/bts-sio-1/roster?dryRun=false
{ "members": [
    { "email": "awa@ecole.fr", "displayName": "Awa Diallo" },
    { "phone": "6 99 12 34 56", "displayName": "Ben Traoré" } ] 
}

La classe se désigne dans l'adresse, par sa référence chez vous. Chaque personne se désigne par son courriel, son téléphone, ou les deux : bien des apprenants n'ont pas de courriel qu'ils relèvent, tous ont un téléphone.

À blanc par défaut

Sans ?dryRun=false, rien n'est écrit : la réponse dit seulement ce qui serait fait. C'est l'inverse du dépôt d'emploi du temps, et c'est voulu : appliquer une liste crée des comptes, ce qui ne se défait pas d'un clic. Lancez d'abord l'essai, lisez le rapport, puis appliquez.

Une personne qui a déjà un compte ailleurs n'entre pas d'office : elle est invitée, reçoit un courriel, et rejoint votre établissement — et la classe — en acceptant depuis « Mon espace ». Le rapport la cite dans awaitingAcceptance. Tant qu'elle n'a pas accepté, vous ne voyez ni son nom, ni ses coordonnées.

Le nom est obligatoire

Chaque personne doit avoir un displayName : c'est le nom qui figurera sur les feuilles de présence, et « awa@ecole.fr » n'en est pas un. Une ligne sans nom est refusée plutôt que d'en inventer un.

Les lignes refusées sont rendues dans le rapport avec leur position dans la liste, en comptant à partir de 1, et leur cause : courriel ou téléphone illisible, ni l'un ni l'autre, doublon, ou nom absent. Les autres lignes passent.

Les liens d'activation

Un compte créé par le dépôt n'a pas encore de mot de passe : la personne le choisit elle-même, en suivant un lien d'activation.

Aujourd'hui, MeetingHub n'envoie pas ces liens. Le rapport les rend, un par compte créé, dans invitations. C'est à votre système de les remettre aux personnes, par votre propre messagerie, un SMS ou WhatsApp.

Un lien vaut un mot de passe : il ouvre le compte à qui le possède. Transmettez-le à la seule personne concernée, et ne le gardez pas dans vos journaux. Il est valable 7 jours et ne sert qu'une fois.

Rejouer le dépôt

Rejouer la même liste est sans effet : les personnes déjà inscrites sont comptées comme telles, rien n'est recréé. En conséquence, un lien perdu n'est pas réémis par un nouveau dépôt : un administrateur de l'établissement en émet un nouveau depuis MeetingHub.

Le dépôt n'enlève jamais personne : une personne absente de la liste reste dans la classe.