- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Cria um convite para o responsável e envia um e-mail para o responsável solicitando a confirmação de identidade do responsável.
Quando o responsável aceitar o convite, o state
mudará para COMPLETED
, e ele começará a receber notificações. Um recurso de Guardian
também será criado para representar o responsável ativo.
O objeto de solicitação precisa ter os campos studentId
e invitedEmailAddress
definidos. Deixar de definir esses campos ou configurar outros na solicitação resultará em um erro.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED
: se o usuário atual não tiver permissão para gerenciar os responsáveis, o responsável em questão já tiver recusado muitas solicitações para o aluno, os responsáveis não estiverem ativados para o domínio em questão ou outros erros de acesso.RESOURCE_EXHAUSTED
se o estudante ou o responsável tiver excedido o limite de links de responsável.INVALID_ARGUMENT
se o endereço de e-mail do responsável não for válido (por exemplo, se for muito longo) ou se o formato da carteira de estudante fornecida não for reconhecido (não é um endereço de e-mail nem umuserId
desta API). Esse erro também será retornado se os campos somente leitura estiverem definidos ou se o campostate
estiver definido como um valor diferente dePENDING
.NOT_FOUND
se o ID de estudante fornecido for válido, mas o Google Sala de Aula não tiver um registro desse estudante.ALREADY_EXISTS
se já houver um convite pendente para o responsável pelo estudante e peloinvitedEmailAddress
fornecido ou se oinvitedEmailAddress
informado corresponder à Conta do Google de umGuardian
para o usuário.
Solicitação HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
guardianInvitation.studentId |
Documento de identificação do estudante (no formato padrão) |
Corpo da solicitação
O corpo da solicitação contém uma instância de GuardianInvitation
.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de GuardianInvitation
.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para mais informações, consulte o Guia de autorização.