REST Resource: invitations

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 uma das seguintes opções:

  • 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 que você quer convidar o usuário a ter. Não pode ser COURSE_ROLE_UNSPECIFIED.

CourseRole

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

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

Métodos

accept

 Aceita um convite, removendo-o 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.