Method: userProfiles.guardianInvitations.get

Retorna um convite de responsável específico.

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

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para visualizar os convites de responsáveis pelo estudante identificado pelo studentId, 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, um studentId da API nem a string literal me).
  • NOT_FOUND se o Google Sala de Aula não encontrar nenhum registro do estudante ou do invitationId. Também pode ser retornado se o estudante existir, mas o usuário solicitante não tiver acesso para visualizar esse estudante.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
studentId

string

O documento de identificação do estudante para quem o convite de responsável está sendo solicitado.
invitationId

string

O campo id do GuardianInvitation que está sendo solicitado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de GuardianInvitation.

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.