REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

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

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

string

Documento de identificação do estudante (no 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ó é visível para administradores de domínio.
state

enum (GuardianInvitationState)

O estado em que o convite está.
creationTime

string (Timestamp format)

O horário em que o convite foi criado.

Somente leitura.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Estado de um convite de responsável

Enums
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. Talvez ela tenha sido aceita, recusada, retirada ou expirado.

Métodos

create

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

get

 Retorna um convite de responsável específico.

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.