Method: invitations.list

Retorna uma lista de convites que o usuário solicitante tem permissão para visualizar, restrita aos que correspondem à solicitação de lista.

Observação:é necessário fornecer pelo menos userId ou courseId. É possível fornecer os dois campos.

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

Solicitação HTTP

GET https://classroom.googleapis.com/v1/invitations

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

Parâmetros de consulta

Parâmetros
userId

string

Restringe os convites retornados para um usuário específico. O identificador pode ser 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

Restringe os convites retornados para aqueles de um curso com o identificador especificado.
pageSize

integer

Número máximo de itens a serem retornados. O padrão é 500 se não for especificado ou 0.

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.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao receber convites para listagens.

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

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

object (Invitation)

Convites que correspondem à solicitação de lista.
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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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