REST Resource: invitations

Risorsa: invito

Un invito a partecipare a un corso.

Rappresentazione JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Campi
id

string

Identificatore assegnato da Classroom.

Sola lettura.
userId

string

Identificatore dell'utente invitato.

Se specificato come parametro di una richiesta, questo identificatore può essere impostato su uno dei seguenti valori:

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • la stringa letterale "me", che indica l'utente che effettua la richiesta
courseId

string

Identificatore del corso a cui invitare l'utente.
role

enum (CourseRole)

Ruolo da assegnare all'utente. Non deve essere COURSE_ROLE_UNSPECIFIED.

CourseRole

Possibili ruoli che un utente può ricevere.

Enum
COURSE_ROLE_UNSPECIFIED Nessun ruolo nel corso.
STUDENT Studente del corso.
TEACHER Insegnante del corso.
OWNER Proprietario del corso.

Metodi

accept

 Accetta un invito, rimuovendolo e aggiungendo l'utente invitato agli insegnanti o agli studenti (a seconda dei casi) del corso specificato.

create

 Crea un invito.

delete

 Consente di eliminare un invito.

get

 Restituisce un invito.

list

 Restituisce un elenco di inviti che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta dell'elenco.