REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Um convite para se tornar responsável por um usuário específico, enviado para um endereço de e-mail especificado.

Representação JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Campos
studentId

string

ID do estudante (em formato padrão)
invitationId

string

Identificador exclusivo do convite.

Somente leitura.
invitedEmailAddress

string

Endereço de e-mail para onde o convite foi enviado. Esse campo só fica visível para administradores de domínio.
state

enum (GuardianInvitationState)

O estado em que este convite se encontra.
creationTime

string (Timestamp format)

O horário em que o convite foi criado.

Somente leitura.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Estado de um convite de responsável.

Tipos enumerados
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca deve ser retornado.
PENDING O convite está ativo e aguardando uma resposta.
COMPLETE O convite não está mais ativo. Ele pode ter sido aceito, recusado, retirado ou expirado.

Métodos

create

 Cria um convite para responsável e envia um e-mail pedindo que ele confirme que é o responsável do estudante.

get

 Retorna um convite específico de responsável.

list

 Retorna uma lista de convites de responsáveis que o usuário solicitante tem permissão para visualizar, filtrada pelos parâmetros fornecidos.

patch

 Modifica um convite de responsável.