REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Um convite para se tornar responsável de 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

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 o qual o convite foi enviado. Esse campo só é visível para administradores de domínio.
state

enum (GuardianInvitationState)

O estado em que este convite se encontra.
creationTime

string (Timestamp format)

A hora em que este convite foi criado.

Somente leitura.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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. Ela pode ter sido aceita, recusada, retirada ou expirou.

Métodos

create

 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.

get

 Retorna o convite de um responsável específico.

list

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

patch

 Modifica um convite de responsável.