Method: userProfiles.guardians.get

Retorna um tutor específico.

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

  • PERMISSION_DENIED se nenhum usuário que corresponda ao studentId fornecido estiver visível para o usuário solicitante, se o usuário solicitante não tiver permissão para acessar as informações de responsáveis do 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 usuário solicitante tiver permissão para visualizar os responsáveis do studentId solicitado, mas não houver um registro de Guardian para esse estudante que corresponda ao guardianId fornecido.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
studentId

string

O estudante cujo responsável está sendo solicitado. Opções:

  • 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
guardianId

string

O campo id de um Guardian.

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • 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.