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

Identificador asignado por Classroom.

Solo lectura.

userId

string

Identificador del usuario invitado.

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

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

string

Identificador del curso al que invitar al usuario.

role

enum ( CourseRole )

Rol a invitar al usuario a tener. No debe ser COURSE_ROLE_UNSPECIFIED .

CursoRol

Posibles roles a los que se puede invitar a un usuario.

Enumeraciones
COURSE_ROLE_UNSPECIFIED Sin función de curso.
STUDENT Estudiante en el curso.
TEACHER Profesor del curso.
OWNER Dueño del curso.

Métodos

accept

Acepta una invitación, eliminándola y agregando el usuario invitado a los profesores o alumnos (según corresponda) del curso especificado.

create

Crea una invitación.

delete

Elimina una invitación.

get

Devuelve una invitación.

list

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