REST Resource: invitations

• Recurso: invitación
  • Representación JSON
• Función del curso
• Métodos

Recurso: Invitation

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 un parámetro de una solicitud, este identificador se puede establecer como 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 para invitar al usuario.
role	enum (CourseRole) Función que se debe invitar al usuario. No debe ser COURSE_ROLE_UNSPECIFIED.

Función del curso

Posibles funciones que se le pueden invitar a un usuario.

Enumeradores
COURSE_ROLE_UNSPECIFIED	No hay ningún rol en el curso.
STUDENT	Alumno en el curso.
TEACHER	Profesor del curso.
OWNER	Propietario del curso.

Métodos
accept	Acepta una invitación, la quita y agrega el usuario invitado a los profesores o los 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 que realiza la solicitud puede ver, restringida a aquellas que coinciden con la solicitud de la lista.