REST Resource: invitations

• Recurso: convite
  • Representação JSON
• Cargo
• Métodos

Recurso: convite

Um convite para participar de um curso.

Representação JSON
{ "id": string, "userId": string, "courseId": string, "role": enum (CourseRole) }

Campos
id	string Identificador atribuído pelo Google Sala de Aula. Somente leitura.
userId	string Identificador do usuário convidado. Quando especificado como um parâmetro de uma solicitação, esse identificador pode ser definido como um dos seguintes: o identificador numérico do usuário o endereço de e-mail do usuário; o literal de string "me", indicando o usuário solicitante
courseId	string Identificador do curso para convidar o usuário.
role	enum (CourseRole) Função a ser convidada para o usuário. Não pode ser COURSE_ROLE_UNSPECIFIED.

Função do curso

Possíveis funções que um usuário pode ser convidado.

Enums
COURSE_ROLE_UNSPECIFIED	Sem função de curso.
STUDENT	Estudante no curso.
TEACHER	Professor do curso.
OWNER	Proprietário do curso.

Métodos
accept	Aceita um convite, removendo e adicionando o usuário convidado aos professores ou estudantes (conforme apropriado) do curso especificado.
create	Cria um convite.
delete	Exclui um convite.
get	Retorna um convite.
list	Retorna uma lista de convites que o usuário solicitante tem permissão para visualizar, restrita aos que correspondem à solicitação de lista.