Method: userProfiles.guardianInvitations.list

Retorna uma lista de convites para responsáveis que o usuário solicitante tem permissão para ver, filtrada pelos parâmetros fornecidos.

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

  • PERMISSION_DENIED se uma studentId for especificada e o usuário solicitante não tiver permissão para ver os convites para os responsáveis desse estudante, se "-" for especificado como studentId e o usuário não for um administrador do domínio, se os responsáveis não estiverem ativados para o domínio em questão ou por outros erros de acesso.
  • INVALID_ARGUMENT se uma studentId for especificada, mas o formato não puder ser reconhecido (não é um endereço de e-mail, um studentId da API nem a string literal me). Também pode ser retornado se um pageToken ou state inválido for fornecido.
  • NOT_FOUND: se uma studentId for especificada, e o formato puder ser reconhecido, mas o Google Sala de Aula não tiver registro desse estudante.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

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

Parâmetros de caminho

Parâmetros
studentId

string

O documento de identificação do estudante que vai receber os convites dos responsáveis. 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
  • O literal de string "-", indicando que os resultados precisam ser retornados para todos os estudantes que têm permissão para ver os convites para os responsáveis.

Parâmetros de consulta

Parâmetros
invitedEmailAddress

string

Se especificado, apenas os resultados com o invitedEmailAddress especificado são retornados.
states[]

enum (GuardianInvitationState)

Se especificado, apenas os resultados com os valores state especificados são retornados. Caso contrário, os resultados com um state de PENDING serão retornados.
pageToken

string

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.
pageSize

integer

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

O servidor pode retornar menos resultados que o especificado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar convites para responsáveis.

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

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

object (GuardianInvitation)

Convites para os responsáveis que correspondem à solicitação da lista.
nextPageToken

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, nenhum outro resultado estará disponível.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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