Method: userProfiles.guardianInvitations.patch

Modifica um convite de responsável.

No momento, a única modificação válida é mudar o state de PENDING para COMPLETE. Isso tem o efeito de cancelar o convite.

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

  • PERMISSION_DENIED se o usuário atual não tiver permissão para gerenciar tutores, se os tutores não estiverem ativados para o domínio em questão ou por outros erros de acesso.
  • FAILED_PRECONDITION se a vinculação do responsável não estiver no estado PENDING.
  • INVALID_ARGUMENT se o formato do ID do estudante fornecido não puder ser reconhecido (não é um endereço de e-mail nem um userId dessa API) ou se o GuardianInvitation transmitido tiver um state diferente de COMPLETE ou se ele modificar campos diferentes de state.
  • NOT_FOUND se o documento de identificação do estudante fornecido for válido, mas o Google Sala de Aula não tiver registro desse estudante ou se o campo id não se referir a um convite de responsável conhecido do Google Sala de Aula.

Solicitação HTTP

PATCH 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 cujo convite para o responsável será modificado.
invitationId

string

O campo id do GuardianInvitation a ser modificado.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Máscara que identifica quais campos do curso serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização falha se campos inválidos forem especificados. Os seguintes campos são válidos:

  • state

Quando definido em um parâmetro de consulta, esse campo precisa ser especificado como

updateMask=<field1>,<field2>,...

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

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 conterá 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.