Method: userProfiles.guardianInvitations.list

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

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

  • PERMISSION_DENIED se um studentId for especificado e o usuário solicitante não tiver permissão para visualizar os convites de responsáveis para esse estudante, se "-" for especificado como studentId e o usuário não for 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 um studentId for especificado, mas o formato dele não puder ser reconhecido (ele não é um endereço de e-mail, nem 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 um studentId for especificado e o formato dele 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 cujos convites para o responsável serão devolvidos. 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 devem ser retornados para todos os estudantes que o usuário solicitante tem permissão para visualizar os convites de responsáveis.

Parâmetros de consulta

Parâmetros
invitedEmailAddress

string

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

enum (GuardianInvitationState)

Se especificado, apenas os resultados com os valores state especificados serão retornados. Caso contrário, os resultados com um state de PENDING são retornados.
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.
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.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao mostrar convites de 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 de responsáveis que corresponderam à 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.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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