REST Resource: invitations

Recurso: Invitación

Una invitación para unirse a un curso.

Representación JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Campos
id

string

Es el identificador que asigna Classroom.

Solo lectura.
userId

string

Es el identificador del usuario invitado.

Cuando se especifica como un parámetro de una solicitud, este identificador se puede establecer en uno de los siguientes valores:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante
courseId

string

Es el identificador del curso al que se invitará al usuario.
role

enum (CourseRole)

Es el rol que se le invita al usuario a tener. No debe ser COURSE_ROLE_UNSPECIFIED.

CourseRole

Son los posibles roles que se le pueden invitar a tener a un usuario.

Enumeraciones
COURSE_ROLE_UNSPECIFIED No hay ningún rol en el curso.
STUDENT Estudiante del curso.
TEACHER Es el profesor del curso.
OWNER Es el propietario del curso.

Métodos

accept

 Acepta una invitación, la quita y agrega al usuario invitado a los profesores o estudiantes (según corresponda) del curso especificado.

create

 Crea una invitación.

delete

 Borra una invitación.

get

 Muestra una invitación.

list

 Muestra una lista de invitaciones que el usuario solicitante puede ver, restringida a aquellas que coinciden con la solicitud de lista.