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

Es el identificador del usuario invitado.

Cuando se especifica como parámetro de una solicitud, este identificador se puede establecer en una de las siguientes opciones:

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

string

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

role

enum (CourseRole)

Rol para invitar al usuario. No debe ser COURSE_ROLE_UNSPECIFIED.

CourseRole

Posibles roles que podría tener un usuario

Enumeradores
COURSE_ROLE_UNSPECIFIED Sin rol en el curso.
STUDENT Estudiante del curso.
TEACHER Profesora del curso.
OWNER Propietario del curso

Métodos

accept

Acepta una invitación, la quita y agrega al usuario invitado a los profesores o alumnos (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.