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 sur l'un des éléments suivants:

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête
courseId

string

Identifiant du cours auquel inviter l'utilisateur.
role

enum (CourseRole)

Rôle que vous invitez l'utilisateur à occuper. Ne doit pas être COURSE_ROLE_UNSPECIFIED.

CourseRole

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

Enums
COURSE_ROLE_UNSPECIFIED Aucun rôle dans le cours.
STUDENT Élève participant au cours.
TEACHER Enseignant 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

 Affiche la liste des invitations que l'utilisateur à l'origine de la requête est autorisé à consulter, limitées à celles qui correspondent à la requête de liste.