Method: courses.courseWork.list

Retorna uma lista de trabalhos do curso que o solicitante tem permissão para acessar.

Os estudantes do curso só podem acessar o trabalho do curso PUBLISHED. Os professores e administradores do domínio podem acessar todo o trabalho do curso.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para acessar o curso solicitado ou em caso de erros de acesso.
  • INVALID_ARGUMENT se a solicitação estiver incorreta.
  • NOT_FOUND, se o curso solicitado não existir.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
courseId

string

Identificador do curso. Esse identificador pode ser o atribuído pelo Google Sala de Aula ou um alias.

Parâmetros de consulta

Parâmetros
courseWorkStates[]

enum (CourseWorkState)

Restrição ao status do trabalho a ser retornado. Somente as atividades correspondentes são retornadas. Se não for especificado, os itens com um status de trabalho de PUBLISHED serão retornados.

orderBy

string

Ordem de classificação opcional para os resultados. Uma lista de campos separados por vírgulas com uma palavra-chave opcional de direção de ordenação. Os campos aceitos são updateTime e dueDate. As palavras-chave de direção aceitas são asc e desc. Se não for especificado, o comportamento padrão será updateTime desc. Exemplos: dueDate asc,updateTime desc, updateTime,dueDate desc

pageSize

integer

Número máximo de itens a serem retornados. Zero ou indefinido indica que o servidor pode atribuir um valor máximo.

O servidor pode retornar menos resultados do que o especificado.

pageToken

string

O valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada.

A solicitação list precisa ser idêntica à que resultou nesse token.

previewVersion

enum (PreviewVersion)

Opcional. A versão de pré-lançamento da API. Isso precisa ser definido para acessar novos recursos de API disponibilizados para desenvolvedores no programa de visualização.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar o trabalho do curso.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}
Campos
courseWork[]

object (CourseWork)

Itens de trabalho de curso que correspondem à solicitação.

nextPageToken

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

Para mais informações, consulte o guia de autorização.