Method: userProfiles.guardianInvitations.get

Retorna o convite de um 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 acessar os convites para os responsáveis do estudante identificado pelo studentId, se os responsáveis não estiverem ativados para o domínio em questão ou para outros erros de acesso.
  • INVALID_ARGUMENT se um studentId for especificado, 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).
  • NOT_FOUND se o Google Sala de Aula não encontrar nenhum registro do estudante ou invitationId. Também pode ser devolvido se o estudante existir, mas o usuário solicitante não tiver acesso para acessá-lo.

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 ID do estudante para quem o convite para o 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 de 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.