REST Resource: invitations

Ressource: Invitation

Invitation à rejoindre un cours.

Représentation JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Champs
id

string

Identifiant attribué par Classroom.

Lecture seule.
userId

string

Identifiant de l'utilisateur invité.

Lorsqu'il est spécifié en tant que paramètre d'une requête, cet identifiant peut être défini comme suit:

  • l'identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • Le littéral de chaîne "me", indiquant l'utilisateur à l'origine de la demande
courseId

string

Identifiant du cours auquel inviter l'utilisateur.
role

enum (CourseRole)

Rôle à inviter l'utilisateur. Ne doit pas être COURSE_ROLE_UNSPECIFIED.

CourseRole

Rôles qu'un utilisateur peut être invité à occuper.

Enums
COURSE_ROLE_UNSPECIFIED Aucun rôle dans le cours.
STUDENT Élève faisant partie du cours.
TEACHER Professeur du cours.
OWNER Propriétaire du cours

Méthodes

accept

 Accepte une invitation, la supprime et ajoute l'utilisateur invité aux enseignants ou aux élèves (selon le cas) du cours spécifié.

create

 Crée une invitation.

delete

 Supprime une invitation.

get

 Renvoie une invitation.

list

 Renvoie une liste d'invitations que l'utilisateur à l'origine de la demande est autorisé à consulter, limitée à celles qui correspondent à la demande de liste.